DocuSign.Api.Groups (DocuSign v0.3.3) View Source

API calls for all endpoints tagged Groups.

Link to this section Summary

Functions

Deletes an existing user group. Deletes an existing user group.

Gets information about groups associated with the account. Retrieves information about groups associated with the account.

Creates one or more groups for the account. Creates one or more groups for the account. Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.

Updates the group information for a group. Updates the group name and modifies, or sets, the permission profile for the group.

Link to this section Functions

Link to this function

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

View Source

Specs

groups_delete_groups(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.Groups.t()} | {:error, Tesla.Env.t()}

Deletes an existing user group. Deletes an existing user group.

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
    • :groups (Groups):

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

groups_get_groups(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.Groups.t()} | {:error, Tesla.Env.t()}

Gets information about groups associated with the account. Retrieves information about groups associated with the account.

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
    • :count (String.t): Number of records to return. The number must be greater than 1 and less than or equal to 100.
    • :group_type (String.t):
    • :search_text (String.t):
    • :start_position (String.t): Starting value for the list.

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

groups_post_groups(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.Groups.t()} | {:error, Tesla.Env.t()}

Creates one or more groups for the account. Creates one or more groups for the account. Groups can be used to help manage users by associating users with a group. You can associate a group with a Permission Profile, which sets the user permissions for users in that group without having to set the `userSettings` property for each user. You are not required to set Permission Profiles for a group, but it makes it easier to manage user permissions for a large number of users. You can also use groups with template sharing to limit user access to templates.

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
    • :groups (Groups):

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

groups_put_groups(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.Groups.t()} | {:error, Tesla.Env.t()}

Updates the group information for a group. Updates the group name and modifies, or sets, the permission profile for the group.

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
    • :groups (Groups):

Returns

} on success {:error, info} on failure