View Source DocuSign.Api.SigningGroups (DocuSign v1.3.0)

API calls for all endpoints tagged SigningGroups.

Summary

Functions

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

Deletes one or more signing groups. Deletes one or more signing groups in the specified account.

signing_groups_get_signing_group(connection, account_id, signing_group_id, opts \\ [])

Gets information about a signing group. Retrieves information, including group member information, for the specified signing group.

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

Gets a list of the Signing Groups in an account. Retrieves a list of all signing groups in the specified account.

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

Creates a signing group. Creates one or more signing groups. Multiple signing groups can be created in one call. Only users with account administrator privileges can create signing groups. An account can have a maximum of 50 signing groups. Each signing group can have a maximum of 50 group members. Signing groups can be used by any account user.

signing_groups_put_signing_group(connection, account_id, signing_group_id, opts \\ [])

Updates a signing group. Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members.

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

Updates signing group names. Updates the name of one or more existing signing groups.

Functions

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

@spec signing_groups_delete_signing_groups(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.SigningGroupInformation.t()}
  | {:error, Tesla.Env.t()}

Deletes one or more signing groups. Deletes one or more signing groups in the specified account.

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 (SigningGroupInformation):

Returns

{:ok, DocuSign.Model.SigningGroupInformation.t} on success
{:error, Tesla.Env.t} on failure

signing_groups_get_signing_group(connection, account_id, signing_group_id, opts \\ [])

@spec signing_groups_get_signing_group(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.SigningGroup.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Gets information about a signing group. Retrieves information, including group member information, for the specified signing group.

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
signing_group_id (String.t): The ID of the signing group.
opts (keyword): Optional parameters

Returns

{:ok, DocuSign.Model.SigningGroup.t} on success
{:error, Tesla.Env.t} on failure

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

@spec signing_groups_get_signing_groups(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.SigningGroupInformation.t()}
  | {:error, Tesla.Env.t()}

Gets a list of the Signing Groups in an account. Retrieves a list of all signing groups in the specified account.

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
opts (keyword): Optional parameters
- :group_type (String.t): Filters by the type of signing group. Valid values: sharedSigningGroup privateSigningGroup * systemSigningGroup
- :include_users (String.t): When true, the response includes the signing group members.

Returns

{:ok, DocuSign.Model.SigningGroupInformation.t} on success
{:error, Tesla.Env.t} on failure

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

@spec signing_groups_post_signing_groups(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.SigningGroupInformation.t()}
  | {:error, Tesla.Env.t()}

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 (SigningGroupInformation):

Returns

{:ok, DocuSign.Model.SigningGroupInformation.t} on success
{:error, Tesla.Env.t} on failure

signing_groups_put_signing_group(connection, account_id, signing_group_id, opts \\ [])

@spec signing_groups_put_signing_group(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.SigningGroup.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Updates a signing group. Updates signing group name and member information. You can also add new members to the signing group. A signing group can have a maximum of 50 members.

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
signing_group_id (String.t): The ID of the signing group.
opts (keyword): Optional parameters
- :body (SigningGroup):

Returns

{:ok, DocuSign.Model.SigningGroup.t} on success
{:error, Tesla.Env.t} on failure

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

@spec signing_groups_put_signing_groups(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.SigningGroupInformation.t()}
  | {:error, Tesla.Env.t()}

Updates signing group names. Updates the name of one or more existing signing groups.

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 (SigningGroupInformation):

Returns

{:ok, DocuSign.Model.SigningGroupInformation.t} on success
{:error, Tesla.Env.t} on failure