DocuSign CSharp Docs
Public Member Functions | List of all members
DocuSign.eSign.Api.ISigningGroupsApi Interface Reference

Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for DocuSign.eSign.Api.ISigningGroupsApi:
DocuSign.eSign.Client.IApiAccessor DocuSign.eSign.Api.SigningGroupsApi

Public Member Functions

SigningGroupInformation CreateList (string accountId, SigningGroupInformation signingGroupInformation=null)
 Creates a signing group. More...
 
ApiResponse< SigningGroupInformationCreateListWithHttpInfo (string accountId, SigningGroupInformation signingGroupInformation=null)
 Creates a signing group. More...
 
SigningGroupInformation DeleteList (string accountId, SigningGroupInformation signingGroupInformation=null)
 Deletes one or more signing groups. More...
 
ApiResponse< SigningGroupInformationDeleteListWithHttpInfo (string accountId, SigningGroupInformation signingGroupInformation=null)
 Deletes one or more signing groups. More...
 
SigningGroupUsers DeleteUsers (string accountId, string signingGroupId, SigningGroupUsers signingGroupUsers=null)
 Deletes one or more members from a signing group. More...
 
ApiResponse< SigningGroupUsersDeleteUsersWithHttpInfo (string accountId, string signingGroupId, SigningGroupUsers signingGroupUsers=null)
 Deletes one or more members from a signing group. More...
 
SigningGroup Get (string accountId, string signingGroupId)
 Gets information about a signing group. More...
 
ApiResponse< SigningGroupGetWithHttpInfo (string accountId, string signingGroupId)
 Gets information about a signing group. More...
 
SigningGroupInformation List (string accountId, SigningGroupsApi.ListOptions options=null)
 Gets a list of the Signing Groups in an account. More...
 
ApiResponse< SigningGroupInformationListWithHttpInfo (string accountId, SigningGroupsApi.ListOptions options=null)
 Gets a list of the Signing Groups in an account. More...
 
SigningGroupUsers ListUsers (string accountId, string signingGroupId)
 Gets a list of members in a Signing Group. More...
 
ApiResponse< SigningGroupUsersListUsersWithHttpInfo (string accountId, string signingGroupId)
 Gets a list of members in a Signing Group. More...
 
SigningGroup Update (string accountId, string signingGroupId, SigningGroup signingGroup=null)
 Updates a signing group. More...
 
ApiResponse< SigningGroupUpdateWithHttpInfo (string accountId, string signingGroupId, SigningGroup signingGroup=null)
 Updates a signing group. More...
 
SigningGroupInformation UpdateList (string accountId, SigningGroupInformation signingGroupInformation=null)
 Updates signing group names. More...
 
ApiResponse< SigningGroupInformationUpdateListWithHttpInfo (string accountId, SigningGroupInformation signingGroupInformation=null)
 Updates signing group names. More...
 
SigningGroupUsers UpdateUsers (string accountId, string signingGroupId, SigningGroupUsers signingGroupUsers=null)
 Adds members to a signing group. More...
 
ApiResponse< SigningGroupUsersUpdateUsersWithHttpInfo (string accountId, string signingGroupId, SigningGroupUsers signingGroupUsers=null)
 Adds members to a signing group. More...
 
System.Threading.Tasks.Task< SigningGroupInformationCreateListAsync (string accountId, SigningGroupInformation signingGroupInformation=null)
 Creates a signing group. More...
 
System.Threading.Tasks.Task< ApiResponse< SigningGroupInformation > > CreateListAsyncWithHttpInfo (string accountId, SigningGroupInformation signingGroupInformation=null)
 Creates a signing group. More...
 
System.Threading.Tasks.Task< SigningGroupInformationDeleteListAsync (string accountId, SigningGroupInformation signingGroupInformation=null)
 Deletes one or more signing groups. More...
 
System.Threading.Tasks.Task< ApiResponse< SigningGroupInformation > > DeleteListAsyncWithHttpInfo (string accountId, SigningGroupInformation signingGroupInformation=null)
 Deletes one or more signing groups. More...
 
System.Threading.Tasks.Task< SigningGroupUsersDeleteUsersAsync (string accountId, string signingGroupId, SigningGroupUsers signingGroupUsers=null)
 Deletes one or more members from a signing group. More...
 
System.Threading.Tasks.Task< ApiResponse< SigningGroupUsers > > DeleteUsersAsyncWithHttpInfo (string accountId, string signingGroupId, SigningGroupUsers signingGroupUsers=null)
 Deletes one or more members from a signing group. More...
 
System.Threading.Tasks.Task< SigningGroupGetAsync (string accountId, string signingGroupId)
 Gets information about a signing group. More...
 
System.Threading.Tasks.Task< ApiResponse< SigningGroup > > GetAsyncWithHttpInfo (string accountId, string signingGroupId)
 Gets information about a signing group. More...
 
System.Threading.Tasks.Task< SigningGroupInformationListAsync (string accountId, SigningGroupsApi.ListOptions options=null)
 Gets a list of the Signing Groups in an account. More...
 
System.Threading.Tasks.Task< ApiResponse< SigningGroupInformation > > ListAsyncWithHttpInfo (string accountId, SigningGroupsApi.ListOptions options=null)
 Gets a list of the Signing Groups in an account. More...
 
System.Threading.Tasks.Task< SigningGroupUsersListUsersAsync (string accountId, string signingGroupId)
 Gets a list of members in a Signing Group. More...
 
System.Threading.Tasks.Task< ApiResponse< SigningGroupUsers > > ListUsersAsyncWithHttpInfo (string accountId, string signingGroupId)
 Gets a list of members in a Signing Group. More...
 
System.Threading.Tasks.Task< SigningGroupUpdateAsync (string accountId, string signingGroupId, SigningGroup signingGroup=null)
 Updates a signing group. More...
 
System.Threading.Tasks.Task< ApiResponse< SigningGroup > > UpdateAsyncWithHttpInfo (string accountId, string signingGroupId, SigningGroup signingGroup=null)
 Updates a signing group. More...
 
System.Threading.Tasks.Task< SigningGroupInformationUpdateListAsync (string accountId, SigningGroupInformation signingGroupInformation=null)
 Updates signing group names. More...
 
System.Threading.Tasks.Task< ApiResponse< SigningGroupInformation > > UpdateListAsyncWithHttpInfo (string accountId, SigningGroupInformation signingGroupInformation=null)
 Updates signing group names. More...
 
System.Threading.Tasks.Task< SigningGroupUsersUpdateUsersAsync (string accountId, string signingGroupId, SigningGroupUsers signingGroupUsers=null)
 Adds members to a signing group. More...
 
System.Threading.Tasks.Task< ApiResponse< SigningGroupUsers > > UpdateUsersAsyncWithHttpInfo (string accountId, string signingGroupId, SigningGroupUsers signingGroupUsers=null)
 Adds members to a signing group. More...
 
- Public Member Functions inherited from DocuSign.eSign.Client.IApiAccessor
String GetBasePath ()
 Gets the base path of the API client. More...
 

Additional Inherited Members

- Properties inherited from DocuSign.eSign.Client.IApiAccessor
DocuSignClient ApiClient [get, set]
 Gets or sets the ApiClient object More...
 
ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateList()

SigningGroupInformation DocuSign.eSign.Api.ISigningGroupsApi.CreateList ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ CreateListAsync()

System.Threading.Tasks.Task<SigningGroupInformation> DocuSign.eSign.Api.ISigningGroupsApi.CreateListAsync ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns
Task of SigningGroupInformation

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ CreateListAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<SigningGroupInformation> > DocuSign.eSign.Api.ISigningGroupsApi.CreateListAsyncWithHttpInfo ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns
Task of ApiResponse (SigningGroupInformation)

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ CreateListWithHttpInfo()

ApiResponse<SigningGroupInformation> DocuSign.eSign.Api.ISigningGroupsApi.CreateListWithHttpInfo ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ DeleteList()

SigningGroupInformation DocuSign.eSign.Api.ISigningGroupsApi.DeleteList ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

Deletes one or more signing groups.

Deletes one or more signing groups in the specified account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ DeleteListAsync()

System.Threading.Tasks.Task<SigningGroupInformation> DocuSign.eSign.Api.ISigningGroupsApi.DeleteListAsync ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

Deletes one or more signing groups.

Deletes one or more signing groups in the specified account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns
Task of SigningGroupInformation

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ DeleteListAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<SigningGroupInformation> > DocuSign.eSign.Api.ISigningGroupsApi.DeleteListAsyncWithHttpInfo ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

Deletes one or more signing groups.

Deletes one or more signing groups in the specified account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns
Task of ApiResponse (SigningGroupInformation)

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ DeleteListWithHttpInfo()

ApiResponse<SigningGroupInformation> DocuSign.eSign.Api.ISigningGroupsApi.DeleteListWithHttpInfo ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

Deletes one or more signing groups.

Deletes one or more signing groups in the specified account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ DeleteUsers()

SigningGroupUsers DocuSign.eSign.Api.ISigningGroupsApi.DeleteUsers ( string  accountId,
string  signingGroupId,
SigningGroupUsers  signingGroupUsers = null 
)

Deletes one or more members from a signing group.

Deletes one or more members from the specified signing group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers(optional)
Returns

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ DeleteUsersAsync()

System.Threading.Tasks.Task<SigningGroupUsers> DocuSign.eSign.Api.ISigningGroupsApi.DeleteUsersAsync ( string  accountId,
string  signingGroupId,
SigningGroupUsers  signingGroupUsers = null 
)

Deletes one or more members from a signing group.

Deletes one or more members from the specified signing group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers(optional)
Returns
Task of SigningGroupUsers

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ DeleteUsersAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<SigningGroupUsers> > DocuSign.eSign.Api.ISigningGroupsApi.DeleteUsersAsyncWithHttpInfo ( string  accountId,
string  signingGroupId,
SigningGroupUsers  signingGroupUsers = null 
)

Deletes one or more members from a signing group.

Deletes one or more members from the specified signing group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers(optional)
Returns
Task of ApiResponse (SigningGroupUsers)

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ DeleteUsersWithHttpInfo()

ApiResponse<SigningGroupUsers> DocuSign.eSign.Api.ISigningGroupsApi.DeleteUsersWithHttpInfo ( string  accountId,
string  signingGroupId,
SigningGroupUsers  signingGroupUsers = null 
)

Deletes one or more members from a signing group.

Deletes one or more members from the specified signing group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers(optional)
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ Get()

SigningGroup DocuSign.eSign.Api.ISigningGroupsApi.Get ( string  accountId,
string  signingGroupId 
)

Gets information about a signing group.

Retrieves information, including group member information, for the specified signing group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
Returns

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ GetAsync()

System.Threading.Tasks.Task<SigningGroup> DocuSign.eSign.Api.ISigningGroupsApi.GetAsync ( string  accountId,
string  signingGroupId 
)

Gets information about a signing group.

Retrieves information, including group member information, for the specified signing group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
Returns
Task of SigningGroup

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ GetAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<SigningGroup> > DocuSign.eSign.Api.ISigningGroupsApi.GetAsyncWithHttpInfo ( string  accountId,
string  signingGroupId 
)

Gets information about a signing group.

Retrieves information, including group member information, for the specified signing group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
Returns
Task of ApiResponse (SigningGroup)

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ GetWithHttpInfo()

ApiResponse<SigningGroup> DocuSign.eSign.Api.ISigningGroupsApi.GetWithHttpInfo ( string  accountId,
string  signingGroupId 
)

Gets information about a signing group.

Retrieves information, including group member information, for the specified signing group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ List()

SigningGroupInformation DocuSign.eSign.Api.ISigningGroupsApi.List ( string  accountId,
SigningGroupsApi.ListOptions  options = null 
)

Gets a list of the Signing Groups in an account.

Retrieves a list of all signing groups in the specified account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns

◆ ListAsync()

System.Threading.Tasks.Task<SigningGroupInformation> DocuSign.eSign.Api.ISigningGroupsApi.ListAsync ( string  accountId,
SigningGroupsApi.ListOptions  options = null 
)

Gets a list of the Signing Groups in an account.

Retrieves a list of all signing groups in the specified account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of SigningGroupInformation

◆ ListAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<SigningGroupInformation> > DocuSign.eSign.Api.ISigningGroupsApi.ListAsyncWithHttpInfo ( string  accountId,
SigningGroupsApi.ListOptions  options = null 
)

Gets a list of the Signing Groups in an account.

Retrieves a list of all signing groups in the specified account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
Task of ApiResponse (SigningGroupInformation)

◆ ListUsers()

SigningGroupUsers DocuSign.eSign.Api.ISigningGroupsApi.ListUsers ( string  accountId,
string  signingGroupId 
)

Gets a list of members in a Signing Group.

Retrieves the list of members in the specified Signing Group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
Returns

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ ListUsersAsync()

System.Threading.Tasks.Task<SigningGroupUsers> DocuSign.eSign.Api.ISigningGroupsApi.ListUsersAsync ( string  accountId,
string  signingGroupId 
)

Gets a list of members in a Signing Group.

Retrieves the list of members in the specified Signing Group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
Returns
Task of SigningGroupUsers

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ ListUsersAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<SigningGroupUsers> > DocuSign.eSign.Api.ISigningGroupsApi.ListUsersAsyncWithHttpInfo ( string  accountId,
string  signingGroupId 
)

Gets a list of members in a Signing Group.

Retrieves the list of members in the specified Signing Group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
Returns
Task of ApiResponse (SigningGroupUsers)

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ ListUsersWithHttpInfo()

