com.docusign.esign.api

Class SigningGroupsApi

java.lang.Object

com.docusign.esign.api.SigningGroupsApi

public class SigningGroupsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SigningGroupsApi.ListOptions

Constructor Summary

Constructors

Constructor and Description
SigningGroupsApi()
SigningGroupsApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
SigningGroupInformation	createList(String accountId, SigningGroupInformation signingGroupInformation) Creates a signing group.
SigningGroupInformation	deleteList(String accountId, SigningGroupInformation signingGroupInformation) Deletes one or more signing groups.
SigningGroupUsers	deleteUsers(String accountId, String signingGroupId, SigningGroupUsers signingGroupUsers) Deletes one or more members from a signing group.
SigningGroup	get(String accountId, String signingGroupId) Gets information about a signing group.
ApiClient	getApiClient()
SigningGroupInformation	list(String accountId) Gets a list of the Signing Groups in an account.
SigningGroupInformation	list(String accountId, SigningGroupsApi.ListOptions options) Gets a list of the Signing Groups in an account.
SigningGroupUsers	listUsers(String accountId, String signingGroupId) Gets a list of members in a Signing Group.
void	setApiClient(ApiClient apiClient)
SigningGroup	update(String accountId, String signingGroupId, SigningGroup signingGroup) Updates a signing group.
SigningGroupInformation	updateList(String accountId, SigningGroupInformation signingGroupInformation) Updates signing group names.
SigningGroupUsers	updateUsers(String accountId, String signingGroupId, SigningGroupUsers signingGroupUsers) Adds members to a signing group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SigningGroupsApi

public SigningGroupsApi()

SigningGroupsApi

public SigningGroupsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createList

public SigningGroupInformation createList(String accountId,
                                 SigningGroupInformation signingGroupInformation)
                                   throws ApiException

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.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

signingGroupInformation - (optional)

Returns:

SigningGroupInformation

Throws:

ApiException - if fails to make API call

deleteList

public SigningGroupInformation deleteList(String accountId,
                                 SigningGroupInformation signingGroupInformation)
                                   throws ApiException

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

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

signingGroupInformation - (optional)

Returns:

SigningGroupInformation

Throws:

ApiException - if fails to make API call

deleteUsers

public SigningGroupUsers deleteUsers(String accountId,
                            String signingGroupId,
                            SigningGroupUsers signingGroupUsers)
                              throws ApiException

Deletes one or more members from a signing group. Deletes one or more members from the specified signing group.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

signingGroupId - (required)

signingGroupUsers - (optional)

Returns:

SigningGroupUsers

Throws:

ApiException - if fails to make API call

get

public SigningGroup get(String accountId,
               String signingGroupId)
                 throws ApiException

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

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

signingGroupId - (required)

Returns:

SigningGroup

Throws:

ApiException - if fails to make API call

list

public SigningGroupInformation list(String accountId)
                             throws ApiException

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

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

Returns:

SigningGroupInformation

Throws:

ApiException

list

public SigningGroupInformation list(String accountId,
                           SigningGroupsApi.ListOptions options)
                             throws ApiException

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

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

options - for modifying the method behavior.

Returns:

SigningGroupInformation

Throws:

ApiException - if fails to make API call

listUsers

public SigningGroupUsers listUsers(String accountId,
                          String signingGroupId)
                            throws ApiException

Gets a list of members in a Signing Group. Retrieves the list of members in the specified Signing Group.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

signingGroupId - (required)

Returns:

SigningGroupUsers

Throws:

ApiException - if fails to make API call

update

public SigningGroup update(String accountId,
                  String signingGroupId,
                  SigningGroup signingGroup)
                    throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

signingGroupId - (required)

signingGroup - (optional)

Returns:

SigningGroup

Throws:

ApiException - if fails to make API call

updateList

public SigningGroupInformation updateList(String accountId,
                                 SigningGroupInformation signingGroupInformation)
                                   throws ApiException

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

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

signingGroupInformation - (optional)

Returns:

SigningGroupInformation

Throws:

ApiException - if fails to make API call

updateUsers

public SigningGroupUsers updateUsers(String accountId,
                            String signingGroupId,
                            SigningGroupUsers signingGroupUsers)
                              throws ApiException

Adds members to a signing group. Adds one or more new members to a signing group. A signing group can have a maximum of 50 members.

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

signingGroupId - (required)

signingGroupUsers - (optional)

Returns:

SigningGroupUsers

Throws:

ApiException - if fails to make API call