Documentation
¶
Overview ¶
Package diagnostics implements the DocuSign SDK category Diagnostics.
The Diagnostics category provides miscellaneous end points.
They include: * Requesting and managing the API call-logging feature. (Perfect for debugging your app!) * Getting information on the API's resources and versions.
Service Api documentation may be found at: https://developers.docusign.com/esign-rest-api/v2/reference/Diagnostics Usage example:
import (
"github.com/jfcote87/esign"
"github.com/jfcote87/esign/v2/diagnostics"
"github.com/jfcote87/esign/v2/model"
)
...
diagnosticsService := diagnostics.New(esignCredential)
Index ¶
- type RequestLogsDeleteOp
- type RequestLogsGetOp
- type RequestLogsGetSettingsOp
- type RequestLogsListOp
- type RequestLogsUpdateSettingsOp
- type ResourcesGetOp
- type Service
- func (s *Service) RequestLogsDelete() *RequestLogsDeleteOp
- func (s *Service) RequestLogsGet(requestLogID string) *RequestLogsGetOp
- func (s *Service) RequestLogsGetSettings() *RequestLogsGetSettingsOp
- func (s *Service) RequestLogsList() *RequestLogsListOp
- func (s *Service) RequestLogsUpdateSettings(requestLogs *model.DiagnosticsSettingsInformation) *RequestLogsUpdateSettingsOp
- func (s *Service) ResourcesGet() *ResourcesGetOp
- func (s *Service) ServicesGet() *ServicesGetOp
- type ServicesGetOp
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type RequestLogsDeleteOp ¶
RequestLogsDeleteOp implements DocuSign API SDK Diagnostics::deleteRequestLogs
type RequestLogsGetOp ¶
RequestLogsGetOp implements DocuSign API SDK Diagnostics::getRequestLog
type RequestLogsGetSettingsOp ¶
RequestLogsGetSettingsOp implements DocuSign API SDK Diagnostics::getRequestLogSettings
func (*RequestLogsGetSettingsOp) Do ¶
func (op *RequestLogsGetSettingsOp) Do(ctx context.Context) (*model.DiagnosticsSettingsInformation, error)
Do executes the op. A nil context will return error.
type RequestLogsListOp ¶
RequestLogsListOp implements DocuSign API SDK Diagnostics::listRequestLogs
func (*RequestLogsListOp) Do ¶
func (op *RequestLogsListOp) Do(ctx context.Context) (*model.APIRequestLogsResult, error)
Do executes the op. A nil context will return error.
func (*RequestLogsListOp) Encoding ¶
func (op *RequestLogsListOp) Encoding(val string) *RequestLogsListOp
Encoding set the call query parameter encoding
type RequestLogsUpdateSettingsOp ¶
RequestLogsUpdateSettingsOp implements DocuSign API SDK Diagnostics::updateRequestLogSettings
func (*RequestLogsUpdateSettingsOp) Do ¶
func (op *RequestLogsUpdateSettingsOp) Do(ctx context.Context) (*model.DiagnosticsSettingsInformation, error)
Do executes the op. A nil context will return error.
type ResourcesGetOp ¶
ResourcesGetOp implements DocuSign API SDK Diagnostics::getResources
func (*ResourcesGetOp) Do ¶
func (op *ResourcesGetOp) Do(ctx context.Context) (*model.ResourceInformation, error)
Do executes the op. A nil context will return error.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service implements DocuSign Diagnostics Category API operations
func New ¶
func New(cred esign.Credential) *Service
New initializes a diagnostics service using cred to authorize ops.
func (*Service) RequestLogsDelete ¶
func (s *Service) RequestLogsDelete() *RequestLogsDeleteOp
RequestLogsDelete deletes the request log files.
https://developers.docusign.com/esign-rest-api/v2/reference/diagnostics/requestlogs/delete
SDK Method Diagnostics::deleteRequestLogs
func (*Service) RequestLogsGet ¶
func (s *Service) RequestLogsGet(requestLogID string) *RequestLogsGetOp
RequestLogsGet gets a request logging log file.
https://developers.docusign.com/esign-rest-api/v2/reference/diagnostics/requestlogs/get
SDK Method Diagnostics::getRequestLog
func (*Service) RequestLogsGetSettings ¶
func (s *Service) RequestLogsGetSettings() *RequestLogsGetSettingsOp
RequestLogsGetSettings gets the API request logging settings.
https://developers.docusign.com/esign-rest-api/v2/reference/diagnostics/requestlogs/getsettings
SDK Method Diagnostics::getRequestLogSettings
func (*Service) RequestLogsList ¶
func (s *Service) RequestLogsList() *RequestLogsListOp
RequestLogsList gets the API request logging log files.
https://developers.docusign.com/esign-rest-api/v2/reference/diagnostics/requestlogs/list
SDK Method Diagnostics::listRequestLogs
func (*Service) RequestLogsUpdateSettings ¶
func (s *Service) RequestLogsUpdateSettings(requestLogs *model.DiagnosticsSettingsInformation) *RequestLogsUpdateSettingsOp
RequestLogsUpdateSettings enables or disables API request logging for troubleshooting.
https://developers.docusign.com/esign-rest-api/v2/reference/diagnostics/requestlogs/updatesettings
SDK Method Diagnostics::updateRequestLogSettings
func (*Service) ResourcesGet ¶
func (s *Service) ResourcesGet() *ResourcesGetOp
ResourcesGet lists resources for REST version specified
https://developers.docusign.com/esign-rest-api/v2/reference/diagnostics/resources/get
SDK Method Diagnostics::getResources
func (*Service) ServicesGet ¶
func (s *Service) ServicesGet() *ServicesGetOp
ServicesGet retrieves the available REST API versions.
https://developers.docusign.com/esign-rest-api/v2/reference/diagnostics/services/get
SDK Method Diagnostics::getService
type ServicesGetOp ¶
ServicesGetOp implements DocuSign API SDK Diagnostics::getService
func (*ServicesGetOp) Do ¶
func (op *ServicesGetOp) Do(ctx context.Context) (*model.ServiceInformation, error)
Do executes the op. A nil context will return error.
Source Files