index - Documentation

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:

index.js, line 22

Members

(static) AccessTokenResponse

Source:

index.js, line 67

Properties:

Type	Description
module:model/AccessTokenResponse

The AccessTokenResponse model constructor.

(static) AccessTokenTokenTypes

Source:

index.js, line 72

Properties:

Type	Description
module:model/AccessTokenTokenTypes

The AccessTokenTokenTypes model constructor.

(static) ApiClient

Source:

index.js, line 62

Properties:

Type	Description
module:ApiClient

The ApiClient constructor.

(static) CancelResponse

Source:

index.js, line 77

Properties:

Type	Description
module:model/CancelResponse

The CancelResponse model constructor.

(static) Configuration

Source:

index.js, line 57

Properties:

Type	Description
module:Configuration

The configuration constructor.

(static) CreateOrUpdateWorkflowDefinitionRequestBody

Source:

index.js, line 82

Properties:

Type	Description
module:model/CreateOrUpdateWorkflowDefinitionRequestBody

The CreateOrUpdateWorkflowDefinitionRequestBody model constructor.

(static) DeploymentStatus

Source:

index.js, line 402

Properties:

Type	Description
module:model/DeploymentStatus

The DeploymentStatus model constructor.

(static) DeployRequest

Source:

index.js, line 387

Properties:

Type	Description
module:model/DeployRequest

The DeployRequest model constructor.

(static) DeployResponse

Source:

index.js, line 392

Properties:

Type	Description
module:model/DeployResponse

The DeployResponse model constructor.

(static) DeployStatus

Source:

index.js, line 397

Properties:

Type	Description
module:model/DeployStatus

The DeployStatus model constructor.

(static) DSDocGenStep

Source:

index.js, line 92

Properties:

Type	Description
module:model/DSDocGenStep

The DSDocGenStep model constructor.

(static) DSDocGenStepInput

Source:

index.js, line 97

Properties:

Type	Description
module:model/DSDocGenStepInput

The DSDocGenStepInput model constructor.

(static) DSDoUntilStep

Source:

index.js, line 87

Properties:

Type	Description
module:model/DSDoUntilStep

The DSDoUntilStep model constructor.

(static) DSIdvStep

Source:

index.js, line 102

Properties:

Type	Description
module:model/DSIdvStep

The DSIdvStep model constructor.

(static) DSIdvStepInput

Source:

index.js, line 107

Properties:

Type	Description
module:model/DSIdvStepInput

The DSIdvStepInput model constructor.

(static) DSIfElseStep

Source:

index.js, line 112

Properties:

Type	Description
module:model/DSIfElseStep

The DSIfElseStep model constructor.

(static) DSLoopStep

Source:

index.js, line 117

Properties:

Type	Description
module:model/DSLoopStep

The DSLoopStep model constructor.

(static) DSParallelStep

Source:

index.js, line 122

Properties:

Type	Description
module:model/DSParallelStep

The DSParallelStep model constructor.

(static) DSServiceStep

Source:

index.js, line 127

Properties:

Type	Description
module:model/DSServiceStep

The DSServiceStep model constructor.

(static) DSSignStep

Source:

index.js, line 132

Properties:

Type	Description
module:model/DSSignStep

The DSSignStep model constructor.

(static) DSSignStepInput

Source:

index.js, line 137

Properties:

Type	Description
module:model/DSSignStepInput

The DSSignStepInput model constructor.

(static) DSTransformationStep

Source:

index.js, line 142

Properties:

Type	Description
module:model/DSTransformationStep

The DSTransformationStep model constructor.

(static) DSWebFormsStep

Source:

index.js, line 147

Properties:

Type	Description
module:model/DSWebFormsStep

The DSWebFormsStep model constructor.

(static) DSWebFormsStepConfig

Source:

index.js, line 152

Properties:

Type	Description
module:model/DSWebFormsStepConfig

The DSWebFormsStepConfig model constructor.

(static) DSWorkflowBooleanExpression

Source:

index.js, line 157

Properties:

Type	Description
module:model/DSWorkflowBooleanExpression

The DSWorkflowBooleanExpression model constructor.

(static) DSWorkflowComparisonExpression

Source:

index.js, line 162

Properties:

Type	Description
module:model/DSWorkflowComparisonExpression

The DSWorkflowComparisonExpression model constructor.

(static) DSWorkflowComparisonOperatorTypes

Source:

index.js, line 167

Properties:

Type	Description
module:model/DSWorkflowComparisonOperatorTypes

The DSWorkflowComparisonOperatorTypes model constructor.

(static) DSWorkflowConcatExpression

Source:

index.js, line 172

