Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 119 additions & 7 deletions esignature.rest.swagger-v2.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -24978,6 +24978,10 @@
"description": "",
"type": "string"
},
"allowConnectEnvelopeReminderSentEventUI": {
"description": "",
"type": "string"
},
"allowConnectEnvelopeRemovedEvent": {
"description": "",
"type": "string"
Expand Down Expand Up @@ -25970,6 +25974,14 @@
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"disableLegacyKba": {
"description": "",
"type": "string"
},
"disableLegacyKbaMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"disableLegacySharedEnvelopes": {
"description": "",
"type": "string"
Expand Down Expand Up @@ -26222,19 +26234,19 @@
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"enableAISuggestedFieldsAdvanced": {
"enableAISuggestedFields": {
"description": "",
"type": "string"
},
"enableAISuggestedFieldsAdvancedMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"enableAISuggestedFieldsBasic": {
"enableAISuggestedFieldsAutoPlace": {
"description": "",
"type": "string"
},
"enableAISuggestedFieldsBasicMetadata": {
"enableAISuggestedFieldsAutoPlaceMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"enableAISuggestedFieldsMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
Expand Down Expand Up @@ -26270,6 +26282,14 @@
"$ref": "#/definitions/settingsMetadata",
"description": "Metadata that indicates whether the `enableCalculatedFields` property is editable.\n"
},
"enableCFRRapidSigningEmbeddedAuth": {
"description": "",
"type": "string"
},
"enableCFRRapidSigningEmbeddedAuthMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"enableClickPlus": {
"description": "",
"type": "string"
Expand Down Expand Up @@ -26622,6 +26642,30 @@
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"enableNavigatorAPIDataIn": {
"description": "",
"type": "string"
},
"enableNavigatorAPIDataInMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"enableNavigatorAPIDataOut": {
"description": "",
"type": "string"
},
"enableNavigatorAPIDataOutMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"enableNavigatorAPIUtilities": {
"description": "",
"type": "string"
},
"enableNavigatorAPIUtilitiesMetadata": {
"$ref": "#/definitions/settingsMetadata",
"description": ""
},
"enableNavigatorForHR": {
"description": "",
"type": "string"
Expand Down Expand Up @@ -28422,13 +28466,21 @@
"description": "Reserved for Docusign.",
"type": "string"
},
"signatureProviderOptionHintOverrideValue": {
"description": "",
"type": "string"
},
"signatureProviderOptionId": {
"description": "Reserved for Docusign.",
"type": "string"
},
"signatureProviderOptionName": {
"description": "Reserved for Docusign.",
"type": "string"
},
"signatureProviderOptionRegexValidationPattern": {
"description": "",
"type": "string"
}
},
"description": "Reserved for Docusign.",
Expand Down Expand Up @@ -30636,6 +30688,10 @@
"$ref": "#/definitions/brandLink"
}
},
"logoIds": {
"$ref": "#/definitions/brandLogoIds",
"description": ""
},
"logos": {
"$ref": "#/definitions/brandLogos",
"description": "The URIs for retrieving the logos that are associated with the brand."
Expand Down Expand Up @@ -30701,6 +30757,26 @@
"x-ds-definition-name": "brandLink",
"x-ms-summary": "Information about a link that a brand uses."
},
"brandLogoIds": {
"type": "object",
"properties": {
"emailLogoId": {
"description": "",
"type": "string"
},
"primaryLogoId": {
"description": "",
"type": "string"
},
"secondaryLogoId": {
"description": "",
"type": "string"
}
},
"x-ds-definition-name": "brandLogoIds",
"description": "",
"x-ms-summary": ""
},
"brandLogos": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -36079,6 +36155,10 @@
"description": "When **true,** Connect logging is turned on. Docusign recommends that you enable this functionality to help 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 Connect console.\n\nThis property is required.",
"type": "string"
},
"enableOAuthPerConfiguration": {
"description": "",
"type": "string"
},
"envelopeEvents": {
"description": "A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property.\n\nWhen using any of\n[the legacy event message formats](/platform/webhooks/connect/legacy-message-formats/),\nyou must include either the `envelopeEvents` property\nor the `recipientEvents` property.\nIf you are instead using the\n[JSON SIM event model](/platform/webhooks/connect/json-sim-event-model/),\nuse the [`events`](/docs/esign-rest-api/reference/connect/connectconfigurations/create/#schema__connectcustomconfiguration_events) property.\n\nThe [possible event statuses](/platform/webhooks/connect/event-triggers/) are:\n\n* `Sent`\n* `Delivered`\n* `Completed`\n* `Declined`\n* `Voided`\n\n**Note:** These values are case-sensitive.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.",
"type": "array",
Expand Down Expand Up @@ -36156,6 +36236,10 @@
"description": "The name of the Connect configuration.\n\nThis property is required.",
"type": "string"
},
"oAuthConfiguration": {
"$ref": "#/definitions/connectOAuthConfig",
"description": ""
},
"password": {
"description": "The password for the Connect configuration.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.\n",
"type": "string"
Expand Down Expand Up @@ -41465,6 +41549,10 @@
"description": "When **true,** indicates that the envelope is a signature-provided envelope.",
"type": "string"
},
"isTicketRelatedEnvelope": {
"description": "",
"type": "string"
},
"lastModifiedDateTime": {
"description": "The date and time that the item was last modified.",
"type": "string"
Expand Down Expand Up @@ -41942,6 +42030,10 @@
"description": "When **true,** indicates that the envelope is a signature-provided envelope.",
"type": "string"
},
"isTicketRelatedEnvelope": {
"description": "",
"type": "string"
},
"lastModifiedDateTime": {
"description": "The date and time that the item was last modified.",
"type": "string"
Expand Down Expand Up @@ -43275,6 +43367,10 @@
"description": "When **true,** indicates that the envelope is a signature-provided envelope.",
"type": "string"
},
"isTicketRelatedEnvelope": {
"description": "",
"type": "string"
},
"lastModified": {
"description": "The UTC date and time that the comment was last updated.\n\n**Note:** This can only be done by the creator.",
"type": "string"
Expand Down Expand Up @@ -68654,6 +68750,10 @@
"description": "When **true,** Connect logging is turned on. Docusign recommends that you enable this functionality to help 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 Connect console.",
"type": "string"
},
"enableOAuthPerConfiguration": {
"description": "",
"type": "string"
},
"envelopeEvents": {
"description": "An array of strings that lists envelope-related events to track through Connect. The possible event values are: \n\n- `sent`: An envelope has the status `sent` in the following scenarios:\n - When the envelope has been sent to recipients.\n - When using remote signing, this event is triggered when the email notification with a link to the documents is sent to at least one recipient.\n - When using embedded signing, this event is triggered when the link is ready for the recipient to sign the envelope.\n\n An envelope remains in this state until all recipients have viewed or taken action on the envelope.\n\n- `delivered`: This status is triggered when all recipients have opened the envelope, selected the **Continue** button in the interface, and viewed the documents.\n- `completed`: This status is triggered when all recipients have completed their assigned actions on an envelope.\n- `declined`: This status is triggered when a recipient has declined to sign the envelope.\n- `voided`: The voided status indicates that the sender has voided the envelope.\n\n**Note:** In previous versions of the API, this value was a single comma-separated string.\n",
"type": "array",
Expand Down Expand Up @@ -68731,6 +68831,10 @@
"description": "The name of the Connect configuration. The name helps identify the configuration in the list.",
"type": "string"
},
"oAuthConfiguration": {
"$ref": "#/definitions/connectOAuthConfig",
"description": ""
},
"password": {
"description": "The user's password.\n\nThis property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo).\n\nThis property is not returned by `GET` requests and cannot be updated via `PUT` requests.",
"type": "string"
Expand Down Expand Up @@ -69570,6 +69674,10 @@
"description": "When **true,** indicates that the envelope is a signature-provided envelope.",
"type": "string"
},
"isTicketRelatedEnvelope": {
"description": "",
"type": "string"
},
"lastModifiedDateTime": {
"description": "The date and time that the item was last modified.",
"type": "string"
Expand Down Expand Up @@ -70404,6 +70512,10 @@
"description": "When **true,** indicates that the envelope is a signature-provided envelope.",
"type": "string"
},
"isTicketRelatedEnvelope": {
"description": "",
"type": "string"
},
"lastModified": {
"description": "The UTC date and time that the comment was last updated.\n\n**Note:** This can only be done by the creator.",
"type": "string"
Expand Down