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

Inheritance diagram for DocuSign.eSign.Api.GroupsApi:

Classes
class	ListGroupsOptions
	Gets information about groups associated with the account. Retrieves information about groups associated with the account. More...

class	ListGroupUsersOptions
	Gets a list of users in a group. Retrieves a list of users in a group. More...

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

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

GroupInformation	CreateGroups (string accountId, GroupInformation groupInformation=null)
	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. More...

ApiResponse< GroupInformation >	CreateGroupsWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	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. More...

async System.Threading.Tasks.Task< GroupInformation >	CreateGroupsAsync (string accountId, GroupInformation groupInformation=null)
	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. More...

async System.Threading.Tasks.Task< ApiResponse< GroupInformation > >	CreateGroupsAsyncWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	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. More...

GroupBrands	DeleteBrands (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Deletes brand information from the requested group. Deletes brand information from the requested group. More...

ApiResponse< GroupBrands >	DeleteBrandsWithHttpInfo (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Deletes brand information from the requested group. Deletes brand information from the requested group. More...

async System.Threading.Tasks.Task< GroupBrands >	DeleteBrandsAsync (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Deletes brand information from the requested group. Deletes brand information from the requested group. More...

async System.Threading.Tasks.Task< ApiResponse< GroupBrands > >	DeleteBrandsAsyncWithHttpInfo (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Deletes brand information from the requested group. Deletes brand information from the requested group. More...

UsersResponse	DeleteGroupUsers (string accountId, string groupId, UserInfoList userInfoList=null)
	Deletes one or more users from a gro Deletes one or more users from a group. More...

ApiResponse< UsersResponse >	DeleteGroupUsersWithHttpInfo (string accountId, string groupId, UserInfoList userInfoList=null)
	Deletes one or more users from a gro Deletes one or more users from a group. More...

async System.Threading.Tasks.Task< UsersResponse >	DeleteGroupUsersAsync (string accountId, string groupId, UserInfoList userInfoList=null)
	Deletes one or more users from a gro Deletes one or more users from a group. More...

async System.Threading.Tasks.Task< ApiResponse< UsersResponse > >	DeleteGroupUsersAsyncWithHttpInfo (string accountId, string groupId, UserInfoList userInfoList=null)
	Deletes one or more users from a gro Deletes one or more users from a group. More...

GroupInformation	DeleteGroups (string accountId, GroupInformation groupInformation=null)
	Deletes an existing user group. Deletes an existing user group. More...

ApiResponse< GroupInformation >	DeleteGroupsWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	Deletes an existing user group. Deletes an existing user group. More...

async System.Threading.Tasks.Task< GroupInformation >	DeleteGroupsAsync (string accountId, GroupInformation groupInformation=null)
	Deletes an existing user group. Deletes an existing user group. More...

async System.Threading.Tasks.Task< ApiResponse< GroupInformation > >	DeleteGroupsAsyncWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	Deletes an existing user group. Deletes an existing user group. More...

GroupBrands	GetBrands (string accountId, string groupId)
	Gets group brand ID Information. Retrieves information about the brands associated with the requested group. More...

ApiResponse< GroupBrands >	GetBrandsWithHttpInfo (string accountId, string groupId)
	Gets group brand ID Information. Retrieves information about the brands associated with the requested group. More...

async System.Threading.Tasks.Task< GroupBrands >	GetBrandsAsync (string accountId, string groupId)
	Gets group brand ID Information. Retrieves information about the brands associated with the requested group. More...

async System.Threading.Tasks.Task< ApiResponse< GroupBrands > >	GetBrandsAsyncWithHttpInfo (string accountId, string groupId)
	Gets group brand ID Information. Retrieves information about the brands associated with the requested group. More...

UsersResponse	ListGroupUsers (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. Retrieves a list of users in a group. More...

ApiResponse< UsersResponse >	ListGroupUsersWithHttpInfo (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. Retrieves a list of users in a group. More...

async System.Threading.Tasks.Task< UsersResponse >	ListGroupUsersAsync (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. Retrieves a list of users in a group. More...

async System.Threading.Tasks.Task< ApiResponse< UsersResponse > >	ListGroupUsersAsyncWithHttpInfo (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. Retrieves a list of users in a group. More...

GroupInformation	ListGroups (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the account. Retrieves information about groups associated with the account. More...

ApiResponse< GroupInformation >	ListGroupsWithHttpInfo (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the account. Retrieves information about groups associated with the account. More...

async System.Threading.Tasks.Task< GroupInformation >	ListGroupsAsync (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the account. Retrieves information about groups associated with the account. More...

async System.Threading.Tasks.Task< ApiResponse< GroupInformation > >	ListGroupsAsyncWithHttpInfo (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the account. Retrieves information about groups associated with the account. More...

GroupBrands	UpdateBrands (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Adds group brand ID information to a group. Adds group brand ID information to a group. More...

ApiResponse< GroupBrands >	UpdateBrandsWithHttpInfo (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Adds group brand ID information to a group. Adds group brand ID information to a group. More...

async System.Threading.Tasks.Task< GroupBrands >	UpdateBrandsAsync (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Adds group brand ID information to a group. Adds group brand ID information to a group. More...

async System.Threading.Tasks.Task< ApiResponse< GroupBrands > >	UpdateBrandsAsyncWithHttpInfo (string accountId, string groupId, BrandsRequest brandsRequest=null)
	Adds group brand ID information to a group. Adds group brand ID information to a group. More...

UsersResponse	UpdateGroupUsers (string accountId, string groupId, UserInfoList userInfoList=null)
	Adds one or more users to an existing group. Adds one or more users to an existing group. More...

ApiResponse< UsersResponse >	UpdateGroupUsersWithHttpInfo (string accountId, string groupId, UserInfoList userInfoList=null)
	Adds one or more users to an existing group. Adds one or more users to an existing group. More...

async System.Threading.Tasks.Task< UsersResponse >	UpdateGroupUsersAsync (string accountId, string groupId, UserInfoList userInfoList=null)
	Adds one or more users to an existing group. Adds one or more users to an existing group. More...

async System.Threading.Tasks.Task< ApiResponse< UsersResponse > >	UpdateGroupUsersAsyncWithHttpInfo (string accountId, string groupId, UserInfoList userInfoList=null)
	Adds one or more users to an existing group. Adds one or more users to an existing group. More...

GroupInformation	UpdateGroups (string accountId, GroupInformation groupInformation=null)
	Updates the group information for a group. Updates the group name and modifies, or sets, the permission profile for the group. More...

ApiResponse< GroupInformation >	UpdateGroupsWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	Updates the group information for a group. Updates the group name and modifies, or sets, the permission profile for the group. More...

async System.Threading.Tasks.Task< GroupInformation >	UpdateGroupsAsync (string accountId, GroupInformation groupInformation=null)
	Updates the group information for a group. Updates the group name and modifies, or sets, the permission profile for the group. More...

async System.Threading.Tasks.Task< ApiResponse< GroupInformation > >	UpdateGroupsAsyncWithHttpInfo (string accountId, GroupInformation groupInformation=null)
	Updates the group information for a group. Updates the group name and modifies, or sets, the permission profile for the group. More...

Public Member Functions inherited from DocuSign.eSign.Api.IGroupsApi
UsersResponse	ListGroupUsers (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. More...

ApiResponse< UsersResponse >	ListGroupUsersWithHttpInfo (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. More...

GroupInformation	ListGroups (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the account. More...

ApiResponse< GroupInformation >	ListGroupsWithHttpInfo (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the account. More...

System.Threading.Tasks.Task< UsersResponse >	ListGroupUsersAsync (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. More...

System.Threading.Tasks.Task< ApiResponse< UsersResponse > >	ListGroupUsersAsyncWithHttpInfo (string accountId, string groupId, GroupsApi.ListGroupUsersOptions options=null)
	Gets a list of users in a group. More...

System.Threading.Tasks.Task< GroupInformation >	ListGroupsAsync (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the account. More...

System.Threading.Tasks.Task< ApiResponse< GroupInformation > >	ListGroupsAsyncWithHttpInfo (string accountId, GroupsApi.ListGroupsOptions options=null)
	Gets information about groups associated with the 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

◆ GroupsApi()

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

inline

Initializes a new instance of the GroupsApi class using AplClient object

Parameters

aplClient An instance of AplClient

Returns

Member Function Documentation

◆ CreateGroups()

GroupInformation DocuSign.eSign.Api.GroupsApi.CreateGroups	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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.

Exceptions

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

Parameters

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

Returns: GroupInformation

Implements DocuSign.eSign.Api.IGroupsApi.

◆ CreateGroupsAsync()

async System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.GroupsApi.CreateGroupsAsync	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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.

Exceptions

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

Parameters

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

Returns: Task of GroupInformation

Implements DocuSign.eSign.Api.IGroupsApi.

◆ CreateGroupsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.GroupsApi.CreateGroupsAsyncWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (GroupInformation)

Implements DocuSign.eSign.Api.IGroupsApi.

◆ CreateGroupsWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.GroupsApi.CreateGroupsWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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.

Exceptions

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

Parameters

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

Returns: ApiResponse of GroupInformation

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteBrands()

GroupBrands DocuSign.eSign.Api.GroupsApi.DeleteBrands	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

inline

Deletes brand information from the requested group. Deletes brand information from the requested group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: GroupBrands

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteBrandsAsync()

async System.Threading.Tasks.Task<GroupBrands> DocuSign.eSign.Api.GroupsApi.DeleteBrandsAsync	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

inline

Deletes brand information from the requested group. Deletes brand information from the requested group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: Task of GroupBrands

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteBrandsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<GroupBrands> > DocuSign.eSign.Api.GroupsApi.DeleteBrandsAsyncWithHttpInfo	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

inline

Deletes brand information from the requested group. Deletes brand information from the requested group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: Task of ApiResponse (GroupBrands)

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteBrandsWithHttpInfo()

ApiResponse<GroupBrands> DocuSign.eSign.Api.GroupsApi.DeleteBrandsWithHttpInfo	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

inline

Deletes brand information from the requested group. Deletes brand information from the requested group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: ApiResponse of GroupBrands

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteGroups()

GroupInformation DocuSign.eSign.Api.GroupsApi.DeleteGroups	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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

Exceptions

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

Parameters

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

Returns: GroupInformation

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteGroupsAsync()

async System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.GroupsApi.DeleteGroupsAsync	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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

Exceptions

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

Parameters

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

Returns: Task of GroupInformation

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteGroupsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.GroupsApi.DeleteGroupsAsyncWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (GroupInformation)

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteGroupsWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.GroupsApi.DeleteGroupsWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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

Exceptions

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

Parameters

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

Returns: ApiResponse of GroupInformation

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteGroupUsers()

UsersResponse DocuSign.eSign.Api.GroupsApi.DeleteGroupUsers	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

inline

Deletes one or more users from a gro Deletes one or more users from a group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: UsersResponse

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteGroupUsersAsync()

async System.Threading.Tasks.Task<UsersResponse> DocuSign.eSign.Api.GroupsApi.DeleteGroupUsersAsync	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

inline

Deletes one or more users from a gro Deletes one or more users from a group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: Task of UsersResponse

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteGroupUsersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<UsersResponse> > DocuSign.eSign.Api.GroupsApi.DeleteGroupUsersAsyncWithHttpInfo	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

inline

Deletes one or more users from a gro Deletes one or more users from a group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: Task of ApiResponse (UsersResponse)

Implements DocuSign.eSign.Api.IGroupsApi.

◆ DeleteGroupUsersWithHttpInfo()

ApiResponse<UsersResponse> DocuSign.eSign.Api.GroupsApi.DeleteGroupUsersWithHttpInfo	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

inline

Deletes one or more users from a gro Deletes one or more users from a group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: ApiResponse of UsersResponse

Implements DocuSign.eSign.Api.IGroupsApi.

◆ GetBasePath()

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

inline

Gets the base path of the API client.

The base path

Implements DocuSign.eSign.Client.IApiAccessor.

◆ GetBrands()

GroupBrands DocuSign.eSign.Api.GroupsApi.GetBrands	(	string	accountId,
		string	groupId
	)

inline

Gets group brand ID Information. Retrieves information about the brands associated with the requested group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.

Returns: GroupBrands

Implements DocuSign.eSign.Api.IGroupsApi.

◆ GetBrandsAsync()

async System.Threading.Tasks.Task<GroupBrands> DocuSign.eSign.Api.GroupsApi.GetBrandsAsync	(	string	accountId,
		string	groupId
	)

inline

Gets group brand ID Information. Retrieves information about the brands associated with the requested group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.

Returns: Task of GroupBrands

Implements DocuSign.eSign.Api.IGroupsApi.

◆ GetBrandsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<GroupBrands> > DocuSign.eSign.Api.GroupsApi.GetBrandsAsyncWithHttpInfo	(	string	accountId,
		string	groupId
	)

inline

Gets group brand ID Information. Retrieves information about the brands associated with the requested group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.

Returns: Task of ApiResponse (GroupBrands)

Implements DocuSign.eSign.Api.IGroupsApi.

◆ GetBrandsWithHttpInfo()

ApiResponse<GroupBrands> DocuSign.eSign.Api.GroupsApi.GetBrandsWithHttpInfo	(	string	accountId,
		string	groupId
	)

inline

Gets group brand ID Information. Retrieves information about the brands associated with the requested group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.

Returns: ApiResponse of GroupBrands

Implements DocuSign.eSign.Api.IGroupsApi.

◆ ListGroups()

GroupInformation DocuSign.eSign.Api.GroupsApi.ListGroups	(	string	accountId,
		GroupsApi.ListGroupsOptions	options = `null`
	)

inline

Gets information about groups associated with the account. Retrieves information about groups associated with the 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: GroupInformation

◆ ListGroupsAsync()

async System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.GroupsApi.ListGroupsAsync	(	string	accountId,
		GroupsApi.ListGroupsOptions	options = `null`
	)

inline

Gets information about groups associated with the account. Retrieves information about groups associated with the 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 GroupInformation

◆ ListGroupsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.GroupsApi.ListGroupsAsyncWithHttpInfo	(	string	accountId,
		GroupsApi.ListGroupsOptions	options = `null`
	)

inline

Gets information about groups associated with the account. Retrieves information about groups associated with the 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 (GroupInformation)

◆ ListGroupsWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.GroupsApi.ListGroupsWithHttpInfo	(	string	accountId,
		GroupsApi.ListGroupsOptions	options = `null`
	)

inline

Gets information about groups associated with the account. Retrieves information about groups associated with the 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 GroupInformation

◆ ListGroupUsers()

UsersResponse DocuSign.eSign.Api.GroupsApi.ListGroupUsers	(	string	accountId,
		string	groupId,
		GroupsApi.ListGroupUsersOptions	options = `null`
	)

inline

Gets a list of users in a group. Retrieves a list of users in a group.

Exceptions

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

Parameters

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

Returns: UsersResponse

◆ ListGroupUsersAsync()

async System.Threading.Tasks.Task<UsersResponse> DocuSign.eSign.Api.GroupsApi.ListGroupUsersAsync	(	string	accountId,
		string	groupId,
		GroupsApi.ListGroupUsersOptions	options = `null`
	)

inline

Gets a list of users in a group. Retrieves a list of users in a group.

Exceptions

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

Parameters

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

Returns: Task of UsersResponse

◆ ListGroupUsersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<UsersResponse> > DocuSign.eSign.Api.GroupsApi.ListGroupUsersAsyncWithHttpInfo	(	string	accountId,
		string	groupId,
		GroupsApi.ListGroupUsersOptions	options = `null`
	)

inline

Gets a list of users in a group. Retrieves a list of users in a group.

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (UsersResponse)

◆ ListGroupUsersWithHttpInfo()

ApiResponse<UsersResponse> DocuSign.eSign.Api.GroupsApi.ListGroupUsersWithHttpInfo	(	string	accountId,
		string	groupId,
		GroupsApi.ListGroupUsersOptions	options = `null`
	)

inline

Gets a list of users in a group. Retrieves a list of users in a group.

Exceptions

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

Parameters

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

Returns: ApiResponse of UsersResponse

◆ UpdateBrands()

GroupBrands DocuSign.eSign.Api.GroupsApi.UpdateBrands	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

inline

Adds group brand ID information to a group. Adds group brand ID information to a group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: GroupBrands

Implements DocuSign.eSign.Api.IGroupsApi.

◆ UpdateBrandsAsync()

async System.Threading.Tasks.Task<GroupBrands> DocuSign.eSign.Api.GroupsApi.UpdateBrandsAsync	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

inline

Adds group brand ID information to a group. Adds group brand ID information to a group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: Task of GroupBrands

Implements DocuSign.eSign.Api.IGroupsApi.

◆ UpdateBrandsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<GroupBrands> > DocuSign.eSign.Api.GroupsApi.UpdateBrandsAsyncWithHttpInfo	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

inline

Adds group brand ID information to a group. Adds group brand ID information to a group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: Task of ApiResponse (GroupBrands)

Implements DocuSign.eSign.Api.IGroupsApi.

◆ UpdateBrandsWithHttpInfo()

ApiResponse<GroupBrands> DocuSign.eSign.Api.GroupsApi.UpdateBrandsWithHttpInfo	(	string	accountId,
		string	groupId,
		BrandsRequest	brandsRequest = `null`
	)

inline

Adds group brand ID information to a group. Adds group brand ID information to a group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
brandsRequest	(optional)

Returns: ApiResponse of GroupBrands

Implements DocuSign.eSign.Api.IGroupsApi.

◆ UpdateGroups()

GroupInformation DocuSign.eSign.Api.GroupsApi.UpdateGroups	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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

Exceptions

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

Parameters

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

Returns: GroupInformation

Implements DocuSign.eSign.Api.IGroupsApi.

◆ UpdateGroupsAsync()

async System.Threading.Tasks.Task<GroupInformation> DocuSign.eSign.Api.GroupsApi.UpdateGroupsAsync	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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

Exceptions

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

Parameters

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

Returns: Task of GroupInformation

Implements DocuSign.eSign.Api.IGroupsApi.

◆ UpdateGroupsAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<GroupInformation> > DocuSign.eSign.Api.GroupsApi.UpdateGroupsAsyncWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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

Exceptions

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

Parameters

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

Returns: Task of ApiResponse (GroupInformation)

Implements DocuSign.eSign.Api.IGroupsApi.

◆ UpdateGroupsWithHttpInfo()

ApiResponse<GroupInformation> DocuSign.eSign.Api.GroupsApi.UpdateGroupsWithHttpInfo	(	string	accountId,
		GroupInformation	groupInformation = `null`
	)

inline

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

Exceptions

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

Parameters

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

Returns: ApiResponse of GroupInformation

Implements DocuSign.eSign.Api.IGroupsApi.

◆ UpdateGroupUsers()

UsersResponse DocuSign.eSign.Api.GroupsApi.UpdateGroupUsers	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

inline

Adds one or more users to an existing group. Adds one or more users to an existing group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: UsersResponse

Implements DocuSign.eSign.Api.IGroupsApi.

◆ UpdateGroupUsersAsync()

async System.Threading.Tasks.Task<UsersResponse> DocuSign.eSign.Api.GroupsApi.UpdateGroupUsersAsync	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

inline

Adds one or more users to an existing group. Adds one or more users to an existing group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: Task of UsersResponse

Implements DocuSign.eSign.Api.IGroupsApi.

◆ UpdateGroupUsersAsyncWithHttpInfo()

async System.Threading.Tasks.Task<ApiResponse<UsersResponse> > DocuSign.eSign.Api.GroupsApi.UpdateGroupUsersAsyncWithHttpInfo	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

inline

Adds one or more users to an existing group. Adds one or more users to an existing group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: Task of ApiResponse (UsersResponse)

Implements DocuSign.eSign.Api.IGroupsApi.

◆ UpdateGroupUsersWithHttpInfo()

ApiResponse<UsersResponse> DocuSign.eSign.Api.GroupsApi.UpdateGroupUsersWithHttpInfo	(	string	accountId,
		string	groupId,
		UserInfoList	userInfoList = `null`
	)

inline

Adds one or more users to an existing group. Adds one or more users to an existing group.

Exceptions

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

Parameters

accountId	The external account number (int) or account ID Guid.
groupId	The ID of the group being accessed.
userInfoList	(optional)

Returns: ApiResponse of UsersResponse

Implements DocuSign.eSign.Api.IGroupsApi.

Property Documentation

◆ ApiClient

DocuSignClient DocuSign.eSign.Api.GroupsApi.ApiClient

getset

Gets or sets the ApiClient object

An instance of the ApiClient

◆ ExceptionFactory

DocuSign.eSign.Client.ExceptionFactory DocuSign.eSign.Api.GroupsApi.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/GroupsApi.cs

Classes

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ GroupsApi()

Member Function Documentation

◆ CreateGroups()

◆ CreateGroupsAsync()

◆ CreateGroupsAsyncWithHttpInfo()

◆ CreateGroupsWithHttpInfo()

◆ DeleteBrands()

◆ DeleteBrandsAsync()

◆ DeleteBrandsAsyncWithHttpInfo()

◆ DeleteBrandsWithHttpInfo()

◆ DeleteGroups()

◆ DeleteGroupsAsync()

◆ DeleteGroupsAsyncWithHttpInfo()

◆ DeleteGroupsWithHttpInfo()

◆ DeleteGroupUsers()

◆ DeleteGroupUsersAsync()

◆ DeleteGroupUsersAsyncWithHttpInfo()

◆ DeleteGroupUsersWithHttpInfo()

◆ GetBasePath()

◆ GetBrands()

◆ GetBrandsAsync()

◆ GetBrandsAsyncWithHttpInfo()

◆ GetBrandsWithHttpInfo()

◆ ListGroups()

◆ ListGroupsAsync()

◆ ListGroupsAsyncWithHttpInfo()

◆ ListGroupsWithHttpInfo()

◆ ListGroupUsers()

◆ ListGroupUsersAsync()

◆ ListGroupUsersAsyncWithHttpInfo()

◆ ListGroupUsersWithHttpInfo()

◆ UpdateBrands()

◆ UpdateBrandsAsync()

◆ UpdateBrandsAsyncWithHttpInfo()

◆ UpdateBrandsWithHttpInfo()

◆ UpdateGroups()

◆ UpdateGroupsAsync()

◆ UpdateGroupsAsyncWithHttpInfo()

◆ UpdateGroupsWithHttpInfo()

◆ UpdateGroupUsers()

◆ UpdateGroupUsersAsync()

◆ UpdateGroupUsersAsyncWithHttpInfo()

◆ UpdateGroupUsersWithHttpInfo()

Property Documentation

◆ ApiClient

◆ ExceptionFactory