apierror

Documentation

Index

• type Error
  • func (r *Error) DumpRequest(body bool) []byte
  • func (r *Error) DumpResponse(body bool) []byte
  • func (r *Error) Error() string
  • func (r Error) RawJSON() string
  • func (r *Error) UnmarshalJSON(data []byte) error

Types

type Error

type Error struct {
	Code    string `json:"code,required"`
	Message string `json:"message,required"`
	Param   string `json:"param,required"`
	Type    string `json:"type,required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Code        respjson.Field
		Message     respjson.Field
		Param       respjson.Field
		Type        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
	StatusCode int
	Request    *http.Request
	Response   *http.Response
}

Error represents an error that originates from the API, i.e. when a request is made and the API returns a response with a HTTP status code. Other errors are not wrapped by this SDK.

func (*Error) DumpRequest

func (r *Error) DumpRequest(body bool) []byte

func (*Error) DumpResponse

func (r *Error) DumpResponse(body bool) []byte

func (*Error) Error

func (r *Error) Error() string

func (Error) RawJSON

func (r Error) RawJSON() string

Returns the unmodified JSON received from the API

func (*Error) UnmarshalJSON

func (r *Error) UnmarshalJSON(data []byte) error