Properties:

Type	Description
module:model/DSWorkflowConcatExpression

The DSWorkflowConcatExpression model constructor.

(static) DSWorkflowDocGenDocOutputFormat

Source:

index.js, line 177

Properties:

Type	Description
module:model/DSWorkflowDocGenDocOutputFormat

The DSWorkflowDocGenDocOutputFormat model constructor.

(static) DSWorkflowExpressionTypesBooleanExpression

Source:

index.js, line 182

Properties:

Type	Description
module:model/DSWorkflowExpressionTypesBooleanExpression

The DSWorkflowExpressionTypesBooleanExpression model constructor.

(static) DSWorkflowExpressionTypesComparisonExpression

Source:

index.js, line 187

Properties:

Type	Description
module:model/DSWorkflowExpressionTypesComparisonExpression

The DSWorkflowExpressionTypesComparisonExpression model constructor.

(static) DSWorkflowExpressionTypesParallelExpression

Source:

index.js, line 192

Properties:

Type	Description
module:model/DSWorkflowExpressionTypesParallelExpression

The DSWorkflowExpressionTypesParallelExpression model constructor.

(static) DSWorkflowIndexOfExpression

Source:

index.js, line 197

Properties:

Type	Description
module:model/DSWorkflowIndexOfExpression

The DSWorkflowIndexOfExpression model constructor.

(static) DSWorkflowLane

Source:

index.js, line 202

Properties:

Type	Description
module:model/DSWorkflowLane

The DSWorkflowLane model constructor.

(static) DSWorkflowLanesRecord

Source:

index.js, line 207

Properties:

Type	Description
module:model/DSWorkflowLanesRecord

The DSWorkflowLanesRecord model constructor.

(static) DSWorkflowLastIndexOfExpression

Source:

index.js, line 212

Properties:

Type	Description
module:model/DSWorkflowLastIndexOfExpression

The DSWorkflowLastIndexOfExpression model constructor.

(static) DSWorkflowLogicalOperatorTypes

Source:

index.js, line 217

Properties:

Type	Description
module:model/DSWorkflowLogicalOperatorTypes

The DSWorkflowLogicalOperatorTypes model constructor.

(static) DSWorkflowParallelExpression

Source:

index.js, line 222

Properties:

Type	Description
module:model/DSWorkflowParallelExpression

The DSWorkflowParallelExpression model constructor.

(static) DSWorkflowParticipantRecord

Source:

index.js, line 227

Properties:

Type	Description
module:model/DSWorkflowParticipantRecord

The DSWorkflowParticipantRecord model constructor.

(static) DSWorkflowReplaceExpression

Source:

index.js, line 232

Properties:

Type	Description
module:model/DSWorkflowReplaceExpression

The DSWorkflowReplaceExpression model constructor.

(static) DSWorkflowStep

Source:

index.js, line 237

Properties:

Type	Description
module:model/DSWorkflowStep

The DSWorkflowStep model constructor.

(static) DSWorkflowStepTypesDoUntil

Source:

index.js, line 272

Properties:

Type	Description
module:model/DSWorkflowStepTypesDoUntil

The DSWorkflowStepTypesDoUntil model constructor.

(static) DSWorkflowStepTypesDSDocGen

Source:

index.js, line 242

Properties:

Type	Description
module:model/DSWorkflowStepTypesDSDocGen

The DSWorkflowStepTypesDSDocGen model constructor.

(static) DSWorkflowStepTypesDSIdv

Source:

index.js, line 247

Properties:

Type	Description
module:model/DSWorkflowStepTypesDSIdv

The DSWorkflowStepTypesDSIdv model constructor.

(static) DSWorkflowStepTypesDSIfElse

Source:

index.js, line 252

Properties:

Type	Description
module:model/DSWorkflowStepTypesDSIfElse

The DSWorkflowStepTypesDSIfElse model constructor.

(static) DSWorkflowStepTypesDSSign

Source:

index.js, line 257

Properties:

Type	Description
module:model/DSWorkflowStepTypesDSSign

The DSWorkflowStepTypesDSSign model constructor.

(static) DSWorkflowStepTypesDSTransformation

Source:

index.js, line 262

Properties:

Type	Description
module:model/DSWorkflowStepTypesDSTransformation

The DSWorkflowStepTypesDSTransformation model constructor.

(static) DSWorkflowStepTypesDSWebForms

Source:

index.js, line 267

Properties:

Type	Description
module:model/DSWorkflowStepTypesDSWebForms

The DSWorkflowStepTypesDSWebForms model constructor.

(static) DSWorkflowStepTypesLoop

Source:

