index

Docusign Node.js API client..

The index module provides access to constructors for all the classes which comprise the public API.

An AMD (recommended!) or CommonJS application will generally do something equivalent to the following:

var Docusign = require('index'); // See note below*.
var xxxSvc = new Docusign.XxxApi(); // Allocate the API class we're going to use.
var yyyModel = new Docusign.Yyy(); // Construct a model instance.
yyyModel.someProperty = 'someValue';
...
var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
...
*NOTE: For a top-level AMD script, use require(['index'], function(){...}) and put the application logic within the callback function.

A non-AMD browser application (discouraged) might do something like this:

var xxxSvc = new Docusign.XxxApi(); // Allocate the API class we're going to use.
var yyy = new Docusign.Yyy(); // Construct a model instance.
yyyModel.someProperty = 'someValue';
...
var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
...

Source:

Members

(static) ApiClient

Source:
Properties:
Type Description
module:ApiClient

The ApiClient constructor.

(static) AuthenticationMethod

Source:
Properties:
Type Description
module:model/AuthenticationMethod

The AuthenticationMethod model constructor.

(static) Configuration

Source:
Properties:
Type Description
module:Configuration

The configuration constructor.

(static) CreateInstanceRequestBody

Source:
Properties:
Type Description
module:model/CreateInstanceRequestBody

The CreateInstanceRequestBody model constructor.

(static) FormInstanceManagementApi

Source:
Properties:
Type Description
module:api/FormInstanceManagementApi

The FormInstanceManagementApi service constructor.

(static) FormManagementApi

Source:
Properties:
Type Description
module:api/FormManagementApi

The FormManagementApi service constructor.

(static) HttpError

Source:
Properties:
Type Description
module:model/HttpError

The HttpError model constructor.

(static) HttpSuccess

Source:
Properties:
Type Description
module:model/HttpSuccess

The HttpSuccess model constructor.

(static) InstanceSource

Source:
Properties:
Type Description
module:model/InstanceSource

The InstanceSource model constructor.

(static) InstanceStatus

Source:
Properties:
Type Description
module:model/InstanceStatus

The InstanceStatus model constructor.

(static) TemplateProperties

Source:
Properties:
Type Description
module:model/TemplateProperties

The TemplateProperties model constructor.

(static) WebForm

Source:
Properties:
Type Description
module:model/WebForm

The WebForm model constructor.

(static) WebFormComponentType

Source:
Properties:
Type Description
module:model/WebFormComponentType

The WebFormComponentType model constructor.

(static) WebFormContent

Source:
Properties:
Type Description
module:model/WebFormContent

The WebFormContent model constructor.

(static) WebFormInstance

Source:
Properties:
Type Description
module:model/WebFormInstance

The WebFormInstance model constructor.

(static) WebFormInstanceEnvelopes

Source:
Properties:
Type Description
module:model/WebFormInstanceEnvelopes

The WebFormInstanceEnvelopes model constructor.

(static) WebFormInstanceList

Source:
Properties:
Type Description
module:model/WebFormInstanceList

The WebFormInstanceList model constructor.

(static) WebFormInstanceMetadata

Source:
Properties:
Type Description
module:model/WebFormInstanceMetadata

The WebFormInstanceMetadata model constructor.

(static) WebFormMetadata

Source:
Properties:
Type Description
module:model/WebFormMetadata

The WebFormMetadata model constructor.

(static) WebFormProperties

Source:
Properties:
Type Description
module:model/WebFormProperties

The WebFormProperties model constructor.

(static) WebFormSource

Source:
Properties:
Type Description
module:model/WebFormSource

The WebFormSource model constructor.

(static) WebFormState

Source:
Properties:
Type Description
module:model/WebFormState

The WebFormState model constructor.

(static) WebFormSummary

Source:
Properties:
Type Description
module:model/WebFormSummary

The WebFormSummary model constructor.

(static) WebFormSummaryList

Source:
Properties:
Type Description
module:model/WebFormSummaryList

The WebFormSummaryList model constructor.

(static) WebFormType

Source:
Properties:
Type Description
module:model/WebFormType

The WebFormType model constructor.

(static) WebFormUserInfo

Source:
Properties:
Type Description
module:model/WebFormUserInfo

The WebFormUserInfo model constructor.

(static) WebFormValues

Source:
Properties:
Type Description
module:model/WebFormValues

The WebFormValues model constructor.