DocuSign.Api.Workspaces (DocuSign v0.3.4) 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

Link to this function

workspace_delete_workspace(connection, account_id, workspace_id, opts \\ [])

View Source

Specs

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

} on success {:error, info} on failure

Link to this function

workspace_get_workspace(connection, account_id, workspace_id, opts \\ [])

View Source

Specs

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

} on success {:error, info} on failure

Link to this function

workspace_get_workspaces(connection, account_id, opts \\ [])

View Source

Specs

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

} on success {:error, info} on failure

Link to this function

workspace_post_workspace(connection, account_id, opts \\ [])

View Source

Specs

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

} on success {:error, info} on failure

Link to this function

workspace_put_workspace(connection, account_id, workspace_id, opts \\ [])

View Source

Specs

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

} on success {:error, info} on failure