Documentation

DiagnosticsApi
in package

DiagnosticsApi Class Doc Comment

Tags
category

Class

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

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

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
throws
ApiException

on non-2xx response

Return values
mixed

deleteRequestLogsWithHttpInfo()

Operation deleteRequestLogsWithHttpInfo

public deleteRequestLogsWithHttpInfo() : array<string|int, mixed>

Deletes the request log files.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of null, HTTP status code, HTTP response headers (array of strings)

getRequestLog()

Operation getRequestLog

public getRequestLog(string|null $request_log_id) : SplFileObject

Gets a request logging log file.

Parameters
$request_log_id : string|null
Tags
throws
ApiException

on non-2xx response

Return values
SplFileObject

getRequestLogSettingsWithHttpInfo()

Operation getRequestLogSettingsWithHttpInfo

public getRequestLogSettingsWithHttpInfo() : array<string|int, mixed>

Gets the API request logging settings.

Tags
throws
ApiException

on non-2xx response

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
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \SplFileObject, HTTP status code, HTTP response headers (array of strings)

getResourcesWithHttpInfo()

Operation getResourcesWithHttpInfo

public getResourcesWithHttpInfo() : array<string|int, mixed>

Lists resources for REST version specified

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ResourceInformation, HTTP status code, HTTP response headers (array of strings)

getServiceWithHttpInfo()

Operation getServiceWithHttpInfo

public getServiceWithHttpInfo() : array<string|int, mixed>

Retrieves the available REST API versions.

Tags
throws
ApiException

on non-2xx response

Return values
array<string|int, mixed>

of \DocuSign\eSign\Model\ServiceInformation, HTTP status code, HTTP response headers (array of strings)

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
throws
ApiException

on non-2xx response

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

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
throws
ApiException

on non-2xx response

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

Return values
string

Search results