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

Inheritance diagram for DocuSign.eSign.Api.SigningGroupsApi:

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

Public Member Functions
	SigningGroupsApi (DocuSignClient aplClient)
	Initializes a new instance of the SigningGroupsApi class using AplClient object More...

String	GetBasePath ()
	Gets the base path of the API client. More...

SigningGroupInformation	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. More...

ApiResponse< SigningGroupInformation >	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. More...

async System.Threading.Tasks.Task< SigningGroupInformation >	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. More...

async System.Threading.Tasks.Task< ApiResponse< SigningGroupInformation > >	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. More...

SigningGroupInformation	DeleteList (string accountId, SigningGroupInformation signingGroupInformation=null)
	Deletes one or more signing groups. Deletes one or more signing groups in the specified account. More...

ApiResponse< SigningGroupInformation >	DeleteListWithHttpInfo (string accountId, SigningGroupInformation signingGroupInformation=null)
	Deletes one or more signing groups. Deletes one or more signing groups in the specified account. More...

async System.Threading.Tasks.Task< SigningGroupInformation >	DeleteListAsync (string accountId, SigningGroupInformation signingGroupInformation=null)
	Deletes one or more signing groups. Deletes one or more signing groups in the specified account. More...

async System.Threading.Tasks.Task< ApiResponse< SigningGroupInformation > >	DeleteListAsyncWithHttpInfo (string accountId, SigningGroupInformation signingGroupInformation=null)
	Deletes one or more signing groups. Deletes one or more signing groups in the specified account. More...

SigningGroupUsers	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. More...

ApiResponse< SigningGroupUsers >	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. More...

async System.Threading.Tasks.Task< SigningGroupUsers >	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. More...

async System.Threading.Tasks.Task< ApiResponse< SigningGroupUsers > >	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. More...

SigningGroup	Get (string accountId, string signingGroupId)
	Gets information about a signing group. Retrieves information, including group member information, for the specified signing group. More...

ApiResponse< SigningGroup >	GetWithHttpInfo (string accountId, string signingGroupId)
	Gets information about a signing group. Retrieves information, including group member information, for the specified signing group. More...

async System.Threading.Tasks.Task< SigningGroup >	GetAsync (string accountId, string signingGroupId)
	Gets information about a signing group. Retrieves information, including group member information, for the specified signing group. More...

async System.Threading.Tasks.Task< ApiResponse< SigningGroup > >	GetAsyncWithHttpInfo (string accountId, string signingGroupId)
	Gets information about a signing group. Retrieves information, including group member information, for the specified signing group. More...

SigningGroupInformation	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. More...

ApiResponse< SigningGroupInformation >	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. More...

async System.Threading.Tasks.Task< SigningGroupInformation >	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. More...

async System.Threading.Tasks.Task< ApiResponse< SigningGroupInformation > >	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. More...

SigningGroupUsers	ListUsers (string accountId, string signingGroupId)
	Gets a list of members in a Signing Group. Retrieves the list of members in the specified Signing Group. More...

ApiResponse< SigningGroupUsers >	ListUsersWithHttpInfo (string accountId, string signingGroupId)
	Gets a list of members in a Signing Group. Retrieves the list of members in the specified Signing Group. More...

async System.Threading.Tasks.Task< SigningGroupUsers >	ListUsersAsync (string accountId, string signingGroupId)
	Gets a list of members in a Signing Group. Retrieves the list of members in the specified Signing Group. More...

async System.Threading.Tasks.Task< ApiResponse< SigningGroupUsers > >	ListUsersAsyncWithHttpInfo (string accountId, string signingGroupId)
	Gets a list of members in a Signing Group. Retrieves the list of members in the specified Signing Group. More...

SigningGroup	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. More...

ApiResponse< SigningGroup >	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. More...

async System.Threading.Tasks.Task< SigningGroup >	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. More...

async System.Threading.Tasks.Task< ApiResponse< SigningGroup > >	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. More...

SigningGroupInformation	UpdateList (string accountId, SigningGroupInformation signingGroupInformation=null)
	Updates signing group names. Updates the name of one or more existing signing groups. More...

ApiResponse< SigningGroupInformation >	UpdateListWithHttpInfo (string accountId, SigningGroupInformation signingGroupInformation=null)
	Updates signing group names. Updates the name of one or more existing signing groups. More...

async System.Threading.Tasks.Task< SigningGroupInformation >	UpdateListAsync (string accountId, SigningGroupInformation signingGroupInformation=null)
	Updates signing group names. Updates the name of one or more existing signing groups. More...

async System.Threading.Tasks.Task< ApiResponse< SigningGroupInformation > >	UpdateListAsyncWithHttpInfo (string accountId, SigningGroupInformation signingGroupInformation=null)
	Updates signing group names. Updates the name of one or more existing signing groups. More...

SigningGroupUsers	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. More...

ApiResponse< SigningGroupUsers >	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. More...

async System.Threading.Tasks.Task< SigningGroupUsers >	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. More...

async System.Threading.Tasks.Task< ApiResponse< SigningGroupUsers > >	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. More...

Public Member Functions inherited from DocuSign.eSign.Api.ISigningGroupsApi
SigningGroupInformation	List (string accountId, SigningGroupsApi.ListOptions options=null)
	Gets a list of the Signing Groups in an account. More...

ApiResponse< SigningGroupInformation >	ListWithHttpInfo (string accountId, SigningGroupsApi.ListOptions options=null)
	Gets a list of the Signing Groups in an account. More...

System.Threading.Tasks.Task< SigningGroupInformation >	ListAsync (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...

Properties
DocuSignClient	ApiClient `[get, set]`
	Gets or sets the ApiClient object More...

DocuSign.eSign.Client.ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

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

Constructor & Destructor Documentation

◆ SigningGroupsApi()

DocuSign.eSign.Api.SigningGroupsApi.SigningGroupsApi ( DocuSignClient aplClient )

inline

Initializes a new instance of the SigningGroupsApi class using AplClient object

Parameters

aplClient An instance of AplClient

Returns

Member Function Documentation

◆ CreateList()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: SigningGroupInformation

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ CreateListAsync()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: Task of SigningGroupInformation

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ CreateListAsyncWithHttpInfo()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: Task of ApiResponse (SigningGroupInformation)

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ CreateListWithHttpInfo()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: ApiResponse of SigningGroupInformation

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ DeleteList()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: SigningGroupInformation

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ DeleteListAsync()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: Task of SigningGroupInformation

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ DeleteListAsyncWithHttpInfo()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: Task of ApiResponse (SigningGroupInformation)

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ DeleteListWithHttpInfo()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: ApiResponse of SigningGroupInformation

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ DeleteUsers()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers	(optional)

Returns: SigningGroupUsers

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ DeleteUsersAsync()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers	(optional)

Returns: Task of SigningGroupUsers

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ DeleteUsersAsyncWithHttpInfo()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers	(optional)

Returns: Task of ApiResponse (SigningGroupUsers)

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ DeleteUsersWithHttpInfo()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers	(optional)

Returns: ApiResponse of SigningGroupUsers

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ Get()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: SigningGroup

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ GetAsync()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of SigningGroup

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ GetAsyncWithHttpInfo()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of ApiResponse (SigningGroup)

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ GetBasePath()

String DocuSign.eSign.Api.SigningGroupsApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetWithHttpInfo()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: ApiResponse of SigningGroup

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ List()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: SigningGroupInformation

◆ ListAsync()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of SigningGroupInformation

◆ ListAsyncWithHttpInfo()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: Task of ApiResponse (SigningGroupInformation)

◆ ListUsers()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: SigningGroupUsers

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ ListUsersAsync()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of SigningGroupUsers

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ ListUsersAsyncWithHttpInfo()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: Task of ApiResponse (SigningGroupUsers)

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ ListUsersWithHttpInfo()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

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

Returns: ApiResponse of SigningGroupUsers

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ ListWithHttpInfo()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
options	Options for modifying the behavior of the function.

Returns: ApiResponse of SigningGroupInformation

◆ Update()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroup	(optional)

Returns: SigningGroup

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ UpdateAsync()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroup	(optional)

Returns: Task of SigningGroup

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ UpdateAsyncWithHttpInfo()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroup	(optional)

Returns: Task of ApiResponse (SigningGroup)

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ UpdateList()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: SigningGroupInformation

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ UpdateListAsync()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: Task of SigningGroupInformation

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ UpdateListAsyncWithHttpInfo()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: Task of ApiResponse (SigningGroupInformation)

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ UpdateListWithHttpInfo()

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

inline

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

Exceptions

DocuSign.eSign.Client.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupInformation	(optional)

Returns: ApiResponse of SigningGroupInformation

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ UpdateUsers()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers	(optional)

Returns: SigningGroupUsers

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ UpdateUsersAsync()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers	(optional)

Returns: Task of SigningGroupUsers

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ UpdateUsersAsyncWithHttpInfo()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers	(optional)

Returns: Task of ApiResponse (SigningGroupUsers)

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ UpdateUsersWithHttpInfo()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroupUsers	(optional)

Returns: ApiResponse of SigningGroupUsers

Implements DocuSign.eSign.Api.ISigningGroupsApi.

◆ UpdateWithHttpInfo()

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

inline

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.ApiException Thrown when fails to make API call

Parameters

accountId	The external account number (int) or account ID Guid.
signingGroupId
signingGroup	(optional)

Returns: ApiResponse of SigningGroup

Implements DocuSign.eSign.Api.ISigningGroupsApi.

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.SigningGroupsApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.SigningGroupsApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

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

sdk/src/DocuSign.eSign/Api/SigningGroupsApi.cs

Classes

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SigningGroupsApi()

Member Function Documentation

◆ CreateList()

◆ CreateListAsync()

◆ CreateListAsyncWithHttpInfo()

◆ CreateListWithHttpInfo()

◆ DeleteList()

◆ DeleteListAsync()

◆ DeleteListAsyncWithHttpInfo()

◆ DeleteListWithHttpInfo()

◆ DeleteUsers()

◆ DeleteUsersAsync()

◆ DeleteUsersAsyncWithHttpInfo()

◆ DeleteUsersWithHttpInfo()

◆ Get()

◆ GetAsync()

◆ GetAsyncWithHttpInfo()

◆ GetBasePath()

◆ GetWithHttpInfo()

◆ List()

◆ ListAsync()

◆ ListAsyncWithHttpInfo()

◆ ListUsers()

◆ ListUsersAsync()

◆ ListUsersAsyncWithHttpInfo()

◆ ListUsersWithHttpInfo()

◆ ListWithHttpInfo()

◆ Update()

◆ UpdateAsync()

◆ UpdateAsyncWithHttpInfo()

◆ UpdateList()

◆ UpdateListAsync()

◆ UpdateListAsyncWithHttpInfo()

◆ UpdateListWithHttpInfo()

◆ UpdateUsers()

◆ UpdateUsersAsync()

◆ UpdateUsersAsyncWithHttpInfo()

◆ UpdateUsersWithHttpInfo()

◆ UpdateWithHttpInfo()

Property Documentation

◆ ApiClient

◆ ExceptionFactory