NotaryApi
in package
NotaryApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- createNotary() : Notary
- Operation createNotary
- createNotaryJurisdictions() : NotaryJurisdiction
- Operation createNotaryJurisdictions
- createNotaryJurisdictionsWithHttpInfo() : array<string|int, mixed>
- Operation createNotaryJurisdictionsWithHttpInfo
- createNotaryWithHttpInfo() : array<string|int, mixed>
- Operation createNotaryWithHttpInfo
- deleteNotaryJurisdiction() : mixed
- Operation deleteNotaryJurisdiction
- deleteNotaryJurisdictionWithHttpInfo() : array<string|int, mixed>
- Operation deleteNotaryJurisdictionWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getNotary() : NotaryResult
- Operation getNotary
- getNotaryJurisdiction() : NotaryJurisdiction
- Operation getNotaryJurisdiction
- getNotaryJurisdictions() : NotaryJurisdictionList
- Operation getNotaryJurisdictions
- getNotaryJurisdictionSeal() : mixed
- Operation getNotaryJurisdictionSeal
- getNotaryJurisdictionSealWithHttpInfo() : array<string|int, mixed>
- Operation getNotaryJurisdictionSealWithHttpInfo
- getNotaryJurisdictionsWithHttpInfo() : array<string|int, mixed>
- Operation getNotaryJurisdictionsWithHttpInfo
- getNotaryJurisdictionWithHttpInfo() : array<string|int, mixed>
- Operation getNotaryJurisdictionWithHttpInfo
- getNotaryWithHttpInfo() : array<string|int, mixed>
- Operation getNotaryWithHttpInfo
- listNotaryJournals() : NotaryJournalList
- Operation listNotaryJournals
- listNotaryJournalsWithHttpInfo() : array<string|int, mixed>
- Operation listNotaryJournalsWithHttpInfo
- setApiClient() : self
- Set the API client
- updateNotary() : Notary
- Operation updateNotary
- updateNotaryJurisdiction() : NotaryJurisdiction
- Operation updateNotaryJurisdiction
- updateNotaryJurisdictionWithHttpInfo() : array<string|int, mixed>
- Operation updateNotaryJurisdictionWithHttpInfo
- updateNotaryWithHttpInfo() : array<string|int, mixed>
- Operation updateNotaryWithHttpInfo
- 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 —createNotary()
Operation createNotary
public
createNotary([Notary $notary = null ]) : Notary
Add a notary to the system
Parameters
- $notary : Notary = null
-
(optional)
Tags
Return values
Notary —createNotaryJurisdictions()
Operation createNotaryJurisdictions
public
createNotaryJurisdictions([NotaryJurisdiction $notary_jurisdiction = null ]) : NotaryJurisdiction
Add a notary jurisdiction to the system
Parameters
- $notary_jurisdiction : NotaryJurisdiction = null
-
(optional)
Tags
Return values
NotaryJurisdiction —createNotaryJurisdictionsWithHttpInfo()
Operation createNotaryJurisdictionsWithHttpInfo
public
createNotaryJurisdictionsWithHttpInfo([NotaryJurisdiction $notary_jurisdiction = null ]) : array<string|int, mixed>
Add a notary jurisdiction to the system
Parameters
- $notary_jurisdiction : NotaryJurisdiction = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\NotaryJurisdiction, HTTP status code, HTTP response headers (array of strings)
createNotaryWithHttpInfo()
Operation createNotaryWithHttpInfo
public
createNotaryWithHttpInfo([Notary $notary = null ]) : array<string|int, mixed>
Add a notary to the system
Parameters
- $notary : Notary = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Notary, HTTP status code, HTTP response headers (array of strings)
deleteNotaryJurisdiction()
Operation deleteNotaryJurisdiction
public
deleteNotaryJurisdiction(string|null $jurisdiction_id) : mixed
Delete a notary jurisdiction a specified user.
Parameters
- $jurisdiction_id : string|null
Tags
Return values
mixed —deleteNotaryJurisdictionWithHttpInfo()
Operation deleteNotaryJurisdictionWithHttpInfo
public
deleteNotaryJurisdictionWithHttpInfo(string|null $jurisdiction_id) : array<string|int, mixed>
Delete a notary jurisdiction a specified user.
Parameters
- $jurisdiction_id : string|null
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getNotary()
Operation getNotary
public
getNotary([GetNotaryOptions $options = null ]) : NotaryResult
Get notary settings for a user
Parameters
- $options : GetNotaryOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
NotaryResult —getNotaryJurisdiction()
Operation getNotaryJurisdiction
public
getNotaryJurisdiction(string|null $jurisdiction_id) : NotaryJurisdiction
Get notary a jurisdiction for a user
Parameters
- $jurisdiction_id : string|null
Tags
Return values
NotaryJurisdiction —getNotaryJurisdictions()
Operation getNotaryJurisdictions
public
getNotaryJurisdictions() : NotaryJurisdictionList
Get notary jurisdictions for a user
Tags
Return values
NotaryJurisdictionList —getNotaryJurisdictionSeal()
Operation getNotaryJurisdictionSeal
public
getNotaryJurisdictionSeal(string|null $jurisdiction_id) : mixed
Get notary seal for a jurisdiction
Parameters
- $jurisdiction_id : string|null
Tags
Return values
mixed —getNotaryJurisdictionSealWithHttpInfo()
Operation getNotaryJurisdictionSealWithHttpInfo
public
getNotaryJurisdictionSealWithHttpInfo(string|null $jurisdiction_id) : array<string|int, mixed>
Get notary seal for a jurisdiction
Parameters
- $jurisdiction_id : string|null
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getNotaryJurisdictionsWithHttpInfo()
Operation getNotaryJurisdictionsWithHttpInfo
public
getNotaryJurisdictionsWithHttpInfo() : array<string|int, mixed>
Get notary jurisdictions for a user
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\NotaryJurisdictionList, HTTP status code, HTTP response headers (array of strings)
getNotaryJurisdictionWithHttpInfo()
Operation getNotaryJurisdictionWithHttpInfo
public
getNotaryJurisdictionWithHttpInfo(string|null $jurisdiction_id) : array<string|int, mixed>
Get notary a jurisdiction for a user
Parameters
- $jurisdiction_id : string|null
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\NotaryJurisdiction, HTTP status code, HTTP response headers (array of strings)
getNotaryWithHttpInfo()
Operation getNotaryWithHttpInfo
public
getNotaryWithHttpInfo([GetNotaryOptions $options = null ]) : array<string|int, mixed>
Get notary settings for a user
Parameters
- $options : GetNotaryOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\NotaryResult, HTTP status code, HTTP response headers (array of strings)
listNotaryJournals()
Operation listNotaryJournals
public
listNotaryJournals([ListNotaryJournalsOptions $options = null ]) : NotaryJournalList
Get notary jurisdictions for a user
Parameters
- $options : ListNotaryJournalsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
NotaryJournalList —listNotaryJournalsWithHttpInfo()
Operation listNotaryJournalsWithHttpInfo
public
listNotaryJournalsWithHttpInfo([ListNotaryJournalsOptions $options = null ]) : array<string|int, mixed>
Get notary jurisdictions for a user
Parameters
- $options : ListNotaryJournalsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\NotaryJournalList, 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 —updateNotary()
Operation updateNotary
public
updateNotary([Notary $notary = null ]) : Notary
Update a notary
Parameters
- $notary : Notary = null
-
(optional)
Tags
Return values
Notary —updateNotaryJurisdiction()
Operation updateNotaryJurisdiction
public
updateNotaryJurisdiction(string|null $jurisdiction_id[, NotaryJurisdiction $notary_jurisdiction = null ]) : NotaryJurisdiction
Update a notary jurisdiction
Parameters
- $jurisdiction_id : string|null
- $notary_jurisdiction : NotaryJurisdiction = null
-
(optional)
Tags
Return values
NotaryJurisdiction —updateNotaryJurisdictionWithHttpInfo()
Operation updateNotaryJurisdictionWithHttpInfo
public
updateNotaryJurisdictionWithHttpInfo(string|null $jurisdiction_id[, NotaryJurisdiction $notary_jurisdiction = null ]) : array<string|int, mixed>
Update a notary jurisdiction
Parameters
- $jurisdiction_id : string|null
- $notary_jurisdiction : NotaryJurisdiction = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\NotaryJurisdiction, HTTP status code, HTTP response headers (array of strings)
updateNotaryWithHttpInfo()
Operation updateNotaryWithHttpInfo
public
updateNotaryWithHttpInfo([Notary $notary = null ]) : array<string|int, mixed>
Update a notary
Parameters
- $notary : Notary = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\Notary, 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