index.js, line 277

Properties:

Type	Description
module:model/DSWorkflowStepTypesLoop

The DSWorkflowStepTypesLoop model constructor.

(static) DSWorkflowStepTypesParallel

Source:

index.js, line 282

Properties:

Type	Description
module:model/DSWorkflowStepTypesParallel

The DSWorkflowStepTypesParallel model constructor.

(static) DSWorkflowSubstringExpression

Source:

index.js, line 287

Properties:

Type	Description
module:model/DSWorkflowSubstringExpression

The DSWorkflowSubstringExpression model constructor.

(static) DSWorkflowToLowerExpression

Source:

index.js, line 292

Properties:

Type	Description
module:model/DSWorkflowToLowerExpression

The DSWorkflowToLowerExpression model constructor.

(static) DSWorkflowToUpperExpression

Source:

index.js, line 297

Properties:

Type	Description
module:model/DSWorkflowToUpperExpression

The DSWorkflowToUpperExpression model constructor.

(static) DSWorkflowTransformationExpression

Source:

index.js, line 302

Properties:

Type	Description
module:model/DSWorkflowTransformationExpression

The DSWorkflowTransformationExpression model constructor.

(static) DSWorkflowTransformationExpressionTypesConcatExpression

Source:

index.js, line 307

Properties:

Type	Description
module:model/DSWorkflowTransformationExpressionTypesConcatExpression

The DSWorkflowTransformationExpressionTypesConcatExpression model constructor.

(static) DSWorkflowTransformationExpressionTypesIndexOfExpression

Source:

index.js, line 312

Properties:

Type	Description
module:model/DSWorkflowTransformationExpressionTypesIndexOfExpression

The DSWorkflowTransformationExpressionTypesIndexOfExpression model constructor.

(static) DSWorkflowTransformationExpressionTypesLastIndexOfExpression

Source:

index.js, line 317

Properties:

Type	Description
module:model/DSWorkflowTransformationExpressionTypesLastIndexOfExpression

The DSWorkflowTransformationExpressionTypesLastIndexOfExpression model constructor.

(static) DSWorkflowTransformationExpressionTypesReplaceExpression

Source:

index.js, line 322

Properties:

Type	Description
module:model/DSWorkflowTransformationExpressionTypesReplaceExpression

The DSWorkflowTransformationExpressionTypesReplaceExpression model constructor.

(static) DSWorkflowTransformationExpressionTypesSubstringExpression

Source:

index.js, line 327

Properties:

Type	Description
module:model/DSWorkflowTransformationExpressionTypesSubstringExpression

The DSWorkflowTransformationExpressionTypesSubstringExpression model constructor.

(static) DSWorkflowTransformationExpressionTypesToLowerExpression

Source:

index.js, line 332

Properties:

Type	Description
module:model/DSWorkflowTransformationExpressionTypesToLowerExpression

The DSWorkflowTransformationExpressionTypesToLowerExpression model constructor.

(static) DSWorkflowTransformationExpressionTypesToUpperExpression

Source:

index.js, line 337

Properties:

Type	Description
module:model/DSWorkflowTransformationExpressionTypesToUpperExpression

The DSWorkflowTransformationExpressionTypesToUpperExpression model constructor.

(static) DSWorkflowTrigger

Source:

index.js, line 342

Properties:

Type	Description
module:model/DSWorkflowTrigger

The DSWorkflowTrigger model constructor.

(static) DSWorkflowTriggerTypes

Source:

index.js, line 347

Properties:

Type	Description
module:model/DSWorkflowTriggerTypes

The DSWorkflowTriggerTypes model constructor.

(static) DSWorkflowVariable

Source:

index.js, line 352

Properties:

Type	Description
module:model/DSWorkflowVariable

The DSWorkflowVariable model constructor.

(static) DSWorkflowVariableFromParticipant

Source:

index.js, line 357

Properties:

Type	Description
module:model/DSWorkflowVariableFromParticipant

The DSWorkflowVariableFromParticipant model constructor.

(static) DSWorkflowVariableFromStep

Source:

index.js, line 362

Properties:

Type	Description
module:model/DSWorkflowVariableFromStep

The DSWorkflowVariableFromStep model constructor.

(static) DSWorkflowVariableFromVariable

Source:

index.js, line 367

Properties:

Type	Description
module:model/DSWorkflowVariableFromVariable

The DSWorkflowVariableFromVariable model constructor.

(static) DSWorkflowVariableRecord

Source:

index.js, line 372

Properties:

Type	Description
module:model/DSWorkflowVariableRecord

The DSWorkflowVariableRecord model constructor.

