DiagnosticsApi
in package
DiagnosticsApi Class Doc Comment
Tags
Table of Contents
- $apiClient : ApiClient
- API Client
- __construct() : void
- Constructor
- deleteRequestLogs() : mixed
- Operation deleteRequestLogs
- deleteRequestLogsWithHttpInfo() : array<string|int, mixed>
- Operation deleteRequestLogsWithHttpInfo
- getApiClient() : ApiClient
- Get API client
- getRequestLog() : SplFileObject
- Operation getRequestLog
- getRequestLogSettings() : DiagnosticsSettingsInformation
- Operation getRequestLogSettings
- getRequestLogSettingsWithHttpInfo() : array<string|int, mixed>
- Operation getRequestLogSettingsWithHttpInfo
- getRequestLogWithHttpInfo() : array<string|int, mixed>
- Operation getRequestLogWithHttpInfo
- getResources() : ResourceInformation
- Operation getResources
- getResourcesWithHttpInfo() : array<string|int, mixed>
- Operation getResourcesWithHttpInfo
- getService() : ServiceInformation
- Operation getService
- getServiceWithHttpInfo() : array<string|int, mixed>
- Operation getServiceWithHttpInfo
- listRequestLogs() : ApiRequestLogsResult
- Operation listRequestLogs
- listRequestLogsWithHttpInfo() : array<string|int, mixed>
- Operation listRequestLogsWithHttpInfo
- setApiClient() : self
- Set the API client
- updateRequestLogSettings() : DiagnosticsSettingsInformation
- Operation updateRequestLogSettings
- updateRequestLogSettingsWithHttpInfo() : array<string|int, mixed>
- Operation updateRequestLogSettingsWithHttpInfo
- 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 —deleteRequestLogs()
Operation deleteRequestLogs
public
deleteRequestLogs() : mixed
Deletes the request log files.
Tags
Return values
mixed —deleteRequestLogsWithHttpInfo()
Operation deleteRequestLogsWithHttpInfo
public
deleteRequestLogsWithHttpInfo() : array<string|int, mixed>
Deletes the request log files.
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
getRequestLog()
Operation getRequestLog
public
getRequestLog(string|null $request_log_id) : SplFileObject
Gets a request logging log file.
Parameters
- $request_log_id : string|null
Tags
Return values
SplFileObject —getRequestLogSettings()
Operation getRequestLogSettings
public
getRequestLogSettings() : DiagnosticsSettingsInformation
Gets the API request logging settings.
Tags
Return values
DiagnosticsSettingsInformation —getRequestLogSettingsWithHttpInfo()
Operation getRequestLogSettingsWithHttpInfo
public
getRequestLogSettingsWithHttpInfo() : array<string|int, mixed>
Gets the API request logging settings.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DiagnosticsSettingsInformation, HTTP status code, HTTP response headers (array of strings)
getRequestLogWithHttpInfo()
Operation getRequestLogWithHttpInfo
public
getRequestLogWithHttpInfo(string|null $request_log_id) : array<string|int, mixed>
Gets a request logging log file.
Parameters
- $request_log_id : string|null
Tags
Return values
array<string|int, mixed> —of \SplFileObject, HTTP status code, HTTP response headers (array of strings)
getResources()
Operation getResources
public
getResources() : ResourceInformation
Lists resources for REST version specified
Tags
Return values
ResourceInformation —getResourcesWithHttpInfo()
Operation getResourcesWithHttpInfo
public
getResourcesWithHttpInfo() : array<string|int, mixed>
Lists resources for REST version specified
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ResourceInformation, HTTP status code, HTTP response headers (array of strings)
getService()
Operation getService
public
getService() : ServiceInformation
Retrieves the available REST API versions.
Tags
Return values
ServiceInformation —getServiceWithHttpInfo()
Operation getServiceWithHttpInfo
public
getServiceWithHttpInfo() : array<string|int, mixed>
Retrieves the available REST API versions.
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ServiceInformation, HTTP status code, HTTP response headers (array of strings)
listRequestLogs()
Operation listRequestLogs
public
listRequestLogs([ListRequestLogsOptions $options = null ]) : ApiRequestLogsResult
Gets the API request logging log files.
Parameters
- $options : ListRequestLogsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
ApiRequestLogsResult —listRequestLogsWithHttpInfo()
Operation listRequestLogsWithHttpInfo
public
listRequestLogsWithHttpInfo([ListRequestLogsOptions $options = null ]) : array<string|int, mixed>
Gets the API request logging log files.
Parameters
- $options : ListRequestLogsOptions = null
-
for modifying the behavior of the function. (optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\ApiRequestLogsResult, 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 —updateRequestLogSettings()
Operation updateRequestLogSettings
public
updateRequestLogSettings([DiagnosticsSettingsInformation $diagnostics_settings_information = null ]) : DiagnosticsSettingsInformation
Enables or disables API request logging for troubleshooting.
Parameters
- $diagnostics_settings_information : DiagnosticsSettingsInformation = null
-
(optional)
Tags
Return values
DiagnosticsSettingsInformation —updateRequestLogSettingsWithHttpInfo()
Operation updateRequestLogSettingsWithHttpInfo
public
updateRequestLogSettingsWithHttpInfo([DiagnosticsSettingsInformation $diagnostics_settings_information = null ]) : array<string|int, mixed>
Enables or disables API request logging for troubleshooting.
Parameters
- $diagnostics_settings_information : DiagnosticsSettingsInformation = null
-
(optional)
Tags
Return values
array<string|int, mixed> —of \DocuSign\eSign\Model\DiagnosticsSettingsInformation, 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