Namespace: envelopes

Methods

envelopes.create (descriptor, body)Envelope asyncstatic

Creates a new envelope

Name	Type	Default	Description
descriptor	string		Envelope descriptor
body	object	{}	optional API request payload

Returns:

Type	Description
Envelope

envelopes.get (id)Envelope asyncstatic

Gets an envelope by its id

Name	Type	Description
id	string	Envelope id

Returns:

Type	Description
Envelope

envelopes.getDescriptor (descriptorId)json asyncstatic

Gets an envelope by its id

Name	Type	Description
descriptorId	string	Descriptor id

Returns:

Type	Description
json	Descriptor data

envelopes.getFromUrl ()Envelope asyncstatic

Gets an envelope from the document_uid URL parameter

Returns:

Type	Description
Envelope

envelopes.query ()json asyncstatic

Creates a new envelope

Returns:

Type	Description
json	List of envelopes