DocuSign v0.1.2 DocuSign.Api.Workspaces View Source
API calls for all endpoints tagged Workspaces
.
Link to this section Summary
Functions
Delete Workspace Deletes an existing workspace (logically)
Get Workspace Retrives properties about a workspace given a unique workspaceId
List Workspaces Gets information about the Workspaces that have been created
Create a Workspace Creates a new workspace
Update Workspace Updates information about a specific workspace
Link to this section Functions
workspace_delete_workspace( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.Workspaces.t()} | {:error, Tesla.Env.t()}
Delete Workspace Deletes an existing workspace (logically).
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- workspace_id (String.t): Specifies the workspace ID GUID.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %DocuSign.Model.Workspaces{}} on success {:error, info} on failure
workspace_get_workspace(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.Workspaces.t()} | {:error, Tesla.Env.t()}
Get Workspace Retrives properties about a workspace given a unique workspaceId.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- workspace_id (String.t): Specifies the workspace ID GUID.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %DocuSign.Model.Workspaces{}} on success {:error, info} on failure
workspace_get_workspaces(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.WorkspaceList.t()} | {:error, Tesla.Env.t()}
List Workspaces Gets information about the Workspaces that have been created.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %DocuSign.Model.WorkspaceList{}} on success {:error, info} on failure
workspace_post_workspace(Tesla.Env.client(), String.t(), keyword()) :: {:ok, DocuSign.Model.Workspaces.t()} | {:error, Tesla.Env.t()}
Create a Workspace Creates a new workspace.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
opts (KeywordList): [optional] Optional parameters
- :workspaces (Workspaces):
Returns
{:ok, %DocuSign.Model.Workspaces{}} on success {:error, info} on failure
workspace_put_workspace(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.Workspaces.t()} | {:error, Tesla.Env.t()}
Update Workspace Updates information about a specific workspace.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- workspace_id (String.t): Specifies the workspace ID GUID.
opts (KeywordList): [optional] Optional parameters
- :workspaces (Workspaces):
Returns
{:ok, %DocuSign.Model.Workspaces{}} on success {:error, info} on failure