(static) DSWorkflowVariableSourceTypesStep

Source:

index.js, line 377

Properties:

Type	Description
module:model/DSWorkflowVariableSourceTypesStep

The DSWorkflowVariableSourceTypesStep model constructor.

(static) DSWorkflowVariableSourceTypesVariable

Source:

index.js, line 382

Properties:

Type	Description
module:model/DSWorkflowVariableSourceTypesVariable

The DSWorkflowVariableSourceTypesVariable model constructor.

(static) ErrorCodes

Source:

index.js, line 452

Properties:

Type	Description
module:model/ErrorCodes

The ErrorCodes model constructor.

(static) ErrorResponse

Source:

index.js, line 457

Properties:

Type	Description
module:model/ErrorResponse

The ErrorResponse model constructor.

(static) ESignDocumentFromESignTemplate

Source:

index.js, line 407

Properties:

Type	Description
module:model/ESignDocumentFromESignTemplate

The ESignDocumentFromESignTemplate model constructor.

(static) ESignDocumentFromPreviousStep

Source:

index.js, line 412

Properties:

Type	Description
module:model/ESignDocumentFromPreviousStep

The ESignDocumentFromPreviousStep model constructor.

(static) ESignDocuments

Source:

index.js, line 427

Properties:

Type	Description
module:model/ESignDocuments

The ESignDocuments model constructor.

(static) ESignDocumentTypesFromDSTemplate

Source:

index.js, line 417

Properties:

Type	Description
module:model/ESignDocumentTypesFromDSTemplate

The ESignDocumentTypesFromDSTemplate model constructor.

(static) ESignDocumentTypesFromPreviousStep

Source:

index.js, line 422

Properties:

Type	Description
module:model/ESignDocumentTypesFromPreviousStep

The ESignDocumentTypesFromPreviousStep model constructor.

(static) ESignLocalePolicy

Source:

index.js, line 432

Properties:

Type	Description
module:model/ESignLocalePolicy

The ESignLocalePolicy model constructor.

(static) ESignSigner

Source:

index.js, line 437

Properties:

Type	Description
module:model/ESignSigner

The ESignSigner model constructor.

(static) ESignTabs

Source:

index.js, line 442

Properties:

Type	Description
module:model/ESignTabs

The ESignTabs model constructor.

(static) ESignTabsRecord

Source:

index.js, line 447

Properties:

Type	Description
module:model/ESignTabsRecord

The ESignTabsRecord model constructor.

(static) EventTypes

Source:

index.js, line 462

Properties:

Type	Description
module:model/EventTypes

The EventTypes model constructor.

(static) GetConfigurationInstanceResponse

Source:

index.js, line 467

Properties:

Type	Description
module:model/GetConfigurationInstanceResponse

The GetConfigurationInstanceResponse model constructor.

(static) GetConfigurationInstancesResponse

Source:

index.js, line 472

Properties:

Type	Description
module:model/GetConfigurationInstancesResponse

The GetConfigurationInstancesResponse model constructor.

(static) GetConfigurationInstancesResponseConfigInstances

Source:

index.js, line 477

Properties:

Type	Description
module:model/GetConfigurationInstancesResponseConfigInstances

The GetConfigurationInstancesResponseConfigInstances model constructor.

(static) HttpTypes

Source:

index.js, line 482

Properties:

Type	Description
module:model/HttpTypes

The HttpTypes model constructor.

(static) InvalidWorkflowResponse

Source:

index.js, line 487

Properties:

Type	Description
module:model/InvalidWorkflowResponse

The InvalidWorkflowResponse model constructor.

(static) NewOrUpdatedWorkflowDefinitionResponse

Source:

index.js, line 492

Properties:

Type	Description
module:model/NewOrUpdatedWorkflowDefinitionResponse

The NewOrUpdatedWorkflowDefinitionResponse model constructor.

(static) NumberOrVariable

Source:

index.js, line 497

Properties:

Type	Description
module:model/NumberOrVariable

The NumberOrVariable model constructor.

(static) Participant

Source:

index.js, line 502

Properties:

Type	Description
module:model/Participant

The Participant model constructor.

(static) ProgressInstance

Source:

index.js, line 507

Properties:

Type	Description
module:model/ProgressInstance

The ProgressInstance model constructor.

(static) RecordStringBoolean

Source:

index.js, line 512

Properties:

Type	Description
module:model/RecordStringBoolean

The RecordStringBoolean model constructor.

(static) RecordStringOrVariableOrTransformation

Source:

index.js, line 517

Properties:

Type	Description
module:model/RecordStringOrVariableOrTransformation

The RecordStringOrVariableOrTransformation model constructor.