ApiResponse<SigningGroupUsers> DocuSign.eSign.Api.ISigningGroupsApi.ListUsersWithHttpInfo ( string  accountId,
string  signingGroupId 
)

Gets a list of members in a Signing Group.

Retrieves the list of members in the specified Signing Group.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ ListWithHttpInfo()

ApiResponse<SigningGroupInformation> DocuSign.eSign.Api.ISigningGroupsApi.ListWithHttpInfo ( string  accountId,
SigningGroupsApi.ListOptions  options = null 
)

Gets a list of the Signing Groups in an account.

Retrieves a list of all signing groups in the specified account.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
optionsOptions for modifying the behavior of the function.
Returns
ApiResponse of

◆ Update()

SigningGroup DocuSign.eSign.Api.ISigningGroupsApi.Update ( string  accountId,
string  signingGroupId,
SigningGroup  signingGroup = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroup(optional)
Returns

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ UpdateAsync()

System.Threading.Tasks.Task<SigningGroup> DocuSign.eSign.Api.ISigningGroupsApi.UpdateAsync ( string  accountId,
string  signingGroupId,
SigningGroup  signingGroup = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroup(optional)
Returns
Task of SigningGroup

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ UpdateAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<SigningGroup> > DocuSign.eSign.Api.ISigningGroupsApi.UpdateAsyncWithHttpInfo ( string  accountId,
string  signingGroupId,
SigningGroup  signingGroup = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroup(optional)
Returns
Task of ApiResponse (SigningGroup)

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ UpdateList()

SigningGroupInformation DocuSign.eSign.Api.ISigningGroupsApi.UpdateList ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

Updates signing group names.

Updates the name of one or more existing signing groups.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ UpdateListAsync()

System.Threading.Tasks.Task<SigningGroupInformation> DocuSign.eSign.Api.ISigningGroupsApi.UpdateListAsync ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

Updates signing group names.

Updates the name of one or more existing signing groups.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns
Task of SigningGroupInformation

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ UpdateListAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<SigningGroupInformation> > DocuSign.eSign.Api.ISigningGroupsApi.UpdateListAsyncWithHttpInfo ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

Updates signing group names.

Updates the name of one or more existing signing groups.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns
Task of ApiResponse (SigningGroupInformation)

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ UpdateListWithHttpInfo()

ApiResponse<SigningGroupInformation> DocuSign.eSign.Api.ISigningGroupsApi.UpdateListWithHttpInfo ( string  accountId,
SigningGroupInformation  signingGroupInformation = null 
)

Updates signing group names.

Updates the name of one or more existing signing groups.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupInformation(optional)
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ UpdateUsers()

SigningGroupUsers DocuSign.eSign.Api.ISigningGroupsApi.UpdateUsers ( string  accountId,
string  signingGroupId,
SigningGroupUsers  signingGroupUsers = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers(optional)
Returns

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ UpdateUsersAsync()

System.Threading.Tasks.Task<SigningGroupUsers> DocuSign.eSign.Api.ISigningGroupsApi.UpdateUsersAsync ( string  accountId,
string  signingGroupId,
SigningGroupUsers  signingGroupUsers = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers(optional)
Returns
Task of SigningGroupUsers

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ UpdateUsersAsyncWithHttpInfo()

System.Threading.Tasks.Task<ApiResponse<SigningGroupUsers> > DocuSign.eSign.Api.ISigningGroupsApi.UpdateUsersAsyncWithHttpInfo ( string  accountId,
string  signingGroupId,
SigningGroupUsers  signingGroupUsers = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers(optional)
Returns
Task of ApiResponse (SigningGroupUsers)

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ UpdateUsersWithHttpInfo()

ApiResponse<SigningGroupUsers> DocuSign.eSign.Api.ISigningGroupsApi.UpdateUsersWithHttpInfo ( string  accountId,
string  signingGroupId,
SigningGroupUsers  signingGroupUsers = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers(optional)
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.SigningGroupsApi.

◆ UpdateWithHttpInfo()

ApiResponse<SigningGroup> DocuSign.eSign.Api.ISigningGroupsApi.UpdateWithHttpInfo ( string  accountId,
string  signingGroupId,
SigningGroup  signingGroup = null 
)

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.

Exceptions
DocuSign.eSign.Client.ApiExceptionThrown when fails to make API call
Parameters
accountIdThe external account number (int) or account ID Guid.
signingGroupId
signingGroup(optional)
Returns
ApiResponse of

Implemented in DocuSign.eSign.Api.SigningGroupsApi.


The documentation for this interface was generated from the following file: