6.0.0 • Published 5 years ago

@datafire/docusign v6.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

@datafire/docusign

Client library for DocuSign

Installation and Usage

npm install --save @datafire/docusign
let docusign = require('@datafire/docusign').create();

.then(data => {
  console.log(data);
});

Description

The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.

Actions

ServiceInformation_GetServiceInformation

Retrieves the available REST API versions.

DocuSign Production system: https://www.docusign.net/restapi/service_information DocuSign Demo system: https://demo.docusign.net/restapi/service_information

You do not need an integrator key to view the REST API versions and resources.

docusign.ServiceInformation_GetServiceInformation(null, context)

Input

This action has no parameters

Output

ServiceInformation_GetResourceInformation

Retrieves the base resources available for the DocuSign REST APIs.

You do not need an integrator key to view the REST API versions and resources.

Example: https://demo.docusign.net/restapi/v2 lists all of the base resources available in version 2 of the REST API on the DocuSign Demo system.

To view descriptions and samples of the service operations for all versions, remove the version number and add /help to the URL.

Example: https://demo.docusign.net/restapi/help lists the REST API operations on the DocuSign Demo system with XML and JSON request and response samples.

docusign.ServiceInformation_GetResourceInformation(null, context)

Input

This action has no parameters

Output

Accounts_PostAccounts

Creates new DocuSign accounts. You can use this method to create a single account or up to 100 accounts at a time.

When creating a single account, the body of the request is a newAccountDefinition object.

If the request succeeds. it returns a 201 (Created) code. The response returns the new account ID, password and the default user information for each newly created account.

When creating multiple accounts, the body of the request is a newAccountRequests object, which contains one or more newAccountDefinition objects. You can create up to 100 new accounts at a time this way.

The body for a multi-account creation request looks like this in JSON:

{
  "newAccountRequests": [
    {
      "accountName": "accountone",
      . . .
    },
    {
      "accountName": "accounttwo",
      . . .
    }
  ]
}

A multi-account request looks like this in XML:

<newAccountsDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <newAccountRequests>
    <newAccountDefinition>
      . . .
    </newAccountDefinition>
    <newAccountDefinition>
      . . .
    </newAccountDefinition>
  </newAccountRequests>
</newAccountsDefinition>

A multi-account creation request may succeed (report a 201 code) even if some accounts could not be created. In this case, the errorDetails property in the response contains specific information about the failure.

Account Settings

The accountSettings property is a name/value list that can contain the following settings:

NameTypeAuthorization RequiredDescription
adoptSigConfigBooleanAdminWhen true, the Signature Adoption Configuration page is available to account administrators.
allowAccessCodeFormatBooleanAdminWhen true, the Access Code Format page is available to account administrators.
allowAccountManagementGranularBooleanAdminWhen true, the Delegated Administration functionality is available to account.
allowBulkSendBooleanAdminWhen true, the account can set if the bulk send feature can be used.
allowCDWithdrawBooleanAdminWhen true, signers can withdraw their consent to use electronic signatures.
allowConnectSendFinishLaterBooleanReservedReserved for DocuSign.
allowDataDownloadBooleanAdminWhen true, the account can download envelope data.
allowEnvelopeCorrectBooleanAdminWhen true, the account allows in process envelopes to be corrected.
allowEnvelopePublishReportingBooleanAdminWhen true, the account can access the Envelope Publish section in Classic DocuSign Experience Account Administration.
allowExpressSignerCertificateBooleanAdminWhen true, senders are allowed to use the DocuSign Express digital signatures.
allowExternalSignaturePadBooleanAdminWhen true, an external signature pad can be used for signing. The signature pad type is set by the externalSignaturePadType property.
allowInPersonBooleanSysAdminWhen true, the account allows In Person Signing.
allowMarkupBooleanAdminWhen true, the document markup feature is enabled for the account.
allowMemberTimezoneBooleanAdminWhen true, account users can set their own time zones.
allowMergeFieldsBooleanAdminWhen true, the account can use merge fields in conjunction with DocuSign for Salesforce.
allowMultipleSignerAttachmentsBooleanAdminWhen true, multiple signer attachments are allowed for an envelope.
allowOfflineSigningBooleanAdminWhen true, the account can use Offline Signing and envelopes signed using offline signing on mobile devices are synchronized with this account. This option and the inSessionEnabled option must both be enabled (true) for a caller to use offline signing.
allowOpenTrustSignerCertificateBooleanAdminWhen true, senders are allowed to use the OpenTrust digital signatures.
allowPaymentProcessingBooleanAdminWhen true, the account can access the Payment Processing set up page.
allowPersonalSignerCertificateBooleanAdminWhen true, the account can specify that signers must use personal signer certificates during signing.
allowPrivateSigningGroupsBooleanSysAdmin Read OnlyReserved for DocuSign. This currently returns false in a response. This setting is only shown in the response when listing account settings.
allowRemindersBooleanAdminWhen true, the reminder and expiration functionality is available when sending envelops.
allowSafeBioPharmaSignerCertificateBooleanAdminWhen true, senders are allowed to use the SAFE BioPharma digital signatures.
allowSharedTabsBooleanAdminWhen true, the account allows users to share custom tabs (fields). This setting is only shown when getting account settings. It cannot be modified.
allowSignDocumentFromHomePageBooleanAdminWhen true, the Sign a Document Now button is available on the Home tab.
allowSignatureStampsBooleanReservedReserved for DocuSign.
allowSignerReassignBooleanAdminWhen true, the account allows signers to reassign an envelope.
allowSignerReassignOverrideBooleanAdminWhen true, the sender has the option override the default account setting for reassigning recipients.
allowSigningGroupsBooleanSysAdmin Read OnlyWhen true, the account can use signing groups. This setting is only shown in the response when listing account settings.
allowTabOrderBooleanAdminWhen true, the Tab Order field is available for use when creating tabs.
allowWorkspaceCommentsBooleanReservedReserved for DocuSign.
allowWorkspaceCreateBooleanAdminWhen true, account users can create DocuSign Rooms.
attachCompletedEnvelopeBooleanSysAdminWhen true, envelope documents are included as a PDF file attachment for signing completed emails.
authenticationCheckStringAdminSets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks: Phone Authentication SMS Authentication Knowledge-Based ID This setting takes one of the following options: initial_access: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account. each_access: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable timeframe.
autoNavRuleStringAdminThe auto-navigation rule for the account. Enumeration values are: off required_fields required_and_blank_fields all_fields page_then_required_fields page_then_required_and_blank_fields page_then_all_fields
bulkSendBooleanAdminWhen true, the account allows bulk sending of envelopes.
canSelfBrandSendBooleanSysAdminWhen true, account administrators can self-brand their sending console through the DocuSign Console.
canSelfBrandSignBooleanSysAdminWhen true, account administrators can self-brand their signing console through the DocuSign Console.
conditionalFieldsEnabledBooleanAdminWhen true, conditional fields can be used by the account.
consumerDisclosureFrequencyenumAdminPossible values are: once: Per account, the supplemental document is displayed once only per userId. always: Per envelope, the supplemental document is displayed once only per userId. each_access: - Per envelope, the supplemental document is displayed once only per recipientId.
dataFieldRegexEnabledBooleanAdminWhen true, the Regex field is available for tabs with that property.
dataFieldSizeEnabledBooleanAdminWhen true, the maximum number of characters field is available for tabs with that property.
dataPopulationScopeStringAdminSpecifies how data is shared for tabs with the same tabLabel. There are two possible values: document: Tabs in a document with the same label populate with the same data. envelope: Tabs in all documents in the envelope with the same label populate with the same data. This setting applies to the following tab types: Check box Company Data Field Dropdown List Full Name Formula Note Title Changing this setting affects envelopes that have been sent but not completed.
disableMobilePushNotificationsBooleanAdminWhen true, mobile push notifications are disabled on the account.
disableMobileSendingBooleanAdminWhen true, sending from mobile applications is disabled.