From ef550d44af74138cc1828c7cea0c0f1cca08ad66 Mon Sep 17 00:00:00 2001 From: Bharat Rele Date: Wed, 25 Jan 2023 12:00:06 -0800 Subject: [PATCH] TIR - Updated esignature.rest.swagger-v2.1.json --- esignature.rest.swagger-v2.1.json | 1176 +++++++++++++++++++---------- 1 file changed, 765 insertions(+), 411 deletions(-) diff --git a/esignature.rest.swagger-v2.1.json b/esignature.rest.swagger-v2.1.json index cf03e5e..8bff231 100644 --- a/esignature.rest.swagger-v2.1.json +++ b/esignature.rest.swagger-v2.1.json @@ -3488,6 +3488,53 @@ "description": "Gets the Connect OAuth configuration for the specified account.\n\n**Note:** To use this function, you must be an account administrator and Connect must be enabled on your account.\n\n## Related topics:\n- [OAuth for DocuSign Connect](/platform/webhooks/connect/validation-and-security/oauth-connect/)\n", "x-ds-in-sdk": true }, + "put": { + "tags": [ + "ConnectConfigurations" + ], + "summary": "", + "operationId": "ConnectOAuthConfig_PutConnectOAuthConfig", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "connectOAuthConfig", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/connectOAuthConfig" + }, + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "$ref": "#/definitions/connectOAuthConfig" + } + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "updateConnectOAuthConfig", + "x-ds-method": "updateConnectOAuthConfig", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, "post": { "tags": [ "ConnectConfigurations" @@ -7372,72 +7419,6 @@ }, "parameters": [] }, - "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{regenDocumentId}/regen": { - "put": { - "tags": [ - "EnvelopeDocuments" - ], - "summary": "Retrieves a PDF document from the envelope with no CoC.", - "operationId": "Documents_PutRegenDocument", - "consumes": [], - "produces": [ - "application/pdf" - ], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "envelopeId", - "in": "path", - "description": "The envelope's GUID. \n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n", - "required": true, - "type": "string" - }, - { - "name": "regenDocumentId", - "in": "path", - "required": true, - "type": "string", - "description": "" - }, - { - "name": "document", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/document" - }, - "description": "An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically." - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "type": "file" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "updateRegenDocument", - "x-ds-method": "updateRegenDocument", - "x-ds-service": "Uncategorized", - "description": "", - "x-ds-in-sdk": true - }, - "parameters": [] - }, "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/email_settings": { "get": { "tags": [ @@ -11284,6 +11265,13 @@ "required": true, "type": "string" }, + { + "name": "count", + "in": "query", + "required": false, + "type": "string", + "description": "The maximum number of results to return." + }, { "name": "include", "in": "query", @@ -11305,6 +11293,13 @@ "type": "string", "description": "The zero-based index of the\nresult from which to start returning results.\n\nThe default value is `0`.\n" }, + { + "name": "sub_folder_depth", + "in": "query", + "required": false, + "type": "string", + "description": "" + }, { "name": "template", "in": "query", @@ -17884,13 +17879,13 @@ "parameters": [] }, "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/bulk_recipients": { - "get": { + "delete": { "tags": [ "TemplateBulkRecipients" ], - "summary": "Gets the bulk recipient file from a template.", - "description": "Retrieves the bulk recipient file information from a template that has a bulk recipient.", - "operationId": "Recipients_GetTemplateBulkRecipients", + "summary": "Deletes the bulk recipient list on a template.", + "description": "Deletes the bulk recipient list on a template.", + "operationId": "Recipients_DeleteTemplateBulkRecipientsFile", "consumes": [], "produces": [], "parameters": [ @@ -17914,27 +17909,67 @@ "description": "The ID of the template.", "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": "deleteBulkRecipients", + "x-ds-method": "delete", + "x-ds-service": "Templates", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility": { + "get": { + "tags": [ + "TemplateDocumentVisibility" + ], + "summary": "Returns document visibility for a template recipient", + "operationId": "Recipients_GetTemplateRecipientDocumentVisibility", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" }, { - "name": "include_tabs", - "in": "query", - "required": false, - "type": "string", - "description": "When **true,** the tab information associated with the recipient is included in the response. If you do not specify this parameter, the effect is the default behavior (**false**)." + "name": "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": "start_position", - "in": "query", - "required": false, - "type": "string", - "description": "The zero-based index of the\nresult from which to start returning results.\n\nUse with `count` to limit the number\nof results.\n\nThe default value is `0`.\n" + "name": "templateId", + "in": "path", + "description": "The ID of the template.", + "required": true, + "type": "string" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/bulkRecipientsResponse" + "$ref": "#/definitions/documentVisibilityList" } }, "400": { @@ -17945,18 +17980,18 @@ } }, "deprecated": false, - "x-ds-methodname": "listBulkRecipients", - "x-ds-method": "list", - "x-ds-service": "Templates", + "x-ds-methodname": "getTemplateRecipientDocumentVisibility", + "description": "This method returns information about document visibility for a template recipient.", + "x-ds-method": "get", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, - "delete": { + "put": { "tags": [ - "TemplateBulkRecipients" + "TemplateDocumentVisibility" ], - "summary": "Deletes the bulk recipient list on a template.", - "description": "Deletes the bulk recipient list on a template.", - "operationId": "Recipients_DeleteTemplateBulkRecipientsFile", + "summary": "Updates document visibility for a template recipient", + "operationId": "Recipients_PutTemplateRecipientDocumentVisibility", "consumes": [], "produces": [], "parameters": [ @@ -17980,13 +18015,22 @@ "description": "The ID of the template.", "required": true, "type": "string" + }, + { + "name": "templateDocumentVisibilityList", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/templateDocumentVisibilityList" + }, + "description": "" } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/bulkRecipientsUpdateResponse" + "$ref": "#/definitions/templateDocumentVisibilityList" } }, "400": { @@ -17997,20 +18041,22 @@ } }, "deprecated": false, - "x-ds-methodname": "deleteBulkRecipients", - "x-ds-method": "delete", - "x-ds-service": "Templates", + "x-ds-methodname": "updateTemplateRecipientDocumentVisibility", + "description": "This method updates the document visibility for a template recipient.\n\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.", + "x-ds-method": "update", + "x-ds-service": "Envelopes", "x-ds-in-sdk": true }, "parameters": [] }, - "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/document_visibility": { + "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs": { "get": { "tags": [ - "TemplateDocumentVisibility" + "TemplateRecipientTabs" ], - "summary": "Returns document visibility for a template recipient", - "operationId": "Recipients_GetTemplateRecipientDocumentVisibility", + "summary": "Gets the tabs information for a signer or sign-in-person recipient in a template.", + "description": "Gets the tabs information for a signer or sign-in-person recipient in a template.", + "operationId": "Recipients_GetTemplateRecipientTabs", "consumes": [], "produces": [], "parameters": [ @@ -18034,13 +18080,27 @@ "description": "The ID of the template.", "required": true, "type": "string" + }, + { + "name": "include_anchor_tab_locations", + "in": "query", + "description": "When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**", + "required": false, + "type": "string" + }, + { + "name": "include_metadata", + "in": "query", + "required": false, + "type": "string", + "description": "When **true,** the response includes metadata indicating which properties are editable." } ], "responses": { "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/documentVisibilityList" + "$ref": "#/definitions/tabs" } }, "400": { @@ -18051,18 +18111,18 @@ } }, "deprecated": false, - "x-ds-methodname": "getTemplateRecipientDocumentVisibility", - "description": "This method returns information about document visibility for a template recipient.", - "x-ds-method": "get", - "x-ds-service": "Envelopes", + "x-ds-methodname": "listTabs", + "x-ds-method": "list", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, "put": { "tags": [ - "TemplateDocumentVisibility" + "TemplateRecipientTabs" ], - "summary": "Updates document visibility for a template recipient", - "operationId": "Recipients_PutTemplateRecipientDocumentVisibility", + "summary": "Updates the tabs for a recipient.", + "description": "Updates one or more tabs for a recipient in a template.", + "operationId": "Recipients_PutTemplateRecipientTabs", "consumes": [], "produces": [], "parameters": [ @@ -18088,11 +18148,11 @@ "type": "string" }, { - "name": "templateDocumentVisibilityList", + "name": "templateTabs", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/templateDocumentVisibilityList" + "$ref": "#/definitions/templateTabs" }, "description": "" } @@ -18101,7 +18161,7 @@ "200": { "description": "Successful response.", "schema": { - "$ref": "#/definitions/templateDocumentVisibilityList" + "$ref": "#/definitions/tabs" } }, "400": { @@ -18112,149 +18172,18 @@ } }, "deprecated": false, - "x-ds-methodname": "updateTemplateRecipientDocumentVisibility", - "description": "This method updates the document visibility for a template recipient.\n\n**Note:** A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all documents.", + "x-ds-methodname": "updateTabs", "x-ds-method": "update", - "x-ds-service": "Envelopes", + "x-ds-service": "Templates", "x-ds-in-sdk": true }, - "parameters": [] - }, - "/v2.1/accounts/{accountId}/templates/{templateId}/recipients/{recipientId}/tabs": { - "get": { + "post": { "tags": [ "TemplateRecipientTabs" ], - "summary": "Gets the tabs information for a signer or sign-in-person recipient in a template.", - "description": "Gets the tabs information for a signer or sign-in-person recipient in a template.", - "operationId": "Recipients_GetTemplateRecipientTabs", - "consumes": [], - "produces": [], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "include_anchor_tab_locations", - "in": "query", - "description": "When **true,** all tabs with anchor tab properties are included in the response. The default value is **false.**", - "required": false, - "type": "string" - }, - { - "name": "include_metadata", - "in": "query", - "required": false, - "type": "string", - "description": "When **true,** the response includes metadata indicating which properties are editable." - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/tabs" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "listTabs", - "x-ds-method": "list", - "x-ds-service": "Templates", - "x-ds-in-sdk": true - }, - "put": { - "tags": [ - "TemplateRecipientTabs" - ], - "summary": "Updates the tabs for a recipient.", - "description": "Updates one or more tabs for a recipient in a template.", - "operationId": "Recipients_PutTemplateRecipientTabs", - "consumes": [], - "produces": [], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "recipientId", - "in": "path", - "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", - "required": true, - "type": "string" - }, - { - "name": "templateId", - "in": "path", - "description": "The ID of the template.", - "required": true, - "type": "string" - }, - { - "name": "templateTabs", - "in": "body", - "required": false, - "schema": { - "$ref": "#/definitions/templateTabs" - }, - "description": "" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/tabs" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "updateTabs", - "x-ds-method": "update", - "x-ds-service": "Templates", - "x-ds-in-sdk": true - }, - "post": { - "tags": [ - "TemplateRecipientTabs" - ], - "summary": "Adds tabs for a recipient.", - "description": "Adds one or more tabs for a recipient.", - "operationId": "Recipients_PostTemplateRecipientTabs", + "summary": "Adds tabs for a recipient.", + "description": "Adds one or more tabs for a recipient.", + "operationId": "Recipients_PostTemplateRecipientTabs", "consumes": [], "produces": [], "parameters": [ @@ -24762,6 +24691,14 @@ "$ref": "#/definitions/settingsMetadata", "description": "" }, + "allowTransactionsWorkspace": { + "description": "", + "type": "string" + }, + "allowTransactionsWorkspaceMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "allowUsersToAccessDirectory": { "description": "", "type": "string" @@ -24786,6 +24723,14 @@ "$ref": "#/definitions/settingsMetadata", "description": "" }, + "allowWhatsAppDelivery": { + "description": "", + "type": "string" + }, + "allowWhatsAppDeliveryMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "anchorPopulationScope": { "description": "This property determines how template anchor tabs are applied.\n\nValid values are:\n\n- `document`: Anchor tabs are applied only to the document that you specify. \n- `envelope`: Anchor tabs are applied to all of the documents in the envelope associated with the template.\n\n**Note:** When you are using the `anchorPopulationScope` property with a Composite Template, the value `document` is supported only with a single server template and a single inline template.\n\n", "type": "string" @@ -25650,6 +25595,14 @@ "$ref": "#/definitions/settingsMetadata", "description": "Metadata that indicates whether the `enforceTemplateNameUniqueness` property is editable.\n" }, + "enforceTlsEmails": { + "description": "", + "type": "string" + }, + "enforceTlsEmailsMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "envelopeIntegrationAllowed": { "description": "Shows the envelope integration rule for the account, which indicates whether custom admins can enable Connect for their accounts. Enumeration values are: \n\n- `not_allowed`\n- `full` \n\n**Note:** Only SysAdmin users can change this setting. ", "type": "string" @@ -26067,6 +26020,10 @@ "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" }, + "sbsTransactionLevel": { + "description": "", + "type": "string" + }, "selfSignedRecipientEmailDocument": { "description": "Sets how self-signed documents are presented to the email recipients.\nValid values are:\n\n- `include_pdf`: A PDF of the completed document is attached to the email.\n- `include_link`: A secure link to the self-signed documents is included\n in the email.\n\n**Note:** Only Admin users can change this setting.\n", "type": "string" @@ -29534,118 +29491,6 @@ "description": "", "x-ms-summary": "" }, - "bulkRecipient": { - "type": "object", - "properties": { - "accessCode": { - "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required.", - "type": "string" - }, - "email": { - "description": "Specifies the recipient's email address. \n\nMaximum length: 100 characters.", - "type": "string" - }, - "errorDetails": { - "description": "Array or errors.", - "type": "array", - "items": { - "$ref": "#/definitions/errorDetails" - } - }, - "identification": { - "description": "Specifies the authentication check used for the signer. If blank then no authentication check is required for the signer. Only one value can be used in this field.\n\nValid values:\n\n* KBA: Enables the normal ID check authentication set up for your account.\n* Phone: Enables phone authentication.\n* SMS: Enables SMS authentication.", - "type": "string" - }, - "name": { - "description": "Specifies the recipient's name. \n\nMaximum length: 50 characters.", - "type": "string" - }, - "note": { - "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n", - "type": "string" - }, - "phoneNumber": { - "description": "This is only used if the Identification field value is Phone or SMS. The value for this field can be a valid telephone number or, if Phone, usersupplied (SMS authentication cannot use a user supplied number). Parenthesis and dashes can be used in the telephone number.\n\nIf `usersupplied` is used, the signer supplies his or her own telephone number.", - "type": "string" - }, - "recipientSignatureProviderInfo": { - "description": "", - "type": "array", - "items": { - "$ref": "#/definitions/bulkRecipientSignatureProvider" - } - }, - "rowNumber": { - "description": "", - "type": "string" - }, - "tabLabels": { - "description": "Specifies values used to populate recipient tabs with information. This allows each bulk recipient signer to have different values for their associated tabs. Any number of `tabLabel` columns can be added to the bulk recipient file.\n\nThe information used in the bulk recipient file header must be the same as the `tabLabel` for the tab.\n\nThe values entered in this column are automatically inserted into the corresponding tab for the recipient in the same row.\n\nNote that this option cannot be used for tabs that do not have data or that are automatically populated data such as Signature, Full Name, Email Address, Company, Title, and Date Signed tabs.", - "type": "array", - "items": { - "$ref": "#/definitions/bulkRecipientTabLabel" - } - } - }, - "x-ds-definition-name": "bulkRecipient", - "description": "", - "x-ms-summary": "" - }, - "bulkRecipientSignatureProvider": { - "type": "object", - "properties": { - "name": { - "description": "", - "type": "string" - }, - "value": { - "description": "Specifies the value of the tab. ", - "type": "string" - } - }, - "x-ds-definition-name": "bulkRecipientSignatureProvider", - "description": "", - "x-ms-summary": "" - }, - "bulkRecipientsResponse": { - "type": "object", - "properties": { - "bulkRecipients": { - "description": "A complex type containing information about the bulk recipients in the response.", - "type": "array", - "items": { - "$ref": "#/definitions/bulkRecipient" - } - }, - "endPosition": { - "description": "The last index position in the result set. ", - "type": "string" - }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", - "type": "string" - }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", - "type": "string" - }, - "resultSetSize": { - "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", - "type": "string" - }, - "startPosition": { - "description": "The starting index position of the current result set.", - "type": "string" - }, - "totalSetSize": { - "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "string" - } - }, - "x-ds-definition-name": "bulkRecipientsResponse", - "description": "", - "x-ms-summary": "" - }, "bulkRecipientsUpdateResponse": { "type": "object", "properties": { @@ -29658,22 +29503,6 @@ "description": "", "x-ms-summary": "" }, - "bulkRecipientTabLabel": { - "type": "object", - "properties": { - "name": { - "description": "", - "type": "string" - }, - "value": { - "description": "Specifies the value of the tab. ", - "type": "string" - } - }, - "x-ds-definition-name": "bulkRecipientTabLabel", - "description": "", - "x-ms-summary": "" - }, "bulkSendBatchActionRequest": { "type": "object", "properties": { @@ -30095,6 +29924,10 @@ "description": "", "type": "string" }, + "identityVerification": { + "$ref": "#/definitions/recipientIdentityVerification", + "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)." + }, "name": { "description": "", "type": "string" @@ -39685,6 +39518,10 @@ "description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.", "type": "string" }, + "burnDefaultTabData": { + "description": "", + "type": "string" + }, "certificateUri": { "description": "The URI for retrieving certificate information.", "type": "string" @@ -40136,6 +39973,10 @@ "description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.", "type": "string" }, + "burnDefaultTabData": { + "description": "", + "type": "string" + }, "certificateUri": { "description": "The URI for retrieving certificate information.", "type": "string" @@ -41381,6 +41222,10 @@ "description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.", "type": "string" }, + "burnDefaultTabData": { + "description": "", + "type": "string" + }, "certificateUri": { "description": "The URI for retrieving certificate information.", "type": "string" @@ -46822,6 +46667,10 @@ "timeZone": { "description": "", "type": "string" + }, + "useLongCurrencyFormat": { + "description": "", + "type": "string" } }, "x-ds-definition-name": "localePolicyTab", @@ -49904,6 +49753,481 @@ "x-ds-definition-name": "number", "x-ms-summary": "A tab that allows the recipient to enter numbers and decimal\n(.) points.\n" }, + "numerical": { + "type": "object", + "properties": { + "anchorAllowWhiteSpaceInCharacters": { + "description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, Docu   Sign will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then Docu   Sign will match.\n\nThe default value is **true.**\n", + "type": "string" + }, + "anchorAllowWhiteSpaceInCharactersMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable." + }, + "anchorCaseSensitive": { + "description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **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]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/", + "type": "string" + }, + "anchorCaseSensitiveMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorCaseSensitive` property is editable." + }, + "anchorHorizontalAlignment": { + "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n", + "type": "string" + }, + "anchorHorizontalAlignmentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorHorizontalAlignment` property is editable." + }, + "anchorIgnoreIfNotPresent": { + "description": "When **true,** this tab is ignored if the `anchorString` is not found in the document.", + "type": "string" + }, + "anchorIgnoreIfNotPresentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable." + }, + "anchorMatchWholeWord": { + "description": "When **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 **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]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n", + "type": "string" + }, + "anchorMatchWholeWordMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorMatchWholeWord` property is editable." + }, + "anchorString": { + "description": "Specifies the string to find in the document and use as the basis for tab placement.", + "type": "string" + }, + "anchorStringMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorString` property is editable." + }, + "anchorTabProcessorVersion": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "anchorTabProcessorVersionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "anchorUnits": { + "description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n", + "type": "string" + }, + "anchorUnitsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorUnits` property is editable." + }, + "anchorXOffset": { + "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", + "type": "string" + }, + "anchorXOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorXOffset` property is editable." + }, + "anchorYOffset": { + "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n", + "type": "string" + }, + "anchorYOffsetMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `anchorYOffset` property is editable." + }, + "bold": { + "description": "When **true,** the information in the tab is bold.", + "type": "string" + }, + "boldMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `bold` property is editable." + }, + "caption": { + "description": "", + "type": "string" + }, + "captionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "" + }, + "concealValueOnDocument": { + "description": "When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is only available to the sender through the Form Data link in the DocuSign Console. The information on the downloaded document remains masked by asterisks.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.", + "type": "string" + }, + "concealValueOnDocumentMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `concealValueOnDocument` property is editable." + }, + "conditionalParentLabel": { + "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.", + "type": "string" + }, + "conditionalParentLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentLabel` property is editable." + }, + "conditionalParentValue": { + "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n", + "type": "string" + }, + "conditionalParentValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `conditionalParentValue` property is editable." + }, + "customTabId": { + "description": "The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.", + "type": "string" + }, + "customTabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `customTabId` property is editable." + }, + "disableAutoSize": { + "description": "When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.", + "type": "string" + }, + "disableAutoSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `disableAutoSize` property is editable." + }, + "documentId": { + "description": "The unique ID of the document within the envelope.\n\nUnlike other IDs in the eSignature API,\nyou specify the `documentId` yourself.\nTypically the first document has the ID\n`1`, the second document `2`, and so on,\nbut you can use any numbering scheme\nthat fits within a 32-bit signed integer\n(1 through 2147483647).\n\n\nTab objects have a `documentId` property\nthat specifies the document on which to place\nthe tab.\n", + "type": "string" + }, + "documentIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `documentId` property is editable." + }, + "errorDetails": { + "$ref": "#/definitions/errorDetails", + "description": "This object describes errors that occur. It is only valid for responses and ignored in requests." + }, + "font": { + "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n", + "type": "string" + }, + "fontColor": { + "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n", + "type": "string" + }, + "fontColorMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontColor` property is editable." + }, + "fontMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `font` property is editable." + }, + "fontSize": { + "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72", + "type": "string" + }, + "fontSizeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fontSize` property is editable." + }, + "formOrder": { + "description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.", + "type": "string" + }, + "formOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formOrder` property is editable." + }, + "formPageLabel": { + "description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.", + "type": "string" + }, + "formPageLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `formPageLabel` property is editable." + }, + "formPageNumber": { + "description": "An integer specifying the order in which to present the guided form pages.", + "type": "string" + }, + "formPageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `fromPageNumber` property is editable." + }, + "height": { + "description": "The height of the tab in pixels.", + "type": "string" + }, + "heightMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `height` property is editable." + }, + "italic": { + "description": "When **true,** the information in the tab is italic.", + "type": "string" + }, + "italicMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `italic` property is editable." + }, + "localePolicy": { + "$ref": "#/definitions/localePolicyTab", + "description": "Reserved for DocuSign." + }, + "locked": { + "description": "When **true,** the signer cannot change the data of the custom tab.", + "type": "string" + }, + "lockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `locked` property is editable." + }, + "maxLength": { + "description": "An optional value that describes the maximum length of the property when the property is a string.", + "type": "string" + }, + "maxLengthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `maxLength` property is editable." + }, + "maxNumericalValue": { + "description": "", + "type": "string" + }, + "mergeField": { + "$ref": "#/definitions/mergeField", + "description": "Contains the information necessary to map the tab to a field in SalesForce." + }, + "mergeFieldXml": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "minNumericalValue": { + "description": "", + "type": "string" + }, + "name": { + "description": "", + "type": "string" + }, + "nameMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `name` property is editable. This property is read-only." + }, + "numericalValue": { + "description": "", + "type": "string" + }, + "originalValue": { + "description": "The initial value of the tab when it was sent to the recipient. ", + "type": "string" + }, + "originalValueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `originalValue` property is editable." + }, + "pageNumber": { + "description": "The page number being accessed.", + "type": "string" + }, + "pageNumberMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `pageNumber` property is editable." + }, + "recipientId": { + "description": "A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`.", + "type": "string" + }, + "recipientIdGuid": { + "description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.", + "type": "string" + }, + "recipientIdGuidMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientIdGuid` property is editable." + }, + "recipientIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `recipientId` property is editable." + }, + "requireAll": { + "description": "When **true** and shared is true, information must be entered in this field to complete the envelope. ", + "type": "string" + }, + "requireAllMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireAll` property is editable." + }, + "required": { + "description": "When **true,** the signer is required to fill out this tab.", + "type": "string" + }, + "requiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `required` property is editable." + }, + "requireInitialOnSharedChange": { + "description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.", + "type": "string" + }, + "requireInitialOnSharedChangeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `requireInitialOnSharedChange` property is editable." + }, + "senderRequired": { + "description": "When **true,** the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope.", + "type": "string" + }, + "senderRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `senderRequired` property is editable." + }, + "shared": { + "description": "When **true,** the tab is shared.", + "type": "string" + }, + "sharedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `shared` property is editable." + }, + "shareToRecipients": { + "description": "Reserved for DocuSign.", + "type": "string" + }, + "shareToRecipientsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Reserved for DocuSign." + }, + "smartContractInformation": { + "$ref": "#/definitions/smartContractInformation", + "description": "Reserved for DocuSign." + }, + "source": { + "description": "", + "type": "string" + }, + "status": { + "description": "The status of the item.", + "type": "string" + }, + "statusMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `status` property is editable." + }, + "tabGroupLabels": { + "description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array.", + "type": "array", + "items": { + "type": "string" + } + }, + "tabGroupLabelsMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabGroupLabels` property is editable." + }, + "tabId": { + "description": "The unique identifier for the tab.", + "type": "string" + }, + "tabIdMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabId` property is editable." + }, + "tabLabel": { + "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n", + "type": "string" + }, + "tabLabelMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabLabel` property is editable." + }, + "tabOrder": { + "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used.", + "type": "string" + }, + "tabOrderMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabOrder` property is editable." + }, + "tabType": { + "description": "Indicates the type of tab (for example, `signHere` or `initialHere`).", + "type": "string" + }, + "tabTypeMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `tabType` property is editable." + }, + "templateLocked": { + "description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. ", + "type": "string" + }, + "templateLockedMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateLocked` property is editable." + }, + "templateRequired": { + "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients.", + "type": "string" + }, + "templateRequiredMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `templateRequired` property is editable." + }, + "tooltip": { + "description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n", + "type": "string" + }, + "toolTipMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `toolTip` property is editable.\n" + }, + "underline": { + "description": "When **true,** the information in the tab is underlined.", + "type": "string" + }, + "underlineMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `underline` property is editable." + }, + "validationType": { + "description": "", + "type": "string" + }, + "value": { + "description": "Specifies the value of the tab. ", + "type": "string" + }, + "valueMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `value` property is editable." + }, + "width": { + "description": "The width of the tab in pixels.", + "type": "string" + }, + "widthMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `width` property is editable." + }, + "xPosition": { + "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "type": "string" + }, + "xPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `xPosition` property is editable." + }, + "yPosition": { + "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. May be zero.\n", + "type": "string" + }, + "yPositionMetadata": { + "$ref": "#/definitions/propertyMetadata", + "description": "Metadata that indicates whether the `yPosition` property is editable." + } + }, + "x-ds-definition-name": "numerical", + "description": "", + "x-ms-summary": "" + }, "oauthAccess": { "type": "object", "properties": { @@ -52769,6 +53093,10 @@ "workflowIdMetadata": { "$ref": "#/definitions/propertyMetadata", "description": "" + }, + "workflowLabel": { + "description": "", + "type": "string" } }, "description": "Specifies ID Verification applied on an envelope by workflow ID.\nSee the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/)\nmethod in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource\nfor more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods.", @@ -58002,6 +58330,10 @@ "description": "A regular expression used to validate input for the tab.", "type": "string" }, + "validationType": { + "description": "", + "type": "string" + }, "width": { "description": "The width of the tab in pixels.", "type": "string" @@ -58211,6 +58543,13 @@ "$ref": "#/definitions/number" } }, + "numericalTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/numerical" + } + }, "phoneNumberTabs": { "description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/", "type": "array", @@ -58538,6 +58877,10 @@ "description": "When **true,** this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient.", "type": "string" }, + "deliveryMethod": { + "description": "Reserved for DocuSign.", + "type": "string" + }, "email": { "description": "The email address of the person associated with a role name. It is the email address of the person specified in the `name` property.\n\nFor an in-person signer, this is the email address of the host.", "type": "string" @@ -58861,6 +59204,13 @@ "$ref": "#/definitions/number" } }, + "numericalTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/numerical" + } + }, "phoneNumberTabs": { "description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/", "type": "array", @@ -63667,6 +64017,13 @@ "$ref": "#/definitions/number" } }, + "numericalTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/numerical" + } + }, "phoneNumberTabs": { "description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/", "type": "array", @@ -63947,6 +64304,13 @@ "$ref": "#/definitions/number" } }, + "numericalTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/numerical" + } + }, "phoneNumberTabs": { "description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/", "type": "array", @@ -64227,6 +64591,13 @@ "$ref": "#/definitions/number" } }, + "numericalTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/numerical" + } + }, "phoneNumberTabs": { "description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/", "type": "array", @@ -65201,6 +65572,10 @@ "description": "A regular expression used to validate input for the tab.", "type": "string" }, + "validationType": { + "description": "", + "type": "string" + }, "width": { "description": "The width of the tab in pixels.", "type": "string" @@ -65530,6 +65905,10 @@ "description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.", "type": "string" }, + "burnDefaultTabData": { + "description": "", + "type": "string" + }, "certificateUri": { "description": "The URI for retrieving certificate information.", "type": "string" @@ -66148,45 +66527,9 @@ "x-ms-summary": "Template recipients" }, "TemplateBulkRecipients": { - "type": "object", - "properties": { - "bulkRecipients": { - "description": "A complex type containing information about the bulk recipients in the response.", - "type": "array", - "items": { - "$ref": "#/definitions/bulkRecipient" - } - }, - "endPosition": { - "description": "The last index position in the result set. ", - "type": "string" - }, - "nextUri": { - "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. ", - "type": "string" - }, - "previousUri": { - "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. ", - "type": "string" - }, - "resultSetSize": { - "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.", - "type": "string" - }, - "startPosition": { - "description": "The starting index position of the current result set.", - "type": "string" - }, - "totalSetSize": { - "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.", - "type": "string" - } - }, - "x-ds-definition-name": "bulkRecipientsResponse", - "description": "Template bulk recipients", "x-ds-category": "Templates", - "x-ds-order": "30", - "x-ms-summary": "Template bulk recipients" + "x-ms-summary": "Template bulk recipients", + "description": "Template bulk recipients" }, "TemplateCustomFields": { "description": "A template custom field enables you to prepopulate custom metadata for all new envelopes that are created by using a specific template. You can then use the custom data for sorting, organizing, searching, and other downstream processes.", @@ -66355,6 +66698,10 @@ "description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.", "type": "string" }, + "burnDefaultTabData": { + "description": "", + "type": "string" + }, "certificateUri": { "description": "The URI for retrieving certificate information.", "type": "string" @@ -66909,6 +67256,13 @@ "$ref": "#/definitions/number" } }, + "numericalTabs": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/numerical" + } + }, "phoneNumberTabs": { "description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/", "type": "array",