Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppAction ¶ added in v0.6.4
type AppAction struct {
// Name of the action
Name string `json:"name,required"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Name respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
An action available on the app
func (*AppAction) UnmarshalJSON ¶ added in v0.6.4
type ErrorDetail ¶
type ErrorDetail struct {
// Lower-level error code providing more specific detail
Code string `json:"code"`
// Further detail about the error
Message string `json:"message"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Code respjson.Field
Message respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
func (ErrorDetail) RawJSON ¶
func (r ErrorDetail) RawJSON() string
Returns the unmodified JSON received from the API
func (*ErrorDetail) UnmarshalJSON ¶
func (r *ErrorDetail) UnmarshalJSON(data []byte) error
type ErrorEvent ¶
type ErrorEvent struct {
Error ErrorModel `json:"error,required"`
// Event type identifier (always "error").
Event constant.Error `json:"event,required"`
// Time the error occurred.
Timestamp time.Time `json:"timestamp,required" format:"date-time"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Error respjson.Field
Event respjson.Field
Timestamp respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
An error event from the application.
func (ErrorEvent) ImplInvocationFollowResponseUnion ¶
func (ErrorEvent) ImplInvocationFollowResponseUnion()
func (ErrorEvent) RawJSON ¶
func (r ErrorEvent) RawJSON() string
Returns the unmodified JSON received from the API
func (*ErrorEvent) UnmarshalJSON ¶
func (r *ErrorEvent) UnmarshalJSON(data []byte) error
type ErrorModel ¶
type ErrorModel struct {
// Application-specific error code (machine-readable)
Code string `json:"code,required"`
// Human-readable error description for debugging
Message string `json:"message,required"`
// Additional error details (for multiple errors)
Details []ErrorDetail `json:"details"`
InnerError ErrorDetail `json:"inner_error"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Code respjson.Field
Message respjson.Field
Details respjson.Field
InnerError respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
func (ErrorModel) RawJSON ¶
func (r ErrorModel) RawJSON() string
Returns the unmodified JSON received from the API
func (*ErrorModel) UnmarshalJSON ¶
func (r *ErrorModel) UnmarshalJSON(data []byte) error
type HeartbeatEvent ¶ added in v0.6.2
type HeartbeatEvent struct {
// Event type identifier (always "sse_heartbeat").
Event constant.SseHeartbeat `json:"event,required"`
// Time the heartbeat was sent.
Timestamp time.Time `json:"timestamp,required" format:"date-time"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Event respjson.Field
Timestamp respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
Heartbeat event sent periodically to keep SSE connection alive.
func (HeartbeatEvent) ImplInvocationFollowResponseUnion ¶ added in v0.6.2
func (HeartbeatEvent) ImplInvocationFollowResponseUnion()
func (HeartbeatEvent) RawJSON ¶ added in v0.6.2
func (r HeartbeatEvent) RawJSON() string
Returns the unmodified JSON received from the API
func (*HeartbeatEvent) UnmarshalJSON ¶ added in v0.6.2
func (r *HeartbeatEvent) UnmarshalJSON(data []byte) error
type LogEvent ¶
type LogEvent struct {
// Event type identifier (always "log").
Event constant.Log `json:"event,required"`
// Log message text.
Message string `json:"message,required"`
// Time the log entry was produced.
Timestamp time.Time `json:"timestamp,required" format:"date-time"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Event respjson.Field
Message respjson.Field
Timestamp respjson.Field
ExtraFields map[string]respjson.Field
// contains filtered or unexported fields
} `json:"-"`
}
A log entry from the application.
func (LogEvent) ImplInvocationFollowResponseUnion ¶
func (LogEvent) ImplInvocationFollowResponseUnion()
func (*LogEvent) UnmarshalJSON ¶
Click to show internal directories.
Click to hide internal directories.