SigningGroupsApi
in package
SigningGroupsApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- callList() : SigningGroupInformation
- Operation callList
- callListWithHttpInfo() : array<string|int, mixed>
- Operation callListWithHttpInfo
- createList() : SigningGroupInformation
- Operation createList
- createListWithHttpInfo() : array<string|int, mixed>
- Operation createListWithHttpInfo
- deleteList() : SigningGroupInformation
- Operation deleteList
- deleteListWithHttpInfo() : array<string|int, mixed>
- Operation deleteListWithHttpInfo
- deleteUsers() : SigningGroupUsers
- Operation deleteUsers
- deleteUsersWithHttpInfo() : array<string|int, mixed>
- Operation deleteUsersWithHttpInfo
- get() : SigningGroup
- Operation get
- getApiClient() : ApiClient
- Get API client
- getWithHttpInfo() : array<string|int, mixed>
- Operation getWithHttpInfo
- listUsers() : SigningGroupUsers
- Operation listUsers
- listUsersWithHttpInfo() : array<string|int, mixed>
- Operation listUsersWithHttpInfo
- setApiClient() : self
- Set the API client
- update() : SigningGroup
- Operation update
- updateList() : SigningGroupInformation
- Operation updateList
- updateListWithHttpInfo() : array<string|int, mixed>
- Operation updateListWithHttpInfo
- updateResourcePath() : string
- Update $resourcePath with $
- updateUsers() : SigningGroupUsers
- Operation updateUsers
- updateUsersWithHttpInfo() : array<string|int, mixed>
- Operation updateUsersWithHttpInfo
- updateWithHttpInfo() : array<string|int, mixed>
- Operation updateWithHttpInfo
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 —callList()
Operation callList
public
callList(string|null $account_id[, ListOptions $options = null ]) : SigningGroupInformation
Gets a list of the Signing Groups in an account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
SigningGroupInformation —callListWithHttpInfo()
Operation callListWithHttpInfo
public
callListWithHttpInfo(string|null $account_id[, ListOptions $options = null ]) : array<string|int, mixed>
Gets a list of the Signing Groups in an account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $options : ListOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\SigningGroupInformation, HTTP status code, HTTP response headers (array of strings)
createList()
Operation createList
public
createList(string|null $account_id[, SigningGroupInformation $signing_group_information = null ]) : SigningGroupInformation
Creates a signing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_information : SigningGroupInformation = null
-
(optional)
Tags
Return values
SigningGroupInformation —createListWithHttpInfo()
Operation createListWithHttpInfo
public
createListWithHttpInfo(string|null $account_id[, SigningGroupInformation $signing_group_information = null ]) : array<string|int, mixed>
Creates a signing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_information : SigningGroupInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\SigningGroupInformation, HTTP status code, HTTP response headers (array of strings)
deleteList()
Operation deleteList
public
deleteList(string|null $account_id[, SigningGroupInformation $signing_group_information = null ]) : SigningGroupInformation
Deletes one or more signing groups.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_information : SigningGroupInformation = null
-
(optional)
Tags
Return values
SigningGroupInformation —deleteListWithHttpInfo()
Operation deleteListWithHttpInfo
public
deleteListWithHttpInfo(string|null $account_id[, SigningGroupInformation $signing_group_information = null ]) : array<string|int, mixed>
Deletes one or more signing groups.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_information : SigningGroupInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\SigningGroupInformation, HTTP status code, HTTP response headers (array of strings)
deleteUsers()
Operation deleteUsers
public
deleteUsers(string|null $account_id, string|null $signing_group_id[, SigningGroupUsers $signing_group_users = null ]) : SigningGroupUsers
Deletes one or more members from a signing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_id : string|null
- $signing_group_users : SigningGroupUsers = null
-
(optional)
Tags
Return values
SigningGroupUsers —deleteUsersWithHttpInfo()
Operation deleteUsersWithHttpInfo
public
deleteUsersWithHttpInfo(string|null $account_id, string|null $signing_group_id[, SigningGroupUsers $signing_group_users = null ]) : array<string|int, mixed>
Deletes one or more members from a signing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_id : string|null
- $signing_group_users : SigningGroupUsers = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\SigningGroupUsers, HTTP status code, HTTP response headers (array of strings)
get()
Operation get
public
get(string|null $account_id, string|null $signing_group_id) : SigningGroup
Gets information about a signing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_id : string|null
Tags
Return values
SigningGroup —getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getWithHttpInfo()
Operation getWithHttpInfo
public
getWithHttpInfo(string|null $account_id, string|null $signing_group_id) : array<string|int, mixed>
Gets information about a signing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_id : string|null
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\SigningGroup, HTTP status code, HTTP response headers (array of strings)
listUsers()
Operation listUsers
public
listUsers(string|null $account_id, string|null $signing_group_id) : SigningGroupUsers
Gets a list of members in a Signing Group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_id : string|null
Tags
Return values
SigningGroupUsers —listUsersWithHttpInfo()
Operation listUsersWithHttpInfo
public
listUsersWithHttpInfo(string|null $account_id, string|null $signing_group_id) : array<string|int, mixed>
Gets a list of members in a Signing Group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_id : string|null
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\SigningGroupUsers, 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 —update()
Operation update
public
update(string|null $account_id, string|null $signing_group_id[, SigningGroup $signing_group = null ]) : SigningGroup
Updates a signing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_id : string|null
- $signing_group : SigningGroup = null
-
(optional)
Tags
Return values
SigningGroup —updateList()
Operation updateList
public
updateList(string|null $account_id[, SigningGroupInformation $signing_group_information = null ]) : SigningGroupInformation
Updates signing group names.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_information : SigningGroupInformation = null
-
(optional)
Tags
Return values
SigningGroupInformation —updateListWithHttpInfo()
Operation updateListWithHttpInfo
public
updateListWithHttpInfo(string|null $account_id[, SigningGroupInformation $signing_group_information = null ]) : array<string|int, mixed>
Updates signing group names.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_information : SigningGroupInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\SigningGroupInformation, 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
Return values
string —updateUsers()
Operation updateUsers
public
updateUsers(string|null $account_id, string|null $signing_group_id[, SigningGroupUsers $signing_group_users = null ]) : SigningGroupUsers
Adds members to a signing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_id : string|null
- $signing_group_users : SigningGroupUsers = null
-
(optional)
Tags
Return values
SigningGroupUsers —updateUsersWithHttpInfo()
Operation updateUsersWithHttpInfo
public
updateUsersWithHttpInfo(string|null $account_id, string|null $signing_group_id[, SigningGroupUsers $signing_group_users = null ]) : array<string|int, mixed>
Adds members to a signing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_id : string|null
- $signing_group_users : SigningGroupUsers = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\SigningGroupUsers, HTTP status code, HTTP response headers (array of strings)
updateWithHttpInfo()
Operation updateWithHttpInfo
public
updateWithHttpInfo(string|null $account_id, string|null $signing_group_id[, SigningGroup $signing_group = null ]) : array<string|int, mixed>
Updates a signing group.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signing_group_id : string|null
- $signing_group : SigningGroup = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\SigningGroup, HTTP status code, HTTP response headers (array of strings)