DocuSign.Api.Workspaces (DocuSign v3.1.1)

View Source

API calls for all endpoints tagged Workspaces.

Summary

Functions

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

Delete Workspace Deletes an existing workspace (logically).

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

Get Workspace Retrieves properties about a workspace given a unique workspaceId.

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

List Workspaces Gets information about the Workspaces that have been created.

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

Create a Workspace This method creates a new workspace.

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

Update Workspace Updates information about a specific workspace.

Functions

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

@spec workspace_delete_workspace(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.Workspace.t()} | {:error, Req.Response.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): The ID of the workspace.
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.Workspace.t} on success
  • {:error, Req.Response.t} on failure

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

@spec workspace_get_workspace(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.Workspace.t()} | {:error, Req.Response.t()}

Get Workspace Retrieves 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): The ID of the workspace.
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.Workspace.t} on success
  • {:error, Req.Response.t} on failure

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

@spec workspace_get_workspaces(DocuSign.Connection.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.WorkspaceList.t()} | {:error, Req.Response.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 (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.WorkspaceList.t} on success
  • {:error, Req.Response.t} on failure

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

@spec workspace_post_workspace(DocuSign.Connection.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.Workspace.t()} | {:error, Req.Response.t()}

Create a Workspace This method 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 (keyword): Optional parameters
    • :body (Workspace):

Returns

  • {:ok, DocuSign.Model.Workspace.t} on success
  • {:error, Req.Response.t} on failure

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

@spec workspace_put_workspace(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.Workspace.t()} | {:error, Req.Response.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): The ID of the workspace.
  • opts (keyword): Optional parameters
    • :body (Workspace):

Returns

  • {:ok, DocuSign.Model.Workspace.t} on success
  • {:error, Req.Response.t} on failure