(static) RecordToNever

Source:

index.js, line 522

Properties:

Type	Description
module:model/RecordToNever

The RecordToNever model constructor.

(static) ReplicationStatus

Source:

index.js, line 527

Properties:

Type	Description
module:model/ReplicationStatus

The ReplicationStatus model constructor.

(static) StartedByInstance

Source:

index.js, line 532

Properties:

Type	Description
module:model/StartedByInstance

The StartedByInstance model constructor.

(static) StringOrVariableOrTransformation

Source:

index.js, line 537

Properties:

Type	Description
module:model/StringOrVariableOrTransformation

The StringOrVariableOrTransformation model constructor.

(static) SuccessMessageResponse

Source:

index.js, line 542

Properties:

Type	Description
module:model/SuccessMessageResponse

The SuccessMessageResponse model constructor.

(static) TriggerPayload

Source:

index.js, line 547

Properties:

Type	Description
module:model/TriggerPayload

The TriggerPayload model constructor.

(static) TriggerWorkflowViaPostResponse

Source:

index.js, line 552

Properties:

Type	Description
module:model/TriggerWorkflowViaPostResponse

The TriggerWorkflowViaPostResponse model constructor.

(static) ValidationErrors

Source:

index.js, line 557

Properties:

Type	Description
module:model/ValidationErrors

The ValidationErrors model constructor.

(static) WorkflowDefinition

Source:

index.js, line 562

Properties:

Type	Description
module:model/WorkflowDefinition

The WorkflowDefinition model constructor.

(static) WorkflowDefinitionList

Source:

index.js, line 567

Properties:

Type	Description
module:model/WorkflowDefinitionList

The WorkflowDefinitionList model constructor.

(static) WorkflowDefinitionMetadata

Source:

index.js, line 572

Properties:

Type	Description
module:model/WorkflowDefinitionMetadata

The WorkflowDefinitionMetadata model constructor.

(static) WorkflowDefinitionWithId

Source:

index.js, line 577

Properties:

Type	Description
module:model/WorkflowDefinitionWithId

The WorkflowDefinitionWithId model constructor.

(static) WorkflowDeleteResponse

Source:

index.js, line 582

Properties:

Type	Description
module:model/WorkflowDeleteResponse

The WorkflowDeleteResponse model constructor.

(static) WorkflowInstance

Source:

index.js, line 587

Properties:

Type	Description
module:model/WorkflowInstance

The WorkflowInstance model constructor.

(static) WorkflowInstanceManagementApi

Source:

index.js, line 637

Properties:

Type	Description
module:api/WorkflowInstanceManagementApi

The WorkflowInstanceManagementApi service constructor.

(static) WorkflowInstanceMap

Source:

index.js, line 592

Properties:

Type	Description
module:model/WorkflowInstanceMap

The WorkflowInstanceMap model constructor.

(static) WorkflowInstancesList

Source:

index.js, line 602

Properties:

Type	Description
module:model/WorkflowInstancesList

The WorkflowInstancesList model constructor.

(static) WorkflowInstanceState

Source:

index.js, line 597

Properties:

Type	Description
module:model/WorkflowInstanceState

The WorkflowInstanceState model constructor.

(static) WorkflowManagementApi

Source:

index.js, line 642

Properties:

Type	Description
module:api/WorkflowManagementApi

The WorkflowManagementApi service constructor.

(static) WorkflowMetadataStatus

Source:

index.js, line 607

Properties:

Type	Description
module:model/WorkflowMetadataStatus

The WorkflowMetadataStatus model constructor.

(static) WorkflowStepError

Source:

index.js, line 612

Properties:

Type	Description
module:model/WorkflowStepError

The WorkflowStepError model constructor.

(static) WorkflowStepErrorError

Source:

index.js, line 617

Properties:

Type	Description
module:model/WorkflowStepErrorError

The WorkflowStepErrorError model constructor.

(static) WorkflowStepHistory

Source:

index.js, line 622

Properties:

Type	Description
module:model/WorkflowStepHistory

The WorkflowStepHistory model constructor.

(static) WorkflowStepHistoryList

Source:

index.js, line 627

Properties:

Type	Description
module:model/WorkflowStepHistoryList

The WorkflowStepHistoryList model constructor.

(static) WorkflowStepHistoryState

Source:

index.js, line 632

Properties:

Type	Description
module:model/WorkflowStepHistoryState

The WorkflowStepHistoryState model constructor.

(static) WorkflowTriggerApi

Source:

index.js, line 647

Properties:

Type	Description
module:api/WorkflowTriggerApi

The WorkflowTriggerApi service constructor.