From b077a6adea61f02efe90b4f75027e5d527276a57 Mon Sep 17 00:00:00 2001 From: rituraj-chanda Date: Wed, 6 May 2026 18:33:38 +0530 Subject: [PATCH 1/2] TIR - Updated esignature.rest.swagger-v2.1.json --- esignature.rest.swagger-v2.1.json | 518 ++++++++++++++++++++++++------ 1 file changed, 427 insertions(+), 91 deletions(-) diff --git a/esignature.rest.swagger-v2.1.json b/esignature.rest.swagger-v2.1.json index 5f1f3f3..37e47ab 100644 --- a/esignature.rest.swagger-v2.1.json +++ b/esignature.rest.swagger-v2.1.json @@ -3633,6 +3633,124 @@ }, "parameters": [] }, + "/v2.1/accounts/{accountId}/connect/secret": { + "get": { + "tags": [ + "ConnectConfiguration" + ], + "summary": "", + "operationId": "ConnectHMAC_GetConnectSecret", + "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." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "getConnectSecret", + "x-ds-method": "getConnectSecret", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "post": { + "tags": [ + "ConnectConfiguration" + ], + "summary": "Generates a new connect HMAC Secret.", + "operationId": "ConnectHMAC_CreateConnectSecret", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "createConnectSecret", + "x-ds-method": "createConnectSecret", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, + "/v2.1/accounts/{accountId}/connect/secret/{keyId}": { + "delete": { + "tags": [ + "ConnectConfiguration" + ], + "summary": "Deletes the connect HMAC Secret for specified account.", + "operationId": "ConnectHMAC_DeleteConnectSecret", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "accountId", + "in": "path", + "description": "The external account number (int) or account ID GUID.", + "required": true, + "type": "string" + }, + { + "name": "keyId", + "in": "path", + "required": true, + "type": "string", + "description": "" + } + ], + "responses": { + "200": { + "description": "Successful response." + }, + "400": { + "description": "Error encountered.", + "schema": { + "$ref": "#/definitions/errorDetails" + } + } + }, + "deprecated": false, + "x-ds-methodname": "deleteConnectSecret", + "x-ds-method": "deleteConnectSecret", + "x-ds-service": "Uncategorized", + "description": "", + "x-ds-in-sdk": true + }, + "parameters": [] + }, "/v2.1/accounts/{accountId}/consumer_disclosure": { "get": { "tags": [ @@ -5894,6 +6012,13 @@ "type": "string", "description": "Reserved for Docusign." }, + { + "name": "include_is_edited", + "in": "query", + "required": false, + "type": "string", + "description": "" + }, { "name": "include_metadata", "in": "query", @@ -13093,54 +13218,6 @@ }, "parameters": [] }, - "/v2.1/accounts/{accountId}/recipient_names": { - "get": { - "tags": [ - "Accounts" - ], - "summary": "Gets the recipient names associated with an email address.", - "description": "Retrieves a list of all of the names associated with the email address that you pass in. This list can include variants of a single recipient's name that are used for signing, as well as the names of multiple different recipients.", - "operationId": "RecipientNames_GetRecipientNames", - "consumes": [], - "produces": [], - "parameters": [ - { - "name": "accountId", - "in": "path", - "description": "The external account number (int) or account ID GUID.", - "required": true, - "type": "string" - }, - { - "name": "email", - "in": "query", - "description": "(Required) The email address for which you want to retrieve recipient names.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "$ref": "#/definitions/recipientNamesResponse" - } - }, - "400": { - "description": "Error encountered.", - "schema": { - "$ref": "#/definitions/errorDetails" - } - } - }, - "deprecated": false, - "x-ds-methodname": "listRecipientNamesByEmail", - "x-ds-method": "listRecipientNamesByEmail", - "x-ds-service": "Accounts", - "x-ds-in-sdk": true - }, - "parameters": [] - }, "/v2.1/accounts/{accountId}/seals": { "get": { "tags": [ @@ -15569,6 +15646,13 @@ "type": "string", "description": "When **true,** downloads the templates listed in `template_ids` as a collection of JSON definitions in a single zip file.\n\nThe `Content-Disposition` header is set in the response. The value of the header provides the filename of the file.\n\nThe default is **false.**\n\n**Note:** This parameter only works when you specify a list of templates in the `template_ids` parameter." }, + { + "name": "link_configuration_id", + "in": "query", + "required": false, + "type": "string", + "description": "" + }, { "name": "modified_from_date", "in": "query", @@ -16260,6 +16344,13 @@ "type": "string", "description": "" }, + { + "name": "include_is_edited", + "in": "query", + "required": false, + "type": "string", + "description": "" + }, { "name": "include_tabs", "in": "query", @@ -24002,6 +24093,11 @@ "description": "The name of the Identity Verification workflow.", "type": "string" }, + "displayOrder": { + "format": "int32", + "description": "The position on the page where the display section appears.", + "type": "string" + }, "inputOptions": { "description": "", "type": "array", @@ -26526,6 +26622,14 @@ "$ref": "#/definitions/settingsMetadata", "description": "" }, + "enableCacPivSignatureGroup": { + "description": "", + "type": "string" + }, + "enableCacPivSignatureGroupMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "enableCalculatedFields": { "description": "When **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" @@ -26626,6 +26730,14 @@ "$ref": "#/definitions/settingsMetadata", "description": "" }, + "enableCoupaIAMConnector": { + "description": "", + "type": "string" + }, + "enableCoupaIAMConnectorMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "enableCustomDataVerificationExtensions": { "description": "", "type": "string" @@ -26790,6 +26902,30 @@ "$ref": "#/definitions/settingsMetadata", "description": "" }, + "enableGreenhouseApp": { + "description": "", + "type": "string" + }, + "enableGreenhouseAppMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableI9OnDemand": { + "description": "", + "type": "string" + }, + "enableI9OnDemandMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, + "enableIAMClauseLibrary": { + "description": "", + "type": "string" + }, + "enableIAMClauseLibraryMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "enableIDFxAccountlessSMSAuthForPart11": { "description": "", "type": "string" @@ -27318,6 +27454,14 @@ "$ref": "#/definitions/settingsMetadata", "description": "" }, + "enableWorkdayHRApp": { + "description": "", + "type": "string" + }, + "enableWorkdayHRAppMetadata": { + "$ref": "#/definitions/settingsMetadata", + "description": "" + }, "enforceTemplateNameUniqueness": { "description": "When **true,** the template name must be unique.", "type": "string" @@ -37259,6 +37403,10 @@ "contact": { "type": "object", "properties": { + "canManage": { + "description": "", + "type": "string" + }, "cloudProvider": { "description": "The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)\n\n", "type": "string" @@ -38524,6 +38672,10 @@ "$ref": "#/definitions/propertyMetadata", "description": "Metadata that indicates whether the `templateRequired` property is editable." }, + "timestampStandardized": { + "description": "", + "type": "string" + }, "tooltip": { "description": "**Note:** Date Signed tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient.\n", "type": "string" @@ -41933,10 +42085,6 @@ "description": "The data and time that the status changed.", "type": "string" }, - "statusDateTime": { - "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", - "type": "string" - }, "templatesUri": { "description": "The URI for retrieving the templates.", "type": "string" @@ -42422,10 +42570,6 @@ "description": "The data and time that the status changed.", "type": "string" }, - "statusDateTime": { - "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", - "type": "string" - }, "templateId": { "description": "The ID of the template. If a value is not provided, Docusign generates a value. ", "type": "string" @@ -42600,6 +42744,10 @@ "description": "", "type": "string" }, + "isEdited": { + "description": "", + "type": "string" + }, "isExternallyAvailable": { "description": "", "type": "string" @@ -43888,10 +44036,6 @@ "description": "The data and time that the status changed.", "type": "string" }, - "statusDateTime": { - "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", - "type": "string" - }, "templateId": { "description": "The unique identifier of the template. If this is not provided, Docusign will generate a value. ", "type": "string" @@ -56758,29 +56902,6 @@ "x-ds-definition-name": "recipientIdentityVerification", "x-ms-summary": "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/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods." }, - "recipientNamesResponse": { - "type": "object", - "properties": { - "multipleUsers": { - "description": "When **true,** the email address is used by more than one user.", - "type": "string" - }, - "recipientNames": { - "description": "The names of the recipients associated with the email address.", - "type": "array", - "items": { - "type": "string" - } - }, - "reservedRecipientEmail": { - "description": "When **true,** new names cannot be added to the email address.", - "type": "string" - } - }, - "description": "This response object contains a list of recipients.", - "x-ds-definition-name": "recipientNamesResponse", - "x-ms-summary": "This response object contains a list of recipients." - }, "recipientOption": { "type": "object", "properties": { @@ -57458,6 +57579,10 @@ "reminderFrequency": { "description": "An integer specifying the interval in days between reminder emails. The default value is 0.", "type": "string" + }, + "smartReminderEnabled": { + "description": "", + "type": "string" } }, "x-ds-definition-name": "reminders", @@ -58206,6 +58331,57 @@ "description": "", "x-ms-summary": "" }, + "senderCompletionInfo": { + "type": "object", + "properties": { + "completed": { + "format": "int32", + "description": "", + "type": "string" + }, + "completionRate": { + "format": "double", + "description": "", + "type": "string" + }, + "expired": { + "format": "int32", + "description": "", + "type": "string" + }, + "expiredRate": { + "format": "double", + "description": "", + "type": "string" + }, + "name": { + "description": "", + "type": "string" + }, + "senderId": { + "description": "", + "type": "string" + }, + "sent": { + "format": "int32", + "description": "The number of entries with a status of `sent`.", + "type": "string" + }, + "voided": { + "format": "int32", + "description": "", + "type": "string" + }, + "voidedRate": { + "format": "double", + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "senderCompletionInfo", + "description": "", + "x-ms-summary": "" + }, "senderEmailNotifications": { "type": "object", "properties": { @@ -62549,6 +62725,114 @@ "description": "", "x-ms-summary": "" }, + "templateCompletionInfo": { + "type": "object", + "properties": { + "completed": { + "format": "int32", + "description": "", + "type": "string" + }, + "completionRate": { + "format": "double", + "description": "", + "type": "string" + }, + "expired": { + "format": "int32", + "description": "", + "type": "string" + }, + "expiredRate": { + "format": "double", + "description": "", + "type": "string" + }, + "name": { + "description": "", + "type": "string" + }, + "sent": { + "format": "int32", + "description": "The number of entries with a status of `sent`.", + "type": "string" + }, + "templateId": { + "description": "The ID of the template.", + "type": "string" + }, + "voided": { + "format": "int32", + "description": "", + "type": "string" + }, + "voidedRate": { + "format": "double", + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "templateCompletionInfo", + "description": "", + "x-ms-summary": "" + }, + "templateCompletionRateResponse": { + "type": "object", + "properties": { + "bottomSenders": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/senderCompletionInfo" + } + }, + "completed": { + "format": "int32", + "description": "", + "type": "string" + }, + "completionRate": { + "format": "double", + "description": "", + "type": "string" + }, + "expired": { + "format": "int32", + "description": "", + "type": "string" + }, + "expiredRate": { + "format": "double", + "description": "", + "type": "string" + }, + "sent": { + "format": "int32", + "description": "The number of entries with a status of `sent`.", + "type": "string" + }, + "topSenders": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/senderCompletionInfo" + } + }, + "voided": { + "format": "int32", + "description": "", + "type": "string" + }, + "voidedRate": { + "format": "double", + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "templateCompletionRateResponse", + "description": "", + "x-ms-summary": "" + }, "templateCustomFields": { "type": "object", "properties": { @@ -64736,6 +65020,53 @@ "description": "", "x-ms-summary": "" }, + "userCompletionRateResponse": { + "type": "object", + "properties": { + "bottomTemplates": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/templateCompletionInfo" + } + }, + "completed": { + "format": "int32", + "description": "", + "type": "string" + }, + "completionRate": { + "format": "double", + "description": "", + "type": "string" + }, + "expired": { + "format": "int32", + "description": "", + "type": "string" + }, + "sent": { + "format": "int32", + "description": "The number of entries with a status of `sent`.", + "type": "string" + }, + "topTemplates": { + "description": "", + "type": "array", + "items": { + "$ref": "#/definitions/templateCompletionInfo" + } + }, + "voided": { + "format": "int32", + "description": "", + "type": "string" + } + }, + "x-ds-definition-name": "userCompletionRateResponse", + "description": "", + "x-ms-summary": "" + }, "userInfo": { "type": "object", "properties": { @@ -70658,10 +70989,6 @@ "description": "The data and time that the status changed.", "type": "string" }, - "statusDateTime": { - "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", - "type": "string" - }, "templatesUri": { "description": "The URI for retrieving the templates.", "type": "string" @@ -71550,10 +71877,6 @@ "description": "The data and time that the status changed.", "type": "string" }, - "statusDateTime": { - "description": "The DateTime that the envelope changed status (i.e. was created or sent.)", - "type": "string" - }, "templateId": { "description": "The unique identifier of the template. If this is not provided, Docusign will generate a value. ", "type": "string" @@ -72313,6 +72636,10 @@ "Contacts": { "type": "object", "properties": { + "canManage": { + "description": "", + "type": "string" + }, "cloudProvider": { "description": "The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)\n\n", "type": "string" @@ -74450,6 +74777,11 @@ "x-ds-category": "Envelopes", "x-ds-order": "100", "x-ms-summary": "" + }, + "ConnectConfiguration": { + "x-ds-category": "Connect", + "x-ms-summary": "", + "description": "" } }, "parameters": {}, @@ -74828,6 +75160,10 @@ { "name": "EnvelopeShares", "description": "" + }, + { + "name": "ConnectConfiguration", + "description": "" } ], "x-ds-categories": [ From 7749081c6a950c93639548c9a93f425ccda66ea7 Mon Sep 17 00:00:00 2001 From: rituraj-chanda Date: Fri, 8 May 2026 12:29:19 +0530 Subject: [PATCH 2/2] TIR - Updated esignature.rest.swagger-v2.1.json