CommentsApi
in package
CommentsApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : mixed
- Constructor
- getApiClient() : ApiClient
- Get API client
- getCommentsTranscript() : SplFileObject
- Operation getCommentsTranscript
- getCommentsTranscriptWithHttpInfo() : array<string|int, mixed>
- Operation getCommentsTranscriptWithHttpInfo
- setApiClient() : CommentsApi
- Set the API client
Properties
$apiClient
API Client
protected
ApiClient
$apiClient
instance of the ApiClient
Methods
__construct()
Constructor
public
__construct([ApiClient|null $apiClient = null ]) : mixed
Parameters
- $apiClient : ApiClient|null = null
-
The api client to use
Return values
mixed —getApiClient()
Get API client
public
getApiClient() : ApiClient
Return values
ApiClient —get the API client
getCommentsTranscript()
Operation getCommentsTranscript
public
getCommentsTranscript(string $account_id, string $envelope_id[, $options = null ]) : SplFileObject
Gets comment transcript for envelope and user
Parameters
- $account_id : string
-
The external account number (int) or account ID Guid.
- $envelope_id : string
-
The envelopeId Guid of the envelope being accessed.
- $options : = null
-
Options for modifying the behavior of the function. (optional)
Tags
Return values
SplFileObject —getCommentsTranscriptWithHttpInfo()
Operation getCommentsTranscriptWithHttpInfo
public
getCommentsTranscriptWithHttpInfo(string $account_id, string $envelope_id[, $options = null ]) : array<string|int, mixed>
Gets comment transcript for envelope and user
Parameters
- $account_id : string
-
The external account number (int) or account ID Guid.
- $envelope_id : string
-
The envelopeId Guid of the envelope being accessed.
- $options : = null
-
Options 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)
setApiClient()
Set the API client
public
setApiClient(ApiClient $apiClient) : CommentsApi
Parameters
- $apiClient : ApiClient
-
set the API client