diff --git a/esignature.rest.swagger-v2.1.json b/esignature.rest.swagger-v2.1.json index 9bed72a..01c69d4 100644 --- a/esignature.rest.swagger-v2.1.json +++ b/esignature.rest.swagger-v2.1.json @@ -100,7 +100,7 @@ "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\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\n[newAccountDefinition]: #/definitions/newAccountDefinition\n", "operationId": "Accounts_PostAccounts", "consumes": [], "produces": [], @@ -633,7 +633,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": [], @@ -1085,7 +1085,7 @@ "tags": [ "AccountBrands" ], - "summary": "Export a brand.", + "summary": "Exports a brand.", "operationId": "BrandExport_GetBrandExportFile", "consumes": [], "produces": [], @@ -1458,14 +1458,13 @@ }, "parameters": [] }, - "/v2.1/accounts/{accountId}/bulk_envelopes": { + "/v2.1/accounts/{accountId}/bulk_send_lists": { "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": "Gets bulk send lists", + "operationId": "BulkSendV2CRUD_GetBulkSendLists", "consumes": [], "produces": [], "parameters": [ @@ -1475,34 +1474,207 @@ "description": "The external account number (int) or account ID GUID.", "required": true, "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/bulkSendingListSummaries" + } }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "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 + }, + "post": { + "tags": [ + "BulkSend" + ], + "summary": "Creates a bulk send list", + "operationId": "BulkSendV2CRUD_PostBulkSendList", + "consumes": [], + "produces": [], + "parameters": [ { - "name": "count", - "in": "query", - "description": "The number of results to return. Can be 1 to 20.", - "required": false, + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, "type": "string" }, { - "name": "include", - "in": "query", + "name": "BulkSend", + "in": "body", "required": false, + "schema": { + "$ref": "#/definitions/BulkSend" + }, + "description": "" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/BulkSend" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "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.", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}": { + "get": { + "tags": [ + "BulkSend" + ], + "summary": "Gets a specific bulk send list", + "operationId": "BulkSendV2CRUD_GetBulkSendList", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "bulkSendListId", + "in": "path", + "required": true, "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 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/BulkSend" + } }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "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 + }, + "put": { + "tags": [ + "BulkSend" + ], + "summary": "Updates a bulk send list", + "operationId": "BulkSendV2CRUD_PutBulkSendList", + "consumes": [], + "produces": [], + "parameters": [ { - "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.", + "name": "accountId", + "in": "path", + "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." + }, + { + "name": "BulkSend", + "in": "body", "required": false, + "schema": { + "$ref": "#/definitions/BulkSend" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/BulkSend" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "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 + }, + "delete": { + "tags": [ + "BulkSend" + ], + "summary": "Deletes a bulk send list", + "operationId": "BulkSendV2CRUD_DeleteBulkSendList", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "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/BulkEnvelopes" + "$ref": "#/definitions/bulkSendingListSummaries" } }, "400": { @@ -1513,21 +1685,21 @@ } }, "deprecated": false, - "x-ds-methodname": "list", - "x-ds-method": "list", - "x-ds-service": "BulkEnvelopes", + "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 }, "parameters": [] }, - "/v2.1/accounts/{accountId}/bulk_envelopes/{batchId}": { - "get": { + "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/send": { + "post": { "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": "Creates a bulk send request", + "operationId": "BulkSendV2Send_PostBulkSendRequest", "consumes": [], "produces": [], "parameters": [ @@ -1539,39 +1711,84 @@ "type": "string" }, { - "name": "batchId", + "name": "bulkSendListId", "in": "path", "required": true, "type": "string", - "description": "Identifier used to query the status of an individual bulk recipient batch." + "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list." }, { - "name": "count", - "in": "query", - "description": "The maximum number of results to return.", + "name": "bulkSendRequest", + "in": "body", "required": false, - "type": "string" + "schema": { + "$ref": "#/definitions/bulkSendRequest" + }, + "description": "" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/bulkSendResponse" + } }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "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\n[create_list]: ./createBulkSendList.html\n[create_test]: ./createBulkSendTestRequest.html\n[BulkSendOverview]: ./BulkSend.html", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/bulk_send_lists/{bulkSendListId}/test": { + "post": { + "tags": [ + "BulkSend" + ], + "summary": "Creates a bulk send test", + "operationId": "BulkSendV2Test_PostBulkSendTestRequest", + "consumes": [], + "produces": [], + "parameters": [ { - "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, + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, "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.", + "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, - "type": "string" + "schema": { + "$ref": "#/definitions/bulkSendRequest" + }, + "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/bulkEnvelopeStatus" + "$ref": "#/definitions/bulkSendTestResponse" } }, "400": { @@ -1582,9 +1799,10 @@ } }, "deprecated": false, - "x-ds-methodname": "get", - "x-ds-method": "get", - "x-ds-service": "BulkEnvelopes", + "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\n", "x-ds-in-sdk": true }, "parameters": [] @@ -1595,7 +1813,7 @@ "Accounts" ], "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.", + "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": [], @@ -2057,7 +2275,7 @@ "tags": [ "ConnectConfigurations" ], - "summary": "Get information on a Connect Configuration", + "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": [], @@ -2207,7 +2425,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": { @@ -2360,7 +2578,7 @@ "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": { @@ -2406,7 +2624,7 @@ { "name": "failureId", "in": "path", - "description": "ID of the Connect post failure.", + "description": "The id of the Connect post failure.", "required": true, "type": "string" } @@ -2460,7 +2678,7 @@ "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": { @@ -2487,8 +2705,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,7 +2743,7 @@ "tags": [ "ConnectEvents" ], - "summary": "Get the specified Connect log entry.", + "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": [], @@ -2541,14 +2759,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 +2811,7 @@ { "name": "logId", "in": "path", - "description": "ID of the Connect log entry.", + "description": "The id of the Connect log entry.", "required": true, "type": "string" } @@ -2779,7 +2997,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 +3037,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 +3084,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 +3131,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 +3141,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 +3156,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 +3165,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 +3186,14 @@ "x-ds-methodname": "getContactById", "x-ds-method": "get", "x-ds-service": "Users", - "description": "", + "description": "This method returns one or more contacts associated with a DocuSign account. You can also retrieve contacts from connected [cloud storage][CloudStorage] providers by using the `cloud_provider` query parameter. By default, contacts are retrieved from the DocuSign account's default address book.\n\nTo return a specific contact, use the `contactId` query parameter. To return all contacts associated with an account, omit this parameter.\n\n[CloudStorage]: /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 +3208,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 +3231,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 +3241,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 +3279,7 @@ "tags": [ "AccountCustomFields" ], - "summary": "Creates an acount custom field.", + "summary": "Creates an account custom field.", "operationId": "AccountCustomFields_PostAccountCustomFields", "consumes": [], "produces": [], @@ -3078,7 +3296,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 +3326,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 +3336,7 @@ "tags": [ "AccountCustomFields" ], - "summary": "Updates an existing account custom field.", + "summary": "Updates an account custom field.", "operationId": "AccountCustomFields_PutAccountCustomFields", "consumes": [], "produces": [], @@ -3135,7 +3353,7 @@ "in": "path", "required": true, "type": "string", - "description": "" + "description": "The id of the custom field." }, { "name": "apply_to_templates", @@ -3172,14 +3390,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 +3414,7 @@ "in": "path", "required": true, "type": "string", - "description": "" + "description": "The id of the custom field." }, { "name": "apply_to_templates", @@ -3221,6 +3439,51 @@ "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}/data_feeds/data/{dataFeedElementId}": { + "get": { + "tags": [ + "DataFeedElement" + ], + "summary": "", + "operationId": "DataFeedsRest_GetDataFeedElement", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "dataFeedElementId", + "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": "get", + "x-ds-method": "get", + "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true }, @@ -3347,7 +3610,7 @@ "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 +3654,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", @@ -3519,7 +3789,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/esign-rest-api/guides/features/templates#sending-from-a-template).\n* [Create and send an envelope from\n a combination of documents and templates](https://developers.docusign.com/esign-rest-api/guides/features/templates#composite-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", "operationId": "Envelopes_PostEnvelopes", "consumes": [], "produces": [], @@ -4549,7 +4819,7 @@ }, "deprecated": false, "x-ds-methodname": "createEnvelopeComments", - "x-ds-method": "createEnvelopeComments", + "x-ds-method": "create", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true @@ -4606,7 +4876,6 @@ }, "deprecated": false, "x-ds-methodname": "getCommentsTranscript", - "x-ds-api-status": "beta", "x-ds-method": "get", "x-ds-service": "Uncategorized", "description": "", @@ -4718,7 +4987,7 @@ "tags": [ "EnvelopeCustomFields" ], - "summary": "Updates envelope custom fields for an envelope.", + "summary": "Creates 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", "consumes": [], @@ -4824,231 +5093,13 @@ }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info": { "get": { "tags": [ - "EnvelopeDocuments" - ], - "summary": "Gets a list of envelope documents.", - "description": "Retrieves a list of documents associated with the specified envelope.", - "operationId": "Documents_GetDocuments", - "consumes": [], - "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-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": "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" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "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" - } - ] - }, - "put": { - "tags": [ - "EnvelopeDocuments" + "EnvelopeAppliance" ], - "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": [ - { - "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-afa0-4adf-933c-f752070d71ec`", - "required": true, - "type": "string" - }, - { - "name": "envelopeDefinition", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/envelopeDefinition" - }, - "description": "" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeDocuments" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "updateDocuments", - "x-ds-method": "updateList", - "x-ds-service": "Envelopes", - "x-ds-in-sdk": true - }, - "delete": { - "tags": [ - "EnvelopeDocuments" - ], - "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": "", + "operationId": "EnvelopeApplianceInfo_GetApplianceInfo", "consumes": [], "produces": [], "parameters": [ @@ -5065,22 +5116,13 @@ "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", "required": true, "type": "string" - }, - { - "name": "envelopeDefinition", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/envelopeDefinition" - }, - "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocuments" + "$ref": "#/definitions/EnvelopeAppliance" } }, "400": { @@ -5091,25 +5133,799 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteDocuments", - "x-ds-method": "delete", - "x-ds-service": "Envelopes", + "x-ds-methodname": "getApplianceInfo", + "x-ds-method": "getApplianceInfo", + "x-ds-service": "Uncategorized", + "description": "", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}": { - "get": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document/{documentId}": { + "put": { "tags": [ - "EnvelopeDocuments" + "EnvelopeAppliance" ], - "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": "", + "operationId": "EnvelopeApplianceInfo_PutDocument", "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": "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" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateApplianceDocument", + "x-ds-method": "updateApplianceDocument", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/document_page_list": { + "get": { + "tags": [ + "EnvelopeAppliance" + ], + "summary": "", + "operationId": "EnvelopeApplianceInfo_GetDocumentPage", + "consumes": [], + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/EnvelopeAppliance" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getApplianceDocumentPage", + "x-ds-method": "getDocumentPage", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/page_info": { + "put": { + "tags": [ + "EnvelopeAppliance" + ], + "summary": "", + "operationId": "EnvelopeApplianceInfo_PutPageInfo", + "consumes": [], + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateAppliancePageInformation", + "x-ds-method": "updatePageInfo", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "post": { + "tags": [ + "EnvelopeAppliance" + ], + "summary": "", + "operationId": "EnvelopeApplianceInfo_PostPageInfo", + "consumes": [], + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createAppliancePageInformation", + "x-ds-method": "createPageInfo", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "EnvelopeAppliance" + ], + "summary": "", + "operationId": "EnvelopeApplianceInfo_DeletePageInfo", + "consumes": [], + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteAppliancePageInformation", + "x-ds-method": "deletePageInfo", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/pdf_blobs": { + "get": { + "tags": [ + "EnvelopeAppliance" + ], + "summary": "", + "operationId": "EnvelopeApplianceInfo_GetPdfBlob", + "consumes": [], + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/displayAppliancePdf" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getAppliancePdfBlob", + "x-ds-method": "getPdfBlob", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "EnvelopeAppliance" + ], + "summary": "", + "operationId": "EnvelopeApplianceInfo_PutPdfBlob", + "consumes": [], + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateAppliancePdfBlob", + "x-ds-method": "updatePdfBlob", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "post": { + "tags": [ + "EnvelopeAppliance" + ], + "summary": "", + "operationId": "EnvelopeApplianceInfo_PostPdfBlob", + "consumes": [], + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/displayAppliancePdf" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createAppliancePdfBlob", + "x-ds-method": "createPdfBlob", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/recipient_denied_copy": { + "put": { + "tags": [ + "EnvelopeAppliance" + ], + "summary": "", + "operationId": "EnvelopeApplianceInfo_PutRecipientDeniedDocumentCopy", + "consumes": [], + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateApplianceRecipientDeniedDocumentCopy", + "x-ds-method": "updateRecipientDeniedDocumentCopy", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/display_appliance_info/signer_attachment_info": { + "get": { + "tags": [ + "EnvelopeAppliance" + ], + "summary": "", + "operationId": "EnvelopeApplianceInfo_GetSignerAttachment", + "consumes": [], + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/displayApplianceSignerAttachment" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getApplianceSignerAttachment", + "x-ds-method": "getSignerAttachment", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "EnvelopeAppliance" + ], + "summary": "", + "operationId": "EnvelopeApplianceInfo_PutSignerAttachment", + "consumes": [], + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateApplianceSignerAttachment", + "x-ds-method": "updateSignerAttachment", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents": { + "get": { + "tags": [ + "EnvelopeDocuments" + ], + "summary": "Gets a list of envelope documents.", + "description": "Retrieves a list of documents associated with the specified envelope.", + "operationId": "Documents_GetDocuments", + "consumes": [], + "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-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": "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" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "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" + } + ] + }, + "put": { + "tags": [ + "EnvelopeDocuments" + ], + "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": [ + { + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + }, + { + "name": "envelopeDefinition", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/envelopeDefinition" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/EnvelopeDocuments" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateDocuments", + "x-ds-method": "updateList", + "x-ds-service": "Envelopes", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "EnvelopeDocuments" + ], + "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": [ + { + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + }, + { + "name": "envelopeDefinition", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/envelopeDefinition" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/EnvelopeDocuments" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteDocuments", + "x-ds-method": "delete", + "x-ds-service": "Envelopes", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}": { + "get": { + "tags": [ + "EnvelopeDocuments" + ], + "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", + "consumes": [], + "produces": [ + "application/pdf" + ], "parameters": [ { "name": "accountId", @@ -6051,7 +6867,7 @@ "tags": [ "DocumentResponsiveHtmlPreview" ], - "summary": "", + "summary": "Creates a preview of the responsive version of a document.", "operationId": "ResponsiveHtml_PostDocumentResponsiveHtmlPreview", "consumes": [], "produces": [], @@ -6105,7 +6921,7 @@ "x-ds-methodname": "createDocumentResponsiveHtmlPreview", "x-ds-method": "create", "x-ds-service": "Uncategorized", - "description": "", + "description": "Creates a preview of the [responsive](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/api-overview), HTML version of a specific document. This method enables you to preview a PDF document conversion 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 }, "parameters": [] @@ -6226,7 +7042,7 @@ }, "deprecated": false, "x-ds-methodname": "updateDocumentTabs", - "x-ds-method": "updateDocumentTabs", + "x-ds-method": "update", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true @@ -6287,7 +7103,7 @@ }, "deprecated": false, "x-ds-methodname": "createDocumentTabs", - "x-ds-method": "createDocumentTabs", + "x-ds-method": "create", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true @@ -6348,7 +7164,7 @@ }, "deprecated": false, "x-ds-methodname": "deleteDocumentTabs", - "x-ds-method": "deleteDocumentTabs", + "x-ds-method": "delete", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true @@ -6513,7 +7329,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" } @@ -6938,8 +7754,8 @@ "tags": [ "EnvelopeLocks" ], - "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.", + "summary": "Locks an envelope.", + "description": "This method locks the specified envelope and sets the time until the lock expires to prevent other users or recipients from changing the envelope.\n\nThe response to this request returns a `lockToken` parameter. You must use the `lockToken` to update or delete an existing lock. You must also include the `lockToken` in the header for every PUT call that you make on the envelope while it is locked. If you do not include the `lockToken`, the system returns the following error:\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**Note**: Users must have envelope locking capability enabled to use this function (userSetting `canLockEnvelopes` must be set to true for the user).\n", "operationId": "Lock_PostEnvelopeLock", "consumes": [], "produces": [], @@ -6993,7 +7809,7 @@ "EnvelopeLocks" ], "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}}`", + "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}}`\n\n##### Important: You must use the query parameter `save_changes` to indicate whether you want to commit the user's changes when deleting the lock. When set to **true**, the system commits the changes that the user made while the lock was active. When set to **false**, the user's changes are discarded. This query parameter does not currently appear in the list of query parameters on this page. However, it is crucial that you include it to ensure that the user's changes are saved or discarded as appropriate.", "operationId": "Lock_DeleteEnvelopeLock", "consumes": [], "produces": [], @@ -7308,7 +8124,7 @@ "EnvelopeRecipients" ], "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).", + "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 resend an envelope to a recipient 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", "consumes": [], "produces": [], @@ -7344,7 +8160,7 @@ { "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.", + "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.", "required": false, "type": "string" }, @@ -7405,7 +8221,7 @@ { "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.", + "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.", "required": false, "type": "string" }, @@ -7550,190 +8366,6 @@ }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/bulk_recipients": { - "get": { - "tags": [ - "EnvelopeBulkRecipients" - ], - "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", - "consumes": [], - "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-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`.", - "required": true, - "type": "string" - }, - { - "name": "include_tabs", - "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." - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/EnvelopeBulkRecipients" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "getRecipients", - "x-ds-method": "list", - "x-ds-service": "BulkEnvelopes", - "x-ds-in-sdk": true - }, - "put": { - "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" - ], - "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-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`.", - "required": true, - "type": "string" - }, - { - "name": "bulkRecipientsRequest", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/bulkRecipientsRequest" - }, - "description": "" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/bulkRecipientsSummaryResponse" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "updateRecipients", - "x-ds-method": "update", - "x-ds-service": "BulkEnvelopes", - "x-ds-in-sdk": true - }, - "delete": { - "tags": [ - "EnvelopeBulkRecipients" - ], - "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", - "consumes": [], - "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-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`.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/bulkRecipientsUpdateResponse" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "deleteRecipients", - "x-ds-method": "delete", - "x-ds-service": "BulkEnvelopes", - "x-ds-in-sdk": true - }, - "parameters": [] - }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/consumer_disclosure": { "get": { "tags": [ @@ -8301,7 +8933,7 @@ { "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**).", + "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" }, @@ -8436,7 +9068,68 @@ } ], "responses": { - "201": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/EnvelopeRecipientTabs" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createTabs", + "x-ds-method": "create", + "x-ds-service": "Envelopes", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "EnvelopeRecipientTabs" + ], + "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": [ + { + "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-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`.", + "required": true, + "type": "string" + }, + { + "name": "EnvelopeRecipientTabs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EnvelopeRecipientTabs" + }, + "description": "" + } + ], + "responses": { + "200": { "description": "Successful response.", "schema": { "$ref": "#/definitions/EnvelopeRecipientTabs" @@ -8450,18 +9143,20 @@ } }, "deprecated": false, - "x-ds-methodname": "createTabs", - "x-ds-method": "create", + "x-ds-methodname": "deleteTabs", + "x-ds-method": "delete", "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "delete": { + "parameters": [] + }, + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/document_visibility": { + "put": { "tags": [ - "EnvelopeRecipientTabs" + "EnvelopeDocumentVisibility" ], - "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": "Updates document visibility for recipients", + "operationId": "Recipients_PutRecipientsDocumentVisibility", "consumes": [], "produces": [], "parameters": [ @@ -8480,18 +9175,11 @@ "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", + "name": "EnvelopeDocumentVisibility", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/EnvelopeRecipientTabs" + "$ref": "#/definitions/EnvelopeDocumentVisibility" }, "description": "" } @@ -8500,7 +9188,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeRecipientTabs" + "$ref": "#/definitions/EnvelopeDocumentVisibility" } }, "400": { @@ -8511,20 +9199,21 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteTabs", - "x-ds-method": "delete", + "x-ds-methodname": "updateRecipientsDocumentVisibility", + "x-ds-method": "updateList", "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}/recipients/document_visibility": { - "put": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview": { + "post": { "tags": [ - "EnvelopeDocumentVisibility" + "ResponsiveHtmlPreview" ], - "summary": "Updates document visibility for recipients", - "operationId": "Recipients_PutRecipientsDocumentVisibility", + "summary": "Creates a preview of the responsive versions of all of the documents in an envelope.", + "operationId": "ResponsiveHtml_PostResponsiveHtmlPreview", "consumes": [], "produces": [], "parameters": [ @@ -8543,20 +9232,20 @@ "type": "string" }, { - "name": "EnvelopeDocumentVisibility", + "name": "documentHtmlDefinition", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/EnvelopeDocumentVisibility" + "$ref": "#/definitions/documentHtmlDefinition" }, "description": "" } ], "responses": { - "200": { + "201": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/EnvelopeDocumentVisibility" + "$ref": "#/definitions/DocumentResponsiveHtmlPreview" } }, "400": { @@ -8567,21 +9256,21 @@ } }, "deprecated": false, - "x-ds-methodname": "updateRecipientsDocumentVisibility", - "x-ds-method": "updateList", - "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-methodname": "createResponsiveHtmlPreview", + "x-ds-method": "create", + "x-ds-service": "Uncategorized", + "description": "Creates a preview of the [responsive](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/api-overview), HTML versions of all of the documents in an envelope. This method enables you to preview the PDF document conversions 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 documents.", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/responsive_html_preview": { - "post": { + "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/tabs_blob": { + "get": { "tags": [ - "ResponsiveHtmlPreview" + "TabsBlob" ], "summary": "", - "operationId": "ResponsiveHtml_PostResponsiveHtmlPreview", + "operationId": "TabsBlob_GetTabsBlob", "consumes": [], "produces": [], "parameters": [ @@ -8598,23 +9287,53 @@ "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", "required": true, "type": "string" - }, - { - "name": "documentHtmlDefinition", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/documentHtmlDefinition" - }, - "description": "" } ], "responses": { - "201": { - "description": "Successful response.", + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", "schema": { - "$ref": "#/definitions/DocumentResponsiveHtmlPreview" + "$ref": "#/definitions/errorDetails" } + } + }, + "deprecated": false, + "x-ds-methodname": "getTabsBlob", + "x-ds-method": "getTabsBlob", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "TabsBlob" + ], + "summary": "", + "operationId": "TabsBlob_PutTabsBlob", + "consumes": [], + "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-afa0-4adf-933c-f752070d71ec`", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response." }, "400": { "description": "Error encountered.", @@ -8624,8 +9343,8 @@ } }, "deprecated": false, - "x-ds-methodname": "createResponsiveHtmlPreview", - "x-ds-method": "create", + "x-ds-methodname": "putTabsBlob", + "x-ds-method": "putTabsBlob", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true @@ -8747,7 +9466,7 @@ "EnvelopeViews" ], "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. ", + "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": [], @@ -8804,7 +9523,7 @@ "EnvelopeViews" ], "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. ", + "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": [], @@ -8876,7 +9595,7 @@ "EnvelopeViews" ], "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.", + "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 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": [], @@ -8930,9 +9649,9 @@ "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/views/recipient_preview": { "post": { "tags": [ - "EnvelopeViews" + "EnvelopeRecipients" ], - "summary": "", + "summary": "Creates an envelope recipient preview.", "operationId": "Views_PostEnvelopeRecipientPreview", "consumes": [], "produces": [], @@ -8979,7 +9698,7 @@ "x-ds-methodname": "createEnvelopeRecipientPreview", "x-ds-method": "createEnvelopeRecipientPreview", "x-ds-service": "Uncategorized", - "description": "", + "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": [] @@ -8990,7 +9709,7 @@ "EnvelopeViews" ], "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", + "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": [], @@ -9046,7 +9765,7 @@ "tags": [ "EnvelopeViews" ], - "summary": "", + "summary": "Returns a URL to the shared recipient view UI for an envelope.", "operationId": "Views_PostEnvelopeRecipientSharedView", "consumes": [], "produces": [], @@ -9093,7 +9812,7 @@ "x-ds-methodname": "createEnvelopeRecipientSharedView", "x-ds-method": "createSharedRecipient", "x-ds-service": "Uncategorized", - "description": "", + "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": [] @@ -9237,7 +9956,7 @@ "tags": [ "EnvelopeTransferRules" ], - "summary": "", + "summary": "Gets envelope transfer rules.", "operationId": "EnvelopeTransferRules_GetEnvelopeTransferRules", "consumes": [], "produces": [], @@ -9254,14 +9973,14 @@ "in": "query", "required": false, "type": "string", - "description": "The maximum number of results to return." + "description": "(Optional) The maximum number of results to return." }, { "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": "(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": { @@ -9279,17 +9998,17 @@ } }, "deprecated": false, - "x-ds-methodname": "getEnvelopeTransferRules", - "x-ds-method": "getEnvelopeTransferRules", + "x-ds-methodname": "get", + "x-ds-method": "get", "x-ds-service": "Uncategorized", - "description": "", + "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 }, "put": { "tags": [ "EnvelopeTransferRules" ], - "summary": "", + "summary": "Changes the status of multiple envelope transfer rules.", "operationId": "EnvelopeTransferRules_PutEnvelopeTransferRules", "consumes": [], "produces": [], @@ -9326,17 +10045,17 @@ } }, "deprecated": false, - "x-ds-methodname": "updateEnvelopeTransferRules", - "x-ds-method": "updateEnvelopeTransferRules", + "x-ds-methodname": "update", + "x-ds-method": "update", "x-ds-service": "Uncategorized", - "description": "", + "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": [ "EnvelopeTransferRules" ], - "summary": "", + "summary": "Creates an envelope transfer rule.", "operationId": "EnvelopeTransferRules_PostEnvelopeTransferRules", "consumes": [], "produces": [], @@ -9373,10 +10092,10 @@ } }, "deprecated": false, - "x-ds-methodname": "createEnvelopeTransferRules", - "x-ds-method": "createEnvelopeTransferRules", + "x-ds-methodname": "create", + "x-ds-method": "create", "x-ds-service": "Uncategorized", - "description": "", + "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 }, "parameters": [] @@ -9386,7 +10105,7 @@ "tags": [ "EnvelopeTransferRules" ], - "summary": "", + "summary": "Changes the status of an envelope transfer rule.", "operationId": "EnvelopeTransferRules_PutEnvelopeTransferRule", "consumes": [], "produces": [], @@ -9403,7 +10122,7 @@ "in": "path", "required": true, "type": "string", - "description": "" + "description": "The id of the envelope transfer rule. The system generates this id when the rule is first created." }, { "name": "envelopeTransferRule", @@ -9433,14 +10152,14 @@ "x-ds-methodname": "updateEnvelopeTransferRule", "x-ds-method": "updateEnvelopeTransferRule", "x-ds-service": "Uncategorized", - "description": "", + "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 }, "delete": { "tags": [ "EnvelopeTransferRules" ], - "summary": "", + "summary": "Deletes an envelope transfer rule.", "operationId": "EnvelopeTransferRules_DeleteEnvelopeTransferRules", "consumes": [], "produces": [], @@ -9457,7 +10176,7 @@ "in": "path", "required": true, "type": "string", - "description": "" + "description": "The id of the envelope transfer rule. The system generates this id when the rule is first created." } ], "responses": { @@ -9472,8 +10191,143 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteEnvelopeTransferRules", - "x-ds-method": "deleteEnvelopeTransferRules", + "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 + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/favorite_templates": { + "get": { + "tags": [ + "FavoriteTemplates" + ], + "summary": "", + "operationId": "FavoriteTemplates_GetFavoriteTemplates", + "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/FavoriteTemplates" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getFavoriteTemplates", + "x-ds-method": "getFavoriteTemplates", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "put": { + "tags": [ + "FavoriteTemplates" + ], + "summary": "", + "operationId": "FavoriteTemplates_PutFavoriteTemplate", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "FavoriteTemplates", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/FavoriteTemplates" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/FavoriteTemplates" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateFavoriteTemplate", + "x-ds-method": "updateFavoriteTemplate", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "delete": { + "tags": [ + "FavoriteTemplates" + ], + "summary": "", + "operationId": "FavoriteTemplates_UnFavoriteTemplate", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "FavoriteTemplates", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/FavoriteTemplates" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/FavoriteTemplates" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "unFavoriteTemplate", + "x-ds-method": "unFavoriteTemplate", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true @@ -9577,7 +10431,7 @@ { "name": "folderId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "required": true, "type": "string" }, @@ -9663,7 +10517,7 @@ "Folders" ], "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. ", + "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": [], @@ -9678,7 +10532,7 @@ { "name": "folderId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "required": true, "type": "string" }, @@ -9887,7 +10741,7 @@ "Groups" ], "summary": "Deletes an existing user group.", - "description": "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": [], @@ -9936,8 +10790,8 @@ "tags": [ "GroupBrands" ], - "summary": "Gets group brand ID Information.\n", - "description": "Retrieves information about the brands associated with the requested group.", + "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": [], @@ -9952,7 +10806,7 @@ { "name": "groupId", "in": "path", - "description": "The ID of the group being accessed.", + "description": "The id of the group.", "required": true, "type": "string" } @@ -9981,8 +10835,8 @@ "tags": [ "GroupBrands" ], - "summary": "Adds group brand ID information to a group.", - "description": "Adds group brand ID information to a group.", + "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": [], @@ -10035,8 +10889,8 @@ "tags": [ "GroupBrands" ], - "summary": "Deletes brand information from the requested group.", - "description": "Deletes brand information from the requested group.", + "summary": "Deletes brand information from a group.", + "description": "This method deletes one or more brands from a group.", "operationId": "Brands_DeleteGroupBrands", "consumes": [], "produces": [], @@ -10051,7 +10905,7 @@ { "name": "groupId", "in": "path", - "description": "The ID of the group being accessed.", + "description": "The id of the group.", "required": true, "type": "string" }, @@ -10262,7 +11116,7 @@ "tags": [ "IdentityVerifications" ], - "summary": "Retrieves the list of identity verification workflows available to an account", + "summary": "Retrieves the Identity Verification workflows available to an account.", "operationId": "AccountIdentityVerification_GetAccountIdentityVerification", "consumes": [], "produces": [], @@ -10293,7 +11147,7 @@ "x-ds-methodname": "getAccountIdentityVerification", "x-ds-method": "list", "x-ds-service": "Uncategorized", - "description": "Retrieves the list of identity verification workflows available to an account", + "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 }, "parameters": [] @@ -10303,7 +11157,7 @@ "tags": [ "PaymentGatewayAccounts" ], - "summary": "List payment gateway account information", + "summary": "List payment gateway accounts", "operationId": "PaymentGatewayAccounts_GetAllPaymentGatewayAccounts", "consumes": [], "produces": [], @@ -10335,7 +11189,7 @@ "x-ds-api-status": "beta", "x-ds-method": "list", "x-ds-service": "Accounts", - "description": "List payment gateway account information", + "description": "This method returns a list of payment gateway accounts and basic information about them.", "x-ds-in-sdk": true }, "parameters": [] @@ -11029,8 +11883,8 @@ "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.", + "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": [], @@ -11038,14 +11892,14 @@ { "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": "email", "in": "query", - "description": "The email address for the user", + "description": "The email address for which you want to retrieve recipient names.", "required": false, "type": "string" } @@ -11302,6 +12156,212 @@ }, "parameters": [] }, + "/v2.1/accounts/{accountId}/settings/bcc_email_archives": { + "get": { + "tags": [ + "BCCEmailArchive" + ], + "summary": "Gets the BCC email archive configurations for an account.", + "operationId": "BCCEmailArchive_GetBCCEmailArchiveList", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "count", + "in": "query", + "required": false, + "type": "string", + "description": "(Optional) The maximum number of results to return." + }, + { + "name": "start_position", + "in": "query", + "required": false, + "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/bccEmailArchiveList" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "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 + }, + "post": { + "tags": [ + "BCCEmailArchive" + ], + "summary": "Creates a BCC email archive configuration.", + "operationId": "BCCEmailArchive_PostBCCEmailArchive", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "bccEmailArchive", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/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." + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/bccEmailArchive" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "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 + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}": { + "get": { + "tags": [ + "BCCEmailArchive" + ], + "summary": "Gets a BCC email archive configuration and its history.", + "operationId": "BCCEmailArchive_GetBCCEmailArchiveHistoryList", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "bccEmailArchiveId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the BCC email archive configuration." + }, + { + "name": "count", + "in": "query", + "required": false, + "type": "string", + "description": "(Optional) The maximum number of results (changes) to return." + }, + { + "name": "start_position", + "in": "query", + "required": false, + "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/BCCEmailArchive" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "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 + }, + "delete": { + "tags": [ + "BCCEmailArchive" + ], + "summary": "Deletes a BCC email archive configuration.", + "operationId": "BCCEmailArchive_DeleteBCCEmailArchive", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "bccEmailArchiveId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the BCC email archive configuration." + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "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 + }, + "parameters": [] + }, "/v2.1/accounts/{accountId}/settings/enote_configuration": { "get": { "tags": [ @@ -11431,9 +12491,9 @@ "/v2.1/accounts/{accountId}/settings/envelope_purge_configuration": { "get": { "tags": [ - "EnvelopePurgeConfiguration" + "Accounts" ], - "summary": "", + "summary": "Gets the envelope purge configuration for an account.", "operationId": "EnvelopePurgeConfiguration_GetEnvelopePurgeConfiguration", "consumes": [], "produces": [], @@ -11465,14 +12525,14 @@ "x-ds-api-status": "beta", "x-ds-method": "getEnvelopePurgeConfiguration", "x-ds-service": "Uncategorized", - "description": "", + "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": [ - "EnvelopePurgeConfiguration" + "Accounts" ], - "summary": "", + "summary": "Sets the envelope purge configuration for an account.", "operationId": "EnvelopePurgeConfiguration_PutEnvelopePurgeConfiguration", "consumes": [], "produces": [], @@ -11513,7 +12573,7 @@ "x-ds-api-status": "beta", "x-ds-method": "updateEnvelopePurgeConfiguration", "x-ds-service": "Uncategorized", - "description": "", + "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 }, "parameters": [] @@ -11521,9 +12581,9 @@ "/v2.1/accounts/{accountId}/settings/notification_defaults": { "get": { "tags": [ - "NotificationDefaults" + "Accounts" ], - "summary": "", + "summary": "Gets envelope notification defaults.", "operationId": "NotificationDefaults_GetNotificationDefaults", "consumes": [], "produces": [], @@ -11554,14 +12614,14 @@ "x-ds-methodname": "getNotificationDefaults", "x-ds-method": "getNotificationDefaults", "x-ds-service": "Uncategorized", - "description": "", + "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": [ - "NotificationDefaults" + "Accounts" ], - "summary": "", + "summary": "Updates envelope notification default settings.", "operationId": "NotificationDefaults_PutNotificationDefaults", "consumes": [], "produces": [], @@ -11601,7 +12661,7 @@ "x-ds-methodname": "updateNotificationDefaults", "x-ds-method": "updateNotificationDefaults", "x-ds-service": "Uncategorized", - "description": "", + "description": "This method changes the default settings for the email notifications that signers and senders receive about envelopes.", "x-ds-in-sdk": true }, "parameters": [] @@ -11611,7 +12671,7 @@ "tags": [ "AccountPasswordRules" ], - "summary": "Get the password rules", + "summary": "Gets the password rules for an account.", "operationId": "AccountPasswordRules_GetAccountPasswordRules", "consumes": [], "produces": [], @@ -11642,14 +12702,14 @@ "x-ds-methodname": "getAccountPasswordRules", "x-ds-method": "get", "x-ds-service": "Accounts", - "description": "", + "description": "This method retrieves the password rules for an account.", "x-ds-in-sdk": true }, "put": { "tags": [ "AccountPasswordRules" ], - "summary": "Update the password rules", + "summary": "Updates the password rules for an account.", "operationId": "AccountPasswordRules_PutAccountPasswordRules", "consumes": [], "produces": [], @@ -11689,7 +12749,7 @@ "x-ds-methodname": "updateAccountPasswordRules", "x-ds-method": "update", "x-ds-service": "Accounts", - "description": "", + "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": [] @@ -11730,7 +12790,7 @@ "x-ds-methodname": "getAccountTabSettings", "x-ds-method": "get", "x-ds-service": "Accounts", - "description": "", + "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": { @@ -11777,7 +12837,7 @@ "x-ds-methodname": "updateAccountTabSettings", "x-ds-method": "update", "x-ds-service": "Accounts", - "description": "", + "description": "This method modifies the tab types and tab functionality that is enabled for an account.", "x-ds-in-sdk": true }, "parameters": [] @@ -11882,7 +12942,7 @@ "Accounts" ], "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", + "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/esign-rest-api/reference/Templates/Templates/updateGroupShare) functionality.\n\n", "operationId": "SharedAccess_PutSharedAccess", "consumes": [], "produces": [], @@ -11952,7 +13012,7 @@ "tags": [ "AccountSignatureProviders" ], - "summary": "Returns Account available signature providers for specified account.", + "summary": "Gets the available signature providers for an account.", "operationId": "AccountSignatureProviders_GetSignatureProviders", "consumes": [], "produces": [], @@ -11983,7 +13043,7 @@ "x-ds-methodname": "listSignatureProviders", "x-ds-method": "list", "x-ds-service": "Accounts", - "description": "", + "description": "Returns a list of signature providers that the specified account can use.", "x-ds-in-sdk": true }, "parameters": [] @@ -12207,7 +13267,7 @@ "in": "path", "required": true, "type": "string", - "description": "The id of the signing group of which the recipient is a member, if applicable." + "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": { @@ -12252,7 +13312,7 @@ "in": "path", "required": true, "type": "string", - "description": "The id of the signing group of which the recipient is a member, if applicable." + "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": "SigningGroups", @@ -12309,7 +13369,7 @@ "in": "path", "required": true, "type": "string", - "description": "The id of the signing group of which the recipient is a member, if applicable." + "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": { @@ -12354,7 +13414,7 @@ "in": "path", "required": true, "type": "string", - "description": "The id of the signing group of which the recipient is a member, if applicable." + "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": "SigningGroupUsers", @@ -12408,7 +13468,7 @@ "in": "path", "required": true, "type": "string", - "description": "The id of the signing group of which the recipient is a member, if applicable." + "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": "SigningGroupUsers", @@ -12447,7 +13507,7 @@ "tags": [ "Accounts" ], - "summary": "List supported languages for the recipient language setting", + "summary": "Gets the supported languages for envelope recipients.", "operationId": "SupportedLanguages_GetSupportedLanguages", "consumes": [], "produces": [], @@ -12478,7 +13538,7 @@ "x-ds-methodname": "getSupportedLanguages", "x-ds-method": "listSupportedLanguages", "x-ds-service": "Accounts", - "description": "List supported languages for the recipient language setting", + "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 }, "parameters": [] @@ -12727,7 +13787,7 @@ "tags": [ "Templates" ], - "summary": "Gets the definition of a template.", + "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": [], @@ -12743,7 +13803,7 @@ { "name": "count", "in": "query", - "description": "Number of records to return in the cache.", + "description": "The number of records to return in the cache.", "required": false, "type": "string" }, @@ -12752,19 +13812,19 @@ "in": "query", "required": false, "type": "string", - "description": "List templates created on or after this date." + "description": "Lists templates created on or after this date." }, { "name": "created_to_date", "in": "query", "required": false, "type": "string", - "description": "List templates modified before this date." + "description": "Lists templates modified before this date." }, { "name": "folder_ids", "in": "query", - "description": "A comma separated list of folder ID GUIDs.", + "description": "A comma-separated list of folder id GUIDs.", "required": false, "type": "string" }, @@ -12785,7 +13845,7 @@ { "name": "include", "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": "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.", "required": false, "type": "string" }, @@ -12862,7 +13922,7 @@ { "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.", + "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" }, @@ -12985,7 +14045,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -12994,7 +14054,7 @@ "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`" + "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": { @@ -13037,7 +14097,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13078,8 +14138,8 @@ "tags": [ "Templates" ], - "summary": "Shares a template with a group", - "description": "Shares a template with the specified members group.", + "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/esign-rest-api/reference/Accounts/Accounts/updateSharedAccess).", "operationId": "Templates_PutTemplatePart", "consumes": [], "produces": [], @@ -13094,7 +14154,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13155,7 +14215,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13219,7 +14279,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" } @@ -13264,7 +14324,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13318,7 +14378,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13372,7 +14432,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13429,7 +14489,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13481,7 +14541,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13520,7 +14580,7 @@ "TemplateDocuments" ], "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```", + "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": [], @@ -13535,7 +14595,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13577,7 +14637,7 @@ "TemplateDocuments" ], "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.", + "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": [ @@ -13601,7 +14661,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13644,8 +14704,8 @@ "tags": [ "TemplateDocuments" ], - "summary": "Adds a document to a template document.", - "description": "Adds the specified document to an existing template document.", + "summary": "Updates a template document.", + "description": "This methods updates an existing template document.", "operationId": "Documents_PutTemplateDocument", "consumes": [], "produces": [], @@ -13667,7 +14727,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13738,7 +14798,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" } @@ -13790,7 +14850,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13851,7 +14911,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13912,7 +14972,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -13975,7 +15035,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" } @@ -14142,7 +15202,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -14212,7 +15272,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -14299,7 +15359,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -14366,7 +15426,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" } @@ -14399,7 +15459,7 @@ "tags": [ "TemplateDocumentResponsiveHtmlPreview" ], - "summary": "", + "summary": "Creates a preview of the responsive version of a template document.", "operationId": "ResponsiveHtml_PostTemplateDocumentResponsiveHtmlPreview", "consumes": [], "produces": [], @@ -14421,7 +15481,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -14453,7 +15513,7 @@ "x-ds-methodname": "createTemplateDocumentResponsiveHtmlPreview", "x-ds-method": "create", "x-ds-service": "Uncategorized", - "description": "", + "description": "Creates a preview of the [responsive](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/api-overview), HTML version of a specific template document. This method enables you to preview a PDF document conversion 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 }, "parameters": [] @@ -14485,7 +15545,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -14544,7 +15604,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -14573,8 +15633,8 @@ } }, "deprecated": false, - "x-ds-methodname": "updateTemplateDocumentTabs", - "x-ds-method": "updateTemplateDocumentTabs", + "x-ds-methodname": "putDocumentTabs", + "x-ds-method": "update", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true @@ -14605,7 +15665,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -14634,8 +15694,8 @@ } }, "deprecated": false, - "x-ds-methodname": "createTemplateDocumentTabs", - "x-ds-method": "createTemplateDocumentTabs", + "x-ds-methodname": "postDocumentTabs", + "x-ds-method": "create", "x-ds-service": "Uncategorized", "description": "This method creates Template Document Tabs.", "x-ds-in-sdk": true @@ -14666,7 +15726,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -14695,8 +15755,8 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteTemplateDocumentTabs", - "x-ds-method": "deleteTemplateDocumentTabs", + "x-ds-methodname": "deleteDocumentTabs", + "x-ds-method": "delete", "x-ds-service": "Uncategorized", "description": "", "x-ds-in-sdk": true @@ -14723,7 +15783,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" } @@ -14757,7 +15817,7 @@ "TemplateLocks" ], "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.", + "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 integration key as original, then the `X-DocuSign-Edit` header field and additional lock information is included in the response. This enables users to recover a lost editing session token and the `X-DocuSign-Edit` header.", "operationId": "Lock_GetTemplateLock", "consumes": [], "produces": [], @@ -14772,7 +15832,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" } @@ -14802,7 +15862,7 @@ "TemplateLocks" ], "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.", + "description": "This method updates the lock duration time or 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. \n\nYou 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_PutTemplateLock", "consumes": [], "produces": [], @@ -14817,7 +15877,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -14855,8 +15915,8 @@ "tags": [ "TemplateLocks" ], - "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).", + "summary": "Locks a template.", + "description": "Locks the specified template and sets the time until the lock expires to prevent other users or recipients from changing the template.\n\nThe response to this request returns a `lockToken` parameter. You must use the `lockToken` to update or delete an existing lock. You must also include the `lockToken` in the header for every PUT call that you make on the template while the template is locked. If you do not include the `lockToken`, the system returns the following error:\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**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", "consumes": [], "produces": [], @@ -14871,7 +15931,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -14910,7 +15970,7 @@ "TemplateLocks" ], "summary": "Deletes a template lock.", - "description": "Deletes the lock from the specified template. The `X-DocuSign-Edit` header must be included in the request.", + "description": "This method deletes a lock from a template. \n\nYou must 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}}`\n\n\n\n##### Important: You must use the query parameter `save_changes` to indicate whether you want to commit the user's changes when deleting the lock. When set to **true**, the system commits the changes that the user made while the lock was active. When set to **false**, the user's changes are discarded. This query parameter does not currently appear in the list of query parameters on this page due to a technical issue. However, it is crucial that you include it to ensure that the user's changes are saved or discarded as appropriate.\n", "operationId": "Lock_DeleteTemplateLock", "consumes": [], "produces": [], @@ -14925,7 +15985,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -14982,7 +16042,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" } @@ -15027,7 +16087,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15084,7 +16144,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15150,7 +16210,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15159,7 +16219,7 @@ "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": "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", @@ -15211,7 +16271,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15220,7 +16280,7 @@ "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": "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", @@ -15272,7 +16332,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15336,7 +16396,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15400,7 +16460,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15466,7 +16526,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15527,7 +16587,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" } @@ -15581,7 +16641,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" } @@ -15633,7 +16693,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15698,14 +16758,14 @@ { "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**).", + "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" }, @@ -15764,7 +16824,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15825,7 +16885,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15886,7 +16946,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15942,7 +17002,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -15984,7 +17044,7 @@ "tags": [ "TemplateResponsiveHtmlPreview" ], - "summary": "", + "summary": "Creates a preview of the responsive versions of all of the documents associated with a template.", "operationId": "ResponsiveHtml_PostTemplateResponsiveHtmlPreview", "consumes": [], "produces": [], @@ -15999,7 +17059,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -16031,7 +17091,7 @@ "x-ds-methodname": "createTemplateResponsiveHtmlPreview", "x-ds-method": "create", "x-ds-service": "Uncategorized", - "description": "", + "description": "Creates a preview of the [responsive](https://developers.docusign.com/esign-rest-api/guides/responsive-signing/api-overview), HTML versions of all of the documents associated with a template. This method enables you to preview the PDF document conversions 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 documents.", "x-ds-in-sdk": true }, "parameters": [] @@ -16041,7 +17101,7 @@ "tags": [ "TemplateViews" ], - "summary": "Provides a URL to start an edit view of the Template UI", + "summary": "Gets a URL for a template edit view.", "operationId": "Views_PostTemplateEditView", "consumes": [], "produces": [], @@ -16056,7 +17116,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -16088,7 +17148,7 @@ "x-ds-methodname": "createEditView", "x-ds-method": "createEdit", "x-ds-service": "Templates", - "description": "", + "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 }, "parameters": [] @@ -16096,9 +17156,9 @@ "/v2.1/accounts/{accountId}/templates/{templateId}/views/recipient_preview": { "post": { "tags": [ - "EnvelopeViews" + "TemplateRecipients" ], - "summary": "", + "summary": "Creates a template recipient preview.", "operationId": "Views_PostTemplateRecipientPreview", "consumes": [], "produces": [], @@ -16113,7 +17173,7 @@ { "name": "templateId", "in": "path", - "description": "The ID of the template.", + "description": "The id of the template.", "required": true, "type": "string" }, @@ -16145,7 +17205,7 @@ "x-ds-methodname": "createTemplateRecipientPreview", "x-ds-method": "createTemplateRecipientPreview", "x-ds-service": "Uncategorized", - "description": "", + "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": [] @@ -16205,7 +17265,7 @@ { "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" }, @@ -16219,7 +17279,7 @@ { "name": "count", "in": "query", - "description": "Number of records to return. The number must be greater than 0 and less than or equal to 100. ", + "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" }, @@ -16228,19 +17288,19 @@ "in": "query", "required": false, "type": "string", - "description": "Reserved for DocuSign." + "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": "email_substring", "in": "query", - "description": "Reserved for DocuSign.", + "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 returned user records by one or more group IDs.", + "description": "Filters results based on one or more group IDs.", "required": false, "type": "string" }, @@ -16249,14 +17309,14 @@ "in": "query", "required": false, "type": "string", - "description": "Return the `userSettings` object data in CSV format." + "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": "Return the login status of each user." + "description": "When set to **true**, the response includes the login status of each user." }, { "name": "not_group_id", @@ -16277,12 +17337,12 @@ "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" + "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 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.", "required": false, "type": "string" } @@ -16311,7 +17371,7 @@ "tags": [ "Users" ], - "summary": "Change one or more user in the specified account.", + "summary": "Changes one or more users in the specified account.", "operationId": "Users_PutUsers", "consumes": [], "produces": [], @@ -16351,7 +17411,7 @@ "x-ds-methodname": "updateUsers", "x-ds-method": "updateList", "x-ds-service": "Users", - "description": "", + "description": "This method updates the information about one or more account users.", "x-ds-in-sdk": true }, "post": { @@ -16423,7 +17483,7 @@ "in": "query", "required": false, "type": "string", - "description": "ID of the user to delete." + "description": "ID of the user to delete. This parameter takes a comma-separated list of values in the format: `Groups,PermissionSet,SigningGroupsEmail`." }, { "name": "userInfoList", @@ -16915,7 +17975,7 @@ "in": "query", "required": false, "type": "string", - "description": "" + "description": "Use this parameter to search for specific text." }, { "name": "start_position", @@ -16952,8 +18012,8 @@ "tags": [ "CloudStorage" ], - "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.", + "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": [], @@ -16968,7 +18028,7 @@ { "name": "folderId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "required": true, "type": "string" }, @@ -16991,14 +18051,14 @@ "in": "query", "required": false, "type": "string", - "description": "" + "description": "The file path to a cloud storage folder." }, { "name": "cloud_storage_folderid_plain", "in": "query", "required": false, "type": "string", - "description": "" + "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", @@ -17026,12 +18086,12 @@ "in": "query", "required": false, "type": "string", - "description": "" + "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. ", + "description": "The starting index position in the result set from which to start returning values. The default setting is `0`.", "required": false, "type": "string" } @@ -17560,8 +18620,8 @@ "tags": [ "UserSignatures" ], - "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\".", + "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": [], @@ -17585,7 +18645,7 @@ "in": "query", "required": false, "type": "string", - "description": "" + "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": { @@ -17667,7 +18727,7 @@ "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.", + "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": [], @@ -17896,7 +18956,7 @@ "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 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.", + "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": [ @@ -17913,7 +18973,7 @@ { "name": "imageType", "in": "path", - "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`", "required": true, "type": "string" }, @@ -17936,7 +18996,7 @@ "in": "query", "required": false, "type": "string", - "description": "" + "description": "When **true**, the chrome (or frame containing the added line and identifier) is included with the signature image." } ], "responses": { @@ -17981,7 +19041,7 @@ { "name": "imageType", "in": "path", - "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`", "required": true, "type": "string" }, @@ -18047,7 +19107,7 @@ { "name": "imageType", "in": "path", - "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`", "required": true, "type": "string" }, @@ -18094,7 +19154,7 @@ "EnvelopeViews" ], "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.", + "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": [], @@ -18335,7 +19395,7 @@ "Workspaces" ], "summary": "Create a Workspace", - "description": "Creates a new workspace.", + "description": "This method creates a new workspace.", "operationId": "Workspace_PostWorkspace", "consumes": [], "produces": [], @@ -18400,7 +19460,7 @@ { "name": "workspaceId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the workspace.", "required": true, "type": "string" } @@ -18445,7 +19505,7 @@ { "name": "workspaceId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the workspace.", "required": true, "type": "string" }, @@ -18499,7 +19559,7 @@ { "name": "workspaceId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the workspace.", "required": true, "type": "string" } @@ -18531,8 +19591,8 @@ "tags": [ "WorkspaceItems" ], - "summary": "List Workspace Folder Contents", - "description": "Retrieves workspace folder contents, which can include sub folders and files.", + "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": [], @@ -18547,14 +19607,14 @@ { "name": "folderId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "required": true, "type": "string" }, { "name": "workspaceId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the workspace.", "required": true, "type": "string" }, @@ -18568,28 +19628,28 @@ { "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**.", + "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**, information about the sub-folders of the current folder is returned. The default is **false**.", + "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**, thumbnails are returned as part of the response. The default is **false**.", + "description": "When set to **true**, the response returns thumbnails. 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**.", + "description": "When set to **true**, the response includes extended details about the user. The default is **false**.", "required": false, "type": "string" }, @@ -18603,7 +19663,7 @@ { "name": "workspace_user_id", "in": "query", - "description": "If set, then the results are filtered to those associated with the specified userId.", + "description": "If set, the response only includes results associated with the `userId` that you specify.", "required": false, "type": "string" } @@ -18632,7 +19692,7 @@ "tags": [ "WorkspaceItems" ], - "summary": "Deletes workspace one or more specific files/folders from the given folder or root.", + "summary": "Deletes files or sub-folders from a workspace.", "operationId": "WorkspaceFolder_DeleteWorkspaceItems", "consumes": [], "produces": [], @@ -18647,14 +19707,14 @@ { "name": "folderId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "required": true, "type": "string" }, { "name": "workspaceId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the workspace.", "required": true, "type": "string" }, @@ -18683,7 +19743,7 @@ "x-ds-methodname": "deleteWorkspaceFolderItems", "x-ds-method": "deleteFolderItems", "x-ds-service": "Workspaces", - "description": "", + "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": [] @@ -18708,14 +19768,14 @@ { "name": "folderId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "required": true, "type": "string" }, { "name": "workspaceId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the workspace.", "required": true, "type": "string" } @@ -18738,7 +19798,7 @@ "x-ds-methodname": "createWorkspaceFile", "x-ds-method": "createFIle", "x-ds-service": "Workspaces", - "description": "", + "description": "This method adds a file to a workspace.", "x-ds-in-sdk": true }, "parameters": [] @@ -18748,8 +19808,8 @@ "tags": [ "WorkspaceItems" ], - "summary": "Get Workspace File", - "description": "Retrieves a workspace file (the binary).", + "summary": "Gets a workspace file", + "description": "This method returns a binary version of a file in a workspace.", "operationId": "WorkspaceFile_GetWorkspaceFile", "consumes": [], "produces": [], @@ -18764,35 +19824,35 @@ { "name": "fileId", "in": "path", - "description": "Specifies the room file ID GUID.", + "description": "The id of the file.", "required": true, "type": "string" }, { "name": "folderId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "required": true, "type": "string" }, { "name": "workspaceId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "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. Default is **false**.", + "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 returned as a PDF.", + "description": "When set to **true** the file is returned in PDF format.", "required": false, "type": "string" } @@ -18818,8 +19878,8 @@ "tags": [ "WorkspaceItems" ], - "summary": "Update Workspace File Metadata", - "description": "Updates workspace item metadata for one or more specific files/folders.", + "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": [], @@ -18834,21 +19894,21 @@ { "name": "fileId", "in": "path", - "description": "Specifies the room file ID GUID.", + "description": "The id of the file.", "required": true, "type": "string" }, { "name": "folderId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "required": true, "type": "string" }, { "name": "workspaceId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the workspace.", "required": true, "type": "string" } @@ -18881,7 +19941,7 @@ "WorkspaceItems" ], "summary": "List File Pages", - "description": "Retrieves a workspace file as rasterized pages.", + "description": "This method returns a workspace file as rasterized pages.", "operationId": "WorkspaceFilePages_GetWorkspaceFilePages", "consumes": [], "produces": [], @@ -18896,21 +19956,21 @@ { "name": "fileId", "in": "path", - "description": "Specifies the room file ID GUID.", + "description": "The id of the file.", "required": true, "type": "string" }, { "name": "folderId", "in": "path", - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "required": true, "type": "string" }, { "name": "workspaceId", "in": "path", - "description": "Specifies the workspace ID GUID.", + "description": "The id of the workspace.", "required": true, "type": "string" }, @@ -19010,7 +20070,7 @@ "tags": [ "BillingPlans" ], - "summary": "Gets the list of available billing plans.", + "summary": "Gets a list of available billing plans.", "description": "Retrieves a list of the billing plans associated with a distributor.", "operationId": "BillingPlans_GetBillingPlans", "consumes": [], @@ -19101,7 +20161,7 @@ "in": "query", "required": false, "type": "string", - "description": "" + "description": "Use this parameter to search for specific text." }, { "name": "start_position", @@ -19139,7 +20199,7 @@ "tags": [ "AccountPasswordRules" ], - "summary": "Get membership account password rules", + "summary": "Gets membership account password rules.", "operationId": "PasswordRules_GetPasswordRules", "consumes": [], "produces": [], @@ -19422,7 +20482,7 @@ "type": "string" }, "email": { - "description": "Filters returned user records by the specified email address.", + "description": "", "type": "string" }, "fax": { @@ -19480,11 +20540,11 @@ "type": "string" }, "currencyCode": { - "description": "Specifies the ISO currency code for the account.", + "description": "Specifies the ISO currency code to use for the account.", "type": "string" }, "enableSupport": { - "description": "When set to **true**, then customer support is provided as part of the account plan.", + "description": "When set to **true**, customer support is provided as part of the account plan.", "type": "string" }, "includedSeats": { @@ -19500,19 +20560,19 @@ "type": "string" }, "otherDiscountPercent": { - "description": " Any other percentage discount for the plan. ", + "description": "Any other percentage discount for the plan.\n\nExample: `\"0.00\"`", "type": "string" }, "paymentCycle": { - "description": "", + "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. ", + "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": "", + "description": "The per-seat price associated with the plan.\n\nExample: `\"456.0000\"`", "type": "string" }, "planClassification": { @@ -19527,30 +20587,30 @@ } }, "planId": { - "description": "The DocuSign plan id for the account.", + "description": "DocuSign's id for the account plan.", "type": "string" }, "planName": { - "description": "The name of the billing plan.", + "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.", + "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": " A complex type that contains any seat discount information. Valid values are: \n\n- `BeginSeatCount`\n- `EndSeatCount`\n- `SeatDiscountPercent`\n ", + "description": "\n ", "type": "array", "items": { "$ref": "#/definitions/seatDiscount" } }, "supportIncidentFee": { - "description": "The support incident fee charged for each support incident.", + "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.", + "description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`", "type": "string" } }, @@ -19594,7 +20654,7 @@ "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" }, "successorPlans": { - "description": "", + "description": "A list of billing plans that the current billing plan can be rolled into.", "type": "array", "items": { "$ref": "#/definitions/billingPlan" @@ -19623,45 +20683,45 @@ "type": "object", "properties": { "name": { - "description": "Name of the identity verification step", + "description": "The name of the Identity Verification workflow step.", "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "description": "Reserved for DocuSign.", "type": "string" } }, "x-ds-definition-name": "accountIdentityVerificationStep", - "description": "Identity verification step", - "x-ms-summary": "Identity verification step" + "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 ID Verification workflow", + "description": "Text describing the purpose of the Identity Verification workflow.", "type": "string" }, "defaultName": { - "description": "Name of the ID Verification workflow", + "description": "The name of the Identity Verification workflow.", "type": "string" }, "signatureProvider": { "$ref": "#/definitions/accountSignatureProvider", - "description": "Signature provider associated with the identity verification workflow" + "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](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipients)", + "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/esign-rest-api/reference/Envelopes/EnvelopeRecipients#core-recipient-parameters)", "type": "string" }, "workflowResourceKey": { - "description": "Key for translated resources", + "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" + "description": "Specifies an Identity Verification workflow.", + "x-ms-summary": "Specifies an Identity Verification workflow." }, "accountInformation": { "description": "", @@ -19735,6 +20795,13 @@ "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" @@ -19768,7 +20835,7 @@ "type": "string" }, "planName": { - "description": "The name of the billing plan used for the account.", + "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": { @@ -19925,11 +20992,11 @@ "type": "object", "properties": { "expirePassword": { - "description": "", + "description": "When set to **true**, passwords expire. The default value is `false`.", "type": "string" }, "expirePasswordDays": { - "description": "", + "description": "The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true**.", "type": "string" }, "expirePasswordDaysMetadata": { @@ -19937,7 +21004,7 @@ "description": "Metadata that indicates whether the `expirePasswordDays` property is editable.\n" }, "lockoutDurationMinutes": { - "description": "", + "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": { @@ -19945,7 +21012,7 @@ "description": "Metadata that indicates whether the `lockoutDurationMinutes` property is editable.\n" }, "lockoutDurationType": { - "description": "", + "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": { @@ -19953,7 +21020,7 @@ "description": "Metadata that indicates whether the `lockoutDurationType` property is editable.\n" }, "minimumPasswordAgeDays": { - "description": "", + "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": { @@ -19961,7 +21028,7 @@ "description": "Metadata that indicates whether the `minimumPasswordAgeDays` property is editable.\n" }, "minimumPasswordLength": { - "description": "", + "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": { @@ -19969,27 +21036,27 @@ "description": "Metadata that indicates whether the `minimumPasswordLength` property is editable.\n" }, "passwordIncludeDigit": { - "description": "", + "description": "When set to **true**, passwords must include a digit. The default value is `false`.", "type": "string" }, "passwordIncludeDigitOrSpecialCharacter": { - "description": "", + "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": "", + "description": "When set to **true**, passwords must include a lowercase letter. The default value is `false`.", "type": "string" }, "passwordIncludeSpecialCharacter": { - "description": "", + "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": "", + "description": "When set to **true**, passwords must include an uppercase letter. The default value is `false`.", "type": "string" }, "passwordStrengthType": { - "description": "", + "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": { @@ -19997,7 +21064,7 @@ "description": "Metadata that indicates whether the `passwordStrengthType` property is editable.\n" }, "questionsRequired": { - "description": "", + "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": { @@ -20036,23 +21103,23 @@ "type": "string" }, "passwordIncludeDigit": { - "description": "", + "description": "When set to **true**, passwords must include a digit. The default value is `false`.", "type": "string" }, "passwordIncludeDigitOrSpecialCharacter": { - "description": "", + "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": "", + "description": "When set to **true**, passwords must include a lowercase letter. The default value is `false`.", "type": "string" }, "passwordIncludeSpecialCharacter": { - "description": "", + "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": "", + "description": "When set to **true**, passwords must include an uppercase letter. The default value is `false`.", "type": "string" } }, @@ -20103,6 +21170,14 @@ "$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" @@ -20127,6 +21202,14 @@ "$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" @@ -20387,8 +21470,12 @@ "$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": "If **true**, [Signature Adoption Configuration](https://support.docusign.com/en/guides/ndse-admin-guide-signature-adopt-config) is enabled.", + "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": { @@ -20404,7 +21491,7 @@ "description": "Metadata that indicates whether the `advancedCorrect` property is editable.\n" }, "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.", + "description": "When **true**, the configured [Access Code Format](https://developers.docusign.com/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": { @@ -20412,7 +21499,7 @@ "description": "Metadata that indicates whether the `allowAccessCodeFormat` property is editable.\n" }, "allowAccountManagementGranular": { - "description": "Boolean that specifies whether the account can be managed on a per-user basis.", + "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": { @@ -20427,6 +21514,14 @@ "$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" @@ -20435,6 +21530,14 @@ "$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" @@ -20443,8 +21546,16 @@ "$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": "If **true**, the account is able to bulk send.", + "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": { @@ -20452,7 +21563,7 @@ "description": "Metadata that indicates whether the `allowBulkSend` property is editable.\n" }, "allowCDWithdraw": { - "description": "Indicates whether the customer can withdraw their acceptance of the consumer disclosure.", + "description": "When set to **true**, recipients can withdraw their acceptance of the consumer disclosure.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, "allowCDWithdrawMetadata": { @@ -20464,7 +21575,7 @@ "type": "string" }, "allowConnectSendFinishLater": { - "description": "If **true**, Connect will send FinishLater messages\n", + "description": "Reserved for DocuSign.", "type": "string" }, "allowConnectSendFinishLaterMetadata": { @@ -20472,7 +21583,7 @@ "description": "Metadata that indicates whether the `allowConnectSendFinishLater` property is editable.\n" }, "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", + "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": { @@ -20480,7 +21591,7 @@ "description": "Metadata that indicates whether the `allowConsumerDisclosureOverride` property is editable.\n" }, "allowDataDownload": { - "description": "If **true**,\nsenders can download form data from an envelope.\n", + "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": { @@ -20512,7 +21623,7 @@ "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", + "description": "When **true**,\n[eHanko stamps](https://support.docusign.com/en/guides/ndse-user-guide-manage-your-stamps)\nare enabled.\n", "type": "string" }, "allowEHankoStampsMetadata": { @@ -20528,7 +21639,7 @@ "description": "Metadata that indicates whether the `allowENoteEOriginal` property is editable.\n" }, "allowEnvelopeCorrect": { - "description": "Specifies whether the correction feature is enabled.\n", + "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": { @@ -20536,7 +21647,7 @@ "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 wthin the same account.\n\n\n\n", + "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": { @@ -20552,7 +21663,7 @@ "description": "Metadata that indicates whether the `allowEnvelopeCustomFields` property is editable.\n" }, "allowEnvelopePublishReporting": { - "description": "Specifies whether envelope publishing reporting is enabled.\n", + "description": "When set to **true**, envelope publishing reporting is enabled.\n\n**Note**: Only Admin users can change this setting.\n", "type": "string" }, "allowEnvelopePublishReportingMetadata": { @@ -20576,7 +21687,7 @@ "description": "Metadata that indicates whether the `allowExpression` property is editable.\n" }, "allowExpressSignerCertificate": { - "description": "Specifies whether signers\nare required to use Express Digital Signatures.\n", + "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": { @@ -20592,15 +21703,31 @@ "description": "Metadata that indicates whether the `allowExtendedSendingResourceFile` property is editable.\n" }, "allowExternalSignaturePad": { - "description": "Specifies whether the account can\nconfigure and use signature pads for their recipients.\n", + "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." + }, + "allowIDVPlatform": { + "description": "", + "type": "string" + }, + "allowIDVPlatformMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `allowIDVPlatform` property is editable." + }, "allowInPerson": { - "description": "Specifies whether the account administrator can\nenable\nin person signing.\n\n", + "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": { @@ -20608,7 +21735,7 @@ "description": "Metadata that indicates whether the `allowInPerson` property is editable.\n" }, "allowManagedStamps": { - "description": "Boolean that specifies whether managed stamps can be used in the account.", + "description": "When **true**, [Managed Stamps](https://support.docusign.com/en/guides/ndse-admin-guide-managed-stamps) are enabled.", "type": "string" }, "allowManagedStampsMetadata": { @@ -20616,7 +21743,7 @@ "description": "Metadata that indicates whether the `allowManagedStamps` property is editable.\n" }, "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" }, "allowMarkupMetadata": { @@ -20624,7 +21751,7 @@ "description": "Metadata that indicates whether the `allowMarkup` property is editable.\n" }, "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", + "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": { @@ -20632,7 +21759,7 @@ "description": "Metadata that indicates whether the `allowMemberTimeZone` property is editable.\n" }, "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", + "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": { @@ -20648,7 +21775,7 @@ "description": "Metadata that indicates whether the `allowMultipleBrandProfiles` property is editable.\n" }, "allowMultipleSignerAttachments": { - "description": "Specifies whether recipients are able to\nupload multiple signer attachments with a single attachment.\n", + "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": { @@ -20664,7 +21791,7 @@ "description": "Metadata that indicates whether the `allowNonUSPhoneAuth` property is editable.\n" }, "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", + "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": { @@ -20672,7 +21799,7 @@ "description": "Metadata that indicates whether the `allowOfflineSigning` property is editable.\n" }, "allowOpenTrustSignerCertificate": { - "description": "Boolean that specifies whether OpenTrust signer certificates can be used in the account.", + "description": "When set to **true**, senders can use OpenTrust signer certificates.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, "allowOpenTrustSignerCertificateMetadata": { @@ -20688,7 +21815,7 @@ "description": "Metadata that indicates whether the `allowOrganizations` property is editable.\n" }, "allowPaymentProcessing": { - "description": "Boolean that specifies whether payment processing is enabled for the account.", + "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": { @@ -20696,7 +21823,7 @@ "description": "Metadata that indicates whether the `allowPaymentProcessing` property is editable.\n" }, "allowPersonalSignerCertificate": { - "description": "Boolean that specifies whether a signer certificate is allowed to be used for signing on the account.", + "description": "When set to **true**, signers can use personal signer certificates.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, "allowPersonalSignerCertificateMetadata": { @@ -20720,7 +21847,7 @@ "description": "Metadata that indicates whether the `allowPhoneAuthOverride` property is editable.\n" }, "allowPrivateSigningGroups": { - "description": "Boolean that specifies whether the account allows private signing groups.", + "description": "Reserved for DocuSign. This property returns the value **false** when listing account settings. Read only.", "type": "string" }, "allowPrivateSigningGroupsMetadata": { @@ -20728,7 +21855,7 @@ "description": "Metadata that indicates whether the `allowPrivateSigningGroups` property is editable.\n" }, "allowReminders": { - "description": "If **true**,\nallows an account administrator to turn on reminders\nand expiration defaults for the account.\n", + "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": { @@ -20744,7 +21871,7 @@ "description": "Metadata that indicates whether the `allowResourceFileBranding` property is editable.\n" }, "allowSafeBioPharmaSignerCertificate": { - "description": "If **true**,\nallows the account administrator\nto specify that signers are\nrequired to use SAFE digital signatures.\n", + "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": { @@ -20784,7 +21911,7 @@ "description": "Metadata that indicates whether the `allowServerTemplates` property is editable.\n" }, "allowSharedTabs": { - "description": "If **true**,\nthe account can use shared tabs.\n", + "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": { @@ -20792,7 +21919,7 @@ "description": "Metadata that indicates whether the `allowSharedTabs` property is editable.\n" }, "allowSignatureStamps": { - "description": "Boolean that specifies whether signature stamps can be used with the account.", + "description": "When set to **true**, Signature Stamps are enabled.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, "allowSignatureStampsMetadata": { @@ -20800,7 +21927,7 @@ "description": "Metadata that indicates whether the `allowSignatureStamps` property is editable.\n" }, "allowSignDocumentFromHomePage": { - "description": "Boolean that specifies whether recipients can sign documents from the homepage.", + "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": { @@ -20808,7 +21935,7 @@ "description": "Metadata that indicates whether the `allowSignDocumentFromHomePage` property is editable.\n" }, "allowSignerReassign": { - "description": "Account setting that determines whether the recipient of an envelope sent from this account can reassign it to another person.\n", + "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": { @@ -20816,7 +21943,7 @@ "description": "Metadata that indicates whether the `allowSignerReassign` property is editable.\n" }, "allowSignerReassignOverride": { - "description": "Account setting that determines whether an account administrator can override the ability of an envelope recipient to reassign it to another person.", + "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": { @@ -20832,7 +21959,7 @@ "description": "Metadata that indicates whether the `allowSigningExtensions` property is editable.\n" }, "allowSigningGroups": { - "description": "Boolean that specifies whether the account allows signing groups.", + "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": { @@ -20856,12 +21983,12 @@ "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", + "description": "Deprecated.", "type": "string" }, "allowSocialIdLoginMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `allowSocialIdLogin` property is editable.\n" + "description": "Deprecated." }, "allowSupplementalDocuments": { "description": "When **true**, this user can include supplemental documents.", @@ -20872,7 +21999,7 @@ "description": "Metadata that indicates whether the `allowSupplementalDocuments` property is editable." }, "anchorPopulationScope": { - "description": "Valid values are:\n\n- `document`\n- `envelope`\n\n", + "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": { @@ -20880,7 +22007,7 @@ "description": "Metadata that indicates whether the `anchorPopulationScope` property is editable.\n" }, "anchorTagVersionedPlacementEnabled": { - "description": "Valid values are:\n\n- `system_default`\n- `off`\n- `on`\n", + "description": "Reserved for DocuSign.\n", "type": "string" }, "anchorTagVersionedPlacementMetadataEnabled": { @@ -20888,7 +22015,7 @@ "description": "" }, "attachCompletedEnvelope": { - "description": "Boolean that specifies whether envelope documents are included as a PDF file attachment for signing completed emails.", + "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": { @@ -20896,7 +22023,7 @@ "description": "Metadata that indicates whether the `attachCompletedEnvelope` property is editable." }, "authenticationCheck": { - "description": "Specifies how often\nto check authentication.\nValid values are:\n\n- `initial_access`\n- `each_access`\n", + "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": { @@ -20933,7 +22060,7 @@ }, "betaSwitchConfigurationMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `betaSwitchConfiguration` property is editable.\n" + "description": "Reserved for DocuSign." }, "billingAddress": { "$ref": "#/definitions/addressInformation", @@ -20952,7 +22079,7 @@ "description": "Metadata that indicates whether the `bulkSend` property is editable.\n" }, "canSelfBrandSend": { - "description": "Boolean that specifies whether account administrators can self-brand their sending console through the DocuSign Console.", + "description": "When set to **true**, account administrators can self-brand their sending console through the DocuSign console.", "type": "string" }, "canSelfBrandSendMetadata": { @@ -20960,7 +22087,7 @@ "description": "Metadata that indicates whether the `canSelfBrandSend` property is editable.\n" }, "canSelfBrandSign": { - "description": "Boolean that specifies whether account administrators can self-brand their signing console through the DocuSign Console.", + "description": "When set to **true**, account administrators can self-brand their signing console through the DocuSign console.", "type": "string" }, "canSelfBrandSignMetadata": { @@ -20983,6 +22110,14 @@ "$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" @@ -21008,7 +22143,7 @@ "description": "Metadata that indicates whether the `commentsAllowEnvelopeOverride` property is editable.\n" }, "conditionalFieldsEnabled": { - "description": "Boolean that specifies whether conditional fields can be used in documents.", + "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": { @@ -21016,7 +22151,7 @@ "description": "Metadata that indicates whether the `conditionalFieldsEnabled` property is editable.\n" }, "consumerDisclosureFrequency": { - "description": "Speficies how often to display\nthe consumer disclosure.\nValid values are:\n\n- `once`\n- `always`\n- `each_access`\n", + "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": { @@ -21032,7 +22167,7 @@ "description": "Metadata that indicates whether the `convertPdfFields` property is editable.\n" }, "dataPopulationScope": { - "description": "Valid values are:\n\n- `document`\n- `envelope`\n", + "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": { @@ -21048,7 +22183,7 @@ "description": "Metadata that indicates whether the `disableMobileApp` property is editable.\n" }, "disableMobilePushNotifications": { - "description": "When **true**, push notifications are disabled for the account.", + "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": { @@ -21056,7 +22191,7 @@ "description": "Metadata that indicates whether the `disableMobilePushNotifications` property is editable.\n" }, "disableMobileSending": { - "description": "When **true**, sending from a mobile application is disabled.", + "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": { @@ -21064,7 +22199,7 @@ "description": "Metadata that indicates whether the `disableMobileSending` property is editable.\n" }, "disableMultipleSessions": { - "description": "When **true**, account users cannot be logged into multiple sessions at the same time.", + "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": { @@ -21073,7 +22208,7 @@ }, "disablePurgeNotificationsForSenderMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `disablePurgeNotificationsForSender` property is editable.\n" + "description": "Reserved for DocuSign." }, "disableSignerCertView": { "description": "When **true**, signers cannot view certificates of completion.", @@ -21100,7 +22235,7 @@ "description": "Metadata that indicates whether the `disableStyleSignature` property is editable.\n" }, "disableUploadSignature": { - "description": "When **true**, signers cannot upload custom image files of their signature and initials.", + "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": { @@ -21124,7 +22259,7 @@ "description": "Metadata that indicates whether the `displayBetaSwitch` property is editable.\n" }, "documentConversionRestrictions": { - "description": "Valid values are:\n\n- `no_restrictions`\n- `allow_pdf_only`\n- `no_upload`\n", + "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": { @@ -21132,7 +22267,7 @@ "description": "Metadata that indicates whether the `documentConversionRestrictions` property is editable.\n" }, "documentRetention": { - "description": "", + "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": { @@ -21140,7 +22275,7 @@ "description": "Metadata that indicates whether the `documentRetention` property is editable.\n" }, "documentRetentionPurgeTabs": { - "description": "Specifies when to purge tabs according to the Document Retention policy for the account.", + "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": { @@ -21152,7 +22287,7 @@ "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 minumum version of email supported for the account.", + "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": { @@ -21184,7 +22319,7 @@ "description": "Metadata that indicates whether the `enableAdvancedPowerForms` property is editable.\n" }, "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.", + "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": { @@ -21192,7 +22327,7 @@ "description": "Metadata that indicates whether the `enableAutoNav` property is editable.\n" }, "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).", + "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": { @@ -21200,7 +22335,7 @@ "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.", + "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": { @@ -21224,7 +22359,7 @@ "description": "Metadata that indicates whether the `enableDSPro` property is editable.\n" }, "enableEnvelopeStampingByAccountAdmin": { - "description": "When **true**, enables the account administrator to control envelope stamping for an account (placement of the EnvelopeID).", + "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": { @@ -21232,7 +22367,7 @@ "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).", + "description": "When **true**, enables the DocuSign administrator to control envelope stamping for an account (placement of the `envelopeId`).", "type": "string" }, "enableEnvelopeStampingByDSAdminMetadata": { @@ -21240,7 +22375,7 @@ "description": "Metadata that indicates whether the `enableEnvelopeStampingByDSAdmin` property is editable.\n" }, "enablePaymentProcessing": { - "description": "When **true**, enables payment processing for this account.", + "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": { @@ -21248,11 +22383,11 @@ "description": "Metadata that indicates whether the `enablePaymentProcessing` property is editable.\n" }, "enablePowerForm": { - "description": "When **true**, enables PowerForms for an account.", + "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 **true**, enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms.", + "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": { @@ -21280,7 +22415,7 @@ "description": "Metadata that indicates whether the `enableReportLinks` property is editable.\n" }, "enableRequireSignOnPaper": { - "description": "When true, the account can use the `requireSignOnPaper` option.\n", + "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": { @@ -21288,7 +22423,7 @@ "description": "Metadata that indicates whether the `enableRequireSignOnPaper` property is editable.\n" }, "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.", + "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": { @@ -21304,7 +22439,7 @@ "description": "Metadata that indicates whether the `enableResponsiveSigning` property is editable.\n" }, "enableScheduledRelease": { - "description": "", + "description": "When set to **true**, scheduled releases are enabled. The default value is **false**.", "type": "string" }, "enableScheduledReleaseMetadata": { @@ -21320,7 +22455,7 @@ "description": "Metadata that indicates whether the `enableSendingTagsFontSettings` property is editable.\n" }, "enableSendToAgent": { - "description": "When **true**, this account can use the agent recipient type.\n", + "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": { @@ -21328,7 +22463,7 @@ "description": "Metadata that indicates whether the `enableSendToAgent` property is editable.\n" }, "enableSendToIntermediary": { - "description": "When true, this account can use the intermediary recipient type.\n", + "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": { @@ -21336,7 +22471,7 @@ "description": "Metadata that indicates whether the `enableSendToIntermediary` property is editable.\n" }, "enableSendToManage": { - "description": "When true, this account can use the editor recipient type.\n", + "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": { @@ -21344,7 +22479,7 @@ "description": "Metadata that indicates whether the `enableSendToManage` 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 DocuSign API.\n\n**Note**: Only SysAdmin users can change this setting.", "type": "string" }, "enableSequentialSigningAPIMetadata": { @@ -21352,7 +22487,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": { @@ -21360,7 +22495,7 @@ "description": "Metadata that indicates whether the `enableSequentialSigningUI` property is editable.\n" }, "enableSignerAttachments": { - "description": "When **true**, this user can use the signing attachments feature.", + "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": { @@ -21392,7 +22527,7 @@ "description": "Metadata that indicates whether the `enableSigningOrderSettingsForAccount` property is editable.\n" }, "enableSignOnPaper": { - "description": "When **true**, a sender can allow signers to use the sign on paper option.\n", + "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": { @@ -21400,7 +22535,7 @@ "description": "Metadata that indicates whether the `enableSignOnPaper` 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": { @@ -21408,15 +22543,23 @@ "description": "Metadata that indicates whether the `enableSignOnPaperOverride` property is editable.\n" }, "enableSignWithNotary": { - "description": "When set to **true**, Sign with Notary functionality is enabled on the envelope.", + "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 **true**, the account can use SMS authentication.\n", + "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": { @@ -21424,12 +22567,12 @@ "description": "Metadata that indicates whether the `enableSMSAuthentication` property is editable.\n" }, "enableSocialIdLogin": { - "description": "When **true**, enables the ability to use social IDs to login to an account.", + "description": "Deprecated.", "type": "string" }, "enableSocialIdLoginMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "Metadata that indicates whether the `enableSocialIdLogin` property is editable.\n" + "description": "Deprecated." }, "enableStrikeThrough": { "description": "When **true**, enables strikethrough formatting in documents.", @@ -21445,10 +22588,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": { @@ -21456,7 +22599,7 @@ "description": "Metadata that indicates whether the `enableVaulting` property is editable.\n" }, "enableWitnessing": { - "description": "When **true**, enables documents to be signed by a witness.", + "description": "Reserved for DocuSign.", "type": "string" }, "enableWitnessingMetadata": { @@ -21472,7 +22615,7 @@ "description": "Metadata that indicates whether the `enforceTemplateNameUniqueness` property is editable.\n" }, "envelopeIntegrationAllowed": { - "description": "When **true**, allows custom admins to enable Connect for their accounts.", + "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": { @@ -21480,7 +22623,7 @@ "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.", + "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": { @@ -21488,7 +22631,7 @@ "description": "Metadata that indicates whether the `envelopeIntegrationEnabled` property is editable.\n" }, "envelopeStampingDefaultValue": { - "description": "Specifies the default value for Envelope ID stamping.", + "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": { @@ -21516,7 +22659,7 @@ "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", + "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": { @@ -21524,13 +22667,21 @@ "description": "Metadata that indicates whether the `externalSignaturePadType` property is editable.\n" }, "faxOutEnabled": { - "description": "Boolean that specifies whether fax delivery to recipients is allowed for the account.", + "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" @@ -21555,11 +22706,11 @@ } }, "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.", + "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.", + "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": { @@ -21579,7 +22730,7 @@ "description": "Metadata that indicates whether the `idCheckExpireMinutes` property is editable.\n" }, "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.", + "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": { @@ -21606,7 +22757,7 @@ "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.", + "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": { @@ -21622,7 +22773,7 @@ "description": "Metadata that indicates whether the `inPersonSigningEnabled` property is editable.\n" }, "inSessionEnabled": { - "description": "When **true**, the account can send in-session (embedded) envelopes.", + "description": "When **true**, the account can send in-session (embedded) envelopes.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, "inSessionEnabledMetadata": { @@ -21630,7 +22781,7 @@ "description": "Metadata that indicates whether the `inSessionEnabled` property is editable.\n" }, "inSessionSuppressEmails": { - "description": "When **true**, emails cannot be sent to the in-session (embedded) recipients on an envelope.", + "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": { @@ -21638,7 +22789,7 @@ "description": "Metadata that indicates whether the `inSessionSuppressEmails` property is editable.\n" }, "maximumSigningGroups": { - "description": "The maximum number of signing groups allowed for the account.", + "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": { @@ -21646,7 +22797,7 @@ "description": "Metadata that indicates whether the `maximumSigningGroups` property is editable.\n" }, "maximumUsersPerSigningGroup": { - "description": "The maximum number of users per signing group.", + "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": { @@ -21658,7 +22809,7 @@ "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.", + "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": { @@ -21666,7 +22817,7 @@ "description": "Metadata that indicates whether the `mobileSessionTimeout` property is editable.\n" }, "numberOfActiveCustomStamps": { - "description": "The number of custom stamps currently active.", + "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": { @@ -21694,7 +22845,7 @@ "description": "Metadata that indicates whether the `optOutNewPlatformSealPlatform` property is editable.\n" }, "phoneAuthRecipientMayProvidePhoneNumber": { - "description": "Boolean that specifies whether to allow a recipient to provide a phone number, for an account that uses Phone Authentication.", + "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": { @@ -21702,7 +22853,7 @@ "description": "Metadata that indicates whether the `phoneAuthRecipientMayProvidePhoneNumber` property is editable.\n" }, "pkiSignDownloadedPDFDocs": { - "description": "Always **true**.\nSpecifies that PDF files\ndownloaded from the platform\nare signed.\n", + "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": { @@ -21710,7 +22861,7 @@ "description": "Metadata that indicates whether the `pkiSignDownloadedPDFDocs` property is editable.\n" }, "recipientsCanSignOffline": { - "description": "If **true**,\nrecipients recieving envelopes from this account\ncan sign offline.\n", + "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": { @@ -21718,7 +22869,7 @@ "description": "Metadata that indicates whether the `recipientsCanSignOffline` property is editable.\n" }, "recipientSigningAutoNavigationControl": { - "description": "Boolean that specifies whether recipients recieving envelopes from this account can override autonav functionality.", + "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": { @@ -21726,7 +22877,7 @@ "description": "Metadata that indicates whether the `recipientSigningAutoNavigationControl` property is editable.\n" }, "require21CFRpt11Compliance": { - "description": "If **true**,\nrecipients are required\nto use a 21 CFR part 11-compliant signing experience.\n", + "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": { @@ -21734,7 +22885,7 @@ "description": "Metadata that indicates whether the `require21CFRpt11Compliance` property is editable.\n" }, "requireDeclineReason": { - "description": "If **true**,\nrequires signers who decline to sign an envelope sent from this account\nto provide a reason for declining.\n", + "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": { @@ -21742,7 +22893,7 @@ "description": "Metadata that indicates whether the `requireDeclineReason` property is editable.\n" }, "requireExternalUserManagement": { - "description": "Boolean that specifies whether to require external managing of users in an account.", + "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": { @@ -21750,7 +22901,7 @@ "description": "Metadata that indicates whether the `requireExternalUserManagement` property is editable.\n" }, "requireSignerCertificateType": { - "description": "Valid values are:\n\n- `none`\n- `docusign_express`\n- `docusign_personal`\n- `safe`\n- `open_trust`\n", + "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": { @@ -21758,23 +22909,23 @@ "description": "Metadata that indicates whether the `requireSignerCertificateType` property is editable.\n" }, "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", + "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 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", + "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:**\nModifying this value may disrupt your ID Check capability.\nEnsure you have the correct value before changing it.\n\n\n", + "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:**\nModifying this value may disrupt your ID Check capability.\nEnsure you have the correct value before changing it.\n\n", + "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": "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": { @@ -21782,7 +22933,7 @@ "description": "Metadata that indicates whether the `selfSignedRecipientEmailDocument` property is editable.\n" }, "selfSignedRecipientEmailDocumentUserOverride": { - "description": "When **true** the `selfSignedRecipientEmailDocument` user setting can be set for an individual user.\nThe user setting overrides the account setting.\n\n", + "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": { @@ -21790,7 +22941,7 @@ "description": "Metadata that indicates whether the `selfSignedRecipientEmailDocumentUserOverride` property is editable.\n" }, "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.", + "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": { @@ -21798,7 +22949,7 @@ "description": "Metadata that indicates whether the `senderCanSignInEachLocation` property is editable.\n" }, "senderMustAuthenticateSigning": { - "description": "When *true*, a sender who is also a recipient of an envelope\nmust follow the authentication requirements for the envelope.\n", + "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": { @@ -21806,7 +22957,7 @@ "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\n- `Black`\n- `BrightBlue`\n- `BrightRed`\n- `DarkGreen`\n- `DarkRed`\n- `Gold`\n- `Green`\n- `NavyBlue`\n- `Purple`\n- `White`", + "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": { @@ -21846,7 +22997,7 @@ "description": "Metadata that indicates whether the `sessionTimeout` property is editable.\n" }, "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)", + "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": { @@ -21854,7 +23005,7 @@ "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 by the sender specifying a unique language for a\nrecipient\n", + "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": { @@ -21877,6 +23028,14 @@ "$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" @@ -21913,7 +23072,7 @@ "description": "Metadata that indicates whether the `signatureProviders` property is editable.\n" }, "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", + "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": { @@ -21921,7 +23080,7 @@ "description": "Metadata that indicates whether the `signDateFormat` property is editable.\n" }, "signerAttachCertificateToEnvelopePDF": { - "description": "If **true**,\nthe certificate of completion is included in the envelope documents PDF when it is downloaded.\n", + "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": { @@ -21929,7 +23088,7 @@ "description": "Metadata that indicates whether the `signerAttachCertificateToEnvelopePDF` property is editable.\n" }, "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", + "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": { @@ -21937,7 +23096,7 @@ "description": "Metadata that indicates whether the `signerAttachConcat` property is editable.\n" }, "signerCanCreateAccount": { - "description": "If **true**,\nthe signer can create a DocuSign account\nafter signing.\n", + "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": { @@ -21945,7 +23104,7 @@ "description": "Metadata that indicates whether the `signerCanCreateAccount` property is editable.\n" }, "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" }, "signerCanSignOnMobileMetadata": { @@ -21953,7 +23112,7 @@ "description": "Metadata that indicates whether the `signerCanSignOnMobile` property is editable.\n" }, "signerInSessionUseEnvelopeCompleteEmail": { - "description": "If **true**,\nsend only a completed email to an in-session signer\nand only if in-session emails are not supressed.\n", + "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": { @@ -21961,7 +23120,7 @@ "description": "Metadata that indicates whether the `signerInSessionUseEnvelopeCompleteEmail` property is editable.\n" }, "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", + "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": { @@ -21969,7 +23128,7 @@ "description": "Metadata that indicates whether the `signerLoginRequirements` property is editable.\n" }, "signerMustHaveAccount": { - "description": "When **true**, senders can only send an envelope to a recipient that has a DocuSign account.\n", + "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": { @@ -21977,7 +23136,7 @@ "description": "Metadata that indicates whether the `signerMustHaveAccount` property is editable.\n" }, "signerMustLoginToSign": { - "description": "When **true**,\nsigners must log in to the DocuSign platform to sign an envelope.\n", + "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": { @@ -21985,7 +23144,7 @@ "description": "Metadata that indicates whether the `signerMustLoginToSign` property is editable.\n" }, "signerShowSecureFieldInitialValues": { - "description": "When **true**, the initial value of all SecureFields is written to the document when sent.\n", + "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": { @@ -22025,7 +23184,7 @@ "description": "Metadata that indicates whether the `signTimeShowAmPm` property is editable.\n" }, "simplifiedSendingEnabled": { - "description": "", + "description": "When set to **true**, simplified sending is enabled for the account. The default value is **false**.", "type": "string" }, "simplifiedSendingEnabledMetadata": { @@ -22073,7 +23232,7 @@ "description": "Metadata that indicates whether the `startInAdvancedCorrect` property is editable.\n" }, "supplementalDocumentsMustAccept": { - "description": "When **true**, this user must accept supplemental documents.", + "description": "When set to **true**, account users must accept supplemental documents when signing.", "type": "string" }, "supplementalDocumentsMustAcceptMetadata": { @@ -22081,7 +23240,7 @@ "description": "Metadata that indicates whether the `supplementalDocumentsMustAccept` property is editable.\n" }, "supplementalDocumentsMustRead": { - "description": "When **true**, this user must read supplemental documents.", + "description": "When set to **true**, account users must both view and accept supplemental documents when signing.", "type": "string" }, "supplementalDocumentsMustReadMetadata": { @@ -22089,7 +23248,7 @@ "description": "Metadata that indicates whether the `supplementalDocumentsMustRead` property is editable.\n" }, "supplementalDocumentsMustView": { - "description": "When **true**, this user must view supplemental documents.", + "description": "When set to **true**, account users must view supplemental documents when signing.", "type": "string" }, "supplementalDocumentsMustViewMetadata": { @@ -22137,7 +23296,7 @@ "description": "Metadata that indicates whether the `useAccountLevelEmail` property is editable.\n" }, "useConsumerDisclosure": { - "description": "Boolean that specifies whether the account uses an Electronic Record and Signature Disclosure Statement.", + "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": { @@ -22185,7 +23344,7 @@ "description": "Metadata that indicates whether the `useSAFESignerCertificates` property is editable.\n" }, "usesAPI": { - "description": "If **true**,\nthe account can use the API.\n", + "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": { @@ -22277,7 +23436,7 @@ "type": "string" }, "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "errorDetails": { @@ -22293,7 +23452,7 @@ "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" }, "sharedAccess": { @@ -22304,11 +23463,11 @@ } }, "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" } }, @@ -22318,34 +23477,64 @@ "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. [The current provider list.](https://developers.docusign.com/esign-rest-api/guides/standards-based-signatures)", + "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": "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" + "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": "", + "description": "Reserved for DocuSign.", "type": "string" }, "signatureProviderOptionId": { - "description": "", + "description": "Reserved for DocuSign.", "type": "string" }, "signatureProviderOptionName": { - "description": "", + "description": "Reserved for DocuSign.", "type": "string" } }, "x-ds-definition-name": "accountSignatureProviderOption", - "description": "", - "x-ms-summary": "" + "description": "Reserved for DocuSign.", + "x-ms-summary": "Reserved for DocuSign." }, "accountSignatureProviders": { "type": "object", @@ -22362,16 +23551,88 @@ "description": "", "x-ms-summary": "" }, + "accountUISettings": { + "type": "object", + "properties": { + "enableEasySignCanUseMultiTemplateApply": { + "description": "", + "type": "string" + }, + "enableEasySignCanUseMultiTemplateApplyMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableEasySignTemplateUpload": { + "description": "", + "type": "string" + }, + "enableEasySignTemplateUploadMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "hideSendAnEnvelope": { + "description": "", + "type": "string" + }, + "hideSendAnEnvelopeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "hideUseATemplate": { + "description": "", + "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": "" + } + }, + "x-ds-definition-name": "accountUISettings", + "description": "", + "x-ms-summary": "" + }, "addOn": { "description": "Contains information about add ons.", "type": "object", "properties": { "active": { - "description": "Reserved:", + "description": "Reserved for DocuSign.", "type": "string" }, "addOnId": { - "description": "Reserved:", + "description": "Reserved for DocuSign.", "type": "string" }, "id": { @@ -22379,7 +23640,7 @@ "type": "string" }, "name": { - "description": "Reserved:", + "description": "Reserved for DocuSign.", "type": "string" } }, @@ -22447,7 +23708,7 @@ "x-ms-summary": "" }, "agent": { - "description": "Contains information about agent recipients.", + "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": { @@ -22456,10 +23717,10 @@ }, "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." }, "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 Access Code on the recipient.", "type": "string" }, "clientUserId": { @@ -22471,7 +23732,7 @@ "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": "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.", "type": "array", "items": { "type": "string" @@ -22495,10 +23756,10 @@ }, "deliveryMethodMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `deliveryMethod` property is editable.\n" + "description": "Reserved for DocuSign." }, "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" @@ -22510,14 +23771,14 @@ }, "emailMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the email id of the agent." + "description": "Metadata that indicates whether the `email` 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. " + "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": { @@ -22537,15 +23798,15 @@ }, "faxNumberMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `faxNumber` property is editable.\n" + "description": "Reserved for DocuSign." }, "firstName": { - "description": "The agent'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 agent's first name." + "description": "Metadata that indicates whether the `firstame` property is editable." }, "fullName": { "description": "Reserved for DocuSign.", @@ -22561,7 +23822,7 @@ }, "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." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", @@ -22572,12 +23833,12 @@ "type": "string" }, "lastName": { - "description": "The agent'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 agent's last name." + "description": "Metadata that indicates whether the `lastName` property is editable." }, "lockedRecipientPhoneAuthEditable": { "description": "Reserved for DocuSign.", @@ -22588,12 +23849,12 @@ "type": "string" }, "name": { - "description": "The full legal name of the agent.", + "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 agent." + "description": "Metadata that indicates whether the `name` 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", @@ -22601,11 +23862,11 @@ }, "noteMetadata": { "$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 `note` 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." + "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`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n" }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -22619,7 +23880,7 @@ "description": "Information about the recipient's authentication status." }, "recipientFeatureMetadata": { - "description": "Metadata that indicates whether the `recipientFeature` property is editable.\n", + "description": "Metadata about the features that are supported for the recipient type.", "type": "array", "items": { "$ref": "#/definitions/featureAvailableMetadata" @@ -22634,12 +23895,12 @@ "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." }, "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. ", @@ -22647,10 +23908,10 @@ }, "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." }, "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": { @@ -22659,10 +23920,10 @@ }, "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." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "type": "string" }, "signedDateTime": { @@ -22670,15 +23931,15 @@ "type": "string" }, "signingGroupId": { - "description": "The id of the signing group of which the agent is a member, if applicable.", + "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" }, "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." }, "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": { @@ -22693,18 +23954,22 @@ "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.", + "description": "Deprecated.", "type": "array", "items": { "$ref": "#/definitions/socialAuthentication" } }, "status": { - "description": "Recipient status.\n\n", + "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" }, "templateLocked": { @@ -22725,14 +23990,14 @@ } }, "x-ds-definition-name": "agent", - "x-ms-summary": "Contains information about agent recipients." + "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 date and time the item was created.", + "description": "The UTC DateTime when the item was created.", "type": "string" }, "description": { @@ -22770,20 +24035,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -22794,12 +24059,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -22826,7 +24091,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -22834,7 +24099,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -22965,6 +24230,10 @@ "$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" @@ -23017,7 +24286,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": { @@ -23217,6 +24486,10 @@ "$ref": "#/definitions/eventResult", "description": "Success/failure result of authentication using sign-in with a Google+ account." }, + "identityVerificationResult": { + "$ref": "#/definitions/eventResult", + "description": "" + }, "idLookupResult": { "$ref": "#/definitions/eventResult", "description": "Result of an ID lookup." @@ -23289,6 +24562,164 @@ "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", @@ -23632,7 +25063,7 @@ } }, "enableSupport": { - "description": "When set to **true**, then customer support is provided as part of the account plan.", + "description": "When set to **true**, customer support is provided as part of the account plan.", "type": "string" }, "includedSeats": { @@ -23640,11 +25071,11 @@ "type": "string" }, "otherDiscountPercent": { - "description": "", + "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. ", + "description": "The payment cycle associated with the plan. The possible values are: \n\n- `Monthly`\n- `Annually` ", "type": "string" }, "paymentMethod": { @@ -23652,7 +25083,7 @@ "type": "string" }, "perSeatPrice": { - "description": "The per-seat price for the plan.", + "description": "The per-seat price associated with the plan.\n\nExample: `\"456.0000\"`", "type": "string" }, "planClassification": { @@ -23667,26 +25098,26 @@ } }, "planId": { - "description": "The DocuSign plan id for the account.", + "description": "DocuSign's id for the account plan.", "type": "string" }, "planName": { - "description": "The name of the billing plan.", + "description": "\n", "type": "string" }, "seatDiscounts": { - "description": "", + "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.", + "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.", + "description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`", "type": "string" } }, @@ -23717,7 +25148,7 @@ "type": "string" }, "enableSupport": { - "description": "When set to **true**, then customer support is provided as part of the account plan.", + "description": "When set to **true**, customer support is provided as part of the account plan.", "type": "string" }, "includedSeats": { @@ -23749,29 +25180,29 @@ "type": "string" }, "saleDiscountAmount": { - "description": "Reserved for DocuSign use only.", + "description": "Reserved for DocuSign.", "type": "string" }, "saleDiscountFixedAmount": { - "description": "Reserved for DocuSign use only.", + "description": "Reserved for DocuSign.", "type": "string" }, "saleDiscountPercent": { - "description": "Reserved for DocuSign use only.", + "description": "Reserved for DocuSign.", "type": "string" }, "saleDiscountPeriods": { - "description": "Reserved for DocuSign use only.", + "description": "Reserved for DocuSign.", "type": "string" }, "saleDiscountSeatPriceOverride": { - "description": "Reserved for DocuSign use only.", + "description": "Reserved for DocuSign.", "type": "string" } }, "x-ds-definition-name": "billingPlanInformation", - "description": "", - "x-ms-summary": "" + "description": "This object contains details about a billing plan.", + "x-ms-summary": "This object contains details about a billing plan." }, "billingPlanPreview": { "description": "Contains information about a preview billing plan.", @@ -23814,7 +25245,7 @@ "description": "An object that contains details about the billing plan." }, "successorPlans": { - "description": "", + "description": "A list of billing plans that the current billing plan can be rolled into.", "type": "array", "items": { "$ref": "#/definitions/billingPlan" @@ -23844,7 +25275,7 @@ "type": "object", "properties": { "accountPaymentMethod": { - "description": "", + "description": "The type of payment method used for the account. Valid values are:\n\n- `credit_card`\n- ", "type": "string" }, "billingPlanPreview": { @@ -23860,7 +25291,7 @@ "type": "string" }, "paymentCycle": { - "description": "", + "description": "The payment cycle associated with the plan. The possible values are: \n\n- `Monthly`\n- `Annually` ", "type": "string" }, "paymentMethod": { @@ -23868,11 +25299,11 @@ "type": "string" }, "planId": { - "description": "The DocuSign plan id for the account.", + "description": "DocuSign's id for the account plan.", "type": "string" }, "planName": { - "description": "The name of the billing plan used for the account.", + "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" } }, @@ -24054,13 +25485,13 @@ "type": "object", "properties": { "brandId": { - "description": "The ID of the brand.", + "description": "The id of the brand.", "type": "string" } }, "x-ds-definition-name": "brandRequest", - "description": "", - "x-ms-summary": "" + "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", @@ -24085,7 +25516,7 @@ "description": "Information about the user who last modified the brand resource." }, "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" }, "modifiedTemplates": { @@ -24159,8 +25590,8 @@ } }, "x-ds-definition-name": "brandsRequest", - "description": "", - "x-ms-summary": "" + "description": "Details about one or more brands.", + "x-ms-summary": "Details about one or more brands." }, "brandsResponse": { "type": "object", @@ -24205,7 +25636,7 @@ "type": "string" }, "envelopeUri": { - "description": "URI that you can use to retrieve the bulk envelopes.", + "description": "The URI for retrieving the envelope or envelopes.", "type": "string" }, "errorDetails": { @@ -24240,7 +25671,7 @@ } }, "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "nextUri": { @@ -24252,15 +25683,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" } }, @@ -24291,7 +25722,7 @@ "type": "string" }, "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "failed": { @@ -24311,7 +25742,7 @@ "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" }, "sent": { @@ -24319,7 +25750,7 @@ "type": "string" }, "startPosition": { - "description": "The starting position of the current result set.", + "description": "The starting index position of the current result set.", "type": "string" }, "submittedDate": { @@ -24327,7 +25758,7 @@ "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" } }, @@ -24434,7 +25865,7 @@ } }, "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "nextUri": { @@ -24446,15 +25877,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" } }, @@ -24520,6 +25951,298 @@ "description": "", "x-ms-summary": "" }, + "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. 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).", + "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 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.", + "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" + }, + "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" + }, + "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": "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`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\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`.", + "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" + }, + "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": "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": { + "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" + }, + "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" + } + } + }, + "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]: ./createBulkSendRequest.html", + "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": { @@ -24528,7 +26251,7 @@ "type": "string" }, "email": { - "description": "Specifies the email address associated with the captive recipient.", + "description": "The email address associated with the captive recipient.", "type": "string" }, "errorDetails": { @@ -24536,13 +26259,13 @@ "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.", + "description": "The username associated with the captive recipient.", "type": "string" } }, "x-ds-definition-name": "captiveRecipient", - "description": "", - "x-ms-summary": "" + "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", @@ -24556,8 +26279,8 @@ } }, "x-ds-definition-name": "captiveRecipientInformation", - "description": "", - "x-ms-summary": "" + "description": "Contains information about captive (embedded) recipients.", + "x-ms-summary": "Contains information about captive (embedded) recipients." }, "carbonCopy": { "type": "object", @@ -24568,14 +26291,14 @@ }, "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." }, "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 Access Code on the recipient.", "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.", + "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": { @@ -24591,7 +26314,7 @@ "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": "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.", "type": "array", "items": { "type": "string" @@ -24618,26 +26341,26 @@ "description": "Reserved for DocuSign." }, "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": "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ", + "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" }, "emailMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the email id of the recipient." + "description": "Metadata that indicates whether the `email` 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. " + "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": { @@ -24665,7 +26388,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." }, "fullName": { "description": "Reserved for DocuSign.", @@ -24681,7 +26404,7 @@ }, "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." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", @@ -24697,7 +26420,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." }, "lockedRecipientPhoneAuthEditable": { "description": "Reserved for DocuSign.", @@ -24708,12 +26431,12 @@ "type": "string" }, "name": { - "description": "The full legal name of the recipient. Maximum Length: 100 characters.", + "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." }, "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", @@ -24721,11 +26444,11 @@ }, "noteMetadata": { "$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 `note` 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." + "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`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n" }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -24754,12 +26477,12 @@ "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." }, "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. ", @@ -24767,10 +26490,10 @@ }, "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." }, "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": { @@ -24779,10 +26502,10 @@ }, "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." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "type": "string" }, "signedDateTime": { @@ -24790,15 +26513,15 @@ "type": "string" }, "signingGroupId": { - "description": "The ID of the signing group of which the recipient is a member, if applicable.", + "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" }, "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." }, "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": { @@ -24813,23 +26536,27 @@ "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.", + "description": "Deprecated.", "type": "array", "items": { "$ref": "#/definitions/socialAuthentication" } }, "status": { - "description": "Recipient status.\n\n", + "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 for recipient's status.", + "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." + "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. ", @@ -24849,8 +26576,8 @@ } }, "x-ds-definition-name": "carbonCopy", - "description": "A carbon copy recipient.", - "x-ms-summary": "A carbon copy recipient." + "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. " }, "certifiedDelivery": { "type": "object", @@ -24861,14 +26588,14 @@ }, "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." }, "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 Access Code on the recipient.", "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.", + "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": { @@ -24884,7 +26611,7 @@ "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": "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.", "type": "array", "items": { "type": "string" @@ -24911,26 +26638,26 @@ "description": "Reserved for DocuSign." }, "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 recipient." + "description": "Metadata that indicates whether the `email` 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. " + "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": { @@ -24950,7 +26677,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.", @@ -24958,7 +26685,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." }, "fullName": { "description": "Reserved for DocuSign.", @@ -24974,7 +26701,7 @@ }, "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." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", @@ -24985,12 +26712,12 @@ "type": "string" }, "lastName": { - "description": "The last name of the recipient.", + "description": "The recipient's last name.", "type": "string" }, "lastNameMetadata": { "$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 `lastName` property is editable." }, "lockedRecipientPhoneAuthEditable": { "description": "Reserved for DocuSign.", @@ -25001,12 +26728,12 @@ "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 user can edit the full legal name of the recipient." + "description": "Metadata that indicates whether the `name` 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", @@ -25014,11 +26741,11 @@ }, "noteMetadata": { "$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 `note` 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." + "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`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n" }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -25039,7 +26766,7 @@ } }, "recipientId": { - "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document.", "type": "string" }, "recipientIdGuid": { @@ -25047,12 +26774,12 @@ "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." }, "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. ", @@ -25060,10 +26787,10 @@ }, "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." }, "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": { @@ -25072,10 +26799,10 @@ }, "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." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "type": "string" }, "signedDateTime": { @@ -25083,15 +26810,15 @@ "type": "string" }, "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "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" }, "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." }, "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": { @@ -25106,18 +26833,22 @@ "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.", + "description": "Deprecated.", "type": "array", "items": { "$ref": "#/definitions/socialAuthentication" } }, "status": { - "description": "Recipient status.\n\n", + "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" }, "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" }, "templateLocked": { @@ -25138,27 +26869,27 @@ } }, "x-ds-definition-name": "certifiedDelivery", - "description": "", - "x-ms-summary": "" + "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." }, "checkbox": { "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +26900,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -25201,7 +26932,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -25209,7 +26940,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -25336,6 +27067,10 @@ "$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" @@ -25428,7 +27163,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": { @@ -25571,7 +27306,7 @@ "type": "string" }, "expirationDateTime": { - "description": "The UTC time at which the chunked upload expires and is no longer addressable. ", + "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" }, "maxChunkedUploadParts": { @@ -25611,13 +27346,13 @@ "type": "string" }, "serviceId": { - "description": "The DocuSign generated ID for the cloud storage provider", + "description": "The DocuSign-generated ID for the cloud storage provider.", "type": "string" } }, "x-ds-definition-name": "cloudStorageProvider", - "description": "", - "x-ms-summary": "" + "description": "Contains details about a specific cloud storage provider.", + "x-ms-summary": "Contains details about a specific cloud storage provider." }, "cloudStorageProviders": { "type": "object", @@ -25689,7 +27424,7 @@ "type": "string" }, "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" }, "subject": { @@ -25739,7 +27474,7 @@ "description": "An array of comment tabs that contain information about users' comments on documents.", "type": "array", "items": { - "$ref": "#/definitions/comment" + "$ref": "#/definitions/Comments" } }, "count": { @@ -25820,20 +27555,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -25844,12 +27579,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -25876,7 +27611,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -25884,7 +27619,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -25903,7 +27638,7 @@ "description": "An array of comment tabs that contain information about users' comments on documents.", "type": "array", "items": { - "$ref": "#/definitions/comment" + "$ref": "#/definitions/Comments" } }, "conditionalParentLabel": { @@ -26014,6 +27749,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 being accessed.", "type": "string" @@ -26066,7 +27805,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": { @@ -26158,20 +27897,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +27921,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -26214,7 +27953,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -26222,7 +27961,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -26238,7 +27977,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": { @@ -26377,6 +28116,10 @@ "$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" @@ -26453,7 +28196,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": { @@ -26549,7 +28292,7 @@ "type": "object", "properties": { "documents": { - "description": "Complex element contains the details on the documents in the envelope.", + "description": "A complex element that contains details about the documents associated with the envelope.", "type": "array", "items": { "$ref": "#/definitions/signHashDocument" @@ -26560,7 +28303,7 @@ "type": "string" }, "remainingSignatureRequests": { - "description": "", + "description": "For documents that require multiple signatures, this is the number of signature requests remaining.", "type": "string" } }, @@ -26568,51 +28311,16 @@ "description": "", "x-ms-summary": "" }, - "completeSignRequest": { - "type": "object", - "properties": { - "certificate": { - "description": "When set to **false**, the envelope signing certificate is removed from the download.", - "type": "string" - }, - "correlationId": { - "description": "", - "type": "string" - }, - "documentUpdateInfos": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/documentUpdateInfo" - } - }, - "maxSignatureLength": { - "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`.", - "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.", + "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": "" + "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.", @@ -26622,11 +28330,11 @@ } }, "pdfMetaDataTemplateSequence": { - "description": "", + "description": "A number representing the sequence in which to apply the template that contains the PDF metadata.\n\nExample: `4`", "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", + "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/serverTemplate" @@ -26634,27 +28342,27 @@ } }, "x-ds-definition-name": "compositeTemplate", - "description": "", - "x-ms-summary": "" + "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" }, "connectConfigResults": { "type": "object", "properties": { "configurations": { - "description": "Array of Connect Configurations", + "description": "An array of DocuSign Connect configurations.", "type": "array", "items": { "$ref": "#/definitions/ConnectConfigurations" } }, "totalRecords": { - "description": "The count of records in the log list.", + "description": "The number of results.", "type": "string" } }, "x-ds-definition-name": "connectConfigResults", - "description": "", - "x-ms-summary": "" + "description": "This object contains the results of a ConnectConfigurations::GET method.", + "x-ms-summary": "This object contains the results of a ConnectConfigurations::GET method." }, "connectCustomConfiguration": { "type": "object", @@ -26664,7 +28372,7 @@ "type": "string" }, "allowSalesforcePublish": { - "description": "", + "description": "When set to **true** (default), DocuSign sends data to the designated Salesforce account through Connect.", "type": "string" }, "allUsers": { @@ -26672,7 +28380,7 @@ "type": "string" }, "configurationType": { - "description": "If merge fields are being used, specifies the type of the merge field. The only supported value is **salesforce**.", + "description": "If merge fields are being used, specifies the type of the merge field. The only supported value is `salesforce`.", "type": "string" }, "connectId": { @@ -26680,7 +28388,7 @@ "type": "string" }, "enableLog": { - "description": "This turns Connect logging on or off. When set to **true**, logging is turned on.", + "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" }, "envelopeEvents": { @@ -26691,11 +28399,11 @@ } }, "externalFolderId": { - "description": "", + "description": "The id of an external folder.", "type": "string" }, "externalFolderLabel": { - "description": "", + "description": "The label for an external folder.", "type": "string" }, "includeCertificateOfCompletion": { @@ -26746,11 +28454,11 @@ } }, "requireMutualTls": { - "description": "If **true** [Mutual TLS](https://developers.docusign.com/esign-rest-api/guides/mutual-tls-intro) authentication is enabled.", + "description": "When set to **true**, [Mutual TLS](https://developers.docusign.com/esign-rest-api/guides/mutual-tls-intro) authentication is enabled.", "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.", + "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" }, "salesforceAccessToken": { @@ -26762,11 +28470,11 @@ "type": "string" }, "salesforceDocumentsAsContentFiles": { - "description": "", + "description": "When set to **true**, DocuSign can use documents in your Salesforce account for sending and signing.", "type": "string" }, "salesforceRefreshToken": { - "description": "", + "description": "The Saleforce OAuth refresh token that you use to get a new Salesforceaccess token (session ID). For more information, see [OAuth 2.0 Refresh Token Flow](https://help.salesforce.com/articleView?id=remoteaccess_oauth_refresh_token_flow.htm&type=5).", "type": "string" }, "senderOverride": { @@ -26774,14 +28482,14 @@ "type": "string" }, "senderSelectableItems": { - "description": "", + "description": "This property sets the items that are available for selection when adding or editing Connect objects. ", "type": "array", "items": { "type": "string" } }, "sfObjects": { - "description": "", + "description": "An array of Salesforce objects.", "type": "array", "items": { "$ref": "#/definitions/connectSalesforceObject" @@ -26792,7 +28500,7 @@ "type": "string" }, "soapNamespace": { - "description": "The namespace of the SOAP interface.\n\nThe namespace value must be set if useSoapInterface is set to true.", + "description": "The namespace of the SOAP interface.\n\n**Note**: If `useSoapInterface` is set to **true**, you must set this value.", "type": "string" }, "urlToPublishTo": { @@ -26800,7 +28508,7 @@ "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.", + "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" @@ -26823,7 +28531,7 @@ "type": "object", "properties": { "connectConfig": { - "description": "Name of the Connect configuration.", + "description": "The name of the Connect configuration.", "type": "string" }, "errorDetails": { @@ -26831,11 +28539,11 @@ "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "eventDateTime": { - "description": "Date and time of the event.", + "description": "The UTC date and time of the event.", "type": "string" }, "eventDescription": { - "description": "Description of the event.", + "description": "A description of the event.", "type": "string" }, "payload": { @@ -26882,23 +28590,23 @@ "type": "string" }, "status": { - "description": "Connection status.", + "description": "The connection status.", "type": "string" }, "statusMessage": { - "description": "Connection status message.", + "description": "A human-readable message describing the connection status.", "type": "string" } }, "x-ds-definition-name": "connectFailureResult", - "description": "", - "x-ms-summary": "" + "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": "", + "description": "Details about a Connect failure result.", "type": "array", "items": { "$ref": "#/definitions/connectFailureResult" @@ -26917,54 +28625,54 @@ "type": "string" }, "configUrl": { - "description": "Web address of the listener or retrieving service endpoint for Connect.", + "description": "The web address of the listener or retrieving service endpoint for Connect.", "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).", + "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), but 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" } }, "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.", + "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" }, "created": { - "description": "Date and time the Connect post was created.", + "description": "The UTC DateTime when the Connect post was created.", "type": "string" }, "email": { - "description": "Email address of the envelope sender.", + "description": "The email address of the envelope sender.", "type": "string" }, "envelopeId": { - "description": "ID of the envelope that failed to post.", + "description": "The id of the envelope that failed to post.", "type": "string" }, "error": { - "description": "Server error for the Connect post failure.", + "description": "The server error associated with the Connect post failure.", "type": "string" }, "failureId": { - "description": "ID of the Connect post failure.", + "description": "The id of the Connect post failure.", "type": "string" }, "failureUri": { - "description": "URI for the Connect post failure.", + "description": "The URI for the Connect post failure.", "type": "string" }, "lastTry": { - "description": "Date and time of the last attempt to post.", + "description": "The UTC DateTime of the last attempt to post.", "type": "string" }, "logId": { - "description": "ID of the Connect log entry.", + "description": "The id of the Connect log entry.", "type": "string" }, "logUri": { - "description": "URI for the Connect log entry.", + "description": "The URI for the Connect log entry.", "type": "string" }, "retryCount": { @@ -26972,25 +28680,25 @@ "type": "string" }, "retryUri": { - "description": "URI that can be used to retry to publish the Connect post.", + "description": "A URI that you can use to retry to publish the Connect post.", "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`", + "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" }, "subject": { - "description": "The envelope subject.", + "description": "The subject of the envelope.", "type": "string" }, "userName": { - "description": "The name of the envelope sender.", + "description": "The name of the sender of the envelope.", "type": "string" } }, "x-ds-definition-name": "connectLog", - "description": "", - "x-ms-summary": "" + "description": "Contains information about a Connect log entry.", + "x-ms-summary": "Contains information about a Connect log entry." }, "connectLogs": { "type": "object", @@ -27014,7 +28722,7 @@ "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "description": "", "type": "string" } }, @@ -27030,7 +28738,7 @@ "type": "string" }, "dsLink": { - "description": "", + "description": "A URL that links to the information in the DocuSign field.", "type": "string" }, "dsNode": { @@ -27046,11 +28754,11 @@ "type": "string" }, "sfFieldName": { - "description": "", + "description": "The name of the Salesforce field.", "type": "string" }, "sfFolder": { - "description": "", + "description": "The name of the Salesforce folder.", "type": "string" }, "sfLockedValue": { @@ -27059,22 +28767,22 @@ } }, "x-ds-definition-name": "connectSalesforceField", - "description": "", - "x-ms-summary": "" + "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." }, "connectSalesforceObject": { "type": "object", "properties": { "active": { - "description": "", + "description": "When set to **true**, the `connectSalesforceObject` is active.", "type": "string" }, "description": { - "description": "A sender-defined description of the line item.\n", + "description": "A description of the `connectSalesforceObject`.", "type": "string" }, "id": { - "description": "A unique ID for the Salesforce object.", + "description": "The id of the `connectSalesforceObject`.", "type": "string" }, "insert": { @@ -27082,26 +28790,26 @@ "type": "string" }, "onCompleteOnly": { - "description": "", + "description": "When **true**, Salesforce is updated only when the envelope is complete.", "type": "string" }, "selectFields": { - "description": "", + "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": "", + "description": "The Salesforce.com object type, such as `case`, `contact`, or `opportunity`.", "type": "string" }, "sfObjectName": { - "description": "The name of the Salesforce object.", + "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": "", + "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" @@ -27109,8 +28817,8 @@ } }, "x-ds-definition-name": "connectSalesforceObject", - "description": "", - "x-ms-summary": "" + "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)." }, "connectUserObject": { "type": "object", @@ -27147,17 +28855,17 @@ "type": "object", "properties": { "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", + "description": "The id of the envelope.", "type": "string" }, "returnUrl": { - "description": "The URL to be redirected to after the console view session has ended.", + "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": "", - "x-ms-summary": "" + "description": "The request object for the EnvelopeViews::createConsole method.", + "x-ms-summary": "The request object for the EnvelopeViews::createConsole method." }, "consumerDisclosure": { "type": "object", @@ -27167,7 +28875,7 @@ "type": "string" }, "allowCDWithdraw": { - "description": "Indicates whether the customer can withdraw their acceptance of the consumer disclosure.", + "description": "When set to **true**, recipients can withdraw their acceptance of the consumer disclosure.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, "allowCDWithdrawMetadata": { @@ -27299,26 +29007,26 @@ "type": "object", "properties": { "cloudProvider": { - "description": "", + "description": "The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)\n\n", "type": "string" }, "cloudProviderContainerId": { - "description": "", + "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 unique identifier of a person in the contacts address book.", + "description": "The id of a contact person in the account's address book.", "type": "string" }, "contactPhoneNumbers": { - "description": "", + "description": "A list of the contact's phone numbers.", "type": "array", "items": { "$ref": "#/definitions/contactPhoneNumber" } }, "contactUri": { - "description": "", + "description": "The URI for retrieving information about the contact.", "type": "string" }, "emails": { @@ -27353,7 +29061,7 @@ "type": "string" }, "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" } }, @@ -27365,14 +29073,14 @@ "type": "object", "properties": { "contacts": { - "description": "", + "description": "A list of contacts.", "type": "array", "items": { "$ref": "#/definitions/Contacts" } }, "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "nextUri": { @@ -27384,27 +29092,27 @@ "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" } }, "x-ds-definition-name": "contactGetResponse", - "description": "", - "x-ms-summary": "" + "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." }, "contactModRequest": { "type": "object", "properties": { "contactList": { - "description": "", + "description": "A list of contacts.", "type": "array", "items": { "$ref": "#/definitions/Contacts" @@ -27412,30 +29120,30 @@ } }, "x-ds-definition-name": "contactModRequest", - "description": "", - "x-ms-summary": "" + "description": "The request object containing the new information for the contacts.", + "x-ms-summary": "The request object containing the new information for the contacts." }, "contactPhoneNumber": { "type": "object", "properties": { "phoneNumber": { - "description": "", + "description": "The contact's phone number.\n\nExample: `+12223334444`", "type": "string" }, "phoneType": { - "description": "", + "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": "contactPhoneNumber", - "description": "", - "x-ms-summary": "" + "description": "Details about the phone numbers associated with a specific contact.", + "x-ms-summary": "Details about the phone numbers associated with a specific contact." }, "contactUpdateResponse": { "type": "object", "properties": { "contacts": { - "description": "", + "description": "A list of contacts.", "type": "array", "items": { "$ref": "#/definitions/Contacts" @@ -27443,14 +29151,14 @@ } }, "x-ds-definition-name": "contactUpdateResponse", - "description": "", - "x-ms-summary": "" + "description": "This response objects shows the updated details for the contacts.", + "x-ms-summary": "This response objects shows the updated details for the contacts." }, "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. ", + "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" }, "suppressNavigation": { @@ -27459,8 +29167,8 @@ } }, "x-ds-definition-name": "correctViewRequest", - "description": "", - "x-ms-summary": "" + "description": "The request body for the EnvelopeViews::createCorrect method.", + "x-ms-summary": "The request body for the EnvelopeViews::createCorrect method." }, "country": { "type": "object", @@ -27489,26 +29197,6 @@ "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.", - "type": "string" - }, - "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", - "type": "string" - }, - "value": { - "description": "Specifies the value of the tab. ", - "type": "string" - } - }, - "x-ds-definition-name": "credential", - "description": "", - "x-ms-summary": "" - }, "creditCardInformation": { "type": "object", "properties": { @@ -27600,7 +29288,7 @@ "type": "string" }, "perSeatPrice": { - "description": "", + "description": "The per-seat price associated with the plan.\n\nExample: `\"456.0000\"`", "type": "string" }, "supportedCardTypes": { @@ -27608,11 +29296,11 @@ "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)." }, "supportIncidentFee": { - "description": "The support incident fee charged for each support incident.", + "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.", + "description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`", "type": "string" } }, @@ -27624,7 +29312,7 @@ "type": "object", "properties": { "customFieldType": { - "description": "", + "description": "The type of custom field. Valid values are:\n\n- `text` (default)\n- `list`", "type": "string" }, "errorDetails": { @@ -27632,36 +29320,36 @@ "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" }, "listItems": { - "description": "An array of strings that represent the items in a list.", + "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": { "type": "string" } }, "name": { - "description": "", + "description": "The name of the custom field.", "type": "string" }, "required": { - "description": "When set to **true**, the signer is required to fill out this tab.", + "description": "When set to **true**, the signer must complete the custom field.", "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 custom field displays at the top of the certificate of completion.", "type": "string" }, "value": { - "description": "Specifies the value of the tab. ", + "description": "Specifies the value of the custom field. \n\nMaximum Length: 2,000 characters.", "type": "string" } }, "x-ds-definition-name": "customField", - "description": "", - "x-ms-summary": "" + "description": "This object provides details about a custom field.", + "x-ms-summary": "This object provides details about a custom field." }, "customFields": { "description": "", @@ -27726,20 +29414,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -27750,12 +29438,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -27782,7 +29470,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -27790,7 +29478,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -27806,7 +29494,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": { @@ -27945,6 +29633,10 @@ "$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" @@ -28053,7 +29745,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": { @@ -28165,20 +29857,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -28189,12 +29881,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -28221,7 +29913,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -28229,7 +29921,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -28352,6 +30044,10 @@ "$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" @@ -28412,7 +30108,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": { @@ -28532,20 +30228,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +30252,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -28588,7 +30284,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -28596,7 +30292,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -28735,6 +30431,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.\nFor supplemental documents, this value must be `1`.", "type": "string" @@ -28787,7 +30487,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": { @@ -28895,39 +30595,39 @@ "type": "object", "properties": { "bankBranchCode": { - "description": "", + "description": "The code for the branch of the customer's bank.", "type": "string" }, "bankCheckDigit": { - "description": "", + "description": "One or two digits that are used to formally validate a domestic bank account.", "type": "string" }, "bankCode": { - "description": "", + "description": "The code for the customer's bank.\n\nExample: `200000`", "type": "string" }, "bankName": { - "description": "", + "description": "A free text field for the name of the customer's bank.\n\nExample: `Bank of America`", "type": "string" }, "bankTransferAccountName": { - "description": "", + "description": "The name of the account to which you are transferring the payment.", "type": "string" }, "bankTransferAccountNumber": { - "description": "", + "description": "The bank account number for the account to which you are transferring the payment.", "type": "string" }, "bankTransferType": { - "description": "", + "description": "The type of bank transfer. Valid values are:\n\n- `American Express`\n- `MasterCard`\n- `Visa`\n- `PayPal`\n- `SEPA`: This type of direct debit is only available to countries using the EUR currency under SEPA network.\n- `BACS`: This type of direct debit is only available in the United Kingdom using GBP.\n- `BECS`: This type of direct debit is only available in Australia using AUD. Note: This method is currently unavailable in New Zealand.", "type": "string" }, "country": { - "description": "Specifies the country associated with the address.", + "description": "The country in which the bank is located.", "type": "string" }, "email": { - "description": "Filters returned user records by the specified email address.", + "description": "The user's email address.", "type": "string" }, "firstName": { @@ -28935,15 +30635,442 @@ "type": "string" }, "iBAN": { - "description": "", + "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).", "type": "string" }, "lastName": { - "description": "", + "description": "The user's last name.", "type": "string" } }, "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." + }, + "displayApplianceDocument": { + "type": "object", + "properties": { + "attachmentDescription": { + "description": "", + "type": "string" + }, + "documentId": { + "description": "Integer that identifies the document in the envelope.", + "type": "string" + }, + "documentType": { + "description": "", + "type": "string" + }, + "envelopeId": { + "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "type": "string" + }, + "externalDocumentId": { + "description": "", + "type": "string" + }, + "latestPDFId": { + "description": "", + "type": "string" + }, + "name": { + "description": "", + "type": "string" + }, + "pages": { + "format": "int32", + "description": "An array of page objects.", + "type": "integer" + } + }, + "x-ds-definition-name": "displayApplianceDocument", + "description": "", + "x-ms-summary": "" + }, + "displayApplianceDocumentPage": { + "type": "object", + "properties": { + "docPageCountTotal": { + "format": "int32", + "description": "", + "type": "integer" + }, + "documentId": { + "description": "Integer that identifies the document in the envelope.", + "type": "string" + }, + "documentName": { + "description": "", + "type": "string" + }, + "extension": { + "description": "", + "type": "string" + }, + "height72DPI": { + "format": "int32", + "description": "", + "type": "integer" + }, + "isAttachmentType": { + "description": "", + "type": "boolean" + }, + "page": { + "format": "int32", + "description": "", + "type": "integer" + }, + "pageId": { + "description": "The unique id of the page.", + "type": "string" + }, + "type": { + "description": "", + "type": "string" + }, + "width72DPI": { + "format": "int32", + "description": "", + "type": "integer" + } + }, + "x-ds-definition-name": "displayApplianceDocumentPage", + "description": "", + "x-ms-summary": "" + }, + "displayApplianceEnvelope": { + "type": "object", + "properties": { + "addDemoStamp": { + "description": "", + "type": "boolean" + }, + "allowMultipleAttachments": { + "description": "", + "type": "boolean" + }, + "burnDefaultTabData": { + "description": "", + "type": "boolean" + }, + "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": "boolean" + }, + "envelopeId": { + "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "type": "string" + }, + "envelopeType": { + "description": "", + "type": "string" + }, + "includeSigsBeforeComplete": { + "description": "", + "type": "boolean" + }, + "isConcatMode": { + "description": "", + "type": "boolean" + }, + "isEnvelopeIDStampingEnabled": { + "description": "", + "type": "boolean" + }, + "pdfFormConversionFontScale100": { + "description": "", + "type": "boolean" + }, + "shouldFlatten": { + "description": "", + "type": "boolean" + }, + "showEnvelopeChanges": { + "description": "", + "type": "boolean" + }, + "signOnline": { + "description": "", + "type": "boolean" + }, + "status": { + "description": "The status of the item.", + "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": "displayApplianceEnvelope", + "description": "", + "x-ms-summary": "" + }, + "displayApplianceInfo": { + "type": "object", + "properties": { + "documentData": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/displayApplianceDocument" + } + }, + "documentPages": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/displayApplianceDocumentPage" + } + }, + "envelopeData": { + "$ref": "#/definitions/displayApplianceEnvelope", + "description": "" + }, + "pageData": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/displayAppliancePage" + } + }, + "recipientData": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/displayApplianceRecipient" + } + } + }, + "x-ds-definition-name": "displayApplianceInfo", + "description": "", + "x-ms-summary": "" + }, + "displayAppliancePage": { + "type": "object", + "properties": { + "documentId": { + "description": "Integer that identifies the document in the envelope.", + "type": "string" + }, + "documentName": { + "description": "", + "type": "string" + }, + "externalDocumentId": { + "description": "", + "type": "string" + }, + "height": { + "format": "int32", + "description": "The height of the tab in pixels.", + "type": "integer" + }, + "isFirstPage": { + "description": "", + "type": "boolean" + }, + "pageId": { + "description": "The unique id of the page.", + "type": "string" + }, + "pageNo": { + "format": "int32", + "description": "", + "type": "integer" + }, + "pageStatus": { + "description": "", + "type": "string" + }, + "pageType": { + "description": "", + "type": "string" + }, + "width": { + "format": "int32", + "description": "The width of the tab in pixels.", + "type": "integer" + } + }, + "x-ds-definition-name": "displayAppliancePage", + "description": "", + "x-ms-summary": "" + }, + "displayAppliancePdf": { + "type": "object", + "properties": { + "attachmentInfo": { + "$ref": "#/definitions/displayApplianceSignerAttachment", + "description": "" + }, + "docName": { + "description": "", + "type": "string" + }, + "documentId": { + "description": "Integer that identifies the document in the envelope.", + "type": "string" + }, + "latestPdf": { + "description": "", + "type": "string" + }, + "latestPDFId": { + "description": "", + "type": "string" + }, + "originalPdf": { + "description": "", + "type": "string" + }, + "originalPDFId": { + "description": "", + "type": "string" + }, + "pageCount": { + "format": "int32", + "description": "An integer value specifying the number of document pages in the template. ", + "type": "integer" + }, + "pdfType": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "displayAppliancePdf", + "description": "", + "x-ms-summary": "" + }, + "displayApplianceRecipient": { + "type": "object", + "properties": { + "cfrPart11": { + "description": "", + "type": "boolean" + }, + "company": { + "description": "The name of the user's company.", + "type": "string" + }, + "digitalSignatureBase64": { + "description": "", + "type": "string" + }, + "email": { + "description": "", + "type": "string" + }, + "fullName": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "initialsBase64": { + "description": "", + "type": "string" + }, + "inPersonEmail": { + "description": "", + "type": "string" + }, + "isNotary": { + "description": "", + "type": "boolean" + }, + "notarySealBase64": { + "description": "", + "type": "string" + }, + "phoneNumber": { + "description": "", + "type": "string" + }, + "recipientCompleteCount": { + "format": "int32", + "description": "", + "type": "integer" + }, + "recipientGuidId": { + "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`.", + "type": "string" + }, + "recipientStatus": { + "description": "", + "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" + }, + "rowState": { + "description": "", + "type": "string" + }, + "signatureBase64": { + "description": "", + "type": "string" + }, + "signed": { + "description": "", + "type": "boolean" + }, + "signerApplyTabs": { + "description": "", + "type": "boolean" + }, + "signerAttachmentBase64": { + "description": "", + "type": "string" + }, + "userName": { + "description": "The name of the user.", + "type": "string" + } + }, + "x-ds-definition-name": "displayApplianceRecipient", + "description": "", + "x-ms-summary": "" + }, + "displayApplianceSignerAttachment": { + "type": "object", + "properties": { + "attachmentDescription": { + "description": "", + "type": "string" + }, + "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" + }, + "documentId": { + "description": "Integer that identifies the document in the envelope.", + "type": "string" + }, + "envelopeId": { + "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "type": "string" + }, + "pageCount": { + "format": "int32", + "description": "An integer value specifying the number of document pages in the template. ", + "type": "integer" + }, + "pageId": { + "description": "The unique id of the page.", + "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`.", + "type": "string" + } + }, + "x-ds-definition-name": "displayApplianceSignerAttachment", "description": "", "x-ms-summary": "" }, @@ -28990,7 +31117,7 @@ } }, "documentGroup": { - "description": "The type of group the document belongs to (`certificate` or `content`).", + "description": "The type of group to which the document belongs. Valid values are: \n\n- `content`: This is the default value for non-certificate documents.\n- `certificate`: When a user makes a request to download a certificate of completion, the documents in the `certificate` document group are appended to the DocuSign certificate and the resulting PDF is returned. Documents returned with the DocuSign certificate are stamped or watermarked to indicate that they were not created by DocuSign. \n\n**Note**: A document may only be in a single document group.", "type": "string" }, "documentId": { @@ -29014,7 +31141,7 @@ "description": "" }, "includeInDownload": { - "description": "When set to **true**,\nthe document is included in the combined document download. \nThe default value is **true**.\n", + "description": "When set to **true**,\nthe document is included in the combined document download (`documentsCombinedUri`). \nThe default value is **true**.\n", "type": "string" }, "matchBoxes": { @@ -29065,7 +31192,7 @@ }, "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. ", @@ -29080,7 +31207,7 @@ "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" } }, @@ -29155,11 +31282,11 @@ "type": "object", "properties": { "displayAnchorPrefix": { - "description": "", + "description": "Contains text that all display anchors must start with. Using at least 4 characters will improve anchor processing performance.", "type": "string" }, "displayAnchors": { - "description": "", + "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" @@ -29174,7 +31301,7 @@ "type": "string" }, "documentGuid": { - "description": "", + "description": "The GUID of the document.", "type": "string" }, "documentId": { @@ -29182,29 +31309,29 @@ "type": "string" }, "headerLabel": { - "description": "", + "description": "Header text or an HTML tag to place above the responsive HTML block.", "type": "string" }, "maxScreenWidth": { - "description": "", + "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" }, "removeEmptyTags": { - "description": "", + "description": "Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).", "type": "string" }, "showMobileOptimizedToggle": { - "description": "", + "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" }, "source": { - "description": "", + "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": "documentHtmlDefinition", - "description": "", - "x-ms-summary": "" + "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." }, "documentHtmlDefinitionOriginal": { "type": "object", @@ -29214,7 +31341,7 @@ "type": "string" }, "documentIdGuid": { - "description": "The Guid of the document.", + "description": "The GUID of the document.", "type": "string" }, "htmlDefinition": { @@ -29230,7 +31357,7 @@ "type": "object", "properties": { "htmlDefinitions": { - "description": "", + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { "$ref": "#/definitions/documentHtmlDefinitionOriginal" @@ -29245,7 +31372,7 @@ "type": "object", "properties": { "htmlDefinitions": { - "description": "", + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { "type": "string" @@ -29260,7 +31387,7 @@ "type": "object", "properties": { "caseSensitive": { - "description": "", + "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" }, "displaySettings": { @@ -29342,35 +31469,6 @@ "description": "", "x-ms-summary": "" }, - "documentSecurityStore": { - "type": "object", - "properties": { - "certificates": { - "description": "", - "type": "array", - "items": { - "type": "string" - } - }, - "crls": { - "description": "", - "type": "array", - "items": { - "type": "string" - } - }, - "ocsps": { - "description": "", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ds-definition-name": "documentSecurityStore", - "description": "", - "x-ms-summary": "" - }, "documentTemplate": { "type": "object", "properties": { @@ -29414,45 +31512,6 @@ "description": "", "x-ms-summary": "" }, - "documentUpdateInfo": { - "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" - }, - "documentSecurityStore": { - "$ref": "#/definitions/documentSecurityStore", - "description": "" - }, - "name": { - "description": "", - "type": "string" - }, - "returnFormat": { - "description": "", - "type": "string" - }, - "signatureDataInfos": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/signatureDataInfo" - } - }, - "timeStampField": { - "$ref": "#/definitions/timeStampField", - "description": "" - } - }, - "x-ds-definition-name": "documentUpdateInfo", - "description": "", - "x-ms-summary": "" - }, "documentVisibility": { "type": "object", "properties": { @@ -29505,10 +31564,10 @@ }, "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." }, "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 Access Code on the recipient.", "type": "string" }, "clientUserId": { @@ -29520,7 +31579,7 @@ "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": "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.", "type": "array", "items": { "type": "string" @@ -29544,29 +31603,29 @@ }, "deliveryMethodMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `deliveryMethod` property is editable.\n" + "description": "Reserved for DocuSign." }, "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": "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ", + "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" }, "emailMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the email id of the recipient." + "description": "Metadata that indicates whether the `email` 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. " + "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": { @@ -29579,7 +31638,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. \n\nMaximum Length: 50 characters.", @@ -29587,7 +31646,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." }, "fullName": { "description": "Reserved for DocuSign.", @@ -29603,7 +31662,7 @@ }, "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." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", @@ -29619,7 +31678,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." }, "lockedRecipientPhoneAuthEditable": { "description": "Reserved for DocuSign.", @@ -29630,12 +31689,12 @@ "type": "string" }, "name": { - "description": "The full legal name of the recipient. Maximum Length: 100 characters.", + "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." }, "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", @@ -29643,11 +31702,11 @@ }, "noteMetadata": { "$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 `note` 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." + "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`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n" }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -29668,7 +31727,7 @@ } }, "recipientId": { - "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document.", "type": "string" }, "recipientIdGuid": { @@ -29676,12 +31735,12 @@ "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." }, "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. ", @@ -29689,10 +31748,10 @@ }, "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." }, "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": { @@ -29701,10 +31760,10 @@ }, "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." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "type": "string" }, "signedDateTime": { @@ -29712,15 +31771,15 @@ "type": "string" }, "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "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" }, "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." }, "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": { @@ -29735,18 +31794,22 @@ "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.", + "description": "Deprecated.", "type": "array", "items": { "$ref": "#/definitions/socialAuthentication" } }, "status": { - "description": "Recipient status.\n\n", + "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" }, "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" }, "templateLocked": { @@ -29767,27 +31830,27 @@ } }, "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." + "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." }, "email": { "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +31861,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -29830,7 +31893,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -29838,7 +31901,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -29854,7 +31917,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": { @@ -29993,6 +32056,10 @@ "$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" @@ -30101,7 +32168,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": { @@ -30213,20 +32280,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +32304,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -30269,7 +32336,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -30277,7 +32344,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -30400,6 +32467,10 @@ "$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" @@ -30460,7 +32531,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": { @@ -30579,15 +32650,15 @@ "type": "object", "properties": { "connectConfigured": { - "description": "", + "description": "When **false**, the user must configure Connect and eOriginal for the integration to work.", "type": "string" }, "eNoteConfigured": { - "description": "", + "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": "", + "description": "The name of the organization.", "type": "string" }, "password": { @@ -30595,13 +32666,13 @@ "type": "string" }, "userName": { - "description": "The name of the user.", + "description": "The user's username.", "type": "string" } }, "x-ds-definition-name": "eNoteConfiguration", - "description": "", - "x-ms-summary": "" + "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." }, "envelope": { "type": "object", @@ -30615,7 +32686,7 @@ "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": { @@ -30631,7 +32702,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 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 by using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.", "type": "string" }, "attachmentsUri": { @@ -30639,7 +32710,7 @@ "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": { @@ -30647,7 +32718,7 @@ "type": "string" }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When **true**, autonavigation is set for the recipient.\n", "type": "string" }, "brandId": { @@ -30655,11 +32726,11 @@ "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": { @@ -30667,15 +32738,15 @@ "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": { @@ -30683,7 +32754,7 @@ "type": "string" }, "deletedDateTime": { - "description": "Specifies the data and time the item was deleted.", + "description": "Reserved for DocuSign.", "type": "string" }, "deliveredDateTime": { @@ -30695,11 +32766,11 @@ "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.", + "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": { @@ -30741,7 +32812,7 @@ "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": { @@ -30753,7 +32824,7 @@ "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": { @@ -30773,7 +32844,7 @@ "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" @@ -30812,7 +32883,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" }, "location": { @@ -30832,12 +32903,12 @@ "description": "" }, "notificationUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the notifications.", + "description": "The URI for retrieving notifications.", "type": "string" }, "powerForm": { "$ref": "#/definitions/PowerForms", - "description": "Contains information about any PowerForms that are included in the envelope." + "description": "Information about any PowerForms that are included in the envelope." }, "purgeCompletedDate": { "description": "The date that a purge was completed.", @@ -30868,11 +32939,11 @@ "description": "Information about the sender of the envelope." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "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": { @@ -30884,7 +32955,7 @@ "type": "string" }, "statusChangedDateTime": { - "description": "The data and time the status changed.", + "description": "The data and time that the status changed.", "type": "string" }, "statusDateTime": { @@ -30892,7 +32963,7 @@ "type": "string" }, "templatesUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the templates.", + "description": "The URI for retrieving the templates.", "type": "string" }, "transactionId": { @@ -31020,11 +33091,11 @@ "type": "string" }, "allowComments": { - "description": "When **true**, indicates that comments are allowed on the envelope.", + "description": "When **true**, 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": { @@ -31036,7 +33107,7 @@ "type": "string" }, "allowViewHistory": { - "description": "Specifies if users can view the history of the envelope.", + "description": "When **true**, users can view the history of the envelope.", "type": "string" }, "anySigner": { @@ -31044,22 +33115,22 @@ "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 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 by using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.", "type": "string" }, "attachments": { - "description": "", + "description": "An array of attachment objects containing details about any envelope attachments.", "type": "array", "items": { "$ref": "#/definitions/attachment" } }, "attachmentsUri": { - "description": "The URI for retrieving information about the attachments associated with the envelope.", + "description": "The URI for retrieving the envelope attachments.", "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": { @@ -31067,23 +33138,23 @@ "type": "string" }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When **true**, autonavigation is set for the recipient.\n", "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.", + "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" }, "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.", + "description": "The date and time that the envelope was completed.", "type": "string" }, "compositeTemplates": { @@ -31094,23 +33165,23 @@ } }, "createdDateTime": { - "description": "The date and time the item was created.", + "description": "The date and time that the envelope 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 that the recipient declined the envelope.", "type": "string" }, "deletedDateTime": { - "description": "Specifies the data and time the item was deleted.", + "description": "The date and time that the envelope was deleted.", "type": "string" }, "deliveredDateTime": { @@ -31118,31 +33189,31 @@ "type": "string" }, "disableResponsiveDocument": { - "description": "When **true**, indicates that the responsive document feature has been turned off for the envelope.", + "description": "When set to **true**, the responsive document feature is turned off for the envelope.", "type": "string" }, "documents": { - "description": "Complex element contains the details on the documents in the envelope.", + "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": "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", + "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" }, "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." + "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." }, "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", @@ -31171,11 +33242,11 @@ } }, "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", + "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.", + "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": { @@ -31187,7 +33258,7 @@ "description": "Metadata about the features that are enabled for the envelope." }, "envelopeUri": { - "description": "URI that you can use to retrieve the bulk envelopes.", + "description": "The URI for retrieving the envelope or envelopes.", "type": "string" }, "eventNotification": { @@ -31195,7 +33266,7 @@ "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.", + "description": "An array of `eventNotification` objects.", "type": "array", "items": { "$ref": "#/definitions/eventNotification" @@ -31218,7 +33289,7 @@ "type": "string" }, "folders": { - "description": "An array of the folders in which the envelope is included.", + "description": "An array of folders that the envelope belongs to.", "type": "array", "items": { "$ref": "#/definitions/folder" @@ -31233,7 +33304,7 @@ "type": "string" }, "hasWavFile": { - "description": "When **true**, indicates that a wave file (voice recording) is part of the envelope.", + "description": "When set to **true**, indicates that a wave file (voice recording) is part of the envelope.", "type": "string" }, "holder": { @@ -31241,7 +33312,7 @@ "type": "string" }, "initialSentDateTime": { - "description": "The date and time that the envelope was initially sent.", + "description": "The date and time that the envelope was first sent.", "type": "string" }, "is21CFRPart11": { @@ -31257,7 +33328,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" }, "location": { @@ -31277,7 +33348,7 @@ "description": "An optional complex element that specifies the notification options for the envelope." }, "notificationUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the notifications.", + "description": "The URI for retrieving notifications.", "type": "string" }, "password": { @@ -31286,7 +33357,7 @@ }, "powerForm": { "$ref": "#/definitions/PowerForms", - "description": "Contains information about any PowerForms that are included in the envelope." + "description": "Information about any PowerForms that are included in the envelope." }, "purgeCompletedDate": { "description": "The date that a purge was completed.", @@ -31297,7 +33368,7 @@ "type": "string" }, "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", + "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" }, "recipients": { @@ -31317,11 +33388,11 @@ "description": "Information about the sender of the envelope." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "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": { @@ -31329,11 +33400,11 @@ "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.", + "description": "Indicates the envelope status. Valid values are:\n\n* `sent`: The envelope has been sent to the recipients. \n* `created`: The envelope is saved as a draft and can be modified and sent later.", "type": "string" }, "statusChangedDateTime": { - "description": "The data and time the status changed.", + "description": "The data and time that the status changed.", "type": "string" }, "statusDateTime": { @@ -31341,22 +33412,22 @@ "type": "string" }, "templateId": { - "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. ", + "description": "The id of the template. If a value is not provided, DocuSign generates a value. ", "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", + "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" } }, "templatesUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the templates.", + "description": "The URI for retrieving any templates associated with the envelope.", "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.", + "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" }, "useDisclosure": { @@ -31380,7 +33451,7 @@ "type": "object", "properties": { "addedRecipientIds": { - "description": "If recipients were added by converting form fields into tabs, their ids will appear here. Read only.", + "description": "If recipients were added by converting form fields into tabs, their ids appear here. Read only.", "type": "array", "items": { "type": "string" @@ -31391,7 +33462,7 @@ "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" }, "authoritativeCopyMetadata": { @@ -31418,30 +33489,30 @@ "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.", + "description": "An object containing information about the custom fields on the document.", "type": "array", "items": { "$ref": "#/definitions/nameValue" } }, "documentGroup": { - "description": "The type of group the document belongs to (`certificate` or `content`).", + "description": "The type of group to which the document belongs. Valid values are: \n\n- `content`: This is the default value for non-certificate documents.\n- `certificate`: When a user makes a request to download a certificate of completion, the documents in the `certificate` document group are appended to the DocuSign certificate and the resulting PDF is returned. Documents returned with the DocuSign certificate are stamped or watermarked to indicate that they were not created by DocuSign. \n\n**Note**: A document may only be in a single document group.", "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.", + "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" }, "documentIdGuid": { - "description": "The Guid of the document.", + "description": "The GUID of the document.", "type": "string" }, "errorDetails": { "$ref": "#/definitions/errorDetails", - "description": "If an error occurs, this property describes the error." + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "includeInDownload": { - "description": "When set to **true**,\nthe document is included in the combined document download. \nThe default value is **true**.\n", + "description": "When set to **true**,\nthe document is included in the combined document download (`documentsCombinedUri`). \nThe default value is **true**.\n", "type": "string" }, "includeInDownloadMetadata": { @@ -31449,7 +33520,7 @@ "description": "Metadata that indicates if the sender can edit the `includeInDowload` property. Not applicable for template documents." }, "name": { - "description": "The name of the document.", + "description": "The document's file name. \n\nExample: `Q1-Report.docx`", "type": "string" }, "nameMetadata": { @@ -31461,7 +33532,7 @@ "type": "string" }, "pages": { - "description": "An array of page objects that contain information about the pages in a document.", + "description": "An array of page objects that contain information about the pages in the document.", "type": "array", "items": { "$ref": "#/definitions/page" @@ -31484,17 +33555,17 @@ "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "description": "", "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "The URI for retrieving the document.", "type": "string" } }, "x-ds-definition-name": "envelopeDocument", - "description": "", - "x-ms-summary": "" + "description": "This object contains details about the envelope document.", + "x-ms-summary": "This object contains details about the envelope document." }, "envelopeDocumentsResult": { "type": "object", @@ -31557,7 +33628,7 @@ } }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "type": "string" }, "status": { @@ -31573,20 +33644,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +33668,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -31629,7 +33700,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -31637,7 +33708,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -31760,6 +33831,10 @@ "$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" @@ -31820,7 +33895,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": { @@ -31970,25 +34045,25 @@ "type": "object", "properties": { "purgeEnvelopes": { - "description": "", + "description": "When set to **true**, purging is enabled.", "type": "string" }, "redactPII": { - "description": "", + "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": "", + "description": "When set to **true**, the system also purges the tabs and attachments associated with the envelopes. ", "type": "string" }, "retentionDays": { - "description": "", + "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": "", - "x-ms-summary": "" + "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", @@ -31998,7 +34073,7 @@ "type": "string" }, "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "envelopes": { @@ -32016,7 +34091,7 @@ } }, "folders": { - "description": "A collection of folder objects returned in a response.", + "description": "A list of folder objects.", "type": "array", "items": { "$ref": "#/definitions/folder" @@ -32035,15 +34110,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" } }, @@ -32056,7 +34131,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.", @@ -32067,7 +34142,7 @@ "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", + "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" }, "statusDateTime": { @@ -32075,13 +34150,13 @@ "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" } }, "x-ds-definition-name": "envelopeSummary", - "description": "", - "x-ms-summary": "" + "description": " This object describes an envelope.", + "x-ms-summary": " This object describes an envelope." }, "envelopeTemplate": { "type": "object", @@ -32095,7 +34170,7 @@ "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": { @@ -32111,7 +34186,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 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 by using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.", "type": "string" }, "attachmentsUri": { @@ -32119,7 +34194,7 @@ "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": { @@ -32135,7 +34210,7 @@ "type": "string" }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When **true**, autonavigation is set for the recipient.\n", "type": "string" }, "brandId": { @@ -32143,11 +34218,11 @@ "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": { @@ -32159,15 +34234,15 @@ "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": { @@ -32175,7 +34250,7 @@ "type": "string" }, "deletedDateTime": { - "description": "Specifies the data and time the item was deleted.", + "description": "Reserved for DocuSign.", "type": "string" }, "deliveredDateTime": { @@ -32191,18 +34266,18 @@ "type": "string" }, "documents": { - "description": "Complex element contains the details on the documents in the envelope.", + "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": { @@ -32244,7 +34319,7 @@ "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": { @@ -32256,7 +34331,7 @@ "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": { @@ -32275,8 +34350,12 @@ "description": "May contain an external identifier for the envelope.", "type": "string" }, + "favoritedByMe": { + "description": "", + "type": "string" + }, "folderId": { - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "type": "string" }, "folderIds": { @@ -32291,7 +34370,7 @@ "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" @@ -32330,7 +34409,7 @@ "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" }, "lastModifiedBy": { @@ -32338,7 +34417,7 @@ "description": "" }, "lastModifiedDateTime": { - "description": "The date and time the item was last modified.", + "description": "The date and time that the item was last modified.", "type": "string" }, "lastUsed": { @@ -32370,7 +34449,7 @@ "description": "" }, "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": { @@ -32391,7 +34470,7 @@ }, "powerForm": { "$ref": "#/definitions/PowerForms", - "description": "Contains information about any PowerForms that are included in the envelope." + "description": "Information about any PowerForms that are included in the envelope." }, "powerForms": { "description": "An array of PowerForm objects.", @@ -32429,7 +34508,7 @@ "description": "Information about the sender of the envelope." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "type": "string" }, "shared": { @@ -32441,7 +34520,7 @@ "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": { @@ -32453,7 +34532,7 @@ "type": "string" }, "statusChangedDateTime": { - "description": "The data and time the status changed.", + "description": "The data and time that the status changed.", "type": "string" }, "statusDateTime": { @@ -32461,11 +34540,11 @@ "type": "string" }, "templateId": { - "description": "The ID of the template.", + "description": "The id of the template.", "type": "string" }, "templatesUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the templates.", + "description": "The URI for retrieving the templates.", "type": "string" }, "transactionId": { @@ -32473,7 +34552,7 @@ "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "useDisclosure": { @@ -32497,7 +34576,7 @@ "type": "object", "properties": { "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "envelopeTemplates": { @@ -32508,7 +34587,7 @@ } }, "folders": { - "description": "A collection of folder objects returned in a response.", + "description": "A list of folder objects.", "type": "array", "items": { "$ref": "#/definitions/folder" @@ -32523,15 +34602,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" } }, @@ -32567,59 +34646,59 @@ "type": "object", "properties": { "carbonCopyOriginalOwner": { - "description": "", + "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" }, "enabled": { - "description": "", + "description": "When set to **true**, the envelope transfer rule is active.", "type": "string" }, "envelopeTransferRuleId": { - "description": "", + "description": "The id of the envelope transfer rule. The system generates this id when the rule is first created.", "type": "string" }, "eventType": { - "description": "", + "description": "The type of envelope event that triggers the transfer. Valid values are:\n\n- `sent`\n- `before sent` \n- `completed`", "type": "string" }, "fromGroup": { "$ref": "#/definitions/group", - "description": "" + "description": "Information about the group that triggers the transfer." }, "fromUser": { "$ref": "#/definitions/Users", - "description": "" + "description": "Information about the user who triggers the transfer." }, "modifiedDate": { - "description": "Most recent date on which this user record was modified.", + "description": "The UTC DateTime when the envelope transfer rule was last modified. This property is read only.", "type": "string" }, "modifiedUser": { "$ref": "#/definitions/Users", - "description": "" + "description": "Information about the user who last modified the envelope transfer rule." }, "toFolder": { "$ref": "#/definitions/folder", - "description": "" + "description": "Information about the destination folder to which the envelope is transferred." }, "toUser": { "$ref": "#/definitions/Users", - "description": "" + "description": "Information about the user to which the envelope is transferred." } }, "x-ds-definition-name": "envelopeTransferRule", - "description": "", - "x-ms-summary": "" + "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 position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "envelopeTransferRules": { - "description": "", + "description": "Contains information about a specific envelope transfer rule.", "type": "array", "items": { "$ref": "#/definitions/envelopeTransferRule" @@ -32634,15 +34713,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" } }, @@ -32654,62 +34733,62 @@ "type": "object", "properties": { "carbonCopyOriginalOwner": { - "description": "", + "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" }, "enabled": { - "description": "", + "description": "When set to **true**, the envelope transfer rule is active.", "type": "string" }, "envelopeTransferRuleId": { - "description": "", + "description": "The id of the envelope transfer rule. The system generates this id when the rule is first created.", "type": "string" }, "eventType": { - "description": "", + "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": "", + "description": "Information about the group that triggers the transfer.", "type": "array", "items": { "$ref": "#/definitions/group" } }, "fromUsers": { - "description": "", + "description": "Information about the user who triggers the transfer.", "type": "array", "items": { "$ref": "#/definitions/Users" } }, "modifiedDate": { - "description": "Most recent date on which this user record was modified.", + "description": "The UTC DateTime when the envelope transfer rule was last modified. This property is read only.", "type": "string" }, "modifiedUser": { "$ref": "#/definitions/Users", - "description": "" + "description": "Information about the user who last modified the envelope transfer rule." }, "toFolder": { "$ref": "#/definitions/folder", - "description": "" + "description": "Information about the destination folder to which the envelope is transferred." }, "toUser": { "$ref": "#/definitions/Users", - "description": "" + "description": "Information about the user to which the envelope is transferred." } }, "x-ds-definition-name": "envelopeTransferRuleRequest", - "description": "", - "x-ms-summary": "" + "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." }, "envelopeUpdateSummary": { "type": "object", "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.", @@ -32804,6 +34883,10 @@ "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" }, + "includeHMAC": { + "description": "", + "type": "string" + }, "includeSenderAccountAsCustomField": { "description": "When set to **true**, Connect will include the sender account as Custom Field in the data.", "type": "string" @@ -32895,19 +34978,19 @@ "type": "object", "properties": { "acquiredTime": { - "description": "", + "description": "The UNIX epoch time at which the claim was acquired from the external provider.", "type": "string" }, "claimName": { - "description": "", + "description": "The name of the external claim being requested.", "type": "string" }, "provider": { - "description": "The social account provider (Facebook, Yahoo, etc.)", + "description": "The claim provider's client ID from which the claim is being requested.", "type": "string" }, "value": { - "description": "Specifies the value of the tab. ", + "description": "The value provided for the external claim.", "type": "string" } }, @@ -32987,47 +35070,47 @@ "type": "object", "properties": { "date": { - "description": "", + "description": "The UTC date and time that the file or folder was last modified.", "type": "string" }, "id": { - "description": "A unique ID for the Salesforce object.", + "description": "The storage provider's id for the file or folder.", "type": "string" }, "img": { - "description": "", + "description": "The file extension for a file.\n\n**Note**: If the item is a folder, this value is null.", "type": "string" }, "name": { - "description": "", + "description": "The full name of a file.", "type": "string" }, "size": { - "description": "Reserved: TBD", + "description": "The size of the file. The file size limit varies based on the cloud storage provider.", "type": "string" }, "supported": { - "description": "", + "description": "When set to **true**, DocuSign supports the file type for upload.", "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "description": "The type of cloud storage item. Valid values are:\n\n- `file`\n- `folder`", "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "The URI for the file or folder.", "type": "string" } }, "x-ds-definition-name": "externalFile", - "description": "", - "x-ms-summary": "" + "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 position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "errorDetails": { @@ -33058,15 +35141,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" } }, @@ -33074,6 +35157,50 @@ "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." + }, + "favoritedDate": { + "description": "", + "type": "string" + }, + "templateId": { + "description": "The id of the template.", + "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." + }, + "favoriteTemplates": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/favoriteTemplatesContentItem" + } + }, + "templatesUpdatedCount": { + "format": "int32", + "description": "", + "type": "integer" + } + }, + "x-ds-definition-name": "favoriteTemplatesInfo", + "description": "", + "x-ms-summary": "" + }, "featureAvailableMetadata": { "type": "object", "properties": { @@ -33121,7 +35248,7 @@ "type": "string" }, "isEnabled": { - "description": "Reserved for DocuSign.", + "description": "When set to **true**, the feature set is actively enabled as part of the plan.", "type": "string" }, "name": { @@ -33172,23 +35299,23 @@ "type": "object", "properties": { "actionRequired": { - "description": "Action required.", + "description": "When set to **true**, the current user needs to take action on the item.", "type": "string" }, "expires": { - "description": "", + "description": "The number of days a sent envelope remains active before it expires.", "type": "string" }, "folderIds": { - "description": "", + "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" }, "fromDateTime": { - "description": "", + "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" }, "isTemplate": { - "description": "", + "description": "When set to **true**, the item is a template.", "type": "string" }, "order": { @@ -33196,48 +35323,48 @@ "type": "string" }, "orderBy": { - "description": "", + "description": "The field used to sort the results.\n\nExample: `Created`", "type": "string" }, "searchTarget": { - "description": "", + "description": "Reserved for DocuSign.", "type": "string" }, "searchText": { - "description": "", + "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": "Filter 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": "Latest date to filter.", + "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": "filter", - "description": "", - "x-ms-summary": "" + "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." }, "firstName": { "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +35375,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -33280,7 +35407,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -33288,7 +35415,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -33411,6 +35538,10 @@ "$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" @@ -33471,7 +35602,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": { @@ -33572,88 +35703,88 @@ }, "filter": { "$ref": "#/definitions/filter", - "description": "" + "description": "An object used to present a filtered view of the items in a folder." }, "folderId": { - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "type": "string" }, "folderItems": { - "description": "A list of the envelopes in the specified folder or folders. ", + "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.", + "description": "A list of folder objects.", "type": "array", "items": { "$ref": "#/definitions/folder" } }, "hasAccess": { - "description": "", + "description": "When set to **true**, the current user has access to the folder.", "type": "string" }, "hasSubFolders": { - "description": "", + "description": "When set to **true**, the folder has subfolders.", "type": "string" }, "itemCount": { - "description": "", + "description": "The number of items in the folder.", "type": "string" }, "name": { - "description": "", + "description": "The name of the folder.", "type": "string" }, "owner": { "$ref": "#/definitions/userInfo", - "description": "" + "description": "Information about the user who owns the folder." }, "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" }, "subFolderCount": { - "description": "", + "description": "The number of subfolders.", "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "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": "URI containing the user ID.", + "description": "The URI for the folder.", "type": "string" } }, "x-ds-definition-name": "folder", - "description": "", - "x-ms-summary": "" + "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": "Specifies the date and time this item was completed.", + "description": "If the item is an envelope, this is the UTC DateTime when the envelope was completed.", "type": "string" }, "createdDateTime": { - "description": "The date and time the item was created.", + "description": "The UTC DateTime when the item was created.", "type": "string" }, "envelopeId": { - "description": "The envelope ID of the envelope status that failed to post.", + "description": "If the item is an envelope, this is the id of the envelope.", "type": "string" }, "envelopeUri": { - "description": "URI that you can use to retrieve the bulk envelopes.", + "description": "If the item is an envelope, this is the URI for retrieving it.", "type": "string" }, "expireDateTime": { @@ -33661,11 +35792,11 @@ "type": "string" }, "folderId": { - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "type": "string" }, "folderUri": { - "description": "", + "description": "If the item is a subfolder, this is the URI for retrieving it.", "type": "string" }, "is21CFRPart11": { @@ -33673,7 +35804,7 @@ "type": "string" }, "ownerName": { - "description": "", + "description": "The name of the user who owns the folder.", "type": "string" }, "recipients": { @@ -33685,23 +35816,23 @@ "type": "string" }, "senderCompany": { - "description": "", + "description": "The name of the sender's company.", "type": "string" }, "senderEmail": { - "description": "", + "description": "The sender's email address.", "type": "string" }, "senderName": { - "description": "", + "description": "The sender's name.", "type": "string" }, "senderUserId": { - "description": "", + "description": "The sender's id.", "type": "string" }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "type": "string" }, "status": { @@ -33709,15 +35840,15 @@ "type": "string" }, "subject": { - "description": "", + "description": "The subject of the envelope.", "type": "string" }, "templateId": { - "description": "The ID of the template.", + "description": "The id of the template.", "type": "string" }, "templateUri": { - "description": "", + "description": "The URI for retrieving the template.", "type": "string" } }, @@ -33729,7 +35860,7 @@ "type": "object", "properties": { "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "folderItems": { @@ -33748,11 +35879,11 @@ "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" }, "totalRows": { @@ -33768,7 +35899,7 @@ "type": "object", "properties": { "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "envelopes": { @@ -33779,7 +35910,7 @@ } }, "folders": { - "description": "A collection of folder objects returned in a response.", + "description": "A list of folder objects.", "type": "array", "items": { "$ref": "#/definitions/folder" @@ -33794,15 +35925,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" } }, @@ -33818,11 +35949,11 @@ "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "folderId": { - "description": "Unique identifier for the folder.", + "description": "The id of the folder.", "type": "string" }, "name": { - "description": "The folder name.", + "description": "The name of the folder.", "type": "string" }, "owner": { @@ -33830,33 +35961,33 @@ "description": "Information about the user who owns the folder." }, "parentFolderId": { - "description": "Unique identifier for the parent folder.", + "description": "The id of the parent folder.", "type": "string" }, "parentFolderUri": { - "description": "URI for the parent folder.", + "description": "The URI for the parent folder.", "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`", + "description": "Indicates how the folder is shared. Valid values are:\n\n- `not_shared`\n- `shared_to`", "type": "string" }, "sharedGroups": { - "description": "List of groups that share the folder.", + "description": "A list of groups that share the folder.", "type": "array", "items": { "$ref": "#/definitions/memberGroupSharedItem" } }, "sharedUsers": { - "description": "List of users that share the folder.", + "description": "A list of users that share the folder.", "type": "array", "items": { "$ref": "#/definitions/userSharedItem" } }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "user": { @@ -33879,14 +36010,14 @@ } }, "folders": { - "description": "A collection of folder objects returned in a response.", + "description": "A list of folder objects.", "type": "array", "items": { "$ref": "#/definitions/folder" } }, "fromFolderId": { - "description": " The folder ID the envelope is being moved from.", + "description": " The id of the folder that the envelope is being moved from.", "type": "string" } }, @@ -33898,7 +36029,7 @@ "type": "object", "properties": { "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "envelopes": { @@ -33909,7 +36040,7 @@ } }, "folders": { - "description": "A collection of folder objects returned in a response.", + "description": "A list of folder objects.", "type": "array", "items": { "$ref": "#/definitions/folder" @@ -33924,15 +36055,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" } }, @@ -34012,20 +36143,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -34036,12 +36167,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -34068,7 +36199,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -34076,7 +36207,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -34092,7 +36223,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": { @@ -34255,6 +36386,10 @@ "$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" @@ -34375,7 +36510,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": { @@ -34487,20 +36622,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +36646,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -34543,7 +36678,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -34551,7 +36686,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -34674,6 +36809,10 @@ "$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" @@ -34734,7 +36873,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": { @@ -34862,7 +37001,7 @@ "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" }, "permissionProfileId": { @@ -34882,14 +37021,14 @@ } }, "x-ds-definition-name": "group", - "description": "Information about groups.", - "x-ms-summary": "Information about groups." + "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 position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "groups": { @@ -34908,15 +37047,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" } }, @@ -34987,20 +37126,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -35011,12 +37150,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -35043,7 +37182,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -35051,7 +37190,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -35130,6 +37269,10 @@ "$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" @@ -35206,7 +37349,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": { @@ -35287,10 +37430,10 @@ "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." + "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." }, "documents": { - "description": "Complex element contains the details on the documents in the envelope.", + "description": "A complex element that contains details about the documents associated with the envelope.", "type": "array", "items": { "$ref": "#/definitions/document" @@ -35322,14 +37465,14 @@ }, "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." }, "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 Access Code on the recipient.", "type": "string" }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When **true**, autonavigation is set for the recipient.\n", "type": "string" }, "canSignOffline": { @@ -35345,11 +37488,11 @@ "type": "string" }, "creationReason": { - "description": "Payment status for payment services.", + "description": "The reason why the recipient was created (for example, `sender`). This property is only returned in responses.", "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": "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.", "type": "array", "items": { "type": "string" @@ -35377,10 +37520,10 @@ }, "deliveryMethodMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `deliveryMethod` property is editable.\n" + "description": "Reserved for DocuSign." }, "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" @@ -35392,14 +37535,14 @@ }, "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." }, "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": { @@ -35427,7 +37570,7 @@ }, "hostEmailMetadata": { "$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 `hostEmail` property is editable." }, "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", @@ -35435,7 +37578,7 @@ }, "hostNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `hostName` property is editable.\n" + "description": "Metadata that indicates whether the `hostName` 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.", @@ -35443,7 +37586,7 @@ }, "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." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", @@ -35454,12 +37597,12 @@ "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", + "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" }, "inPersonSigningTypeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `inPersonSigningType` property is editable.\n" + "description": "Metadata that indicates whether the `inPersonSigningType` property is editable." }, "lockedRecipientPhoneAuthEditable": { "description": "Reserved for DocuSign.", @@ -35470,12 +37613,12 @@ "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": "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" }, "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." }, "notaryHost": { "$ref": "#/definitions/notaryHost", @@ -35487,11 +37630,11 @@ }, "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." }, "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": "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`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n" }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -35505,14 +37648,14 @@ "description": "Information about the recipient's authentication status." }, "recipientFeatureMetadata": { - "description": "Metadata that indicates whether the `recipientFeature` property is editable.\n", + "description": "Metadata about the features that are supported for the recipient type.", "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.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document.", "type": "string" }, "recipientIdGuid": { @@ -35531,12 +37674,12 @@ "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." }, "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 +37687,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." }, "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 +37697,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,15 +37711,15 @@ }, "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." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "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.", @@ -35587,20 +37734,20 @@ "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.", + "description": "The signer's first name.", "type": "string" }, "signerFirstNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the first name of the in-person signer." + "description": "Metadata that indicates if the `signerFirstName` property is editable." }, "signerLastName": { - "description": "The last name of the in-person siger.", + "description": "The signer's last name.", "type": "string" }, "signerLastNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the last name of the in-person signer." + "description": "Metadata that indicates whether the `signerLastName` property is editable." }, "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", @@ -35608,7 +37755,7 @@ }, "signerNameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the in-person signer's full legal name." + "description": "Metadata that indicates whether the `signerName` property is editable." }, "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).", @@ -35616,22 +37763,22 @@ }, "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." }, "signingGroupId": { - "description": "The id of the signing group of which the in-person signer is a member.", + "description": "Not applicable. You cannot use a signing group for an in-person signer.", "type": "string" }, "signingGroupIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `signingGroupId` property is editable.\n" + "description": "Not applicable." }, "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "description": "Not applicable.", "type": "string" }, "signingGroupUsers": { - "description": "A complex type that contains information about users in the signing group.", + "description": "Not applicable.", "type": "array", "items": { "$ref": "#/definitions/userInfo" @@ -35642,23 +37789,27 @@ "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.", + "description": "Deprecated.", "type": "array", "items": { "$ref": "#/definitions/socialAuthentication" } }, "status": { - "description": "Recipient status.\n\n", + "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. ", @@ -35678,8 +37829,8 @@ } }, "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" + "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/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/esign-rest-api/reference/Envelopes/EnvelopeRecipients#in-person-signer-recipient\n" }, "integratedUserInfoList": { "type": "object", @@ -35689,7 +37840,7 @@ "type": "string" }, "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "nextUri": { @@ -35701,15 +37852,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": { @@ -35733,10 +37884,10 @@ }, "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." }, "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 Access Code on the recipient.", "type": "string" }, "clientUserId": { @@ -35748,7 +37899,7 @@ "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": "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.", "type": "array", "items": { "type": "string" @@ -35775,26 +37926,26 @@ "description": "Reserved for DocuSign." }, "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": "Email id of the recipient. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. ", + "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" }, "emailMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the email id of the recipient." + "description": "Metadata that indicates whether the `email` 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. " + "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": { @@ -35814,7 +37965,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.", @@ -35822,7 +37973,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." }, "fullName": { "description": "Reserved for DocuSign.", @@ -35838,7 +37989,7 @@ }, "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." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", @@ -35854,7 +38005,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." }, "lockedRecipientPhoneAuthEditable": { "description": "Reserved for DocuSign.", @@ -35865,12 +38016,12 @@ "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." }, "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", @@ -35878,11 +38029,11 @@ }, "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." }, "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": "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`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n" }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -35903,7 +38054,7 @@ } }, "recipientId": { - "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.", + "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document.", "type": "string" }, "recipientIdGuid": { @@ -35911,12 +38062,12 @@ "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." }, "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. ", @@ -35924,10 +38075,10 @@ }, "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." }, "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": { @@ -35936,10 +38087,10 @@ }, "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." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "type": "string" }, "signedDateTime": { @@ -35947,15 +38098,15 @@ "type": "string" }, "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "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" }, "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." }, "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": { @@ -35970,18 +38121,22 @@ "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.", + "description": "Deprecated.", "type": "array", "items": { "$ref": "#/definitions/socialAuthentication" } }, "status": { - "description": "Recipient status.\n\n", + "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" }, "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" }, "templateLocked": { @@ -36002,8 +38157,8 @@ } }, "x-ds-definition-name": "intermediary", - "description": "", - "x-ms-summary": "" + "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." }, "jurisdiction": { "type": "object", @@ -36057,20 +38212,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +38236,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -36113,7 +38268,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -36121,7 +38276,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -36244,6 +38399,10 @@ "$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" @@ -36304,7 +38463,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": { @@ -36400,20 +38559,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +38583,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -36456,7 +38615,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -36464,7 +38623,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -36610,6 +38769,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`.\n", "type": "string" @@ -36702,7 +38865,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": { @@ -36798,7 +38961,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 merge fields are being used, specifies the type of the merge field. The only supported value is `salesforce`.", "type": "string" }, "errorDetails": { @@ -36806,7 +38969,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" }, "listItems": { @@ -36817,15 +38980,15 @@ } }, "name": { - "description": "The name of the custom field.", + "description": "The name of the list custom field.", "type": "string" }, "required": { - "description": "When set to **true**, the signer is required to fill out this tab.", + "description": "When set to **true**, the signer is required to fill out the custom field.", "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 custom field displays at the top of the certificate of completion.", "type": "string" }, "value": { @@ -36834,8 +38997,8 @@ } }, "x-ds-definition-name": "listCustomField", - "description": "", - "x-ms-summary": "" + "description": "This object represents a custom field that accepts a list.", + "x-ms-summary": "This object represents a custom field that accepts a list." }, "listItem": { "type": "object", @@ -36906,7 +39069,7 @@ }, "currencyCodeMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata that indicates whether the `currencyCode` property is editable." }, "currencyNegativeFormat": { "description": "", @@ -37013,7 +39176,7 @@ "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", + "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": { @@ -37117,7 +39280,7 @@ "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": { @@ -37137,7 +39300,7 @@ "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" } }, @@ -37153,7 +39316,7 @@ "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" }, "lockType": { @@ -37161,17 +39324,17 @@ "type": "string" }, "templatePassword": { - "description": "", + "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": "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": "lockRequest", - "description": "", - "x-ms-summary": "" + "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." }, "loginAccount": { "type": "object", @@ -37348,7 +39511,7 @@ "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**.", + "description": "If merge fields are being used, specifies the type of the merge field. The only supported value is `salesforce`.", "type": "string" }, "configurationTypeMetadata": { @@ -37470,8 +39633,8 @@ } }, "x-ds-definition-name": "nameValue", - "description": "", - "x-ms-summary": "" + "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", @@ -37501,7 +39664,11 @@ "type": "string" }, "distributorPassword": { - "description": "The password for the distributorCode.", + "description": "The password for the `distributorCode`.", + "type": "string" + }, + "envelopePartitionId": { + "description": "Reserved for DocuSign.", "type": "string" }, "initialUser": { @@ -37526,7 +39693,7 @@ }, "socialAccountInformation": { "$ref": "#/definitions/UserSocialAccountLogins", - "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." } }, "x-ds-definition-name": "newAccountDefinition", @@ -37577,11 +39744,11 @@ "type": "string" }, "createdDateTime": { - "description": "The date and time the item was created.", + "description": "The UTC DateTime when the item was created.", "type": "string" }, "email": { - "description": "Filters returned user records by the specified email address.", + "description": "", "type": "string" }, "errorDetails": { @@ -37597,7 +39764,7 @@ "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "userId": { @@ -37651,20 +39818,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +39842,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -37707,7 +39874,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -37715,7 +39882,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -37802,6 +39969,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 being accessed.", "type": "string" @@ -37939,10 +40110,10 @@ }, "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." }, "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 Access Code on the recipient.", "type": "string" }, "clientUserId": { @@ -37954,7 +40125,7 @@ "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": "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.", "type": "array", "items": { "type": "string" @@ -37978,10 +40149,10 @@ }, "deliveryMethodMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates whether the `deliveryMethod` property is editable.\n" + "description": "Reserved for DocuSign." }, "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" @@ -37993,14 +40164,14 @@ }, "emailMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the notary's email address." + "description": "Metadata that indicates whether the `email` 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. " + "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": { @@ -38025,7 +40196,7 @@ }, "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." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", @@ -38049,7 +40220,7 @@ }, "nameMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the notary's full legal name." + "description": "Metadata that indicates whether the `name` property is editable." }, "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", @@ -38057,11 +40228,11 @@ }, "noteMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the note sent to the notary in the signing email." + "description": "Metadata that indicates whether the `note` 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." + "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`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n" }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -38090,12 +40261,12 @@ "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." }, "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. ", @@ -38103,10 +40274,10 @@ }, "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." }, "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": { @@ -38115,10 +40286,10 @@ }, "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." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "type": "string" }, "signedDateTime": { @@ -38126,15 +40297,15 @@ "type": "string" }, "signingGroupId": { - "description": "The ID of the signing group of which the notary is a member, if applicable.", + "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" }, "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." }, "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": { @@ -38149,23 +40320,27 @@ "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.", + "description": "Deprecated.", "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.", + "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. ", @@ -38244,7 +40419,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": { @@ -38263,15 +40438,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" } }, @@ -38310,20 +40485,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +40509,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -38366,7 +40541,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -38374,7 +40549,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -38497,6 +40672,10 @@ "$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" @@ -38565,7 +40744,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": { @@ -38682,11 +40861,11 @@ "properties": { "apiEmailNotifications": { "$ref": "#/definitions/notificationDefaultSettings", - "description": "" + "description": "The default notification settings for envelopes sent by using the console." }, "emailNotifications": { "$ref": "#/definitions/notificationDefaultSettings", - "description": "" + "description": "The default notification settings for envelopes sent by using the API." } }, "x-ds-definition-name": "notificationDefaults", @@ -38706,27 +40885,27 @@ } }, "x-ds-definition-name": "notificationDefaultSettings", - "description": "", - "x-ms-summary": "" + "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": { "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +40916,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -38769,7 +40948,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -38777,7 +40956,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -38793,7 +40972,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": { @@ -38948,6 +41127,10 @@ "$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" @@ -39056,7 +41239,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": { @@ -39224,7 +41407,7 @@ "type": "string" }, "pageId": { - "description": "The unique ID of the page.", + "description": "The id of the page.", "type": "string" }, "sequence": { @@ -39243,7 +41426,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": { @@ -39262,15 +41445,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" } }, @@ -39318,7 +41501,7 @@ "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "description": "", "type": "string" }, "typeName": { @@ -39345,12 +41528,24 @@ "type": "string" }, "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", + "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" }, "currencyCodeMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "" + "description": "Metadata that indicates whether the `currencyCode` property is editable." + }, + "customerId": { + "description": "The customer ID.", + "type": "string" + }, + "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" + }, + "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", @@ -39358,7 +41553,7 @@ }, "gatewayAccountIdMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "" + "description": "Metadata that indicates whether the `gatewayAccountId` property is editable." }, "gatewayDisplayName": { "description": "Display name of the gateway connected to sender's Docusign account.\n\nPossible values are: Stripe, Braintree, Authorize.Net.", @@ -39376,11 +41571,15 @@ } }, "paymentOption": { - "description": "", + "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" + }, + "paymentSourceId": { + "description": "The payment source ID.", "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", + "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" }, "total": { @@ -39395,24 +41594,28 @@ "paymentGatewayAccount": { "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" + }, "config": { "$ref": "#/definitions/paymentGatewayAccountSetting", - "description": "" + "description": "This property contains metadata about the payment gateway account's configuration such as the API key, `userId`, and `merchantId` details." }, "displayName": { - "description": "", + "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" }, "isEnabled": { - "description": "", + "description": "When **true**, the payment gateway account is enabled.", "type": "string" }, "isLegacy": { - "description": "", + "description": "Reserved for DocuSign.", "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 payment gateway account was last updated.", "type": "string" }, "paymentGateway": { @@ -39424,29 +41627,29 @@ "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", + "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" }, "payPalLegacySettings": { "$ref": "#/definitions/payPalLegacySettings", - "description": "" + "description": "Reserved for DocuSign." }, "supportedCurrencies": { - "description": "", + "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" } }, "supportedPaymentMethods": { - "description": "", + "description": "An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway.", "type": "array", "items": { "type": "string" } }, "supportedPaymentMethodsWithOptions": { - "description": "", + "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" @@ -39454,8 +41657,8 @@ } }, "x-ds-definition-name": "paymentGatewayAccount", - "description": "", - "x-ms-summary": "" + "description": "This object contains details about a payment gateway account.", + "x-ms-summary": "This object contains details about a payment gateway account." }, "paymentGatewayAccountSetting": { "type": "object", @@ -39524,20 +41727,20 @@ "type": "object", "properties": { "supportedOptions": { - "description": "", + "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" } }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "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": "", - "x-ms-summary": "" + "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", @@ -39551,7 +41754,7 @@ "type": "string" }, "email": { - "description": "Filters returned user records by the specified email address.", + "description": "", "type": "string" } }, @@ -39668,7 +41871,7 @@ } }, "planId": { - "description": "The DocuSign plan id for the account.", + "description": "DocuSign's id for the account plan.", "type": "string" }, "recipientDomains": { @@ -39710,20 +41913,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -39734,12 +41937,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -39766,7 +41969,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -39774,7 +41977,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -39865,6 +42068,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 use. The API currently supports only the `outline` overlay type.", "type": "string" @@ -39940,7 +42147,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": { @@ -40020,7 +42227,7 @@ "type": "string" }, "createdDateTime": { - "description": "The date and time the item was created.", + "description": "The UTC DateTime when the item was created.", "type": "string" }, "emailBody": { @@ -40090,11 +42297,11 @@ } }, "senderName": { - "description": "", + "description": "The sender's name.", "type": "string" }, "senderUserId": { - "description": "", + "description": "The id of the sender.", "type": "string" }, "signingMode": { @@ -40102,7 +42309,7 @@ "type": "string" }, "templateId": { - "description": "The ID of the template.", + "description": "The id of the template.", "type": "string" }, "templateName": { @@ -40114,7 +42321,7 @@ "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "usesRemaining": { @@ -40149,7 +42356,7 @@ "type": "object", "properties": { "email": { - "description": "Filters returned user records by the specified email address.", + "description": "", "type": "string" }, "formData": { @@ -40200,7 +42407,7 @@ "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.", + "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": { @@ -40208,7 +42415,7 @@ "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" }, "roleName": { @@ -40237,7 +42444,7 @@ "properties": { "endPosition": { "format": "int32", - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "integer" }, "nextUri": { @@ -40257,17 +42464,17 @@ }, "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`.", + "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 position of the current result set.", + "description": "The starting index 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`.", + "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" } }, @@ -40310,7 +42517,7 @@ "properties": { "endPosition": { "format": "int32", - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "integer" }, "nextUri": { @@ -40330,17 +42537,17 @@ }, "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`.", + "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 position of the current result set.", + "description": "The starting index 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`.", + "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" } }, @@ -40399,7 +42606,7 @@ "type": "string" }, "distributorPassword": { - "description": "The password for the distributorCode.", + "description": "The password for the `distributorCode`.", "type": "string" }, "passwordRuleText": { @@ -40467,20 +42674,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -40491,12 +42698,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -40523,7 +42730,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -40531,7 +42738,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -40854,7 +43061,7 @@ "type": "object", "properties": { "emailBody": { - "description": "Not applicable for this object.", + "description": "The body of the email message.", "type": "string" }, "emailBodyMetadata": { @@ -40862,7 +43069,7 @@ "description": "Metadata that indicates whether the `emailBody` property can be edited." }, "emailSubject": { - "description": "Not applicable for this object.", + "description": "The subject line for the email notification.", "type": "string" }, "emailSubjectMetadata": { @@ -40870,7 +43077,7 @@ "description": "Metadata that indicates whether the `emailSubject` property can be edited." }, "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. ", + "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]: ./esign/restapi/Accounts/Accounts/listSupportedLanguages/", "type": "string" }, "supportedLanguageMetadata": { @@ -40957,24 +43164,24 @@ "type": "object", "properties": { "multipleUsers": { - "description": "Indicates whether email address is used by more than one user.", + "description": "When set to **true**, the email address is used by more than one user.", "type": "string" }, "recipientNames": { - "description": "", + "description": "The names of the recipients associated with the email address.", "type": "array", "items": { "type": "string" } }, "reservedRecipientEmail": { - "description": "", + "description": "When set to **true**, new names cannot be added to the email address.", "type": "string" } }, "x-ds-definition-name": "recipientNamesResponse", - "description": "", - "x-ms-summary": "" + "description": "This response object contains a list of recipients.", + "x-ms-summary": "This response object contains a list of recipients." }, "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.", @@ -41027,7 +43234,7 @@ "type": "string" }, "authenticationInstant": { - "description": "A sender generated value that indicates the date/time that the signer was authenticated.", + "description": "A sender-generated value that indicates the date and time that the signer was authenticated.", "type": "string" }, "authenticationMethod": { @@ -41035,11 +43242,11 @@ "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.", + "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" }, "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.", + "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": { @@ -41047,7 +43254,7 @@ "type": "string" }, "returnUrl": { - "description": "", + "description": "The URL to which the sender should be redirected after viewing the preview.", "type": "string" }, "securityDomain": { @@ -41055,17 +43262,17 @@ "type": "string" }, "xFrameOptions": { - "description": "", + "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" }, "xFrameOptionsAllowFromUrl": { - "description": "", + "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": "", - "x-ms-summary": "" + "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." }, "recipients": { "description": "", @@ -41097,7 +43304,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" @@ -41122,7 +43329,7 @@ } }, "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": { @@ -41182,7 +43389,7 @@ "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)", + "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" }, "signatureProviderNameMetadata": { @@ -41202,12 +43409,12 @@ "type": "object", "properties": { "cpfNumber": { - "description": "Reserved for DocuSign", + "description": "Reserved for DocuSign.", "type": "string" }, "cpfNumberMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "" + "description": "Reserved for DocuSign." }, "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.", @@ -41215,7 +43422,7 @@ }, "oneTimePasswordMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "" + "description": "Metadata that indicates whether the `oneTimePassword` property is editable." }, "signerRole": { "description": "The role or capacity of the signing recipient. Examples: Manager, Approver, etc.", @@ -41223,7 +43430,7 @@ }, "signerRoleMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "" + "description": "Metadata that indicates whether the `signerRole` property is editable." }, "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.", @@ -41231,7 +43438,7 @@ }, "smsMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "" + "description": "Metadata that indicates whether the `sms` property is editable." } }, "x-ds-definition-name": "recipientSignatureProviderOptions", @@ -41308,7 +43515,7 @@ "type": "string" }, "authenticationInstant": { - "description": "A sender generated value that indicates the date/time that the signer was authenticated.", + "description": "A sender-generated value that indicates the date and time that the signer was authenticated.", "type": "string" }, "authenticationMethod": { @@ -41316,19 +43523,19 @@ "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.", + "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" }, "email": { - "description": "Specifies the email of the recipient. You can use either email and userName or userId to identify the recipient.", + "description": "(Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.", "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.", + "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" }, "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.", + "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": { @@ -41336,7 +43543,7 @@ "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", + "description": "(Optional) 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" }, "securityDomain": { @@ -41344,25 +43551,25 @@ "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.", + "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" }, "userName": { - "description": "Specifies the username of the recipient. You can use either email and userName or userId to identify the recipient.", + "description": "The username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient.", "type": "string" }, "xFrameOptions": { - "description": "", + "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" }, "xFrameOptionsAllowFromUrl": { - "description": "", + "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": "recipientViewRequest", - "description": "", - "x-ms-summary": "" + "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." }, "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.", @@ -41373,7 +43580,7 @@ "type": "string" }, "enableSupport": { - "description": "When set to **true**, then customer support is provided as part of the account plan.", + "description": "When set to **true**, customer support is provided as part of the account plan.", "type": "string" }, "externalOrgId": { @@ -41393,7 +43600,7 @@ "type": "string" }, "industry": { - "description": "", + "description": "The name of the industry associated with the referral. \n\nExample: `Accounting`", "type": "string" }, "planStartMonth": { @@ -41417,23 +43624,23 @@ "type": "string" }, "saleDiscountAmount": { - "description": "Reserved for DocuSign use only.", + "description": "Reserved for DocuSign.", "type": "string" }, "saleDiscountFixedAmount": { - "description": "Reserved for DocuSign use only.", + "description": "Reserved for DocuSign.", "type": "string" }, "saleDiscountPercent": { - "description": "Reserved for DocuSign use only.", + "description": "Reserved for DocuSign.", "type": "string" }, "saleDiscountPeriods": { - "description": "Reserved for DocuSign use only.", + "description": "Reserved for DocuSign.", "type": "string" }, "saleDiscountSeatPriceOverride": { - "description": "Reserved for DocuSign use only.", + "description": "Reserved for DocuSign.", "type": "string" }, "shopperId": { @@ -41483,45 +43690,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 +43721,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 +43737,7 @@ "type": "object", "properties": { "accessCode": { - "description": "Not applicable", + "description": "Not applicable.", "type": "string" }, "accessCodeMetadata": { @@ -41570,34 +43745,34 @@ "description": "Not applicable." }, "addAccessCodeToEmail": { - "description": "Not applicable", + "description": "Not applicable.", "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": { @@ -41609,7 +43784,7 @@ "description": "Reserved for DocuSign." }, "documentVisibility": { - "description": "Not applicable", + "description": "Not applicable.", "type": "array", "items": { "$ref": "#/definitions/documentVisibility" @@ -41617,10 +43792,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 +43808,22 @@ }, "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." }, "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 +43835,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,7 +43859,7 @@ }, "recipientAuthenticationStatus": { "$ref": "#/definitions/authenticationStatus", - "description": "Not applicable" + "description": "Not applicable." }, "recipientFeatureMetadata": { "description": "Metadata about the features that are supported for the recipient type.", @@ -41709,23 +43884,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." }, "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 +43909,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." }, "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 +43955,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-13be-42ca-a6fe-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).", + "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-13be-42ca-a6fe-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)." }, "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 +44003,23 @@ "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" }, "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 +44027,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,35 +44160,15 @@ "description": "Information about the shared item.", "x-ms-summary": "Information about the shared item." }, - "signatureDataInfo": { - "type": "object", - "properties": { - "documentSecurityStore": { - "$ref": "#/definitions/documentSecurityStore", - "description": "" - }, - "signatureData": { - "description": "", - "type": "string" - }, - "signatureFieldName": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "signatureDataInfo", - "description": "", - "x-ms-summary": "" - }, "signatureProperties": { "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,36 +44180,36 @@ "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": "", - "x-ms-summary": "" + "description": "This object contains information about the type of signature.", + "x-ms-summary": "This object contains information about the type of signature." }, "signer": { "type": "object", @@ -42077,10 +44220,10 @@ }, "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." }, "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 Access Code on the recipient.", "type": "string" }, "agentCanEditEmail": { @@ -42092,7 +44235,7 @@ "type": "string" }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When **true**, autonavigation is set for the recipient.\n", "type": "string" }, "bulkRecipientsUri": { @@ -42112,11 +44255,11 @@ "type": "string" }, "creationReason": { - "description": "Payment status for payment services.", + "description": "The reason why the recipient was created (for example, `sender`). This property is only returned in responses.", "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": "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.", "type": "array", "items": { "type": "string" @@ -42147,7 +44290,7 @@ "description": "Reserved for DocuSign." }, "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" @@ -42163,10 +44306,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" }, "errorDetails": { @@ -42210,7 +44353,7 @@ }, "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." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", @@ -42249,7 +44392,7 @@ "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": { @@ -42266,7 +44409,7 @@ }, "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": "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`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n" }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -42306,12 +44449,12 @@ "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." }, "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. ", @@ -42329,8 +44472,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": { @@ -42339,15 +44486,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." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "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.", @@ -42362,15 +44509,15 @@ "description": "Metadata that indicates whether the `signInEachLocation` property is editable.\n" }, "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "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" }, "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." }, "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": { @@ -42385,7 +44532,7 @@ "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.", + "description": "Deprecated.", "type": "array", "items": { "$ref": "#/definitions/socialAuthentication" @@ -42399,6 +44546,10 @@ "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." @@ -42421,27 +44572,27 @@ } }, "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": { "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +44603,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -42484,7 +44635,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -42492,7 +44643,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -42571,6 +44722,10 @@ "$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" @@ -42647,7 +44802,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": { @@ -42740,7 +44895,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 +44911,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 +44931,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 +44950,24 @@ "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": { - "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": { - "description": "", - "type": "string" - }, - "remainingSignatures": { - "format": "int64", - "description": "", - "type": "integer" - }, - "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": "" - }, - "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +44978,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -42943,7 +45010,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -42951,7 +45018,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -43034,6 +45101,10 @@ "$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" @@ -43083,7 +45154,7 @@ "description": "Metadata that indicates whether the `scaleValue` property is editable." }, "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 +45189,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": { @@ -43198,11 +45269,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 +45281,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 +45289,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": "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" }, "users": { @@ -43242,8 +45313,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", @@ -43264,7 +45335,7 @@ "type": "object", "properties": { "email": { - "description": "Filters returned user records by the specified email address.", + "description": "", "type": "string" }, "errorDetails": { @@ -43295,48 +45366,24 @@ "description": "", "x-ms-summary": "" }, - "signSessionInfoRequest": { - "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": { - "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`.", - "type": "string" - } - }, - "x-ds-definition-name": "signSessionInfoRequest", - "description": "", - "x-ms-summary": "" - }, "smartSection": { "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +45394,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -43379,7 +45426,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -43387,7 +45434,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -43440,7 +45487,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 +45537,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" @@ -43544,7 +45595,7 @@ }, "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 +45625,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": { @@ -43775,7 +45826,7 @@ "type": "object", "properties": { "email": { - "description": "Filters returned user records by the specified email address.", + "description": "", "type": "string" }, "errorDetails": { @@ -43815,20 +45866,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +45890,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -43871,7 +45922,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -43879,7 +45930,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -43895,7 +45946,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": { @@ -44034,6 +46085,10 @@ "$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" @@ -44142,7 +46197,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": { @@ -44290,7 +46345,7 @@ "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 +46353,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 +46368,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 +46376,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 +46384,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,7 +46400,7 @@ "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": { @@ -44353,15 +46408,15 @@ "description": "Metadata that indicates whether the `dataFieldSize` property is editable.\n" }, "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,7 +46424,7 @@ "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": { @@ -44377,7 +46432,7 @@ "description": "Metadata that indicates whether the `noteTabs` property is editable.\n" }, "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 +46440,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 +46448,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 +46464,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 +46472,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 +46488,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 +46504,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": { @@ -44465,20 +46520,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +46544,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -44521,7 +46576,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -44529,7 +46584,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -44632,6 +46687,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" @@ -44784,11 +46843,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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\n", "type": "string" }, "anchorIgnoreIfNotPresent": { @@ -44796,7 +46855,7 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace\n", "type": "string" }, "anchorUnits": { @@ -44804,11 +46863,11 @@ "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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "bold": { @@ -44816,7 +46875,7 @@ "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": { @@ -44875,7 +46934,7 @@ } }, "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" }, "lastModifiedByDisplayName": { @@ -44903,15 +46962,15 @@ "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" }, "required": { @@ -44931,7 +46990,7 @@ "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 +46998,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": "", "type": "string" }, "underline": { @@ -44971,7 +47030,7 @@ "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" @@ -45197,8 +47256,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 +47292,7 @@ } }, "templateId": { - "description": "The ID of the template.", + "description": "The id of the template.", "type": "string" } }, @@ -45344,7 +47403,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" @@ -45369,7 +47428,7 @@ } }, "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": { @@ -45419,10 +47478,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 +47500,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 +47508,12 @@ "type": "string" }, "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "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" }, "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 +47536,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 +47598,7 @@ "description": "" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" } }, @@ -45770,7 +47829,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.", @@ -45822,20 +47881,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +47905,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -45878,7 +47937,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -45886,7 +47945,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -45902,7 +47961,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": { @@ -46057,6 +48116,10 @@ "$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" @@ -46165,7 +48228,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": { @@ -46277,7 +48340,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 merge fields are being used, specifies the type of the merge field. The only supported value is `salesforce`.", "type": "string" }, "errorDetails": { @@ -46285,11 +48348,11 @@ "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": { - "description": "The name of the custom field.", + "description": "The name of the text custom field.", "type": "string" }, "required": { @@ -46297,56 +48360,36 @@ "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 custom field displays at the top of the certificate of completion.", "type": "string" }, "value": { - "description": "The value of the custom field.", + "description": "The button text that displays on the custom field in the document.", "type": "string" } }, "x-ds-definition-name": "textCustomField", - "description": "", - "x-ms-summary": "" - }, - "timeStampField": { - "type": "object", - "properties": { - "documentSecurityStore": { - "$ref": "#/definitions/documentSecurityStore", - "description": "" - }, - "maxTimeStampSignatureLength": { - "description": "", - "type": "string" - }, - "timeStampFieldName": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "timeStampField", - "description": "", - "x-ms-summary": "" + "description": "This object represents a custom field that accepts text.", + "x-ms-summary": "This object represents a custom field that accepts text." }, "title": { "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +48400,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -46389,7 +48432,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -46397,7 +48440,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -46413,7 +48456,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": { @@ -46552,6 +48595,10 @@ "$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" @@ -46628,7 +48675,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": { @@ -46720,101 +48767,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 +48791,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": { @@ -46957,7 +48871,7 @@ "type": "string" }, "email": { - "description": "Filters returned user records by the specified email address.", + "description": "", "type": "string" }, "errorDetails": { @@ -46977,7 +48891,7 @@ "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "userId": { @@ -47016,34 +48930,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 +48953,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 +48968,7 @@ "type": "string" }, "email": { - "description": "Filters returned user records by the specified email address.", + "description": "", "type": "string" }, "enableConnectForUser": { @@ -47113,7 +48999,7 @@ "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": { @@ -47189,7 +49075,7 @@ "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "userAddedToAccountDateTime": { @@ -47233,7 +49119,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": { @@ -47245,15 +49131,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": { @@ -47265,8 +49151,8 @@ } }, "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", @@ -47297,7 +49183,7 @@ "properties": { "passwordRules": { "$ref": "#/definitions/AccountPasswordRules", - "description": "" + "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 +49191,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", @@ -47382,8 +49268,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 +49281,23 @@ "description": "Reserved for DocuSign." }, "allowEsealRecipients": { - "description": "", + "description": "When set to **true**, this user can create [electronic seal recipients][eseal].\n\n[eseal]: /esign/restapi//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 +49305,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 +49321,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 +49338,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 +49362,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 +49378,7 @@ }, "canManageAccountMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `canManageAccountMetadata` property." }, "canManageDistributor": { "description": "Reserved for DocuSign.", @@ -47496,7 +49386,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 +49394,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 +49402,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 +49410,7 @@ }, "canSendEnvelopeMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `canSendEnvelope` property." }, "canSignEnvelope": { "description": "When **true**, this user can sign envelopes.", @@ -47528,15 +49418,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 +49461,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 DocuSign API.\n\n**Note**: Only SysAdmin users can change this setting.", "type": "string" }, "enableSequentialSigningAPIMetadata": { @@ -47571,7 +49469,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 +49485,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 +49498,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 +49509,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 +49554,7 @@ }, "modifiedPageMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `modifiedPage` property." }, "newSendUI": { "description": "Reserved for DocuSign.", @@ -47656,7 +49562,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 +49570,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 +49578,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 +49616,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 +49632,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 +49661,7 @@ }, "templateMatchingSensitivityMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `tempalteMatchingSensitivity` property." }, "templatePageLevelMatching": { "description": "When **true**, users see template matching functionality.", @@ -47763,7 +49669,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 +49677,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 +49693,7 @@ }, "timezoneOffsetMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Metadata about the `timezoneOffset` property." }, "timezoneSendingPref": { "description": "Reserved for DocuSign.", @@ -47795,7 +49701,7 @@ }, "timezoneSendingPrefMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Reserved for DocuSign." }, "timezoneSigningPref": { "description": "Reserved for DocuSign.", @@ -47803,7 +49709,7 @@ }, "timezoneSigningPrefMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Reserved for DocuSign." }, "transactionPointSiteNameURL": { "description": "Reserved for DocuSign.", @@ -47811,7 +49717,7 @@ }, "transactionPointSiteNameURLMetadata": { "$ref": "#/definitions/settingsMetadata", - "description": "" + "description": "Reserved for DocuSign." }, "transactionPointUserName": { "description": "Reserved for DocuSign.", @@ -47819,7 +49725,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 +49733,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 +49764,11 @@ "type": "object", "properties": { "adoptedDateTime": { - "description": "The date and time on which the user adopted the signature.", + "description": "The UTC date and time when the user adopted the 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 +49780,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 +49792,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 +49804,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 +49812,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,7 +49836,7 @@ "type": "string" }, "signatureFont": { - "description": "", + "description": "The font to use for the signature.", "type": "string" }, "signatureId": { @@ -47958,11 +49864,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 +49876,7 @@ "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" } }, @@ -47986,7 +49892,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 +49900,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 +49920,7 @@ "type": "string" }, "signatureFont": { - "description": "", + "description": "The font to use for the signature.", "type": "string" }, "signatureId": { @@ -48030,7 +49936,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,7 +49952,7 @@ "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" @@ -48061,7 +49967,7 @@ "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" @@ -48080,7 +49986,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 +49998,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": { @@ -48119,20 +50025,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +50049,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -48175,7 +50081,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -48183,7 +50089,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -48314,6 +50220,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" @@ -48378,7 +50288,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": { @@ -48527,22 +50437,22 @@ }, "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." }, "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 Access Code on the recipient.", "type": "string" }, "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" }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When **true**, autonavigation is set for the recipient.\n", "type": "string" }, "bulkRecipientsUri": { @@ -48562,11 +50472,11 @@ "type": "string" }, "creationReason": { - "description": "Payment status for payment services.", + "description": "The reason why the recipient was created (for example, `sender`). This property is only returned in responses.", "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": "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.", "type": "array", "items": { "type": "string" @@ -48597,26 +50507,26 @@ "description": "Reserved for DocuSign." }, "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." }, "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 +50549,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." }, "fullName": { "description": "Reserved for DocuSign.", @@ -48660,7 +50570,7 @@ }, "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." }, "idCheckInformationInput": { "$ref": "#/definitions/idCheckInformationInput", @@ -48680,15 +50590,15 @@ }, "isBulkRecipientMetadata": { "$ref": "#/definitions/propertyMetadata", - "description": "Metadata that indicates if the sender can edit the `isBulkRecipient` property." + "description": "Metadata that indicates whether the `isBulkRecipient` property is editable." }, "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." }, "lockedRecipientPhoneAuthEditable": { "description": "Reserved for DocuSign.", @@ -48699,12 +50609,12 @@ "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." }, "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 +50622,15 @@ }, "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." }, "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": "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`: ArrayOfStrings. A list of phone numbers the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.\n" }, "recipientAttachments": { "description": "Reserved for DocuSign.", @@ -48760,12 +50670,12 @@ "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." }, "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 +50683,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." }, "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 +50693,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 +50707,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." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "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 +50727,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." }, "signingGroupId": { - "description": "The id of the signing group of which the recipient is a member, if applicable.", + "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" }, "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." }, "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": { @@ -48839,23 +50753,27 @@ "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.", + "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. ", @@ -48874,24 +50792,24 @@ "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." }, "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,26 +50822,26 @@ }, "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.)", + "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" }, "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.", "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 +50849,7 @@ "type": "string" }, "workspaceId": { - "description": "Specifies the workspace ID GUID.", + "description": "The id of the workspace.", "type": "string" }, "workspaceName": { @@ -48939,27 +50857,27 @@ "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." + "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" @@ -48973,27 +50891,27 @@ } }, "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": { - "description": "The id of the workspace, always populated.", + "description": "The id of the workspace.", "type": "string" } }, "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,7 +50919,7 @@ "description": "" }, "contentType": { - "description": "", + "description": "If the item is a file, this property specifies the content type of the file.", "type": "string" }, "created": { @@ -49009,23 +50927,23 @@ "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 +50951,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 +50995,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": "", "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "userAuthorization": { @@ -49094,14 +51012,14 @@ } }, "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" @@ -49109,26 +51027,26 @@ } }, "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": { @@ -49140,26 +51058,26 @@ } }, "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": { @@ -49167,7 +51085,7 @@ "type": "string" }, "activeSince": { - "description": "", + "description": "The UTC DateTime when the user joined the workspace.", "type": "string" }, "created": { @@ -49175,11 +51093,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 +51105,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 +51125,55 @@ "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "description": "", "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 +51181,7 @@ "type": "string" }, "createdById": { - "description": "", + "description": "The id of the user who created the workspace user authorization. ", "type": "string" }, "errorDetails": { @@ -49271,20 +51189,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", @@ -49294,20 +51212,20 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\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 +51236,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/esign-rest-api/guides/concepts/tabs#autoplace\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.", @@ -49350,7 +51268,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorXOffsetMetadata": { @@ -49358,7 +51276,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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "anchorYOffsetMetadata": { @@ -49374,7 +51292,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": { @@ -49513,6 +51431,10 @@ "$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" @@ -49621,7 +51543,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": { @@ -49770,7 +51692,7 @@ "type": "string" }, "allowCDWithdraw": { - "description": "Indicates whether the customer can withdraw their acceptance of the consumer disclosure.", + "description": "When set to **true**, recipients can withdraw their acceptance of the consumer disclosure.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, "allowCDWithdrawMetadata": { @@ -49901,7 +51823,7 @@ "x-ms-summary": "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 +51844,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.", "type": "object", "properties": { "listCustomFields": { @@ -49987,7 +51868,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." }, "EnvelopeDocumentFields": { "type": "object", @@ -50018,7 +51899,7 @@ "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 +51919,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 +51959,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" @@ -50103,7 +51984,7 @@ } }, "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": { @@ -50896,6 +52777,13 @@ "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" @@ -50929,7 +52817,7 @@ "type": "string" }, "planName": { - "description": "The name of the billing plan used for the account.", + "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": { @@ -50981,10 +52869,10 @@ } }, "x-ds-definition-name": "accountSignatureProviders", - "description": "Account SBS Signature Providers", + "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": "Account SBS Signature Providers" + "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", @@ -51023,7 +52911,7 @@ "description": "Contains information describing discounts and promotions." }, "successorPlans": { - "description": "", + "description": "A list of billing plans that the current billing plan can be rolled into.", "type": "array", "items": { "$ref": "#/definitions/billingPlan" @@ -51118,52 +53006,11 @@ "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. ", - "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": "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. ", + "description": "The last index position in the result set. ", "type": "string" }, "errorDetails": { @@ -51175,14 +53022,14 @@ "type": "string" }, "items": { - "description": "", + "description": "A list of objects that contain information about a file or folder in cloud storage.", "type": "array", "items": { "$ref": "#/definitions/externalFile" } }, "name": { - "description": "", + "description": "The name of the cloud storage item.", "type": "string" }, "nextUri": { @@ -51194,15 +53041,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" } }, @@ -51224,10 +53071,10 @@ } }, "x-ds-definition-name": "cloudStorageProviders", - "description": "Cloud storage providers", + "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": "Cloud storage providers" + "x-ms-summary": "The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account." }, "ConnectConfigurations": { "type": "object", @@ -51237,7 +53084,7 @@ "type": "string" }, "allowSalesforcePublish": { - "description": "", + "description": "When set to **true** (default), DocuSign sends data to the designated Salesforce account through Connect.", "type": "string" }, "allUsers": { @@ -51245,30 +53092,30 @@ "type": "string" }, "configurationType": { - "description": "If merge fields are being used, specifies the type of the merge field. The only supported value is **salesforce**.", + "description": "If merge fields are being used, specifies the type of the merge field. The only supported value is `salesforce`.", "type": "string" }, "connectId": { - "description": " Read only: the DocuSign generated ID for the Connect configuration. ", + "description": "The DocuSign-generated ID for the Connect configuration. This property is read only.", "type": "string" }, "enableLog": { - "description": "This turns Connect logging on or off. When set to **true**, logging is turned on.", + "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" }, "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.", + "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": { "type": "string" } }, "externalFolderId": { - "description": "", + "description": "The id of an external folder.", "type": "string" }, "externalFolderLabel": { - "description": "", + "description": "The label for an external folder.", "type": "string" }, "includeCertificateOfCompletion": { @@ -51276,7 +53123,7 @@ "type": "string" }, "includeCertSoapHeader": { - "description": "", + "description": "When set to **true**, a certificate for a SOAP header is included in messages sent through Connect.", "type": "string" }, "includeDocumentFields": { @@ -51284,7 +53131,7 @@ "type": "string" }, "includeDocuments": { - "description": "When set to **true**, Connect will send the PDF document along with the update XML.", + "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" }, "includeEnvelopeVoidReason": { @@ -51292,7 +53139,7 @@ "type": "string" }, "includeHMAC": { - "description": "", + "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" }, "includeSenderAccountasCustomField": { @@ -51312,18 +53159,18 @@ "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.", + "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": { "type": "string" } }, "requireMutualTls": { - "description": "If **true** [Mutual TLS](https://developers.docusign.com/esign-rest-api/guides/mutual-tls-intro) authentication is enabled.", + "description": "When set to **true**, [Mutual TLS](https://developers.docusign.com/esign-rest-api/guides/mutual-tls-intro) authentication is enabled.", "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.", + "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" }, "salesforceAccessToken": { @@ -51335,11 +53182,11 @@ "type": "string" }, "salesforceDocumentsAsContentFiles": { - "description": "", + "description": "When set to **true**, DocuSign can use documents in your Salesforce account for sending and signing.", "type": "string" }, "salesforceRefreshToken": { - "description": "", + "description": "The Saleforce OAuth refresh token that you use to get a new Salesforceaccess token (session ID). For more information, see [OAuth 2.0 Refresh Token Flow](https://help.salesforce.com/articleView?id=remoteaccess_oauth_refresh_token_flow.htm&type=5).", "type": "string" }, "senderOverride": { @@ -51347,14 +53194,14 @@ "type": "string" }, "senderSelectableItems": { - "description": "", + "description": "This property sets the items that are available for selection when adding or editing Connect objects. ", "type": "array", "items": { "type": "string" } }, "sfObjects": { - "description": "", + "description": "An array of Salesforce objects.", "type": "array", "items": { "$ref": "#/definitions/connectSalesforceObject" @@ -51365,15 +53212,15 @@ "type": "string" }, "soapNamespace": { - "description": "The namespace of the SOAP interface.\n\nThe namespace value must be set if useSoapInterface is set to true.", + "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 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.", + "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.", + "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" @@ -51389,10 +53236,10 @@ } }, "x-ds-definition-name": "connectCustomConfiguration", - "description": "Connect configurations", + "description": "Contains information about a DocuSign Connect configuration.", "x-ds-category": "Connect", "x-ds-order": "10", - "x-ms-summary": "Connect configurations" + "x-ms-summary": "Contains information about a DocuSign Connect configuration." }, "ConnectEvents": { "type": "object", @@ -51416,7 +53263,7 @@ "type": "string" }, "type": { - "description": "Type of user:\n- `type_owner`\n- `type_participant`", + "description": "", "type": "string" } }, @@ -51434,11 +53281,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/esign-rest-api/guides/concepts/tabs#autoplace", "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/esign-rest-api/guides/concepts/tabs#autoplace\n", "type": "string" }, "anchorIgnoreIfNotPresent": { @@ -51446,7 +53293,7 @@ "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/esign-rest-api/guides/concepts/tabs#autoplace\n", "type": "string" }, "anchorUnits": { @@ -51454,11 +53301,11 @@ "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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "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\n**Note**: When you provide an x- and y-coordinate for the sign here tab, the tab appears 21 points lower than the value you provide for the y-coordinate. To align the tab as expected, subtract 21 from the expected y-value.", "type": "string" }, "bold": { @@ -51466,7 +53313,7 @@ "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": { @@ -51478,7 +53325,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 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" }, "disableAutoSize": { @@ -51549,19 +53396,19 @@ "description": "Contains the information necessary to map the tab to a field in SalesForce." }, "name": { - "description": "", + "description": "The name of the custom tab.", "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" }, "required": { @@ -51581,7 +53428,7 @@ "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": { @@ -51589,7 +53436,7 @@ "description": "Metadata that indicates whether the `stampType` property is editable.\n" }, "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": { @@ -51706,7 +53553,7 @@ "type": "string" }, "allowCDWithdraw": { - "description": "Indicates whether the customer can withdraw their acceptance of the consumer disclosure.", + "description": "When set to **true**, recipients can withdraw their acceptance of the consumer disclosure.\n\n**Note**: Only Admin users can change this setting.", "type": "string" }, "allowCDWithdrawMetadata": { @@ -51894,7 +53741,7 @@ "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 +53757,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 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 by using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.", "type": "string" }, "attachmentsUri": { @@ -51918,7 +53765,7 @@ "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": { @@ -51926,7 +53773,7 @@ "type": "string" }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When **true**, autonavigation is set for the recipient.\n", "type": "string" }, "brandId": { @@ -51934,11 +53781,11 @@ "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": { @@ -51946,15 +53793,15 @@ "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": { @@ -51962,7 +53809,7 @@ "type": "string" }, "deletedDateTime": { - "description": "Specifies the data and time the item was deleted.", + "description": "Reserved for DocuSign.", "type": "string" }, "deliveredDateTime": { @@ -51974,11 +53821,11 @@ "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.", + "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": { @@ -52020,7 +53867,7 @@ "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": { @@ -52032,7 +53879,7 @@ "description": "Metadata that indicates whether the `envelope` property is editable.\n" }, "envelopeUri": { - "description": "URI that you can use to retrieve the bulk envelopes.", + "description": "The URI for retrieving the envelope or envelopes.", "type": "string" }, "expireAfter": { @@ -52052,7 +53899,7 @@ "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" @@ -52091,7 +53938,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" }, "location": { @@ -52111,12 +53958,12 @@ "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" }, "notificationUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the notifications.", + "description": "The URI for retrieving notifications.", "type": "string" }, "powerForm": { "$ref": "#/definitions/PowerForms", - "description": "Contains information about any PowerForms that are included in the envelope." + "description": "Information about any PowerForms that are included in the envelope." }, "purgeCompletedDate": { "description": "The date that a purge was completed.", @@ -52147,11 +53994,11 @@ "description": "Information about the sender of the envelope." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "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": { @@ -52163,7 +54010,7 @@ "type": "string" }, "statusChangedDateTime": { - "description": "The data and time the status changed.", + "description": "The data and time that the status changed.", "type": "string" }, "statusDateTime": { @@ -52171,7 +54018,7 @@ "type": "string" }, "templatesUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the templates.", + "description": "The URI for retrieving the templates.", "type": "string" }, "transactionId": { @@ -52218,7 +54065,7 @@ "type": "object", "properties": { "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "envelopes": { @@ -52229,7 +54076,7 @@ } }, "folders": { - "description": "A collection of folder objects returned in a response.", + "description": "A list of folder objects.", "type": "array", "items": { "$ref": "#/definitions/folder" @@ -52244,15 +54091,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" } }, @@ -52282,16 +54129,16 @@ } }, "x-ds-definition-name": "brandsResponse", - "description": "Brand management for groups", + "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": "Brand management for groups" + "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." }, "Groups": { "type": "object", "properties": { "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "groups": { @@ -52310,15 +54157,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" } }, @@ -52332,7 +54179,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": { @@ -52344,15 +54191,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": { @@ -52377,7 +54224,7 @@ "type": "string" }, "createdBy": { - "description": "", + "description": "The name of the user who created the signing group.", "type": "string" }, "errorDetails": { @@ -52385,7 +54232,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": { @@ -52393,15 +54240,15 @@ "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 date and time that the signing group was last modified.", "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": { @@ -52494,7 +54341,7 @@ } }, "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": { @@ -52535,7 +54382,7 @@ } }, "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "nextUri": { @@ -52547,15 +54394,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" } }, @@ -52566,7 +54413,7 @@ "x-ms-summary": "Template bulk recipients" }, "TemplateCustomFields": { - "description": "Template custom fields", + "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": { @@ -52587,7 +54434,7 @@ "x-ds-definition-name": "customFields", "x-ds-category": "Templates", "x-ds-order": "70", - "x-ms-summary": "Template custom fields" + "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", @@ -52617,7 +54464,7 @@ } }, "templateId": { - "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. ", + "description": "The id of the template. If a value is not provided, DocuSign generates a value. ", "type": "string" } }, @@ -52659,15 +54506,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": "Template locks", + "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": "Template locks" + "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." }, "Templates": { "type": "object", @@ -52681,7 +54528,7 @@ "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": { @@ -52697,7 +54544,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 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 by using the [transactionId](https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/create/#envelopeDefinition) or by checking the Connect notification.", "type": "string" }, "attachmentsUri": { @@ -52705,7 +54552,7 @@ "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": { @@ -52721,7 +54568,7 @@ "type": "string" }, "autoNavigation": { - "description": "When **true**, auto navigation is set for the recipient.\n", + "description": "When **true**, autonavigation is set for the recipient.\n", "type": "string" }, "brandId": { @@ -52729,11 +54576,11 @@ "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": { @@ -52745,15 +54592,15 @@ "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": { @@ -52761,7 +54608,7 @@ "type": "string" }, "deletedDateTime": { - "description": "Specifies the data and time the item was deleted.", + "description": "Reserved for DocuSign.", "type": "string" }, "deliveredDateTime": { @@ -52777,18 +54624,18 @@ "type": "string" }, "documents": { - "description": "Complex element contains the details on the documents in the envelope.", + "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": { @@ -52830,7 +54677,7 @@ "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": { @@ -52842,7 +54689,7 @@ "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": { @@ -52861,6 +54708,10 @@ "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" @@ -52877,7 +54728,7 @@ "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" @@ -52916,7 +54767,7 @@ "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" }, "lastModifiedBy": { @@ -52956,7 +54807,7 @@ "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": { @@ -53015,7 +54866,7 @@ "description": "Information about the sender." }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "type": "string" }, "shared": { @@ -53027,7 +54878,7 @@ "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": { @@ -53039,7 +54890,7 @@ "type": "string" }, "statusChangedDateTime": { - "description": "The data and time the status changed.", + "description": "The data and time that the status changed.", "type": "string" }, "statusDateTime": { @@ -53047,11 +54898,11 @@ "type": "string" }, "templateId": { - "description": "The ID of the template.", + "description": "The id of the template.", "type": "string" }, "templatesUri": { - "description": "Contains a URI for an endpoint that you can use to retrieve the templates.", + "description": "The URI for retrieving the templates.", "type": "string" }, "transactionId": { @@ -53305,15 +55156,15 @@ "type": "object", "properties": { "url": { - "description": "The view URL to be navigated to.", + "description": "The URL that you navigate to in order to start the view.", "type": "string" } }, "x-ds-definition-name": "viewUrl", - "description": "Embedding template views", + "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": "Embedding template views" + "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", @@ -53416,7 +55267,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": { @@ -53462,7 +55313,7 @@ "description": "The user's physical home address." }, "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": { @@ -53473,10 +55324,6 @@ "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" @@ -53538,7 +55385,7 @@ "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "userAddedToAccountDateTime": { @@ -53575,24 +55422,24 @@ } }, "x-ds-definition-name": "userInformation", - "description": "User management", + "description": "The Users resource enables you to create and manage account users.", "x-ds-category": "Users", "x-ds-order": "10", - "x-ms-summary": "User management" + "x-ms-summary": "The Users resource enables you to create and manage account users." }, "UserSignatures": { "type": "object", "properties": { "adoptedDateTime": { - "description": "The date and time on which the user adopted the signature.", + "description": "The UTC date and time when the user adopted the signature.", "type": "string" }, "createdDateTime": { - "description": "The date and time on which the user created the signature.", + "description": "The UTC date and time when the user created the signature.", "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.", + "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" }, "dateStampProperties": { @@ -53600,7 +55447,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": { @@ -53608,15 +55455,15 @@ "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.", + "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" }, "imageBase64": { - "description": "The base64-encoded bytes of the signature image.", + "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": "The format of the signature image, such as:\n\n- `GIF`\n- `PNG`\n- `JPG`\n- `PDF`\n- `BMP`", "type": "string" }, "initials150ImageId": { @@ -53624,7 +55471,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": { @@ -53632,7 +55479,7 @@ "type": "string" }, "lastModifiedDateTime": { - "description": "The date and time on which the signature was last modified.", + "description": "The UTC date and time when the signature was last modified.", "type": "string" }, "nrdsId": { @@ -53656,7 +55503,7 @@ "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", + "description": "The font type to use for the signature if the signature is not drawn. The following font types are supported:\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": { @@ -53684,11 +55531,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": { @@ -53696,7 +55543,7 @@ "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" } }, @@ -53710,30 +55557,30 @@ "type": "object", "properties": { "cloudProvider": { - "description": "", + "description": "The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)\n\n", "type": "string" }, "cloudProviderContainerId": { - "description": "", + "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 unique identifier of a person in the contacts address book.", + "description": "The id of a contact person in the account's address book.", "type": "string" }, "contactPhoneNumbers": { - "description": "", + "description": "A list of the contact's phone numbers.", "type": "array", "items": { "$ref": "#/definitions/contactPhoneNumber" } }, "contactUri": { - "description": "", + "description": "The URI for retrieving information about the contact.", "type": "string" }, "emails": { - "description": "", + "description": "The email address or addresses associated with the contact.", "type": "array", "items": { "type": "string" @@ -53744,35 +55591,35 @@ "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." }, "isOwner": { - "description": "", + "description": "When **true**, the current user is the owner of the contact.", "type": "boolean" }, "name": { - "description": "", + "description": "The name of the contact.", "type": "string" }, "organization": { - "description": "", + "description": "The name of the contact's organization.", "type": "string" }, "shared": { - "description": "When set to **true**, this custom tab is 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).", "type": "string" }, "signingGroup": { - "description": "", + "description": "If the contact belongs to a signing group, this property contains the `signingGroupId`.", "type": "string" }, "signingGroupName": { - "description": "The display name for the signing group. \n\nMaximum Length: 100 characters. ", + "description": "The name of the signing group that the contact belongs to.", "type": "string" } }, "x-ds-definition-name": "contact", - "description": "", + "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": "" + "x-ms-summary": "The `Contacts` resource enables you to manage the contact in an account's address book." }, "EnvelopeAttachments": { "type": "object", @@ -53990,7 +55837,7 @@ "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 +55845,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 +55853,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 +55861,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,7 +55877,7 @@ "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": { @@ -54038,15 +55885,15 @@ "description": "Metadata that indicates whether the `dataFieldSize` property is editable.\n" }, "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,7 +55901,7 @@ "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": { @@ -54062,7 +55909,7 @@ "description": "Metadata that indicates whether the `noteTabs` property is editable.\n" }, "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 +55917,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 +55925,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 +55941,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 +55949,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,15 +55965,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": { @@ -54134,7 +55981,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": { @@ -54143,10 +55990,10 @@ } }, "x-ds-definition-name": "tabAccountSettings", - "description": "A complex object that configures tab settings for the account.", + "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": "A complex object that configures tab settings for the account." + "x-ms-summary": "Tab settings determine the tab types and tab functionality that are enabled for an account." }, "ENoteConfigurations": { "type": "object", @@ -54179,15 +56026,15 @@ "x-ms-summary": "" }, "WorkspaceItems": { - "description": "", + "description": "This object contains information about a file or folder in a workspace.", "type": "object", "properties": { "callerAuthorization": { "$ref": "#/definitions/workspaceUserAuthorization", - "description": "" + "description": "An object that describes the caller's workspace permissions." }, "contentType": { - "description": "", + "description": "If the item is a file, this property specifies the content type of the file.", "type": "string" }, "created": { @@ -54195,67 +56042,67 @@ "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": { - "description": "A unique ID for the Salesforce object.", + "description": "The id of the workspace item.", "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 DateTime that the item was last modified.", "type": "string" }, "lastModifiedById": { - "description": "Utc date and time the comment was last updated (can only be done by creator)", + "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": "A simple string description of the item, such as a file name or a folder name.", + "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": "The ID of the parent folder. This is the GUID of the parent folder, or the special value 'root' for the root folder.", + "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": { @@ -54263,33 +56110,33 @@ "description": "" }, "thumbWidth": { - "description": "", + "description": "The width of the thumbnail image.", "type": "string" }, "type": { - "description": "The type of the workspace item. Valid values are file, folder.", + "description": "The type of workspace item. Valid values are:\n\n- `file`\n- `folder`", "type": "string" }, "uri": { - "description": "URI containing the user ID.", + "description": "A URI containing the user ID.", "type": "string" }, "userAuthorization": { "$ref": "#/definitions/workspaceUserAuthorization", - "description": "" + "description": "An object that describes the user's workspace permissions." } }, "x-ds-definition-name": "workspaceItem", "x-ds-category": "Workspaces", "x-ds-order": "130", - "x-ms-summary": "" + "x-ms-summary": "This object contains information about a file or folder in a workspace." }, "Workspaces": { - "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": { @@ -54302,26 +56149,26 @@ }, "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.)", + "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" }, "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": "The status of the workspace. Valid values are:\n\n- `active`\n- `closed`", "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": { @@ -54329,7 +56176,7 @@ "type": "string" }, "workspaceId": { - "description": "The id of the workspace, always populated.", + "description": "The id of the workspace.", "type": "string" }, "workspaceName": { @@ -54337,14 +56184,14 @@ "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-ds-category": "Workspaces", "x-ds-order": "140", - "x-ms-summary": "" + "x-ms-summary": "A DocuSign workspace is a collaboration area for sharing files and data." }, "ChunkedUploads": { "type": "object", @@ -54373,7 +56220,7 @@ "type": "string" }, "expirationDateTime": { - "description": "The UTC time at which the chunked upload expires and is no longer addressable. ", + "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" }, "maxChunkedUploadParts": { @@ -54421,7 +56268,7 @@ } }, "sentDateTime": { - "description": "The date and time the envelope was sent.", + "description": "The UTC DateTime when the envelope was sent.", "type": "string" }, "status": { @@ -54473,11 +56320,11 @@ "type": "object", "properties": { "expirePassword": { - "description": "", + "description": "When set to **true**, passwords expire. The default value is `false`.", "type": "string" }, "expirePasswordDays": { - "description": "", + "description": "The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true**.", "type": "string" }, "expirePasswordDaysMetadata": { @@ -54485,7 +56332,7 @@ "description": "Metadata that indicates whether the `expirePasswordDays` property is editable.\n" }, "lockoutDurationMinutes": { - "description": "", + "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": { @@ -54493,7 +56340,7 @@ "description": "Metadata that indicates whether the `lockoutDurationMinutes` property is editable.\n" }, "lockoutDurationType": { - "description": "", + "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": { @@ -54501,7 +56348,7 @@ "description": "Metadata that indicates whether the `lockoutDurationType` property is editable.\n" }, "minimumPasswordAgeDays": { - "description": "", + "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": { @@ -54509,7 +56356,7 @@ "description": "Metadata that indicates whether the `minimumPasswordAgeDays` property is editable.\n" }, "minimumPasswordLength": { - "description": "", + "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": { @@ -54517,27 +56364,27 @@ "description": "Metadata that indicates whether the `minimumPasswordLength` property is editable.\n" }, "passwordIncludeDigit": { - "description": "", + "description": "When set to **true**, passwords must include a digit. The default value is `false`.", "type": "string" }, "passwordIncludeDigitOrSpecialCharacter": { - "description": "", + "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": "", + "description": "When set to **true**, passwords must include a lowercase letter. The default value is `false`.", "type": "string" }, "passwordIncludeSpecialCharacter": { - "description": "", + "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": "", + "description": "When set to **true**, passwords must include an uppercase letter. The default value is `false`.", "type": "string" }, "passwordStrengthType": { - "description": "", + "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": { @@ -54545,7 +56392,7 @@ "description": "Metadata that indicates whether the `passwordStrengthType` property is editable.\n" }, "questionsRequired": { - "description": "", + "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": { @@ -54554,10 +56401,10 @@ } }, "x-ds-definition-name": "accountPasswordRules", - "description": "", + "description": "Contains details about the password rules for an account.", "x-ds-category": "Accounts", "x-ds-order": "190", - "x-ms-summary": "" + "x-ms-summary": "Contains details about the password rules for an account." }, "AccountWatermarks": { "type": "object", @@ -54608,24 +56455,28 @@ "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" + }, "config": { "$ref": "#/definitions/paymentGatewayAccountSetting", - "description": "" + "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" }, "isEnabled": { - "description": "", + "description": "When **true**, the payment gateway account is enabled.", "type": "string" }, "isLegacy": { - "description": "", + "description": "Reserved for DocuSign.", "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 payment gateway account was last updated.", "type": "string" }, "paymentGateway": { @@ -54637,29 +56488,29 @@ "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", + "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" }, "payPalLegacySettings": { "$ref": "#/definitions/payPalLegacySettings", - "description": "" + "description": "Reserved for DocuSign." }, "supportedCurrencies": { - "description": "", + "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" } }, "supportedPaymentMethods": { - "description": "", + "description": "An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway.", "type": "array", "items": { "type": "string" } }, "supportedPaymentMethodsWithOptions": { - "description": "", + "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" @@ -54710,7 +56561,7 @@ "type": "object", "properties": { "identityVerification": { - "description": " ", + "description": " \n", "type": "array", "items": { "$ref": "#/definitions/accountIdentityVerificationWorkflow" @@ -54718,16 +56569,16 @@ } }, "x-ds-definition-name": "accountIdentityVerificationResponse", - "description": "Identity verification workflows available to an account", + "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 workflows available to an account" + "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": "", + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { "$ref": "#/definitions/documentHtmlDefinitionOriginal" @@ -54744,7 +56595,7 @@ "type": "object", "properties": { "htmlDefinitions": { - "description": "", + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { "type": "string" @@ -54752,16 +56603,16 @@ } }, "x-ds-definition-name": "documentHtmlDefinitions", - "description": "", + "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": "" + "x-ms-summary": "This resource is used to create a responsive preview of a specific document." }, "EnvelopeHtmlDefinitions": { "type": "object", "properties": { "htmlDefinitions": { - "description": "", + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { "$ref": "#/definitions/documentHtmlDefinitionOriginal" @@ -54778,7 +56629,7 @@ "type": "object", "properties": { "htmlDefinitions": { - "description": "", + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { "type": "string" @@ -54786,16 +56637,16 @@ } }, "x-ds-definition-name": "documentHtmlDefinitions", - "description": "", + "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": "" + "x-ms-summary": "This resource is used to create a responsive preview of all of the documents in an envelope." }, "TemplateDocumentResponsiveHtmlPreview": { "type": "object", "properties": { "htmlDefinitions": { - "description": "", + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { "type": "string" @@ -54803,16 +56654,16 @@ } }, "x-ds-definition-name": "documentHtmlDefinitions", - "description": "", + "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": "" + "x-ms-summary": "This resource is used to create a responsive preview of a specific template document." }, "TemplateResponsiveHtmlPreview": { "type": "object", "properties": { "htmlDefinitions": { - "description": "", + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { "type": "string" @@ -54820,16 +56671,16 @@ } }, "x-ds-definition-name": "documentHtmlDefinitions", - "description": "", + "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": "" + "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": "", + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { "$ref": "#/definitions/documentHtmlDefinitionOriginal" @@ -54846,7 +56697,7 @@ "type": "object", "properties": { "htmlDefinitions": { - "description": "", + "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.", "type": "array", "items": { "$ref": "#/definitions/documentHtmlDefinitionOriginal" @@ -54863,11 +56714,11 @@ "type": "object", "properties": { "endPosition": { - "description": "The last position in the result set. ", + "description": "The last index position in the result set. ", "type": "string" }, "envelopeTransferRules": { - "description": "", + "description": "Contains information about a specific envelope transfer rule.", "type": "array", "items": { "$ref": "#/definitions/envelopeTransferRule" @@ -54882,40 +56733,476 @@ "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" } }, "x-ds-definition-name": "envelopeTransferRuleInformation", - "description": "", + "description": "This resource provides methods that enable account administrators to create and manage envelope transfer rules.", "x-ds-category": "Envelopes", - "x-ds-order": "250", - "x-ms-summary": "" + "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": "" + "description": "The default notification settings for envelopes sent by using the console." }, "emailNotifications": { "$ref": "#/definitions/notificationDefaultSettings", - "description": "" + "description": "The default notification settings for envelopes sent by using the API." } }, "x-ds-definition-name": "notificationDefaults", - "description": "", + "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" + } + }, + "listId": { + "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list.", + "type": "string" + }, + "name": { + "description": "The name of the bulk send list.", + "type": "string" + } + }, + "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." + }, + "BCCEmailArchive": { + "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": "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" + }, + "TabsBlob": { + "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" + }, + "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" + }, + "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" + }, + "calculatedFieldsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `calculatedFields` property is editable.\n" + }, + "checkboxTabsEnabled": { + "description": "When **true**, checkbox tabs are enabled.", + "type": "string" + }, + "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" + }, + "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" + }, + "dataFieldSizeMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `dataFieldSize` property is editable.\n" + }, + "firstLastEmailTabsEnabled": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "firstLastEmailTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "listTabsEnabled": { + "description": "When **true**, list tabs are enabled.", + "type": "string" + }, + "listTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `listTabs` property is editable.\n" + }, + "noteTabsEnabled": { + "description": "When **true**, note tabs are enabled.", + "type": "string" + }, + "noteTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `noteTabs` property is editable.\n" + }, + "radioTabsEnabled": { + "description": "When **true**, radio button tabs are enabled.", + "type": "string" + }, + "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" + }, + "savingCustomTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `savingCustomTabs` property is editable.\n" + }, + "senderToChangeTabAssignmentsEnabled": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "senderToChangeTabAssignmentsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "sharedCustomTabsEnabled": { + "description": "When **true**, shared custom tabs are enabled.", + "type": "string" + }, + "sharedCustomTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `sharedCustomTabs` property is editable.\n" + }, + "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" + }, + "tabDataLabelMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `tabDataLabel` property is editable.\n" + }, + "tabLocationEnabled": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "tabLocationMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "tabLockingEnabled": { + "description": "When set to **true**, tab locking is enabled.\n\n**Note**: Only Admin users can change this setting.\n", + "type": "string" + }, + "tabLockingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `tabLocking` property is editable.\n" + }, + "tabScaleEnabled": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "tabScaleMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Reserved for DocuSign." + }, + "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" + }, + "tabTextFormattingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `tabTextFormatting` property is editable.\n" + }, + "textTabsEnabled": { + "description": "When **true**, text tabs are enabled.", + "type": "string" + }, + "textTabsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "Metadata that indicates whether the `textTabs` property is editable.\n" + } + }, + "x-ds-definition-name": "tabAccountSettings", + "description": "", + "x-ds-category": "Envelopes", + "x-ds-order": "120", + "x-ms-summary": "" + }, + "DataFeedElement": { + "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 UTC DateTime when the envelope was sent.", + "type": "string" + }, + "status": { + "description": "The status of the item.", + "type": "string" + } + }, + "x-ds-definition-name": "envelopeFormData", + "description": "", + "x-ds-category": "DataFeed", + "x-ds-order": "120", + "x-ms-summary": "" + }, + "Comments": { + "type": "object", + "properties": { + "envelopeId": { + "description": "The envelope's GUID. \n\nExample: `93be49ab-afa0-4adf-933c-f752070d71ec`", + "type": "string" + }, + "hmac": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "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" + } + }, + "read": { + "description": "Indicates if the comment has been read by the target recipient of the comment.", + "type": "boolean" + }, + "sentByEmail": { + "description": "", + "type": "string" + }, + "sentByFullName": { + "description": "", + "type": "string" + }, + "sentByImageId": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "sentByInitials": { + "description": "", + "type": "string" + }, + "sentByRecipientId": { + "description": "", + "type": "string" + }, + "sentByUserId": { + "description": "", + "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" + }, + "signingGroupName": { + "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. ", + "type": "string" + }, + "subject": { + "description": "", + "type": "string" + }, + "tabId": { + "description": "The unique identifier for the tab.", + "type": "string" + }, + "text": { + "description": "Specifies the text that is shown in the dropdown list. ", + "type": "string" + }, + "threadId": { + "description": "The unique identifier for the comment thread.", + "type": "string" + }, + "threadOriginatorId": { + "description": "The userId of the user who created the thread.", + "type": "string" + }, + "timestamp": { + "description": "", + "type": "string" + }, + "timeStampFormatted": { + "description": "", + "type": "string" + }, + "visibleTo": { + "description": "", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ds-definition-name": "comment", + "description": "", + "x-ds-category": "Envelopes", + "x-ds-order": "160", + "x-ms-summary": "" + }, + "EnvelopeAppliance": { + "type": "object", + "properties": { + "documentData": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/displayApplianceDocument" + } + }, + "documentPages": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/displayApplianceDocumentPage" + } + }, + "envelopeData": { + "$ref": "#/definitions/displayApplianceEnvelope", + "description": "" + }, + "pageData": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/displayAppliancePage" + } + }, + "recipientData": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/displayApplianceRecipient" + } + } + }, + "x-ds-definition-name": "displayApplianceInfo", + "description": "", + "x-ds-category": "Envelopes", + "x-ds-order": "260", + "x-ms-summary": "" + }, + "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." + }, + "favoriteTemplates": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/favoriteTemplatesContentItem" + } + }, + "templatesUpdatedCount": { + "format": "int32", + "description": "", + "type": "integer" + } + }, + "x-ds-definition-name": "favoriteTemplatesInfo", + "description": "", + "x-ds-category": "Accounts", + "x-ds-order": "270", "x-ms-summary": "" } }, @@ -54934,15 +57221,11 @@ }, { "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." }, { "name": "EnvelopeDocumentFields", @@ -54950,15 +57233,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 manage locks on an envelope.\n\nTo prevent users from changing an envelope while another user is modifying it, you can lock the envelope and set the time until the 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": "\n\n\nThe 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/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://developers.hqtest.tst/esign-rest-api/guides/concepts/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\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/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/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]: ./esign/restapi/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": "\n\n\nThe 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- [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#### 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-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\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* 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 +57253,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 +57265,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 +57279,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", @@ -55058,7 +57337,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 +57349,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", @@ -55086,7 +57365,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 +57373,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/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 enable you to manage locks on an template.\n\nTo prevent users from changing a template while another user is modifying it, you can lock the template and set the time until the 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 password to save the changes.\n\n**Note**: To use template locks, the user must have template locking capability enabled." }, { "name": "Templates", @@ -55106,11 +57385,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/esign-rest-api/reference/Envelopes/EnvelopeViews/\n" }, { "name": "UserCustomSettings", @@ -55122,7 +57401,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/esign-rest-api/reference/Users/UserProfiles)." }, { "name": "UserSignatures", @@ -55130,7 +57409,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 +57437,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 +57477,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 +57485,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 +57493,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 +57513,38 @@ }, { "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\n [Envelopes::createEnvelope](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeCustomFields/create) 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_GetEnvelopes][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 (`accountSettings enableBulkRecipient` set to **true**) and for the user sending the envelopes (the `allowBulkRecipients` property in `userSettings` set to **true**.)\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 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]: ./createBulkSendList.html\n[create_test]: ./createBulkSendTestRequest.html\n[create_request]: ./createBulkSendRequest.html\n[getbulkenv]: ./list.html\n[GetEnvelopes]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/listStatusChanges\n\nFor more information about using bulk send, see [Bulk Sending Envelopes](https://developers.docusign.com/esign-rest-api/guides/concepts/envelopes/bulk-send)." + }, + { + "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": "DataFeedElement", + "description": "" + }, + { + "name": "Comments", + "description": "" + }, + { + "name": "EnvelopeAppliance", + "description": "" + }, + { + "name": "FavoriteTemplates", "description": "" } ], @@ -55249,18 +57556,18 @@ }, { "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", @@ -55279,7 +57586,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." }, { @@ -55295,7 +57602,7 @@ { "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", @@ -55314,13 +57621,23 @@ }, { "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": "DataFeed", + "summary": "", + "description": "" } ] } \ No newline at end of file diff --git a/esignature.rest.swagger-v2.json b/esignature.rest.swagger-v2.json index 9805da5..b719015 100644 --- a/esignature.rest.swagger-v2.json +++ b/esignature.rest.swagger-v2.json @@ -1488,7 +1488,7 @@ "in": "query", "required": false, "type": "string", - "description": "Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=\"failed,queued\") \n\nValid values: \n* all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided.\n* failed - Entries with a failed status.\n* processing - Entries with a processing status.\n* queued - Entries with a queued status.\n* sent - Entries with a sent status. \n" + "description": "Specifies which entries are included in the response. You can include multiple entries by using commas in the query string. \n\nExample: `?include=\"failed,queued\"`\n\nValid values: \n* `all`: Returns all entries. If present, overrides all other query settings.\n* `failed`: Returns entries with a `failed` status.\n* `processing`: Returns entries with a `processing` status.\n* `queued`: Returns entries with a `queued` status.\n* `sent`: Returns entries with a `sent` status. \n\n**Note**: If you do not provide a query string, no envelopes are included." }, { "name": "start_position", @@ -1543,7 +1543,7 @@ "in": "path", "required": true, "type": "string", - "description": "" + "description": "Specifies the id of the batch." }, { "name": "count", @@ -1555,7 +1555,7 @@ { "name": "include", "in": "query", - "description": "Specifies which entries are included in the response. Multiple entries can be included by using commas in the query string (example: ?include=\"failed,queued\") \n\nValid values: \n* all - Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided.\n* failed - Entries with a failed status.\n* processing - Entries with a processing status.\n* queued - Entries with a queued status.\n* sent - Entries with a sent status. \n", + "description": "Specifies which entries are included in the response. You can include multiple entries by using commas in the query string. \n\nExample: `?include=\"failed,queued\"`\n\nValid values: \n* `all`: Returns all entries. If present, overrides all other query settings. This is the default if no query string is provided.\n* `failed`: Entries with a failed status.\n* `processing`: Entries with a processing status.\n* `queued`: Entries with a queued status.\n* `sent`: Entries with a sent status. \n", "required": false, "type": "string" }, @@ -3400,7 +3400,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.\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\n**Note**: When you create an envelope by using a [composite template](https://developers.docusign.com/esign-rest-api/guides/concepts/templates#composite-templates), 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": [], @@ -3440,6 +3440,13 @@ "required": false, "type": "string" }, + { + "name": "tab_label_exact_matches", + "in": "query", + "required": false, + "type": "string", + "description": "Reserved for DocuSign.\n\n\n" + }, { "name": "envelopeDefinition", "in": "body", @@ -4430,7 +4437,6 @@ }, "deprecated": false, "x-ds-methodname": "getCommentsTranscript", - "x-ds-api-status": "beta", "x-ds-method": "get", "x-ds-service": "Uncategorized", "description": "", @@ -7249,9 +7255,10 @@ { "name": "bulkRecipientsRequest", "in": "body", - "required": false, + "required": true, "schema": { - "$ref": "#/definitions/bulkRecipientsRequest" + "type": "string", + "format": "binary" }, "description": "" } @@ -19173,6 +19180,14 @@ "$ref": "#/definitions/settingsMetadata", "description": "" }, + "allowAutoTagging": { + "description": "", + "type": "string" + }, + "allowAutoTaggingMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "allowBulkSending": { "description": "", "type": "string" @@ -20203,6 +20218,10 @@ "$ref": "#/definitions/eventResult", "description": "" }, + "identityVerificationResult": { + "$ref": "#/definitions/eventResult", + "description": "" + }, "idLookupResult": { "$ref": "#/definitions/eventResult", "description": "" @@ -22408,33 +22427,6 @@ "description": "", "x-ms-summary": "" }, - "completeSignRequest": { - "type": "object", - "properties": { - "correlationId": { - "description": "", - "type": "string" - }, - "documentUpdateInfos": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/documentUpdateInfo" - } - }, - "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" - }, - "transactionId": { - "description": "Specifies the Transaction ID from the AppStore.", - "type": "string" - } - }, - "x-ds-definition-name": "completeSignRequest", - "description": "", - "x-ms-summary": "" - }, "compositeTemplate": { "type": "object", "properties": { @@ -23121,22 +23113,6 @@ "description": "", "x-ms-summary": "" }, - "credential": { - "type": "object", - "properties": { - "type": { - "description": "Type of the user. Valid values: type_owner, type_participant.", - "type": "string" - }, - "value": { - "description": "Specifies the value of the tab. ", - "type": "string" - } - }, - "x-ds-definition-name": "credential", - "description": "", - "x-ms-summary": "" - }, "creditCardInformation": { "type": "object", "properties": { @@ -24311,35 +24287,6 @@ "description": "", "x-ms-summary": "" }, - "documentSecurityStore": { - "type": "object", - "properties": { - "certificates": { - "description": "", - "type": "array", - "items": { - "type": "string" - } - }, - "crls": { - "description": "", - "type": "array", - "items": { - "type": "string" - } - }, - "ocsps": { - "description": "", - "type": "array", - "items": { - "type": "string" - } - } - }, - "x-ds-definition-name": "documentSecurityStore", - "description": "", - "x-ms-summary": "" - }, "documentTemplate": { "type": "object", "properties": { @@ -24383,45 +24330,6 @@ "description": "", "x-ms-summary": "" }, - "documentUpdateInfo": { - "type": "object", - "properties": { - "data": { - "description": "", - "type": "string" - }, - "documentId": { - "description": "The ID of the document being accessed.", - "type": "string" - }, - "documentSecurityStore": { - "$ref": "#/definitions/documentSecurityStore", - "description": "" - }, - "name": { - "description": "", - "type": "string" - }, - "returnFormat": { - "description": "", - "type": "string" - }, - "signatureDataInfos": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/signatureDataInfo" - } - }, - "timeStampField": { - "$ref": "#/definitions/timeStampField", - "description": "" - } - }, - "x-ds-definition-name": "documentUpdateInfo", - "description": "", - "x-ms-summary": "" - }, "documentVisibility": { "type": "object", "properties": { @@ -25138,6 +25046,10 @@ "description": "Reserved: For DocuSign use only.", "type": "string" }, + "disableResponsiveDocument": { + "description": "", + "type": "string" + }, "documentsCombinedUri": { "description": "", "type": "string" @@ -25460,6 +25372,10 @@ "description": "Reserved: For DocuSign use only.", "type": "string" }, + "disableResponsiveDocument": { + "description": "", + "type": "string" + }, "documents": { "description": "Complex element contains the details on the documents in the envelope.", "type": "array", @@ -26108,6 +26024,10 @@ "description": "Reserved: For DocuSign use only.", "type": "string" }, + "disableResponsiveDocument": { + "description": "", + "type": "string" + }, "documents": { "description": "Complex element contains the details on the documents in the envelope.", "type": "array", @@ -26408,6 +26328,10 @@ "description": "A sender-defined description of the line item.\n", "type": "string" }, + "disableResponsiveDocument": { + "description": "", + "type": "string" + }, "documents": { "description": "Complex element contains the details on the documents in the envelope.", "type": "array", @@ -26763,6 +26687,10 @@ "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" }, + "includeHMAC": { + "description": "", + "type": "string" + }, "includeSenderAccountAsCustomField": { "description": "When set to **true**, Connect will include the sender account as Custom Field in the data.", "type": "string" @@ -30660,6 +30588,18 @@ "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" }, + "customerId": { + "description": "", + "type": "string" + }, + "customMetadata": { + "description": "", + "type": "string" + }, + "customMetadataRequired": { + "description": "", + "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" @@ -30683,6 +30623,10 @@ "description": "", "type": "string" }, + "paymentSourceId": { + "description": "", + "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", "type": "string" @@ -31591,6 +31535,18 @@ "description": "", "x-ms-summary": "" }, + "recipientIdentityVerification": { + "type": "object", + "properties": { + "workflowId": { + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "recipientIdentityVerification", + "description": "", + "x-ms-summary": "" + }, "recipientNamesResponse": { "type": "object", "properties": { @@ -32048,34 +32004,6 @@ "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" - }, - "signatureType": { - "description": "", - "type": "string" - }, - "startData": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "revision", - "description": "", - "x-ms-summary": "" - }, "samlAssertionAttribute": { "type": "object", "properties": { @@ -32330,22 +32258,6 @@ "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": "" - }, "senderEmailNotifications": { "type": "object", "properties": { @@ -32515,26 +32427,6 @@ "description": "Information about the shared item.", "x-ms-summary": "Information about the shared item." }, - "signatureDataInfo": { - "type": "object", - "properties": { - "documentSecurityStore": { - "$ref": "#/definitions/documentSecurityStore", - "description": "" - }, - "signatureData": { - "description": "", - "type": "string" - }, - "signatureFieldName": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "signatureDataInfo", - "description": "", - "x-ms-summary": "" - }, "signatureProviderRequiredOption": { "type": "object", "properties": { @@ -32690,6 +32582,10 @@ "$ref": "#/definitions/idCheckInformationInput", "description": "A complex element that contains input information related to a recipient ID check. It can include the following information.\n\naddressInformationInput: Used to set recipient address information and consists of:\n\n* addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\ndobInformationInput: Used to set recipient date of birth information and consists of:\n\n* dateOfBirth: Specifies the recipient's date, month and year of birth.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:\n\n* ssn4: Specifies the last four digits of the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn9InformationInput: 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: \n* ssn9: Specifies the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n " }, + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "" + }, "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" @@ -33039,84 +32935,6 @@ "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": { - "type": "object", - "properties": { - "data": { - "description": "", - "type": "string" - }, - "documentId": { - "description": "The ID of the document being accessed.", - "type": "string" - }, - "format": { - "description": "", - "type": "string" - }, - "name": { - "description": "", - "type": "string" - }, - "remainingSignatures": { - "description": "", - "type": "string" - }, - "revisions": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/revision" - } - }, - "signatureType": { - "description": "", - "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. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ", - "type": "string" - }, - "language": { - "description": "Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, 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": { - "description": "", - "type": "string" - }, - "seal": { - "$ref": "#/definitions/seal", - "description": "Set of information related to the electronic seal used by the Trust Service Provider (TSP)" - }, - "user": { - "$ref": "#/definitions/user", - "description": "" - } - }, - "x-ds-definition-name": "signHashSessionInfoResponse", - "description": "", - "x-ms-summary": "" - }, "signHere": { "type": "object", "properties": { @@ -33354,26 +33172,6 @@ "description": "", "x-ms-summary": "" }, - "signSessionInfoRequest": { - "type": "object", - "properties": { - "certificate": { - "description": "When set to **false**, the envelope signing certificate is removed from the download.", - "type": "string" - }, - "returnFormat": { - "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.", - "type": "string" - } - }, - "x-ds-definition-name": "signSessionInfoRequest", - "description": "", - "x-ms-summary": "" - }, "smartSection": { "type": "object", "properties": { @@ -35332,26 +35130,6 @@ "description": "", "x-ms-summary": "" }, - "timeStampField": { - "type": "object", - "properties": { - "documentSecurityStore": { - "$ref": "#/definitions/documentSecurityStore", - "description": "" - }, - "maxTimeStampSignatureLength": { - "description": "", - "type": "string" - }, - "timeStampFieldName": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "timeStampField", - "description": "", - "x-ms-summary": "" - }, "title": { "type": "object", "properties": { @@ -35529,101 +35307,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": "The error that caused the Connect post to fail.", - "type": "string" - }, - "status": { - "description": "Item status. ", - "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": "The error that caused the Connect post to fail.", - "type": "string" - }, - "hostname": { - "description": "", - "type": "string" - }, - "responseSeconds": { - "description": "", - "type": "string" - }, - "status": { - "description": "Item status. ", - "type": "string" - }, - "type": { - "description": "Type of the user. Valid values: type_owner, 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", @@ -35650,33 +35333,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": { - "countryCode": { - "description": "", - "type": "string" - }, - "credentials": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/credential" - } - }, - "displayName": { - "description": "", - "type": "string" - }, - "email": { - "description": "", - "type": "string" - } - }, - "x-ds-definition-name": "user", - "description": "", - "x-ms-summary": "" - }, "userAccountManagementGranularInformation": { "type": "object", "properties": { @@ -35812,34 +35468,6 @@ "description": "", "x-ms-summary": "" }, - "userInfoResponse": { - "type": "object", - "properties": { - "envelopeId": { - "description": "The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ", - "type": "string" - }, - "language": { - "description": "Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, 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": "" - }, - "user": { - "$ref": "#/definitions/user", - "description": "" - } - }, - "x-ds-definition-name": "userInfoResponse", - "description": "", - "x-ms-summary": "" - }, "userInformation": { "type": "object", "properties": { @@ -36720,6 +36348,10 @@ "$ref": "#/definitions/idCheckInformationInput", "description": "A complex element that contains input information related to a recipient ID check. It can include the following information.\n\naddressInformationInput: Used to set recipient address information and consists of:\n\n* addressInformation: consists of six elements, with stree2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4. The maximum length of each element is: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\ndobInformationInput: Used to set recipient date of birth information and consists of:\n\n* dateOfBirth: Specifies the recipient's date, month and year of birth.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn4InformationInput: Used to set the last four digits of the recipient's SSN information and consists of:\n\n* ssn4: Specifies the last four digits of the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n* receiveInResponse: A Boolean element that specifies if the information needs to be returned in the response.\n\nssn9InformationInput: 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: \n* ssn9: Specifies the recipient's SSN.\n* displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.\n " }, + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "" + }, "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" @@ -39564,6 +39196,10 @@ "description": "Reserved: For DocuSign use only.", "type": "string" }, + "disableResponsiveDocument": { + "description": "", + "type": "string" + }, "documentsCombinedUri": { "description": "", "type": "string" @@ -40215,6 +39851,10 @@ "description": "Reserved: For DocuSign use only.", "type": "string" }, + "disableResponsiveDocument": { + "description": "", + "type": "string" + }, "documents": { "description": "Complex element contains the details on the documents in the envelope.", "type": "array", @@ -40717,10 +40357,6 @@ "description": "Determines if the feature set is actively set as part of the plan.", "type": "string" }, - "jobTitle": { - "description": "", - "type": "string" - }, "lastLogin": { "description": "The date-time when the user last logged on to the system.", "type": "string" @@ -42077,7 +41713,7 @@ }, { "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\nGeneral steps to use 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 [ML: BulkEnvelope: updateRecipients] method.\n* Create draft envelope by calling the Envelopes: createEnvelope method and add a bulk recipient signer. The envelope can be created from a template that has a bulk recipient.\nA bulk recipient signer is a Signer recipient type where `isBulkRecipient` property is set to true. There can only be one bulk recipient signer per envelope.\nTemplates and draft envelopes can be saved with a bulk recipient signer, but a bulk recipient file must be uploaded before an envelope with a bulk recipient signer can be sent.\n* Add the bulk recipient file to the envelope by calling the BulkEnvelope: updateRecipients method.\n* Send the draft envelope by setting the `status` property on the envelope to `sent` and call the Envelopes:update method.\nTransitioning 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\nOnce 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 or 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\nBulk Send Limitations:\n\n* Bulk send must be enabled for your account (`accountSettings enableBulkRecipient` is set to **true**) and for the user sending the envelopes (the `allowBulkRecipients` property in `userSettings` is set to **true**.)\n* Bulk send can only be used with Signer 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. There can only be one bulk recipient file associated with an envelope when it is sent.\n* When an envelope with bulk recipients is sent, the 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 and an error message is shown to the sender if this limit is reached. If you receive this error, you should wait and resend the envelope at a later time.\n\nIf you frequently run into queue limits, you can contact your account manage to discuss modifying the queue limits for your account." + "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\nGeneral steps to use 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 [ML: BulkEnvelope: updateRecipients] method.\n* Create draft envelope by calling the Envelopes: createEnvelope method and add a bulk recipient signer. The envelope can be created from a template that has a bulk recipient.\nA bulk recipient signer is a Signer recipient type where `isBulkRecipient` property is set to true. There can only be one bulk recipient signer per envelope.\nTemplates and draft envelopes can be saved with a bulk recipient signer, but a bulk recipient file must be uploaded before an envelope with a bulk recipient signer can be sent.\n* Add the bulk recipient file to the envelope by calling the BulkEnvelope: updateRecipients method.\n* Send the draft envelope by setting the `status` property on the envelope to `sent` and call the Envelopes:update method.\nTransitioning 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\nOnce 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 or 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\nBulk Send Limitations:\n\n* Bulk send must be enabled for your account (`accountSettings enableBulkRecipient` is set to **true**) and for the user sending the envelopes (the `allowBulkRecipients` property in `userSettings` is set to **true**.)\n* Bulk send can only be used with Signer 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. There can only be one bulk recipient file associated with an envelope when it is sent.\n* When an envelope with bulk recipients is sent, the 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 and an error message is shown to the sender if this limit is reached. If you receive this error, you should wait and resend the envelope at a later time.\n\nIf you frequently run into queue limits, you can contact your account manager to discuss modifying the queue limits for your account." }, { "name": "CloudStorage",