GroupsApi
in package
GroupsApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- createGroups() : GroupInformation
- Operation createGroups
- createGroupsWithHttpInfo() : array<string|int, mixed>
- Operation createGroupsWithHttpInfo
- deleteBrands() : GroupBrands
- Operation deleteBrands
- deleteBrandsWithHttpInfo() : array<string|int, mixed>
- Operation deleteBrandsWithHttpInfo
- deleteGroups() : GroupInformation
- Operation deleteGroups
- deleteGroupsWithHttpInfo() : array<string|int, mixed>
- Operation deleteGroupsWithHttpInfo
- deleteGroupUsers() : UsersResponse
- Operation deleteGroupUsers
- deleteGroupUsersWithHttpInfo() : array<string|int, mixed>
- Operation deleteGroupUsersWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getBrands() : GroupBrands
- Operation getBrands
- getBrandsWithHttpInfo() : array<string|int, mixed>
- Operation getBrandsWithHttpInfo
- listGroups() : GroupInformation
- Operation listGroups
- listGroupsWithHttpInfo() : array<string|int, mixed>
- Operation listGroupsWithHttpInfo
- listGroupUsers() : UsersResponse
- Operation listGroupUsers
- listGroupUsersWithHttpInfo() : array<string|int, mixed>
- Operation listGroupUsersWithHttpInfo
- setApiClient() : self
- Set the API client
- updateBrands() : GroupBrands
- Operation updateBrands
- updateBrandsWithHttpInfo() : array<string|int, mixed>
- Operation updateBrandsWithHttpInfo
- updateGroups() : GroupInformation
- Operation updateGroups
- updateGroupsWithHttpInfo() : array<string|int, mixed>
- Operation updateGroupsWithHttpInfo
- updateGroupUsers() : UsersResponse
- Operation updateGroupUsers
- updateGroupUsersWithHttpInfo() : array<string|int, mixed>
- Operation updateGroupUsersWithHttpInfo
- updateResourcePath() : string
- Update $resourcePath with $
Properties
$apiClient
API Client
protected
ApiClient
$apiClient
instance of the ApiClient
Methods
__construct()
Constructor
public
__construct([ApiClient|null $apiClient = null ]) : void
Parameters
- $apiClient : ApiClient|null = null
-
The api client to use
Return values
void —createGroups()
Operation createGroups
public
createGroups(string|null $account_id[, GroupInformation $group_information = null ]) : GroupInformation
Creates one or more groups for the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_information : GroupInformation = null
-
(optional)
Tags
Return values
GroupInformation —createGroupsWithHttpInfo()
Operation createGroupsWithHttpInfo
public
createGroupsWithHttpInfo(string|null $account_id[, GroupInformation $group_information = null ]) : array<string|int, mixed>
Creates one or more groups for the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_information : GroupInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\GroupInformation, HTTP status code, HTTP response headers (array of strings)
deleteBrands()
Operation deleteBrands
public
deleteBrands(string|null $account_id, string|null $group_id[, BrandsRequest $brands_request = null ]) : GroupBrands
Deletes brand information from the requested group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
- $brands_request : BrandsRequest = null
-
(optional)
Tags
Return values
GroupBrands —deleteBrandsWithHttpInfo()
Operation deleteBrandsWithHttpInfo
public
deleteBrandsWithHttpInfo(string|null $account_id, string|null $group_id[, BrandsRequest $brands_request = null ]) : array<string|int, mixed>
Deletes brand information from the requested group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
- $brands_request : BrandsRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\GroupBrands, HTTP status code, HTTP response headers (array of strings)
deleteGroups()
Operation deleteGroups
public
deleteGroups(string|null $account_id[, GroupInformation $group_information = null ]) : GroupInformation
Deletes an existing user group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_information : GroupInformation = null
-
(optional)
Tags
Return values
GroupInformation —deleteGroupsWithHttpInfo()
Operation deleteGroupsWithHttpInfo
public
deleteGroupsWithHttpInfo(string|null $account_id[, GroupInformation $group_information = null ]) : array<string|int, mixed>
Deletes an existing user group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_information : GroupInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\GroupInformation, HTTP status code, HTTP response headers (array of strings)
deleteGroupUsers()
Operation deleteGroupUsers
public
deleteGroupUsers(string|null $account_id, string|null $group_id[, UserInfoList $user_info_list = null ]) : UsersResponse
Deletes one or more users from a gro
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
- $user_info_list : UserInfoList = null
-
(optional)
Tags
Return values
UsersResponse —deleteGroupUsersWithHttpInfo()
Operation deleteGroupUsersWithHttpInfo
public
deleteGroupUsersWithHttpInfo(string|null $account_id, string|null $group_id[, UserInfoList $user_info_list = null ]) : array<string|int, mixed>
Deletes one or more users from a gro
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
- $user_info_list : UserInfoList = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UsersResponse, HTTP status code, HTTP response headers (array of strings)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getBrands()
Operation getBrands
public
getBrands(string|null $account_id, string|null $group_id) : GroupBrands
Gets group brand ID Information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
Tags
Return values
GroupBrands —getBrandsWithHttpInfo()
Operation getBrandsWithHttpInfo
public
getBrandsWithHttpInfo(string|null $account_id, string|null $group_id) : array<string|int, mixed>
Gets group brand ID Information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\GroupBrands, HTTP status code, HTTP response headers (array of strings)
listGroups()
Operation listGroups
public
listGroups(string|null $account_id[, ListGroupsOptions $options = null ]) : GroupInformation
Gets information about groups associated with the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListGroupsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
GroupInformation —listGroupsWithHttpInfo()
Operation listGroupsWithHttpInfo
public
listGroupsWithHttpInfo(string|null $account_id[, ListGroupsOptions $options = null ]) : array<string|int, mixed>
Gets information about groups associated with the account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListGroupsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\GroupInformation, HTTP status code, HTTP response headers (array of strings)
listGroupUsers()
Operation listGroupUsers
public
listGroupUsers(string|null $account_id, string|null $group_id[, ListGroupUsersOptions $options = null ]) : UsersResponse
Gets a list of users in a group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
- $options : ListGroupUsersOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
UsersResponse —listGroupUsersWithHttpInfo()
Operation listGroupUsersWithHttpInfo
public
listGroupUsersWithHttpInfo(string|null $account_id, string|null $group_id[, ListGroupUsersOptions $options = null ]) : array<string|int, mixed>
Gets a list of users in a group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
- $options : ListGroupUsersOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UsersResponse, HTTP status code, HTTP response headers (array of strings)
setApiClient()
Set the API client
public
setApiClient(ApiClient $apiClient) : self
Parameters
- $apiClient : ApiClient
-
set the API client
Return values
self —updateBrands()
Operation updateBrands
public
updateBrands(string|null $account_id, string|null $group_id[, BrandsRequest $brands_request = null ]) : GroupBrands
Adds group brand ID information to a group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
- $brands_request : BrandsRequest = null
-
(optional)
Tags
Return values
GroupBrands —updateBrandsWithHttpInfo()
Operation updateBrandsWithHttpInfo
public
updateBrandsWithHttpInfo(string|null $account_id, string|null $group_id[, BrandsRequest $brands_request = null ]) : array<string|int, mixed>
Adds group brand ID information to a group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
- $brands_request : BrandsRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\GroupBrands, HTTP status code, HTTP response headers (array of strings)
updateGroups()
Operation updateGroups
public
updateGroups(string|null $account_id[, GroupInformation $group_information = null ]) : GroupInformation
Updates the group information for a group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_information : GroupInformation = null
-
(optional)
Tags
Return values
GroupInformation —updateGroupsWithHttpInfo()
Operation updateGroupsWithHttpInfo
public
updateGroupsWithHttpInfo(string|null $account_id[, GroupInformation $group_information = null ]) : array<string|int, mixed>
Updates the group information for a group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_information : GroupInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\GroupInformation, HTTP status code, HTTP response headers (array of strings)
updateGroupUsers()
Operation updateGroupUsers
public
updateGroupUsers(string|null $account_id, string|null $group_id[, UserInfoList $user_info_list = null ]) : UsersResponse
Adds one or more users to an existing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
- $user_info_list : UserInfoList = null
-
(optional)
Tags
Return values
UsersResponse —updateGroupUsersWithHttpInfo()
Operation updateGroupUsersWithHttpInfo
public
updateGroupUsersWithHttpInfo(string|null $account_id, string|null $group_id[, UserInfoList $user_info_list = null ]) : array<string|int, mixed>
Adds one or more users to an existing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $group_id : string|null
-
The ID of the group being accessed.
- $user_info_list : UserInfoList = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UsersResponse, HTTP status code, HTTP response headers (array of strings)
updateResourcePath()
Update $resourcePath with $
public
updateResourcePath(string $resourcePath, string $baseName, string $paramName) : string
Parameters
- $resourcePath : string
-
the resource path to use
- $baseName : string
-
the base name param
- $paramName : string
-
the parameter name