DocuSign v0.1.2 DocuSign.Api.GroupUsers View Source
API calls for all endpoints tagged GroupUsers
.
Link to this section Summary
Functions
Deletes one or more users from a gro Deletes one or more users from a group
Gets a list of users in a group. Retrieves a list of users in a group
Adds one or more users to an existing group. Adds one or more users to an existing group
Link to this section Functions
groups_delete_group_users(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.GroupUsers.t()} | {:error, Tesla.Env.t()}
Deletes one or more users from a gro Deletes one or more users from a group.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- group_id (String.t): The ID of the group being accessed.
opts (KeywordList): [optional] Optional parameters
- :user_info_list (UserInfoList):
Returns
{:ok, %DocuSign.Model.GroupUsers{}} on success {:error, info} on failure
groups_get_group_users(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.GroupUsers.t()} | {:error, Tesla.Env.t()}
Gets a list of users in a group. Retrieves a list of users in a group.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- group_id (String.t): The ID of the group being accessed.
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.
- :start_position (String.t): Starting value for the list.
Returns
{:ok, %DocuSign.Model.GroupUsers{}} on success {:error, info} on failure
groups_put_group_users(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, DocuSign.Model.GroupUsers.t()} | {:error, Tesla.Env.t()}
Adds one or more users to an existing group. Adds one or more users to an existing group.
Parameters
- connection (DocuSign.Connection): Connection to server
- account_id (String.t): The external account number (int) or account ID Guid.
- group_id (String.t): The ID of the group being accessed.
opts (KeywordList): [optional] Optional parameters
- :user_info_list (UserInfoList):
Returns
{:ok, %DocuSign.Model.GroupUsers{}} on success {:error, info} on failure