diagnostics

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/bradwheel/esign"
    "github.com/bradwheel/esign/v2/diagnostics"
    "github.com/bradwheel/esign/v2/model"
)
...
diagnosticsService := diagnostics.New(esignCredential)

Index

• type RequestLogsDeleteOp
  • func (op *RequestLogsDeleteOp) Do(ctx context.Context) error
• type RequestLogsGetOp
  • func (op *RequestLogsGetOp) Do(ctx context.Context) (*esign.Download, error)
• type RequestLogsGetSettingsOp
  • func (op *RequestLogsGetSettingsOp) Do(ctx context.Context) (*model.DiagnosticsSettingsInformation, error)
• type RequestLogsListOp
  • func (op *RequestLogsListOp) Do(ctx context.Context) (*model.APIRequestLogsResult, error)
  • func (op *RequestLogsListOp) Encoding(val string) *RequestLogsListOp
  • func (op *RequestLogsListOp) Zip(ctx context.Context) (*esign.Download, error)
• type RequestLogsUpdateSettingsOp
  • func (op *RequestLogsUpdateSettingsOp) Do(ctx context.Context) (*model.DiagnosticsSettingsInformation, error)
• type ResourcesGetOp
  • func (op *ResourcesGetOp) Do(ctx context.Context) (*model.ResourceInformation, error)
• type Service
  • func New(cred esign.Credential) *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
  • func (op *ServicesGetOp) Do(ctx context.Context) (*model.ServiceInformation, error)

Types

type RequestLogsDeleteOp

type RequestLogsDeleteOp esign.Op

RequestLogsDeleteOp implements DocuSign API SDK Diagnostics::deleteRequestLogs

func (*RequestLogsDeleteOp) Do

func (op *RequestLogsDeleteOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type RequestLogsGetOp

type RequestLogsGetOp esign.Op

RequestLogsGetOp implements DocuSign API SDK Diagnostics::getRequestLog

func (*RequestLogsGetOp) Do

func (op *RequestLogsGetOp) Do(ctx context.Context) (*esign.Download, error)

Do executes the op. A nil context will return error.

type RequestLogsGetSettingsOp

type RequestLogsGetSettingsOp esign.Op

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

type RequestLogsListOp esign.Op

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

func (*RequestLogsListOp) Zip

func (op *RequestLogsListOp) Zip(ctx context.Context) (*esign.Download, error)

Zip returns a zip file containing log files by setting the Accept header to application/zip

**not included in swagger definition

type RequestLogsUpdateSettingsOp

type RequestLogsUpdateSettingsOp esign.Op

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

type ResourcesGetOp esign.Op

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

type ServicesGetOp esign.Op

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.