docusign.click
Module docusign.click
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_docusign.click_1.3.1.png)
ballerinax/docusign.click Ballerina library
Overview
This is a generated connector for DocuSign Click API OpenAPI specification.
DocuSign Click lets you capture consent to standard agreement terms with a single click terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a DocuSign account.
- Obtain tokens by following this guide.
Quickstart
To use the DocuSign Click connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
First, import the ballerinax/docusign.click
module into the Ballerina project.
import ballerinax/docusign.click;
Step 2 - Create a new connector instance
You can now make the connection configuration using the <ACCESS_TOKEN>.
click:ClientConfig clientConfig = { auth : { token: `<ACCESS_TOKEN>` } }; click:Client baseClient = check new Client(clientConfig);
Step 3: Invoke connector operation
-
Now you can use the operations available within the connector. Note that they are in the form of remote operations.
Following is an example to list all clickwraps using the connector.
public function main() { click:ClickwrapVersionsResponse|error result = baseClient->getClickwraps(); if (result is click:ClickwrapVersionsResponse) { log:printInfo(result.toString()); } else { log:printInfo(result.toString()); } }
-
Use
bal run
command to compile and run the Ballerina program.
Clients![](/images/permalink.svg)
docusign.click: Client![](/images/permalink.svg)
This is a generated connector for DocuSign Click API OpenAPI specification. DocuSign Click lets you capture consent to standard agreement terms with a single click terms and conditions, terms of service, terms of use, privacy policies, and more. The Click API lets you include this customizable clickwrap solution in your DocuSign integrations.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a DocuSign account and obtain tokens by following this guide.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://www.docusign.net/clickapi" - URL of the target service
getServiceInformation![](/images/permalink.svg)
function getServiceInformation() returns ServiceInformation|error
Gets the current version and other information about the Click API.
Return Type
- ServiceInformation|error - Successful response.
getClickwraps![](/images/permalink.svg)
function getClickwraps(string accountId, string? fromDate, string? ownerUserId, string? pageNumber, string? status, string? toDate) returns ClickwrapVersionsResponse|error
Gets all the clickwraps for an account.
Parameters
- accountId string - A GUID that identifies your account.
- fromDate string? (default ()) - Optional. The earliest date to return agreements from.
- ownerUserId string? (default ()) - Optional. The user ID of the owner.
- pageNumber string? (default ()) - Optional. The page number to return.
- status string? (default ()) - Optional. The status of the clickwraps to filter by. One of: -
active
-inactive
- toDate string? (default ()) - Optional. The latest date to return agreements from.
Return Type
- ClickwrapVersionsResponse|error - Successful response.
postClickwrap![](/images/permalink.svg)
function postClickwrap(string accountId, ClickwrapRequest payload) returns ClickwrapVersionSummaryResponse|error
Creates a clickwrap for an account.
Parameters
- accountId string - A GUID that identifies your account.
- payload ClickwrapRequest - Request body for working with clickwrap.
Return Type
- ClickwrapVersionSummaryResponse|error - Successful response.
deleteClickwraps![](/images/permalink.svg)
function deleteClickwraps(string accountId, string? clickwrapIds) returns ClickwrapsDeleteResponse|error
Deletes clickwraps for an account.
Parameters
- accountId string - A GUID that identifies your account.
- clickwrapIds string? (default ()) - A comma-separated list of clickwrap IDs to delete.
Return Type
- ClickwrapsDeleteResponse|error - Successful response.
getClickwrap![](/images/permalink.svg)
function getClickwrap(string accountId, string clickwrapId) returns ClickwrapVersionResponse|error
Gets a single clickwrap object.
Parameters
- accountId string - A GUID that identifies your account.
- clickwrapId string - The ID of the clickwrap.
Return Type
- ClickwrapVersionResponse|error - Successful response.
putClickwrap![](/images/permalink.svg)
function putClickwrap(string accountId, string clickwrapId, ClickwrapTransferRequest payload) returns ClickwrapVersionSummaryResponse|error
Updates the user ID of a clickwrap.
Parameters
- accountId string - A GUID that identifies your account.
- clickwrapId string - The ID of the clickwrap.
- payload ClickwrapTransferRequest - Clieckwrap transfer payload
Return Type
- ClickwrapVersionSummaryResponse|error - Successful response.
deleteClickwrap![](/images/permalink.svg)
function deleteClickwrap(string accountId, string clickwrapId, string? versions) returns ClickwrapVersionsDeleteResponse|error
Deletes a clickwrap and all of its versions.
Parameters
- accountId string - A GUID that identifies your account.
- clickwrapId string - The ID of the clickwrap.
- versions string? (default ()) - A comma-separated list of versions to delete.
Return Type
- ClickwrapVersionsDeleteResponse|error - Successful response.
checkIfUserHasAgreed![](/images/permalink.svg)
function checkIfUserHasAgreed(string accountId, string clickwrapId, UserAgreementRequest payload) returns UserAgreementResponse|error
Checks if a user has agreed to a clickwrap.
Parameters
- accountId string - A GUID that identifies your account.
- clickwrapId string - The ID of the clickwrap.
- payload UserAgreementRequest - User agreement payload
Return Type
- UserAgreementResponse|error - Successful response.
getUserAgreement![](/images/permalink.svg)
function getUserAgreement(string accountId, string agreementId, string clickwrapId) returns UserAgreementResponse|error
Gets a specific agreement for a specified clickwrap.
Parameters
- accountId string - A GUID that identifies your account.
- agreementId string - The agreement ID.
- clickwrapId string - The ID of the clickwrap.
Return Type
- UserAgreementResponse|error - Successful response.
getAgreementPdf![](/images/permalink.svg)
function getAgreementPdf(string accountId, string agreementId, string clickwrapId) returns Response|error
Gets the completed user agreement PDF.
Parameters
- accountId string - A GUID that identifies your account.
- agreementId string - The agreement ID.
- clickwrapId string - The ID of the clickwrap.
getClickwrapAgreements![](/images/permalink.svg)
function getClickwrapAgreements(string accountId, string clickwrapId, string? clientUserId, string? fromDate, string? pageNumber, string? status, string? toDate) returns ClickwrapAgreementsResponse|error
Get user agreements
Parameters
- accountId string - A GUID that identifies your account.
- clickwrapId string - The ID of the clickwrap.
- clientUserId string? (default ()) - The client ID.
- fromDate string? (default ()) - Optional. The earliest date to return agreements from.
- pageNumber string? (default ()) - Optional. The page number to return.
- status string? (default ()) - Optional. The status of the clickwraps to return.
- toDate string? (default ()) - Optional. The latest date to return agreements from.
Return Type
- ClickwrapAgreementsResponse|error - Successful response.
createClickwrapVersion![](/images/permalink.svg)
function createClickwrapVersion(string accountId, string clickwrapId, ClickwrapRequest payload) returns ClickwrapVersionSummaryResponse|error
Creates a new clickwrap version.
Parameters
- accountId string - A GUID that identifies your account.
- clickwrapId string - The ID of the clickwrap.
- payload ClickwrapRequest - Request body for working with clickwrap.
Return Type
- ClickwrapVersionSummaryResponse|error - Successful response.
deleteClickwrapVersions![](/images/permalink.svg)
function deleteClickwrapVersions(string accountId, string clickwrapId, string? clickwrapVersionIds) returns ClickwrapVersionsDeleteResponse|error
Deletes the versions of a clickwrap.
Parameters
- accountId string - A GUID that identifies your account.
- clickwrapId string - The ID of the clickwrap.
- clickwrapVersionIds string? (default ()) - A comma-separated list of clickwrap version IDs to delete.
Return Type
- ClickwrapVersionsDeleteResponse|error - Successful response.
getClickwrapVersion![](/images/permalink.svg)
function getClickwrapVersion(string accountId, string clickwrapId, string versionId) returns ClickwrapVersionResponse|error
Gets a specific version from a clickwrap.
Parameters
- accountId string - A GUID that identifies your account.
- clickwrapId string - The ID of the clickwrap.
- versionId string - The ID of the version.
Return Type
- ClickwrapVersionResponse|error - Successful response.
updateClickwrapVersion![](/images/permalink.svg)
function updateClickwrapVersion(string accountId, string clickwrapId, string versionId, ClickwrapRequest payload) returns ClickwrapVersionSummaryResponse|error
Updates a specific version of a clickwrap.
Parameters
- accountId string - A GUID that identifies your account.
- clickwrapId string - The ID of the clickwrap.
- versionId string - The ID of the version.
- payload ClickwrapRequest - Request body for working with clickwrap.
Return Type
- ClickwrapVersionSummaryResponse|error - Successful response.
deleteClickwrapVersion![](/images/permalink.svg)
function deleteClickwrapVersion(string accountId, string clickwrapId, string versionId) returns ClickwrapVersionDeleteResponse|error
Deletes a specific version of a clickwrap.
Parameters
- accountId string - A GUID that identifies your account.
- clickwrapId string - The ID of the clickwrap.
- versionId string - The ID of the version.
Return Type
- ClickwrapVersionDeleteResponse|error - Successful response.
getClickwrapVersionUserAgreements![](/images/permalink.svg)
function getClickwrapVersionUserAgreements(string accountId, string clickwrapId, string versionId, string? clientUserId, string? fromDate, string? pageNumber, string? status, string? toDate) returns ClickwrapAgreementsResponse|error
Gets the agreement responses for a clickwrap version.
Parameters
- accountId string - A GUID that identifies your account. This value is automatically generated by DocuSign for any account you create. Copy the value from the API Account ID field in the API and Keys page in eSignature Settings.
- clickwrapId string - The ID of the clickwrap.
- versionId string - The ID of the version.
- clientUserId string? (default ()) - Client user ID.
- fromDate string? (default ()) - Optional. The earliest date to return agreements from.
- pageNumber string? (default ()) - Optional. The page number to return.
- status string? (default ()) - Clickwrap status. Possible values: -
active
-inactive
-deleted
- toDate string? (default ()) - Optional. The latest date to return agreements from.
Return Type
- ClickwrapAgreementsResponse|error - Successful response.
Records![](/images/permalink.svg)
docusign.click: ClickwrapAgreementsResponse![](/images/permalink.svg)
Fields
- beginCreatedOn record {}? - User agreements from this datetime.
- minimumPagesRemaining int? - Number of pages remaining in the response.
- page int? - The number of the current page.
- pageSize int? - The number of items per page.
- userAgreements UserAgreementResponse[]? - An array of user agreements.
docusign.click: ClickwrapDeleteResponse![](/images/permalink.svg)
Fields
- clickwrapId string? - The ID of the clickwrap.
- clickwrapName string? - The name of the clickwrap.
- deletionMessage string? - A message describing the result of deletion request. One of:
alreadyDeleted
: Clickwrap is already deleted.deletionSuccess
: Successfully deleted the clickwrap.deletionFailure
: Failed to delete the clickwrap.cannotDelete
: Active clickwrap version cannot be deleted.
- deletionSuccess boolean? - True if the clickwrap was deleted successfully. False otherwise.
- status string? - Clickwrap status. Possible values:
active
inactive
deleted
docusign.click: ClickwrapRequest![](/images/permalink.svg)
Request body for working with clickwrap.
Fields
- clickwrapName string? - The name of the clickwrap.
- displaySettings DisplaySettings? - Information about how an agreement is displayed.
- documents Document[]? - An array of documents.
- fieldsToNull string? - Specifies whether
scheduledReacceptance
andscheduledDate
should be cleared. May be one of:"scheduledReacceptance"
"scheduledDate"
"scheduledReacceptance,scheduledDate"
- isMajorVersion boolean? - When true, the next version created is a major version. When false the next version created is minor.
- isShared boolean? - Shared status
- name string? - Name of the clickwrap.
- requireReacceptance boolean? - When true, requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.
- scheduledDate record {}? - The time and date when this clickwrap is activated.
- scheduledReacceptance ClickwrapScheduledReacceptance? - Specifies the interval between recceptance in days, weeks, months or years
- status record {}? - Clickwrap status. Possible values:
active
inactive
deleted
- transferFromUserId string? - The user ID of current owner of the clickwrap.
- transferToUserId string? - The user ID of the new owner of the clickwrap.
docusign.click: ClickWraps![](/images/permalink.svg)
A paged collection of clickwraps.
Fields
- clickwraps ClickwrapVersionSummaryResponse[]? - An array of clickwraps.
- minimumPagesRemaining int? - Number of pages remaining in the response.
- page int? - The number of the current page.
- pageSize int? - The number of items per page.
docusign.click: ClickwrapScheduledReacceptance![](/images/permalink.svg)
Specifies the interval between recceptance in days, weeks, months or years
Fields
- recurrenceInterval int? - The time between recurrences specified in
recurrenceIntervalType
units. The minimum and maximum values depend onrecurrenceIntervalType
:days
: 1 - 365weeks
: 1 - 52months
: 1 - 12years
: 1
- recurrenceIntervalType string? - The units of the
recurrenceInterval
. Must be one of:days
weeks
month
years
- startDateTime record {}? - The date when the recurrence interval starts.
docusign.click: ClickwrapsDeleteResponse![](/images/permalink.svg)
Fields
- clickwraps ClickwrapDeleteResponse[]? -
docusign.click: ClickwrapTransferRequest![](/images/permalink.svg)
Clieckwrap transfer payload
Fields
- transferFromUserId string? - ID of the user to transfer from.
- transferToUserId string? - ID of the user to transfer to.
docusign.click: ClickwrapVersion![](/images/permalink.svg)
Fields
- clickwrapVersionId string? - The unique version ID, a GUID, of this clickwrap version.
- createdTime record {}? - The time that the clickwrap was created.
- lastModified record {}? - The time that the clickwrap was last modified.
- lastModifiedBy string? - The user ID of the last user who modified this clickwrap.
- ownerUserId string? - The user ID of the owner of this clickwrap.
- requireReacceptance boolean? - When true, requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.
- scheduledDate record {}? - The time and date when this clickwrap is activated.
- scheduledReacceptance ClickwrapScheduledReacceptance? - Specifies the interval between recceptance in days, weeks, months or years
- status string? - Clickwrap status. Possible values:
active
inactive
deleted
- versionId string? - The ID of the version.
- versionNumber string? - Version of the clickwrap.
docusign.click: ClickwrapVersionDeleteResponse![](/images/permalink.svg)
Fields
- clickwrapVersionId string? - The unique version ID, a GUID, of this clickwrap version.
- createdTime record {}? - The time that the clickwrap was created.
- deletionMessage string? - A message describing the result of deletion request. One of:
alreadyDeleted
: Clickwrap is already deleted.deletionSuccess
: Successfully deleted the clickwrap.deletionFailure
: Failed to delete the clickwrap.cannotDelete
: Active clickwrap version cannot be deleted.
- deletionSuccess boolean? - True if the clickwrap was deleted successfully. False otherwise.
- lastModified record {}? - The time that the clickwrap was last modified.
- lastModifiedBy string? - The user ID of the last user who modified this clickwrap.
- ownerUserId string? - The user ID of the owner of this clickwrap.
- requireReacceptance boolean? - When true, requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.
- scheduledDate record {}? - The time and date when this clickwrap is activated.
- scheduledReacceptance ClickwrapScheduledReacceptance? - Specifies the interval between recceptance in days, weeks, months or years
- status string? - Clickwrap status. Possible values:
active
inactive
deleted
- versionId string? - The ID of the version.
- versionNumber string? - Version of the clickwrap.
docusign.click: ClickwrapVersionResponse![](/images/permalink.svg)
Fields
- accountId string? - A GUID that identifies your account. This value is automatically generated by DocuSign for any account you create. Copy the value from the API Account ID field in the API and Keys page in eSignature Settings.
- clickwrapId string? - The ID of the clickwrap.
- clickwrapName string? - The name of the clickwrap.
- clickwrapVersionId string? - The unique version ID, a GUID, of this clickwrap version.
- createdTime record {}? - The time that the clickwrap was created.
- displaySettings DisplaySettings? - Information about how an agreement is displayed.
- documents Document[]? - An array of documents.
- lastModified record {}? - The time that the clickwrap was last modified.
- lastModifiedBy string? - The user ID of the last user who modified this clickwrap.
- ownerUserId string? - The user ID of the owner of this clickwrap.
- requireReacceptance boolean? - When true, requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.
- scheduledDate record {}? - The time and date when this clickwrap is activated.
- scheduledReacceptance ClickwrapScheduledReacceptance? - Specifies the interval between recceptance in days, weeks, months or years
- status string? - Clickwrap status. Possible values:
active
inactive
deleted
- versionId string? - The ID of the version.
- versionNumber string? - Version of the clickwrap.
docusign.click: ClickwrapVersionsDeleteResponse![](/images/permalink.svg)
Fields
- clickwrapId string? - The ID of the clickwrap.
- clickwrapName string? - The name of the clickwrap.
- versions ClickwrapVersionDeleteResponse[]? - An array delete responses.
docusign.click: ClickwrapVersionsPagedResponse![](/images/permalink.svg)
Fields
- accountId string? - A GUID that identifies your account. This value is automatically generated by DocuSign for any account you create. Copy the value from the API Account ID field in the API and Keys page in eSignature Settings.
- clickwrapId string? - The ID of the clickwrap.
- clickwrapName string? - The name of the clickwrap.
- minimumPagesRemaining int? - Number of pages remaining in the response.
- page int? - The number of the current page.
- pageSize int? - The number of items per page.
- versions ClickwrapVersion[]? - An array of clickwrap versions.
docusign.click: ClickwrapVersionsResponse![](/images/permalink.svg)
Fields
- clickwraps ClickwrapVersionSummaryResponse[]? - An array of
clickwrapVersionSummaryResponse
objects.
- minimumPagesRemaining int? - Number of pages remaining in the response.
- page int? - The number of the current page.
- pageSize int? - The number of items per page.
docusign.click: ClickwrapVersionSummaryResponse![](/images/permalink.svg)
Fields
- accountId string? - A GUID that identifies your account. This value is automatically generated by DocuSign for any account you create. Copy the value from the API Account ID field in the API and Keys page in eSignature Settings.
- clickwrapId string? - The ID of the clickwrap.
- clickwrapName string? - The name of the clickwrap.
- clickwrapVersionId string? - The unique version ID, a GUID, of this clickwrap version.
- createdTime record {}? - The time that the clickwrap was created.
- lastModified record {}? - The time that the clickwrap was last modified.
- lastModifiedBy string? - The user ID of the last user who modified this clickwrap.
- ownerUserId string? - The user ID of the owner of this clickwrap.
- requireReacceptance boolean? - When true, requires signers who have previously agreed to this clickwrap to sign again. The version number is incremented.
- scheduledDate record {}? - The time and date when this clickwrap is activated.
- scheduledReacceptance ClickwrapScheduledReacceptance? - Specifies the interval between recceptance in days, weeks, months or years
- status string? - Clickwrap status. Possible values:
active
inactive
deleted
- versionId string? - The ID of the version.
- versionNumber string? - Version of the clickwrap.
docusign.click: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
docusign.click: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
docusign.click: DisplaySettings![](/images/permalink.svg)
Information about how an agreement is displayed.
Fields
- actionButtonAlignment string? - Position of the Accept button in the agreement. One of
right
left
- allowClientOnly boolean? - When true, this agreement can be be used in client-only integrations
- allowedHosts string[]? - Hosts that can host the clickwrap. It is an error if the clickwrap didn't come from one of these hosts.
- brandId string? - The signing brand ID.
- consentButtonText string? - Text on the agree button.
- consentText string? - The text on agree button.
- declineButtonText string? - The text on the decline button.
- displayName string? - The display name of the user agreement.
- documentDisplay string? - Display type: link or document
- downloadable boolean? - True if the agreement is downloadable.
- format string? - Display format: inline or modal.
- hasDeclineButton boolean? - True if the agreement has a decline checkbox.
- hostOrigin string? - The host origin.
- mustRead boolean? - True if the user needs to scroll to the end of the document.
- mustView boolean? - True if the user must view the document.
- recordDeclineResponses boolean? - When true, this agreement records decline actions.
- requireAccept boolean? - True if accept is required.
- sendToEmail boolean? - True if send to email is applicable.
docusign.click: Document![](/images/permalink.svg)
Information about a document.
Fields
- documentBase64 string? - The base64-encoded contents of the document.
- documentHtml string? - The HTML representation of the document.
- documentName string? - The name of the document.
- fileExtension string? - The file extension of the document.
- 'order int? - The order of document layout.
docusign.click: ErrorDetails![](/images/permalink.svg)
Error details.
Fields
- errorCode string? - The error code.
- message string? - The error message.
docusign.click: OAuth2RefreshTokenGrantConfig![](/images/permalink.svg)
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://account-d.docusign.com/oauth/token") - Refresh URL
docusign.click: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
docusign.click: ServiceInformation![](/images/permalink.svg)
Fields
- buildBranch string? -
- buildBranchDeployedDateTime string? -
- buildSHA string? -
- buildVersion string? - The internal build version information.
- linkedSites string[]? - An array of URLs (strings) of related sites.
- serviceVersions ServiceVersion[]? - An array of
serviceVersion
objects.
docusign.click: ServiceVersion![](/images/permalink.svg)
Fields
- 'version string? - The human-readable semver version string.
- versionUrl string? - The URL where this version of the API can be found.
docusign.click: UserAgreementRequest![](/images/permalink.svg)
User agreement payload
Fields
- clientUserId string? - The user ID of the client.
- hostOrigin string? - The host origin.
- metadata string? - A customer-defined string you can use in requests. This string will appear in the corresponding response.
docusign.click: UserAgreementResponse![](/images/permalink.svg)
Fields
- accountId string? - A GUID that identifies your account. This value is automatically generated by DocuSign for any account you create. Copy the value from the API Account ID field in the API and Keys page in eSignature Settings.
- agreedOn record {}? - Date that the client last completed the agreement.
This property is null if
agreementUrl
is not null andstatus
is notagreed
.
- agreementId string? - The agreement ID.
- agreementUrl string? - When not null, an agreement is required for user specified by
clientUserId
. When missing the user specified byclientUserId
has already agreed and does not require a new acceptance. Use this URL to render the agreement in a web page. <!-- or redirected to when providing redirect_url as a query paramter. -->
- clickwrapId string? - The ID of the clickwrap.
- clientUserId string? - The user ID of the client.
- consumerDisclosureHtml string? - The customer-branded HTML with the Electronic Record and Signature Disclosure information
- createdOn record {}? - The date when the clickwrap was created. May be null.
- declinedOn record {}? - The date when the user declined the most recent required agreement.
This property is valid only when
status
isdeclined
. Otherwise it is null.
- documents Document[]? - An array of documents.
- metadata string? - A customer-defined string you can use in requests. This string will appear in the corresponding response.
- settings DisplaySettings? - Information about how an agreement is displayed.
- status string? - User agreement status. One of:
created
agreed
declined
- 'version string? - The human-readable semver version string.
- versionId string? - The ID of the version.
- versionNumber int? - Version of the clickwrap.
Import
import ballerinax/docusign.click;
Metadata
Released date: over 1 year ago
Version: 1.3.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 1
Current verison: 1
Weekly downloads
Keywords
Content & Files/Documents
Cost/Freemium
Contributors
Dependencies