module:model/Workspace

module:model/Workspace

new module:model/Workspace()

Source:

Constructs a new Workspace.
Provides properties that describe a workspace.

Members

(inner) billableAccountId :String

Source:
Type:
  • String

(inner) callerInformation :module:model/WorkspaceUser

Source:
Type:

(inner) created :String

Source:
Type:
  • String

(inner) createdByInformation :module:model/WorkspaceUser

Source:

Details about the user who created the workspace.

Type:

(inner) lastModified :String

Source:

Utc date and time the comment was last updated (can only be done by creator.)

Type:
  • String

(inner) lastModifiedByInformation :module:model/WorkspaceUser

Source:

Details about the user who last modified the workspace.

Type:

(inner) settings :module:model/WorkspaceSettings

Source:

Information about the settings for the workspace.

Type:

(inner) status :String

Source:

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Type:
  • String

(inner) workspaceBaseUrl :String

Source:

The relative URL that may be used to access the workspace.

Type:
  • String

(inner) workspaceDescription :String

Source:

Text describing the purpose of the workspace.

Type:
  • String

(inner) workspaceId :String

Source:

The id of the workspace, always populated.

Type:
  • String

(inner) workspaceName :String

Source:

The name of the workspace.

Type:
  • String

(inner) workspaceUri :String

Source:

The relative URI that may be used to access the workspace.

Type:
  • String

Methods

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

Source:

Constructs a Workspace 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/Workspace

Optional instance to populate.

Returns:

The populated Workspace instance.

Type
module:model/Workspace