UsersApi
in package
UsersApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- callList() : UserInformationList
- Operation callList
- callListWithHttpInfo() : array<string|int, mixed>
- Operation callListWithHttpInfo
- create() : NewUsersSummary
- Operation create
- createSignatures() : UserSignaturesInformation
- Operation createSignatures
- createSignaturesWithHttpInfo() : array<string|int, mixed>
- Operation createSignaturesWithHttpInfo
- createWithHttpInfo() : array<string|int, mixed>
- Operation createWithHttpInfo
- delete() : UsersResponse
- Operation delete
- deleteContacts() : ContactUpdateResponse
- Operation deleteContacts
- deleteContactsWithHttpInfo() : array<string|int, mixed>
- Operation deleteContactsWithHttpInfo
- deleteContactWithId() : ContactUpdateResponse
- Operation deleteContactWithId
- deleteContactWithIdWithHttpInfo() : array<string|int, mixed>
- Operation deleteContactWithIdWithHttpInfo
- deleteCustomSettings() : CustomSettingsInformation
- Operation deleteCustomSettings
- deleteCustomSettingsWithHttpInfo() : array<string|int, mixed>
- Operation deleteCustomSettingsWithHttpInfo
- deleteProfileImage() : mixed
- Operation deleteProfileImage
- deleteProfileImageWithHttpInfo() : array<string|int, mixed>
- Operation deleteProfileImageWithHttpInfo
- deleteSignature() : mixed
- Operation deleteSignature
- deleteSignatureImage() : UserSignature
- Operation deleteSignatureImage
- deleteSignatureImageWithHttpInfo() : array<string|int, mixed>
- Operation deleteSignatureImageWithHttpInfo
- deleteSignatureWithHttpInfo() : array<string|int, mixed>
- Operation deleteSignatureWithHttpInfo
- deleteWithHttpInfo() : array<string|int, mixed>
- Operation deleteWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getContactById() : ContactGetResponse
- Operation getContactById
- getContactByIdWithHttpInfo() : array<string|int, mixed>
- Operation getContactByIdWithHttpInfo
- getInformation() : UserInformation
- Operation getInformation
- getInformationWithHttpInfo() : array<string|int, mixed>
- Operation getInformationWithHttpInfo
- getProfile() : UserProfile
- Operation getProfile
- getProfileImage() : SplFileObject
- Operation getProfileImage
- getProfileImageWithHttpInfo() : array<string|int, mixed>
- Operation getProfileImageWithHttpInfo
- getProfileWithHttpInfo() : array<string|int, mixed>
- Operation getProfileWithHttpInfo
- getSettings() : UserSettingsInformation
- Operation getSettings
- getSettingsWithHttpInfo() : array<string|int, mixed>
- Operation getSettingsWithHttpInfo
- getSignature() : UserSignature
- Operation getSignature
- getSignatureImage() : SplFileObject
- Operation getSignatureImage
- getSignatureImageWithHttpInfo() : array<string|int, mixed>
- Operation getSignatureImageWithHttpInfo
- getSignatureWithHttpInfo() : array<string|int, mixed>
- Operation getSignatureWithHttpInfo
- listCustomSettings() : CustomSettingsInformation
- Operation listCustomSettings
- listCustomSettingsWithHttpInfo() : array<string|int, mixed>
- Operation listCustomSettingsWithHttpInfo
- listSignatures() : UserSignaturesInformation
- Operation listSignatures
- listSignaturesWithHttpInfo() : array<string|int, mixed>
- Operation listSignaturesWithHttpInfo
- postContacts() : ContactUpdateResponse
- Operation postContacts
- postContactsWithHttpInfo() : array<string|int, mixed>
- Operation postContactsWithHttpInfo
- putContacts() : ContactUpdateResponse
- Operation putContacts
- putContactsWithHttpInfo() : array<string|int, mixed>
- Operation putContactsWithHttpInfo
- setApiClient() : self
- Set the API client
- updateCustomSettings() : CustomSettingsInformation
- Operation updateCustomSettings
- updateCustomSettingsWithHttpInfo() : array<string|int, mixed>
- Operation updateCustomSettingsWithHttpInfo
- updateProfile() : mixed
- Operation updateProfile
- updateProfileImage() : mixed
- Operation updateProfileImage
- updateProfileImageWithHttpInfo() : array<string|int, mixed>
- Operation updateProfileImageWithHttpInfo
- updateProfileWithHttpInfo() : array<string|int, mixed>
- Operation updateProfileWithHttpInfo
- updateResourcePath() : string
- Update $resourcePath with $
- updateSettings() : mixed
- Operation updateSettings
- updateSettingsWithHttpInfo() : array<string|int, mixed>
- Operation updateSettingsWithHttpInfo
- updateSignature() : UserSignature
- Operation updateSignature
- updateSignatureImage() : UserSignature
- Operation updateSignatureImage
- updateSignatureImageWithHttpInfo() : array<string|int, mixed>
- Operation updateSignatureImageWithHttpInfo
- updateSignatures() : UserSignaturesInformation
- Operation updateSignatures
- updateSignaturesWithHttpInfo() : array<string|int, mixed>
- Operation updateSignaturesWithHttpInfo
- updateSignatureWithHttpInfo() : array<string|int, mixed>
- Operation updateSignatureWithHttpInfo
- updateUser() : UserInformation
- Operation updateUser
- updateUsers() : UserInformationList
- Operation updateUsers
- updateUsersWithHttpInfo() : array<string|int, mixed>
- Operation updateUsersWithHttpInfo
- updateUserWithHttpInfo() : array<string|int, mixed>
- Operation updateUserWithHttpInfo
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 ]) : UserInformationList
Retrieves the list of users for the specified 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
UserInformationList —callListWithHttpInfo()
Operation callListWithHttpInfo
public
callListWithHttpInfo(string|null $account_id[, ListOptions $options = null ]) : array<string|int, mixed>
Retrieves the list of users for the specified 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\UserInformationList, HTTP status code, HTTP response headers (array of strings)
create()
Operation create
public
create(string|null $account_id[, NewUsersDefinition $new_users_definition = null ]) : NewUsersSummary
Adds news user to the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $new_users_definition : NewUsersDefinition = null
-
(optional)
Tags
Return values
NewUsersSummary —createSignatures()
Operation createSignatures
public
createSignatures(string|null $account_id, string|null $user_id[, UserSignaturesInformation $user_signatures_information = null ]) : UserSignaturesInformation
Adds user Signature and initials images to a Signature.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_signatures_information : UserSignaturesInformation = null
-
(optional)
Tags
Return values
UserSignaturesInformation —createSignaturesWithHttpInfo()
Operation createSignaturesWithHttpInfo
public
createSignaturesWithHttpInfo(string|null $account_id, string|null $user_id[, UserSignaturesInformation $user_signatures_information = null ]) : array<string|int, mixed>
Adds user Signature and initials images to a Signature.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_signatures_information : UserSignaturesInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserSignaturesInformation, HTTP status code, HTTP response headers (array of strings)
createWithHttpInfo()
Operation createWithHttpInfo
public
createWithHttpInfo(string|null $account_id[, NewUsersDefinition $new_users_definition = null ]) : array<string|int, mixed>
Adds news user to the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $new_users_definition : NewUsersDefinition = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\NewUsersSummary, HTTP status code, HTTP response headers (array of strings)
delete()
Operation delete
public
delete(string|null $account_id[, UserInfoList $user_info_list = null ][, DeleteOptions $options = null ]) : UsersResponse
Removes users account privileges.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_info_list : UserInfoList = null
-
(optional)
- $options : DeleteOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
UsersResponse —deleteContacts()
Operation deleteContacts
public
deleteContacts(string|null $account_id[, ContactModRequest $contact_mod_request = null ]) : ContactUpdateResponse
Delete contacts associated with an account for the DocuSign service.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $contact_mod_request : ContactModRequest = null
-
(optional)
Tags
Return values
ContactUpdateResponse —deleteContactsWithHttpInfo()
Operation deleteContactsWithHttpInfo
public
deleteContactsWithHttpInfo(string|null $account_id[, ContactModRequest $contact_mod_request = null ]) : array<string|int, mixed>
Delete contacts associated with an account for the DocuSign service.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $contact_mod_request : ContactModRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ContactUpdateResponse, HTTP status code, HTTP response headers (array of strings)
deleteContactWithId()
Operation deleteContactWithId
public
deleteContactWithId(string|null $account_id, string|null $contact_id) : ContactUpdateResponse
Replaces a particular contact associated with an account for the DocuSign service.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $contact_id : string|null
-
The unique identifier of a person in the contacts address book.
Tags
Return values
ContactUpdateResponse —deleteContactWithIdWithHttpInfo()
Operation deleteContactWithIdWithHttpInfo
public
deleteContactWithIdWithHttpInfo(string|null $account_id, string|null $contact_id) : array<string|int, mixed>
Replaces a particular contact associated with an account for the DocuSign service.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $contact_id : string|null
-
The unique identifier of a person in the contacts address book.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ContactUpdateResponse, HTTP status code, HTTP response headers (array of strings)
deleteCustomSettings()
Operation deleteCustomSettings
public
deleteCustomSettings(string|null $account_id, string|null $user_id[, CustomSettingsInformation $custom_settings_information = null ]) : CustomSettingsInformation
Deletes custom user settings for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $custom_settings_information : CustomSettingsInformation = null
-
(optional)
Tags
Return values
CustomSettingsInformation —deleteCustomSettingsWithHttpInfo()
Operation deleteCustomSettingsWithHttpInfo
public
deleteCustomSettingsWithHttpInfo(string|null $account_id, string|null $user_id[, CustomSettingsInformation $custom_settings_information = null ]) : array<string|int, mixed>
Deletes custom user settings for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $custom_settings_information : CustomSettingsInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CustomSettingsInformation, HTTP status code, HTTP response headers (array of strings)
deleteProfileImage()
Operation deleteProfileImage
public
deleteProfileImage(string|null $account_id, string|null $user_id) : mixed
Deletes the user profile image for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
mixed —deleteProfileImageWithHttpInfo()
Operation deleteProfileImageWithHttpInfo
public
deleteProfileImageWithHttpInfo(string|null $account_id, string|null $user_id) : array<string|int, mixed>
Deletes the user profile image for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteSignature()
Operation deleteSignature
public
deleteSignature(string|null $account_id, string|null $signature_id, string|null $user_id) : mixed
Removes removes signature information for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
mixed —deleteSignatureImage()
Operation deleteSignatureImage
public
deleteSignatureImage(string|null $account_id, string|null $image_type, string|null $signature_id, string|null $user_id) : UserSignature
Deletes the user initials image or the user signature image for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
UserSignature —deleteSignatureImageWithHttpInfo()
Operation deleteSignatureImageWithHttpInfo
public
deleteSignatureImageWithHttpInfo(string|null $account_id, string|null $image_type, string|null $signature_id, string|null $user_id) : array<string|int, mixed>
Deletes the user initials image or the user signature image for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserSignature, HTTP status code, HTTP response headers (array of strings)
deleteSignatureWithHttpInfo()
Operation deleteSignatureWithHttpInfo
public
deleteSignatureWithHttpInfo(string|null $account_id, string|null $signature_id, string|null $user_id) : array<string|int, mixed>
Removes removes signature information for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteWithHttpInfo()
Operation deleteWithHttpInfo
public
deleteWithHttpInfo(string|null $account_id[, UserInfoList $user_info_list = null ][, DeleteOptions $options = null ]) : array<string|int, mixed>
Removes users account privileges.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_info_list : UserInfoList = null
-
(optional)
- $options : DeleteOptions = 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)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getContactById()
Operation getContactById
public
getContactById(string|null $account_id, string|null $contact_id[, GetContactByIdOptions $options = null ]) : ContactGetResponse
Gets a particular contact associated with the user's account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $contact_id : string|null
-
The unique identifier of a person in the contacts address book.
- $options : GetContactByIdOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
ContactGetResponse —getContactByIdWithHttpInfo()
Operation getContactByIdWithHttpInfo
public
getContactByIdWithHttpInfo(string|null $account_id, string|null $contact_id[, GetContactByIdOptions $options = null ]) : array<string|int, mixed>
Gets a particular contact associated with the user's account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $contact_id : string|null
-
The unique identifier of a person in the contacts address book.
- $options : GetContactByIdOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ContactGetResponse, HTTP status code, HTTP response headers (array of strings)
getInformation()
Operation getInformation
public
getInformation(string|null $account_id, string|null $user_id[, GetInformationOptions $options = null ]) : UserInformation
Gets the user information for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $options : GetInformationOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
UserInformation —getInformationWithHttpInfo()
Operation getInformationWithHttpInfo
public
getInformationWithHttpInfo(string|null $account_id, string|null $user_id[, GetInformationOptions $options = null ]) : array<string|int, mixed>
Gets the user information for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $options : GetInformationOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserInformation, HTTP status code, HTTP response headers (array of strings)
getProfile()
Operation getProfile
public
getProfile(string|null $account_id, string|null $user_id) : UserProfile
Retrieves the user profile for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
UserProfile —getProfileImage()
Operation getProfileImage
public
getProfileImage(string|null $account_id, string|null $user_id[, GetProfileImageOptions $options = null ]) : SplFileObject
Retrieves the user profile image for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $options : GetProfileImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
SplFileObject —getProfileImageWithHttpInfo()
Operation getProfileImageWithHttpInfo
public
getProfileImageWithHttpInfo(string|null $account_id, string|null $user_id[, GetProfileImageOptions $options = null ]) : array<string|int, mixed>
Retrieves the user profile image for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $options : GetProfileImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \SplFileObject, HTTP status code, HTTP response headers (array of strings)
getProfileWithHttpInfo()
Operation getProfileWithHttpInfo
public
getProfileWithHttpInfo(string|null $account_id, string|null $user_id) : array<string|int, mixed>
Retrieves the user profile for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserProfile, HTTP status code, HTTP response headers (array of strings)
getSettings()
Operation getSettings
public
getSettings(string|null $account_id, string|null $user_id) : UserSettingsInformation
Gets the user account settings for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
UserSettingsInformation —getSettingsWithHttpInfo()
Operation getSettingsWithHttpInfo
public
getSettingsWithHttpInfo(string|null $account_id, string|null $user_id) : array<string|int, mixed>
Gets the user account settings for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserSettingsInformation, HTTP status code, HTTP response headers (array of strings)
getSignature()
Operation getSignature
public
getSignature(string|null $account_id, string|null $signature_id, string|null $user_id) : UserSignature
Gets the user signature information for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
UserSignature —getSignatureImage()
Operation getSignatureImage
public
getSignatureImage(string|null $account_id, string|null $image_type, string|null $signature_id, string|null $user_id[, GetSignatureImageOptions $options = null ]) : SplFileObject
Retrieves the user initials image or the user signature image for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $options : GetSignatureImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
SplFileObject —getSignatureImageWithHttpInfo()
Operation getSignatureImageWithHttpInfo
public
getSignatureImageWithHttpInfo(string|null $account_id, string|null $image_type, string|null $signature_id, string|null $user_id[, GetSignatureImageOptions $options = null ]) : array<string|int, mixed>
Retrieves the user initials image or the user signature image for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $options : GetSignatureImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \SplFileObject, HTTP status code, HTTP response headers (array of strings)
getSignatureWithHttpInfo()
Operation getSignatureWithHttpInfo
public
getSignatureWithHttpInfo(string|null $account_id, string|null $signature_id, string|null $user_id) : array<string|int, mixed>
Gets the user signature information for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserSignature, HTTP status code, HTTP response headers (array of strings)
listCustomSettings()
Operation listCustomSettings
public
listCustomSettings(string|null $account_id, string|null $user_id) : CustomSettingsInformation
Retrieves the custom user settings for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
CustomSettingsInformation —listCustomSettingsWithHttpInfo()
Operation listCustomSettingsWithHttpInfo
public
listCustomSettingsWithHttpInfo(string|null $account_id, string|null $user_id) : array<string|int, mixed>
Retrieves the custom user settings for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CustomSettingsInformation, HTTP status code, HTTP response headers (array of strings)
listSignatures()
Operation listSignatures
public
listSignatures(string|null $account_id, string|null $user_id[, ListSignaturesOptions $options = null ]) : UserSignaturesInformation
Retrieves a list of user signature definitions for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $options : ListSignaturesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
UserSignaturesInformation —listSignaturesWithHttpInfo()
Operation listSignaturesWithHttpInfo
public
listSignaturesWithHttpInfo(string|null $account_id, string|null $user_id[, ListSignaturesOptions $options = null ]) : array<string|int, mixed>
Retrieves a list of user signature definitions for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $options : ListSignaturesOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserSignaturesInformation, HTTP status code, HTTP response headers (array of strings)
postContacts()
Operation postContacts
public
postContacts(string|null $account_id[, ContactModRequest $contact_mod_request = null ]) : ContactUpdateResponse
Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $contact_mod_request : ContactModRequest = null
-
(optional)
Tags
Return values
ContactUpdateResponse —postContactsWithHttpInfo()
Operation postContactsWithHttpInfo
public
postContactsWithHttpInfo(string|null $account_id[, ContactModRequest $contact_mod_request = null ]) : array<string|int, mixed>
Imports multiple new contacts into the contacts collection from CSV, JSON, or XML (based on content type).
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $contact_mod_request : ContactModRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ContactUpdateResponse, HTTP status code, HTTP response headers (array of strings)
putContacts()
Operation putContacts
public
putContacts(string|null $account_id[, ContactModRequest $contact_mod_request = null ]) : ContactUpdateResponse
Replaces contacts associated with an account for the DocuSign service.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $contact_mod_request : ContactModRequest = null
-
(optional)
Tags
Return values
ContactUpdateResponse —putContactsWithHttpInfo()
Operation putContactsWithHttpInfo
public
putContactsWithHttpInfo(string|null $account_id[, ContactModRequest $contact_mod_request = null ]) : array<string|int, mixed>
Replaces contacts associated with an account for the DocuSign service.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $contact_mod_request : ContactModRequest = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ContactUpdateResponse, 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 —updateCustomSettings()
Operation updateCustomSettings
public
updateCustomSettings(string|null $account_id, string|null $user_id[, CustomSettingsInformation $custom_settings_information = null ]) : CustomSettingsInformation
Adds or updates custom user settings for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $custom_settings_information : CustomSettingsInformation = null
-
(optional)
Tags
Return values
CustomSettingsInformation —updateCustomSettingsWithHttpInfo()
Operation updateCustomSettingsWithHttpInfo
public
updateCustomSettingsWithHttpInfo(string|null $account_id, string|null $user_id[, CustomSettingsInformation $custom_settings_information = null ]) : array<string|int, mixed>
Adds or updates custom user settings for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $custom_settings_information : CustomSettingsInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\CustomSettingsInformation, HTTP status code, HTTP response headers (array of strings)
updateProfile()
Operation updateProfile
public
updateProfile(string|null $account_id, string|null $user_id[, UserProfile $user_profile = null ]) : mixed
Updates the user profile information for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_profile : UserProfile = null
-
(optional)
Tags
Return values
mixed —updateProfileImage()
Operation updateProfileImage
public
updateProfileImage(string|null $account_id, string|null $user_id) : mixed
Updates the user profile image for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
mixed —updateProfileImageWithHttpInfo()
Operation updateProfileImageWithHttpInfo
public
updateProfileImageWithHttpInfo(string|null $account_id, string|null $user_id) : array<string|int, mixed>
Updates the user profile image for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
updateProfileWithHttpInfo()
Operation updateProfileWithHttpInfo
public
updateProfileWithHttpInfo(string|null $account_id, string|null $user_id[, UserProfile $user_profile = null ]) : array<string|int, mixed>
Updates the user profile information for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_profile : UserProfile = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of null, 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 —updateSettings()
Operation updateSettings
public
updateSettings(string|null $account_id, string|null $user_id[, UserSettingsInformation $user_settings_information = null ][, UpdateSettingsOptions $options = null ]) : mixed
Updates the user account settings for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_settings_information : UserSettingsInformation = null
-
(optional)
- $options : UpdateSettingsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
mixed —updateSettingsWithHttpInfo()
Operation updateSettingsWithHttpInfo
public
updateSettingsWithHttpInfo(string|null $account_id, string|null $user_id[, UserSettingsInformation $user_settings_information = null ][, UpdateSettingsOptions $options = null ]) : array<string|int, mixed>
Updates the user account settings for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_settings_information : UserSettingsInformation = null
-
(optional)
- $options : UpdateSettingsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
updateSignature()
Operation updateSignature
public
updateSignature(string|null $account_id, string|null $signature_id, string|null $user_id[, UserSignatureDefinition $user_signature_definition = null ][, UpdateSignatureOptions $options = null ]) : UserSignature
Updates the user signature for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_signature_definition : UserSignatureDefinition = null
-
(optional)
- $options : UpdateSignatureOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
UserSignature —updateSignatureImage()
Operation updateSignatureImage
public
updateSignatureImage(string|null $account_id, string|null $image_type, string|null $signature_id, string|null $user_id[, UpdateSignatureImageOptions $options = null ]) : UserSignature
Updates the user signature image or user initials image for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $options : UpdateSignatureImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
UserSignature —updateSignatureImageWithHttpInfo()
Operation updateSignatureImageWithHttpInfo
public
updateSignatureImageWithHttpInfo(string|null $account_id, string|null $image_type, string|null $signature_id, string|null $user_id[, UpdateSignatureImageOptions $options = null ]) : array<string|int, mixed>
Updates the user signature image or user initials image for the specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $image_type : string|null
-
One of signature_image or initials_image.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $options : UpdateSignatureImageOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserSignature, HTTP status code, HTTP response headers (array of strings)
updateSignatures()
Operation updateSignatures
public
updateSignatures(string|null $account_id, string|null $user_id[, UserSignaturesInformation $user_signatures_information = null ]) : UserSignaturesInformation
Adds/updates a user signature.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_signatures_information : UserSignaturesInformation = null
-
(optional)
Tags
Return values
UserSignaturesInformation —updateSignaturesWithHttpInfo()
Operation updateSignaturesWithHttpInfo
public
updateSignaturesWithHttpInfo(string|null $account_id, string|null $user_id[, UserSignaturesInformation $user_signatures_information = null ]) : array<string|int, mixed>
Adds/updates a user signature.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_signatures_information : UserSignaturesInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserSignaturesInformation, HTTP status code, HTTP response headers (array of strings)
updateSignatureWithHttpInfo()
Operation updateSignatureWithHttpInfo
public
updateSignatureWithHttpInfo(string|null $account_id, string|null $signature_id, string|null $user_id[, UserSignatureDefinition $user_signature_definition = null ][, UpdateSignatureOptions $options = null ]) : array<string|int, mixed>
Updates the user signature for a specified user.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $signature_id : string|null
-
The ID of the signature being accessed.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_signature_definition : UserSignatureDefinition = null
-
(optional)
- $options : UpdateSignatureOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserSignature, HTTP status code, HTTP response headers (array of strings)
updateUser()
Operation updateUser
public
updateUser(string|null $account_id, string|null $user_id[, UserInformation $user_information = null ][, UpdateUserOptions $options = null ]) : UserInformation
Updates the specified user information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_information : UserInformation = null
-
(optional)
- $options : UpdateUserOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
UserInformation —updateUsers()
Operation updateUsers
public
updateUsers(string|null $account_id[, UserInformationList $user_information_list = null ][, UpdateUsersOptions $options = null ]) : UserInformationList
Change one or more user in the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_information_list : UserInformationList = null
-
(optional)
- $options : UpdateUsersOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
UserInformationList —updateUsersWithHttpInfo()
Operation updateUsersWithHttpInfo
public
updateUsersWithHttpInfo(string|null $account_id[, UserInformationList $user_information_list = null ][, UpdateUsersOptions $options = null ]) : array<string|int, mixed>
Change one or more user in the specified account.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_information_list : UserInformationList = null
-
(optional)
- $options : UpdateUsersOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserInformationList, HTTP status code, HTTP response headers (array of strings)
updateUserWithHttpInfo()
Operation updateUserWithHttpInfo
public
updateUserWithHttpInfo(string|null $account_id, string|null $user_id[, UserInformation $user_information = null ][, UpdateUserOptions $options = null ]) : array<string|int, mixed>
Updates the specified user information.
Parameters
- $account_id : string|null
-
The external account number (int) or account ID Guid.
- $user_id : string|null
-
The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.
- $user_information : UserInformation = null
-
(optional)
- $options : UpdateUserOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\UserInformation, HTTP status code, HTTP response headers (array of strings)