module:model/LoginAccount

module:model/LoginAccount

new module:model/LoginAccount()

Source:

Constructs a new LoginAccount.

Members

(inner) accountId :String

Source:

The account ID associated with the envelope.

Type:
  • String

(inner) accountIdGuid :String

Source:

The GUID associated with the account ID.

Type:
  • String

(inner) baseUrl :String

Source:

The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl.

Type:
  • String

(inner) email :String

Source:

The email address for the user.

Type:
  • String

(inner) isDefault :String

Source:

This value is true if this is the default account for the user, otherwise false is returned.

Type:
  • String

(inner) loginAccountSettings :Array.<module:model/NameValue>

Source:

A list of settings on the acccount that indicate what features are available.

Type:

(inner) loginUserSettings :Array.<module:model/NameValue>

Source:

A list of user-level settings that indicate what user-specific features are available.

Type:

(inner) name :String

Source:

The name associated with the account.

Type:
  • String

(inner) siteDescription :String

Source:

An optional descirption of the site that hosts the account.

Type:
  • String

(inner) userId :String

Source:
Type:
  • String

(inner) userName :String

Source:

The name of this user as defined by the account.

Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/LoginAccount}

Source:

Constructs a LoginAccount from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.

obj module:model/LoginAccount

Optional instance to populate.

Returns:

The populated LoginAccount instance.

Type
module:model/LoginAccount