Docusign.All 0.0.3

Docusign.All

Developer-friendly & type-safe Csharp SDK specifically catered to leverage Docusign.All API.

<div align="left"> <a href="https://www.speakeasy.com/?utm_source=docusign-all&utm_campaign=csharp"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a> <a href="https://opensource.org/licenses/MIT"> <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" /> </a> </div>

<br /><br />

Summary

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

For more information about the API: See the Docusign eSignature REST API Guide for more information.

Table of Contents

• Docusign.All
  • SDK Installation
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
• Development
  • Maturity
  • Contributions

SDK Installation

To add a reference to a local instance of the SDK in a .NET project:

dotnet add reference src/Docusign/All/Docusign.All.csproj

SDK Example Usage

Example 1

using Docusign.All;
using Docusign.All.Models.Components;

var sdk = new DocusignAll(bearer: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.UserSignatures.UpdateAsync(
    accountId: "<id>",
    userId: "<id>",
    userSignaturesInformation: new UserSignaturesInformation() {}
);

// handle response

Add User Signatures

using Docusign.All;
using Docusign.All.Models.Components;

var sdk = new DocusignAll(bearer: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.UserSignatures.AddAsync(
    accountId: "<id>",
    userId: "<id>",
    userSignaturesInformation: new UserSignaturesInformation() {}
);

// handle response

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
Bearer	http	HTTP Bearer

To authenticate with the API the Bearer parameter must be set when initializing the SDK client instance. For example:

using Docusign.All;
using Docusign.All.Models.Components;

var sdk = new DocusignAll(bearer: "<YOUR_BEARER_TOKEN_HERE>");

var res = await sdk.Services.GetServiceInformationAsync();

// handle response

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

using Docusign.All;
using Docusign.All.Models.Requests;

var sdk = new DocusignAll();

var res = await sdk.OAuth.ObtainTokenAsync(
    security: new ObtainTokenSecurity() {
        Username = "",
        Password = "",
    },
    grantType: GrantType.AuthorizationCode,
    code: "eyJ0eXAiQFsje43QVZ_gw"
);

// handle response

Available Resources and Operations

<details open> <summary>Available methods</summary>

AccountBrands

• List - Gets a list of brands.
• Create - Creates one or more brand profiles for an account.
• DeleteProfiles - Deletes one or more brand profiles.
• Get - Gets information about a brand.
• Update - Updates an existing brand.
• Delete - Deletes a brand.
• Export - Exports a brand.
• GetLogo - Gets a brand logo.
• UpdateLogo - Updates a brand logo.
• DeleteLogo - Deletes a brand logo.
• GetBrandResourcesList - Returns metadata about the branding resources for an account.
• GetResources - Returns a branding resource file.
• UpdateResources - Updates a branding resource file.

AccountConsumerDisclosures

• Get - Gets the default Electronic Record and Signature Disclosure for an account.
• RetrieveLang - Gets the Electronic Record and Signature Disclosure for an account.
• Update - Updates the Electronic Record and Signature Disclosure for an account.

AccountCustomFields

• Get - Gets a list of custom fields.
• Create - Creates an account custom field.
• Update - Updates an account custom field.
• Delete - Deletes an account custom field.

AccountPasswordRules

• Get - Gets the password rules for an account.
• Update - Updates the password rules for an account.
• Retrieve - Gets membership account password rules.

AccountPermissionProfiles

• List - Gets a list of permission profiles.
• Create - Creates a new permission profile for an account.
• Get - Returns a permission profile for an account.
• Update - Updates a permission profile.
• Delete - Deletes a permission profile from an account.

Accounts

• Create - Creates new accounts.
• Get - Retrieves the account information for the specified account.
• Delete - Deletes the specified account.
• GetBillingCharges - Gets list of recurring and usage charges for the account.
• DeleteCaptiveRecipientsPart - Deletes the signature for one or more captive recipient records.
• GetRecipientNames - Gets the recipient names associated with an email address.
• GetSettings - Gets account settings information.
• UpdateSettings - Updates the account settings for an account.
• GetEnvelopePurgeConfiguration - Gets the envelope purge configuration for an account.
• UpdateEnvelopePurgeConfiguration - Sets the envelope purge configuration for an account.
• GetNotificationDefaults - Gets envelope notification defaults.
• UpdateNotificationDefaults - Updates envelope notification default settings.
• GetSharedAccess - Reserved: Gets the shared item status for one or more users.
• SetSharedAccess - Reserved: Sets the shared access information for users.
• GetSupportedLanguages - Gets the supported languages for envelope recipients.
• GetUnsupportedFileTypes - Gets a list of unsupported file types.
• GetProvisioning - Retrieves the account provisioning information for the account.

AccountSealProviders

• List - Returns available seals for specified account.

AccountSignatureProviders

• GetSignatureProviders - Gets the available signature providers for an account.

AccountSignatures

• ListSignatures - Returns a list of stamps available in the account.
• Update - Updates an account stamp.
• AddOrUpdate - Adds or updates one or more account stamps.
• GetSignature - Returns information about the specified stamp.
• UpdateById - Updates an account stamp by ID.
• Delete - Deletes an account stamp.
• GetImage - Returns the image for an account stamp.
• PutAccountSignatureImage - Sets a signature image, initials, or stamp.
• DeleteImage - Deletes the image for a stamp.

AccountTabSettings

• Get - Returns tab settings list for specified account
• Update - Modifies tab settings for specified account

AccountWatermarks

• GetWatermark - Get watermark information.
• Update - Update watermark information.
• UpdatePreview - Get watermark preview.

Authorizations

• CreateUserAuthorization - Creates a user authorization.
• Get - Returns the user authorization for a given authorization ID.
• UpdateUserAuthorization - Updates the start or end date for a user authorization.
• DeleteUserAuthorization - Deletes the user authorization.
• List - Returns the authorizations for which the specified user is the principal user.
• PostUserAuthorizations - Create or update multiple user authorizations.
• DeleteUserAuthorizations - Delete multiple user authorizations.
• GetAgentUser - Returns the authorizations for which the specified user is the agent user.

BccEmailArchive

• List - Gets the BCC email archive configurations for an account.
• GetHistory - Gets a BCC email archive configuration and its history.
• Delete - Deletes a BCC email archive configuration.

BccEmailArchives

• Create - Creates a BCC email archive configuration.

BillingPlans

• GetBillingPlan - Get Account Billing Plan
• Update - Updates an account billing plan.
• GetCreditCardInfo - Get credit card information
• GetDowngradeRequestBillingInfo - Returns downgrade plan information for the specified account.
• Downgrade - Queues downgrade billing plan request for an account.
• PurchaseEnvelopes - Reserved: Purchase additional envelopes.
• Get - Gets a list of available billing plans.
• Fetch - Gets billing plan details.

BulkSend

• GetBatches - Returns a list of bulk send batch summaries.
• GetBatchStatus - Gets the status of a specific bulk send batch.
• UpdateBatchName - Updates the name of a bulk send batch.
• UpdateBatchAction - Applies a bulk action to all envelopes from a specified bulk send.
• GetBatchEnvelopes - Gets envelopes from a specific bulk send batch.
• GetLists - Gets bulk send lists.
• CreateList - Creates a bulk send list.
• GetList - Gets a specific bulk send list.
• UpdateList - Updates a bulk send list.
• DeleteBulkSendList - Deletes a bulk send list.
• CreateSendRequest - Creates a bulk send request.
• CreateTest - Creates a bulk send test.

ChunkedUploads

• Create - Initiate a new chunked upload.
• Get - Retrieves metadata about a chunked upload.
• Commit - Commit a chunked upload.
• Delete - Deletes a chunked upload.
• AddPart - Add a chunk to an existing chunked upload.

CloudStorage

• GetFolders - Retrieves a list of all the items in a specified folder from the specified cloud storage provider.
• ListItems - Gets a list of items from a cloud storage provider.

CloudStorageProviders

• ListForUser - Get the Cloud Storage Provider configuration for the specified user.
• PostCloudStorage - Configures the redirect URL information for one or more cloud storage providers for the specified user.
• Delete - Deletes the user authentication information for one or more cloud storage providers.
• Get - Gets the specified Cloud Storage Provider configuration for the User.
• RevokeAccess - Deletes the user authentication information for the specified cloud storage provider.

Comments

• GetTranscript - Gets a PDF transcript of all of the comments in an envelope.

ConnectConfigurations

• List - Get Connect configuration information.
• Update - Updates a specified Connect configuration.
• Create - Creates a Connect configuration.
• GetConfiguration - Gets the details about a Connect configuration.
• Delete - Deletes the specified Connect configuration.
• GetAllUsers - Returns all users from the configured Connect service.
• GetUsers - Returns users from the configured Connect service.
• GetOAuthConfig - Retrieves the Connect OAuth information for the account.
• UpdateOAuthConfig - Updates the existing Connect OAuth configuration for the account.
• SetupOAuth - Set up Connect OAuth for the specified account.
• DeleteOAuthConfig - Delete the Connect OAuth configuration.

ConnectEvents

• Retry - Republishes Connect information for the specified envelope.
• RetryQueue - Republishes Connect information for multiple envelopes.
• GetFailures - Gets the Connect failure log information.
• DeleteFailureLog - Deletes a Connect failure log entry.
• GetConnectLogs - Gets the Connect log.
• DeleteLogs - Deletes a list of Connect log entries.
• GetConnectLog - Gets a Connect log entry.
• DeleteLog - Deletes a specified Connect log entry.

Contacts

• Update - Updates one or more contacts.
• Add - Add contacts to a contacts list.
• RemoveMultiple - Deletes multiple contacts from an account.
• GetById - Gets one or more contacts.
• Delete - Deletes a contact.

CustomTabs

• GetDefinitions - Gets a list of all account tabs.
• Create - Creates a custom tab.
• Get - Gets custom tab information.
• Update - Updates custom tab information.
• Delete - Deletes custom tab information.

DocumentGeneration

• GetSenderFields - Returns sender fields for an envelope.
• UpdateFields - Updates sender fields for an envelope.

DocumentResponsiveHtmlPreviews

• Create - Creates a preview of the responsive version of a document.

EnoteConfigurations

• Update - Updates configuration information for the eNote eOriginal integration.

ENoteConfigurations

• GetConfiguration - Returns the configuration information for the eNote eOriginal integration.
• Delete - Deletes configuration information for the eNote eOriginal integration.

Envelope

• CreateResponsiveHtmlPreview - Creates a preview of the responsive versions of all of the documents in an envelope.

EnvelopeAttachments

• List - Returns a list of envelope attachments associated with a specified envelope.
• Update - Adds one or more envelope attachments to a draft or in-process envelope.
• Delete - Deletes one or more envelope attachments from a draft envelope.
• Get - Retrieves an envelope attachment from an envelope.
• Modify - Updates an envelope attachment in a draft or in-process envelope.

EnvelopeConsumerDisclosures

• DefaultRetrieve - Gets the default Electronic Record and Signature Disclosure for an envelope.
• Get - Gets the Electronic Record and Signature Disclosure for a specific envelope recipient.

EnvelopeCustomFields

• List - Gets the custom field information for the specified envelope.
• Update - Updates envelope custom fields in an envelope.
• Create - Creates envelope custom fields for an envelope.
• Delete - Deletes envelope custom fields for draft and in-process envelopes.

EnvelopeDocumentFields

• Get - Gets the custom document fields from an existing envelope document.
• Update - Updates existing custom document fields in an existing envelope document.
• Create - Creates custom document fields in an existing envelope document.
• Delete - Deletes custom document fields from an existing envelope document.

EnvelopeDocuments

• List - Gets a list of documents in an envelope.
• AddDocuments - Adds one or more documents to an existing envelope.
• Delete - Deletes documents from a draft envelope.
• Get - Retrieves a single document or all documents from an envelope.
• AddOrReplace - Adds or replaces a document in an existing envelope.

EnvelopeDocumentTabs

• GetPageTabs - Returns tabs on the specified page.
• GetDocumentTabs - Returns the tabs on a document.
• UpdateDocumentTabs - Updates the tabs for document.
• Add - Adds tabs to a document in an envelope.
• DeleteTabs - Deletes tabs from a document in an envelope.

EnvelopeDocumentVisibility

• Get - Returns document visibility for a recipient
• PutRecipientDocumentVisibility - Updates document visibility for a recipient
• Update - Updates document visibility for recipients

EnvelopeEmailSettings

• Get - Gets the email setting overrides for an envelope.
• Update - Updates the email setting overrides for an envelope.
• Create - Adds email setting overrides to an envelope.
• Delete - Deletes the email setting overrides for an envelope.

EnvelopeFormData

• Get - Returns envelope tab data for an existing envelope.

EnvelopeHtmlDefinitions

• Get - Gets the Original HTML Definition used to generate the Responsive HTML for the envelope.

EnvelopeLocks

• Get - Gets envelope lock information.
• Update - Updates an envelope lock.
• Lock - Locks an envelope.
• Delete - Deletes an envelope lock.

EnvelopePublish

• SubmitHistoricalBatch - Submits a batch of historical envelopes for republish to a webhook.

EnvelopeRecipients

• GetStatus - Gets the status of recipients for an envelope.
• Update - Updates recipients in a draft envelope or corrects recipient information for an in-process envelope.
• Add - Adds one or more recipients to an envelope.
• Delete - Deletes recipients from an envelope.
• Remove - Deletes a recipient from an envelope.
• CreateIdentityProofToken - Creates a resource token for a sender to request ID Evidence data.
• CreateManualReviewLink - Create the link to the page for manually reviewing IDs.
• CreatePreview - Creates an envelope recipient preview.

EnvelopeRecipientTabs

• Get - Gets the tabs information for a signer or sign-in-person recipient in an envelope.
• Update - Updates the tabs for a recipient.
• PostRecipientTabs - Adds tabs for a recipient.
• Delete - Deletes the tabs associated with a recipient.

Note: It is an error to delete a tab that has the

templateLocked property set to true.

This property corresponds to the Restrict changes option in the web app.

Envelopes

• Search - Search for specific sets of envelopes by using search filters.
• Create - Creates an envelope.
• GetStatus - Gets the status of a single envelope.
• Update - Send, void, or modify a draft envelope. Purge documents from a completed envelope.
• GetAuditEvents - Gets the envelope audit events for an envelope.
• GetDocumentPages - Returns document page images based on input.
• DeletePage - Deletes a page from a document in an envelope.
• UpdatePageImage - Rotates page image from an envelope for display.
• GetNotification - Gets envelope notification information.
• UpdateNotification - Sets envelope notifications for an existing envelope.
• GetRecipientInitialsImage - Gets the initials image for a user.
• UpdateRecipientInitialsImage - Sets the initials image for an accountless signer.
• GetRecipientSignature - Gets signature information for a signer or sign-in-person recipient.
• GetRecipientSignatureImage - Retrieve signature image information for a signer/sign-in-person recipient.
• UpdateRecipientSignatureImage - Sets the signature image for an accountless signer.
• UpdateStatus - Gets envelope statuses for a set of envelopes.

Envelopes.Documents

Envelopes.Documents.HtmlDefinitions

• Get - Retrieves the HTML definition used to generate a dynamically sized responsive document.

Envelopes.Documents.Pages

• GetImage - Gets a page image from an envelope for display.

Envelopes.Workflow

• Update - Updates the workflow definition for an envelope.

EnvelopesViews

• CreateSharedView - Returns a URL to the shared recipient view UI for an envelope.

EnvelopeTemplates

• Get - Gets the templates associated with a document in an existing envelope.
• AddDocumentTemplates - Adds templates to a document in an envelope.
• Delete - Deletes a template from a document in an existing envelope.
• List - Gets templates used in an envelope.
• Add - Adds templates to an envelope.

EnvelopeTransferRules

• Get - Gets envelope transfer rules.
• UpdateStatus - Changes the status of multiple envelope transfer rules.
• Create - Creates an envelope transfer rule.
• Update - Changes the status of an envelope transfer rule.
• Delete - Deletes an envelope transfer rule.

EnvelopeViews

• GetCorrectionUrl - Returns a URL to the envelope correction UI. Use after an envelope has been sent.
• RevokeCorrectView - Revokes the correction view URL to the Envelope UI.
• Edit - Returns a URL to the edit view UI. Use before an envelope has been sent.
• CreateRecipientView - Returns a URL to the recipient view UI. For signer recipients, returns the embedded signing view. Can also be used for other recipient types.
• CreateSenderView - Returns a URL to the sender view UI. Used before an envelope has been sent.
• CreateConsoleUrl - Returns a URL to the Docusign eSignature web application.

EnvelopeWorkflow

• GetScheduledSending - Returns the scheduled sending rules for an envelope's workflow definition.
• DeleteDelayedRouting - Deletes the delayed routing rules for the specified envelope workflow step.

EnvelopeWorkflowDefinition

• Get - Returns the workflow definition for an envelope.
• Delete - Delete the workflow definition for an envelope.
• UpdateScheduledSending - Updates the scheduled sending rules for an envelope's workflow.
• DeleteScheduledSendingRules - Deletes the scheduled sending rules for the envelope's workflow.
• GetStep - Returns a specified workflow step for a specified template.
• GetDelayedRouting - Returns the delayed routing rules for an envelope's workflow step definition.
• DeleteTemplateWorkflow - Delete the workflow definition for a template.
• DeleteScheduledSending - Deletes the scheduled sending rules for the template's workflow.
• AddStep - Adds a new step to a template's workflow.
• UpdateStep - Updates a specified workflow step for a template.
• DeleteStep - Deletes a workflow step from an template's workflow definition.
• DeleteDelayedRouting - Deletes the delayed routing rules for the specified template workflow step.

EnvelopeWorkflowDefinitions

• UpdateDelayedRouting - Updates the delayed routing rules for an envelope's workflow step definition.
• GetTemplateScheduledSendingDefinition - Returns the scheduled sending rules for a template's workflow definition.
• GetTemplateWorkflowStep - Returns a specified workflow step for a specified envelope.
• UpdateDelayedRoutingDefinition - Updates the delayed routing rules for a template's workflow step.

EnvelopeWorkflows

• Update - Updates the workflow definition for a template.
• GetDelayedRouting - Returns the delayed routing rules for a template's workflow step definition.

EnvelopeWorkflowSteps

• Add - Adds a new step to an envelope's workflow.
• Update - Updates the specified workflow step for an envelope.
• Delete - Deletes a workflow step from an envelope's workflow definition.

FavoriteTemplates

• List - Retrieves the list of favorite templates for the account.
• Update - Set one or more templates as account favorites.
• Remove - Remove one or more templates from the account favorites.

Folders

• List - Returns a list of the account's folders.
• GetItems - Gets information about items in a specified folder.
• Move - Moves a set of envelopes from their current folder to another folder.
• GetContents - Deprecated. Use Envelopes: listStatusChanges.

GroupBrands

• GetGroupBrands - Gets the brand information for a group.
• Add - Adds an existing brand to a group.
• Delete - Deletes brand information from a group.

Groups

• GetAll - Gets information about groups associated with the account.
• Update - Updates the group information for a group.
• Create - Creates one or more groups for the account.
• Delete - Deletes an existing user group.

GroupUsers

• Get - Gets a list of users in a group.
• AddUsers - Adds one or more users to an existing group.
• Delete - Deletes one or more users from a group

IdentityVerifications

• List - Retrieves the Identity Verification workflows available to an account.

Invoices

• List - Get a List of Billing Invoices
• GetInvoice - Retrieves a billing invoice.
• GetPastDue - Get a list of past due invoices.

Notary

• GetSettings - Gets settings for a notary user.
• Update - Updates notary information for the current user.
• Register - Registers the current user as a notary.

NotaryJournals

• Get - Gets notary jurisdictions for a user.

NotaryJurisdiction

• List - Returns a list of jurisdictions that the notary is registered in.
• Create - Creates a jurisdiction object.
• Update - Updates the jurisdiction information about a notary.

NotaryJurisdictions

• Get - Gets a jurisdiction object for the current user. The user must be a notary.
• Delete - Deletes the specified jurisdiction.

OAuth

• ObtainToken - Obtains an access token from the Docusign API.

PaymentGatewayAccounts

• List - List payment gateway accounts

Payments

• GetList - Gets payment information for one or more payments.
• Post - Posts a payment to a past due invoice.
• GetPayment - Gets billing payment information for a specific payment.

PowerForms

• List - Returns a list of PowerForms.
• Create - Creates a new PowerForm
• Delete - Deletes one or more PowerForms.
• GetPowerForm - Returns a single PowerForm.
• Update - Updates an existing PowerForm.
• Remove - Deletes a PowerForm.
• GetSenders - Gets PowerForm senders.
• GetFormData - Returns the data that users entered in a PowerForm.

RequestLogs

• Retrieve - Gets the API request logging log files.
• Delete - Deletes the request log files.
• Get - Gets a request logging log file.
• GetSettings - Gets the API request logging settings.
• UpdateSettings - Enables or disables API request logging for troubleshooting.

Resources

• List - Lists resources for REST version specified

Services

• GetServiceInformation - Retrieves the available REST API versions.

SigningGroups

• List - Gets a list of the Signing Groups in an account.
• ModifyNames - Updates signing group names.
• Create - Creates a signing group.
• Delete - Deletes one or more signing groups.
• Get - Gets information about a signing group.
• Update - Updates a signing group.
• ListUsers - Gets a list of members in a Signing Group.

SigningGroupUsers

• Add - Adds members to a signing group.
• Delete - Deletes one or more members from a signing group.

TabsBlob

• Get - Reserved for Docusign.
• Put - Reserved for Docusign.

TemplateCustomFields

• Get - Gets the custom document fields from a template.
• Update - Updates envelope custom fields in a template.
• Create - Creates custom document fields in an existing template document.
• Remove - Deletes envelope custom fields in a template.

TemplateDocument

• CreateResponsiveHtmlPreview - Creates a preview of the responsive version of a template document.

TemplateDocumentFields

• Get - Gets the custom document fields for a an existing template document.
• Update - Updates existing custom document fields in an existing template document.
• Create - Creates custom document fields in an existing template document.
• Delete - Deletes custom document fields from an existing template document.

TemplateDocumentHtmlDefinitions

• Get - Gets the Original HTML Definition used to generate the Responsive HTML for a given document in a template.

TemplateDocuments

• List - Gets a list of documents associated with a template.
• Add - Adds documents to a template document.
• DeleteDocuments - Deletes documents from a template.
• Get - Gets PDF documents from a template.
• Update - Updates a template document.

TemplateDocumentTabs

• GetPageTabs - Returns tabs on the specified page.
• List - Returns tabs on a template.
• Update - Updates the tabs for a template.
• Add - Adds tabs to a document in a template.
• Delete - Deletes tabs from a template.

TemplateDocumentVisibility

• Get - Returns document visibility for a template recipient
• UpdateRecipientDocumentVisibility - Updates document visibility for a template recipient

TemplateHtmlDefinitions

• Get - Gets the Original HTML Definition used to generate the Responsive HTML for the template.

TemplateLocks

• Get - Gets template lock information.
• PutTemplateLock - Updates a template lock.
• Lock - Locks a template.
• Delete - Deletes a template lock.

TemplateRecipients

• Get - Gets recipient information from a template.
• Update - Updates recipients in a template.
• Add - Adds tabs for a recipient.
• Delete - Deletes recipients from a template.
• Remove - Deletes the specified recipient file from a template.
• CreateRecipientPreview - Creates a template recipient preview.

TemplateRecipientTabs

• Get - Gets the tabs information for a signer or sign-in-person recipient in a template.
• Update - Updates the tabs for a recipient.
• Add - Adds tabs for a recipient.
• Delete - Deletes the tabs associated with a recipient in a template.

TemplateResponsiveHtmlPreview

• Create - Creates a preview of the responsive versions of all of the documents associated with a template.

Templates

• List - Gets the list of templates.
• Create - Creates one or more templates.
• Get - Gets a specific template associated with a specified account.
• Update - Updates an existing template.
• ShareTemplate - Shares a template with a group.
• DeletePart - Removes a member group's sharing permissions for a template.
• GetPageImages - Returns document page images based on input.
• DeleteDocumentPage - Deletes a page from a document in an template.
• GetPageImage - Gets a page image from a template for display.
• UpdatePageImage - Rotates page image from a template for display.
• GetNotification - Gets template notification information.
• UpdateNotification - Updates the notification structure for an existing template.
• UpdateDocumentVisibility - Updates document visibility for template recipients
• UpdateScheduledSendingRules - Updates the scheduled sending rules for a template's workflow definition.

TemplateViews

• GetEditView - Gets a URL for a template edit view.

TemplateWorkflowDefinition

• Fetch - Returns the workflow definition for a template.

UserCustomSettings

• Get - Retrieves the custom user settings for a specified user.
• AddOrUpdate - Adds or updates custom user settings for the specified user.
• Delete - Deletes custom user settings for a specified user.

UserProfiles

• Get - Retrieves the user profile for a specified user.
• Update - Updates the user profile information for the specified user.

Users

• List - Retrieves the list of users for the specified account.
• Update - Changes one or more users in the specified account.
• Create - Adds new users to the specified account.
• Delete - Closes one or more users in the account.
• Get - Gets the user information for a specified user.
• PutUser - Updates user information for the specified user.
• GetProfileImage - Retrieves the user profile image for the specified user.
• UpdateProfileImage - Updates the user profile image for a specified user.
• DeleteProfileImage - Deletes the user profile image for the specified user.
• GetSettings - Gets the user account settings for a specified user.
• UpdateSettings - Updates the user account settings for a specified user.

UserSignatures

• List - Retrieves a list of signature definitions for a user.
• Update - Adds/updates a user signature.
• Add - Adds user Signature and initials images to a Signature.
• Get - Gets the user signature information for the specified user.
• UpdateById - Updates the user signature for a specified user.
• Delete - Removes removes signature information for the specified user.
• GetUserSignatureImage - Retrieves the user initials image or the user signature image for the specified user.
• UpdateUserSignatureImage - Updates the user signature image or user initials image for the specified user.
• DeleteImage - Deletes the user initials image or the user signature image for the specified user.

WorkspaceItems

• GetFolder - List workspace folder contents
• Delete - Deletes files or sub-folders from a workspace.
• CreateFile - Creates a workspace file.
• GetFile - Gets a workspace file
• UpdateMetadata - Update workspace file or folder metadata

WorkspaceItems.Files

• ListPages - List File Pages

Workspaces

• List - List Workspaces
• Create - Create a Workspace
• Get - Get Workspace
• Update - Update Workspace
• Delete - Delete Workspace

</details>

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply pass a RetryConfig to the call:

using Docusign.All;
using Docusign.All.Models.Requests;

var sdk = new DocusignAll();

var res = await sdk.OAuth.ObtainTokenAsync(
    retryConfig: new RetryConfig(
        strategy: RetryConfig.RetryStrategy.BACKOFF,
        backoff: new BackoffStrategy(
            initialIntervalMs: 1L,
            maxIntervalMs: 50L,
            maxElapsedTimeMs: 100L,
            exponent: 1.1
        ),
        retryConnectionErrors: false
    ),
    security: new ObtainTokenSecurity() {
        Username = "",
        Password = "",
    },
    grantType: GrantType.AuthorizationCode,
    code: "eyJ0eXAiQFsje43QVZ_gw"
);

// handle response

If you'd like to override the default retry strategy for all operations that support retries, you can use the RetryConfig optional parameter when intitializing the SDK:

using Docusign.All;
using Docusign.All.Models.Requests;

var sdk = new DocusignAll(retryConfig: new RetryConfig(
    strategy: RetryConfig.RetryStrategy.BACKOFF,
    backoff: new BackoffStrategy(
        initialIntervalMs: 1L,
        maxIntervalMs: 50L,
        maxElapsedTimeMs: 100L,
        exponent: 1.1
    ),
    retryConnectionErrors: false
));

var res = await sdk.OAuth.ObtainTokenAsync(
    security: new ObtainTokenSecurity() {
        Username = "",
        Password = "",
    },
    grantType: GrantType.AuthorizationCode,
    code: "eyJ0eXAiQFsje43QVZ_gw"
);

// handle response

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.

By default, an API error will raise a Docusign.All.Models.Errors.APIException exception, which has the following properties:

Property	Type	Description
Message	string	The error message
Request	HttpRequestMessage	The HTTP request
Response	HttpResponseMessage	The HTTP response

When custom error responses are specified for an operation, the SDK may also throw their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the ObtainTokenAsync method throws the following exceptions:

Error Type	Status Code	Content Type
Docusign.All.Models.Errors.ErrorDetails	400	application/json
Docusign.All.Models.Errors.APIException	4XX, 5XX	*/*

Example

using Docusign.All;
using Docusign.All.Models.Errors;
using Docusign.All.Models.Requests;

var sdk = new DocusignAll();

try
{
    var res = await sdk.OAuth.ObtainTokenAsync(
        security: new ObtainTokenSecurity() {
            Username = "",
            Password = "",
        },
        grantType: GrantType.AuthorizationCode,
        code: "eyJ0eXAiQFsje43QVZ_gw"
    );

    // handle response
}
catch (Exception ex)
{
    if (ex is Models.Errors.ErrorDetails)
    {
        // Handle exception data
        throw;
    }
    else if (ex is Docusign.All.Models.Errors.APIException)
    {
        // Handle default exception
        throw;
    }
}

Server Selection

Server Variables

The default server https://{domain}/restapi contains variables and is set to https://demo.docusign.net/restapi by default. To override default values, the following parameters are available when initializing the SDK client instance:

Variable	Parameter	Default	Description
domain	domain: string	"demo.docusign.net"	The domain for the Docusign environment to use for SDK calls

Example

using Docusign.All;
using Docusign.All.Models.Requests;

var sdk = new DocusignAll(domain: "official-pulse.name");

var res = await sdk.OAuth.ObtainTokenAsync(
    security: new ObtainTokenSecurity() {
        Username = "",
        Password = "",
    },
    grantType: GrantType.AuthorizationCode,
    code: "eyJ0eXAiQFsje43QVZ_gw"
);

// handle response

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverUrl: string optional parameter when initializing the SDK client instance. For example:

using Docusign.All;
using Docusign.All.Models.Requests;

var sdk = new DocusignAll(serverUrl: "https://demo.docusign.net/restapi");

var res = await sdk.OAuth.ObtainTokenAsync(
    security: new ObtainTokenSecurity() {
        Username = "",
        Password = "",
    },
    grantType: GrantType.AuthorizationCode,
    code: "eyJ0eXAiQFsje43QVZ_gw"
);

// handle response

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy