client

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package client provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.8.0 DO NOT EDIT.

Package client holds Peen's generated HTTP API client.

It is generated from the same `api/api.yml` document the server is generated from, so a caller and the service cannot drift: a change to the contract regenerates both or neither. Use this rather than hand-rolling requests against the documented paths.

For an in-process caller, `pkg/peen` is the supported entry point and needs no HTTP at all. This package is for talking to a Peen that runs somewhere else.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCancelSessionAgentRunRequest

func NewCancelSessionAgentRunRequest(server string, agentRunId AgentRunID, params *CancelSessionAgentRunParams) (*http.Request, error)

NewCancelSessionAgentRunRequest constructs an http.Request for the CancelSessionAgentRun method

func NewCancelSessionRequest

func NewCancelSessionRequest(server string, params *CancelSessionParams) (*http.Request, error)

NewCancelSessionRequest constructs an http.Request for the CancelSession method

func NewGetSessionRequest

func NewGetSessionRequest(server string, params *GetSessionParams) (*http.Request, error)

NewGetSessionRequest constructs an http.Request for the GetSession method

func NewListMessagesRequest

func NewListMessagesRequest(server string, params *ListMessagesParams) (*http.Request, error)

NewListMessagesRequest constructs an http.Request for the ListMessages method

func NewListSessionAgentRunEventsRequest

func NewListSessionAgentRunEventsRequest(server string, agentRunId AgentRunID, params *ListSessionAgentRunEventsParams) (*http.Request, error)

NewListSessionAgentRunEventsRequest constructs an http.Request for the ListSessionAgentRunEvents method

func NewListSessionAgentRunsRequest

func NewListSessionAgentRunsRequest(server string, params *ListSessionAgentRunsParams) (*http.Request, error)

NewListSessionAgentRunsRequest constructs an http.Request for the ListSessionAgentRuns method

func NewListSessionEventsRequest

func NewListSessionEventsRequest(server string, params *ListSessionEventsParams) (*http.Request, error)

NewListSessionEventsRequest constructs an http.Request for the ListSessionEvents method

func NewListSessionJobsRequest

func NewListSessionJobsRequest(server string, params *ListSessionJobsParams) (*http.Request, error)

NewListSessionJobsRequest constructs an http.Request for the ListSessionJobs method

func NewPublishSessionEventRequest

func NewPublishSessionEventRequest(server string, params *PublishSessionEventParams, body PublishSessionEventJSONRequestBody) (*http.Request, error)

NewPublishSessionEventRequest calls the generic PublishSessionEvent builder with application/json body

func NewPublishSessionEventRequestWithBody

func NewPublishSessionEventRequestWithBody(server string, params *PublishSessionEventParams, contentType string, body io.Reader) (*http.Request, error)

NewPublishSessionEventRequestWithBody constructs an http.Request for the PublishSessionEvent method, with any body, and a specified content type

func NewReadSessionJobOutputRequest

func NewReadSessionJobOutputRequest(server string, jobId JobID, params *ReadSessionJobOutputParams) (*http.Request, error)

NewReadSessionJobOutputRequest constructs an http.Request for the ReadSessionJobOutput method

func NewSignalSessionJobRequest

func NewSignalSessionJobRequest(server string, jobId JobID, params *SignalSessionJobParams, body SignalSessionJobJSONRequestBody) (*http.Request, error)

NewSignalSessionJobRequest calls the generic SignalSessionJob builder with application/json body

func NewSignalSessionJobRequestWithBody

func NewSignalSessionJobRequestWithBody(server string, jobId JobID, params *SignalSessionJobParams, contentType string, body io.Reader) (*http.Request, error)

NewSignalSessionJobRequestWithBody constructs an http.Request for the SignalSessionJob method, with any body, and a specified content type

Types

type AgentRun

type AgentRun struct {
	AgentRunId openapi_types.UUID `json:"agentRunId"`

	// Definition Whether the agent came from a file or was defined inline.
	Definition AgentRunDefinition `json:"definition"`

	// Depth Nesting level. The root turn is 0.
	Depth              int32      `json:"depth"`
	EndedAt            *time.Time `json:"endedAt,omitempty"`
	EventBufferedCount int32      `json:"eventBufferedCount"`

	// EventDroppedCount Events evicted because the bounded buffer filled.
	EventDroppedCount int32 `json:"eventDroppedCount"`

	// Name The agent's name. Identification only for an ad-hoc run.
	Name             string        `json:"name"`
	ParentToolCallId *string       `json:"parentToolCallId,omitempty"`
	StartedAt        time.Time     `json:"startedAt"`
	State            AgentRunState `json:"state"`
}

AgentRun defines model for AgentRun.

type AgentRunCancelResponse

type AgentRunCancelResponse struct {
	AgentRunId openapi_types.UUID `json:"agentRunId"`

	// CancelRequested True when this request found a running agent and signalled it. Cancelling an unknown, completed, or already cancelled run is not an error and reports false with the current state.
	CancelRequested bool                        `json:"cancelRequested"`
	State           AgentRunCancelResponseState `json:"state"`
}

AgentRunCancelResponse defines model for AgentRunCancelResponse.

type AgentRunCancelResponseState

type AgentRunCancelResponseState string

AgentRunCancelResponseState defines model for AgentRunCancelResponse.State.

const (
	AgentRunCancelResponseStateCancelled AgentRunCancelResponseState = "cancelled"
	AgentRunCancelResponseStateCompleted AgentRunCancelResponseState = "completed"
	AgentRunCancelResponseStateFailed    AgentRunCancelResponseState = "failed"
	AgentRunCancelResponseStateRunning   AgentRunCancelResponseState = "running"
)

Defines values for AgentRunCancelResponseState.

func (AgentRunCancelResponseState) Valid

Valid indicates whether the value is a known member of the AgentRunCancelResponseState enum.

type AgentRunDefinition

type AgentRunDefinition string

AgentRunDefinition Whether the agent came from a file or was defined inline.

const (
	AgentRunDefinitionAdhoc  AgentRunDefinition = "adhoc"
	AgentRunDefinitionStored AgentRunDefinition = "stored"
)

Defines values for AgentRunDefinition.

func (AgentRunDefinition) Valid

func (e AgentRunDefinition) Valid() bool

Valid indicates whether the value is a known member of the AgentRunDefinition enum.

type AgentRunEvent

type AgentRunEvent struct {
	CreatedAt time.Time               `json:"createdAt"`
	Payload   *map[string]interface{} `json:"payload,omitempty"`
	Sequence  int32                   `json:"sequence"`
	Type      string                  `json:"type"`
}

AgentRunEvent defines model for AgentRunEvent.

type AgentRunEventPage

type AgentRunEventPage struct {
	AgentRunId openapi_types.UUID `json:"agentRunId"`

	// Dropped Events dropped before this window.
	Dropped int32           `json:"dropped"`
	Events  []AgentRunEvent `json:"events"`

	// NextCursor Pass back as cursor to continue from here.
	NextCursor int32                  `json:"nextCursor"`
	State      AgentRunEventPageState `json:"state"`
}

AgentRunEventPage defines model for AgentRunEventPage.

type AgentRunEventPageState

type AgentRunEventPageState string

AgentRunEventPageState defines model for AgentRunEventPage.State.

const (
	AgentRunEventPageStateCancelled AgentRunEventPageState = "cancelled"
	AgentRunEventPageStateCompleted AgentRunEventPageState = "completed"
	AgentRunEventPageStateFailed    AgentRunEventPageState = "failed"
	AgentRunEventPageStateRunning   AgentRunEventPageState = "running"
)

Defines values for AgentRunEventPageState.

func (AgentRunEventPageState) Valid

func (e AgentRunEventPageState) Valid() bool

Valid indicates whether the value is a known member of the AgentRunEventPageState enum.

type AgentRunID

type AgentRunID = openapi_types.UUID

AgentRunID defines model for AgentRunID.

type AgentRunPage

type AgentRunPage struct {
	Agents  []AgentRun `json:"agents"`
	HasMore bool       `json:"hasMore"`
}

AgentRunPage defines model for AgentRunPage.

type AgentRunState

type AgentRunState string

AgentRunState defines model for AgentRun.State.

const (
	AgentRunStateCancelled AgentRunState = "cancelled"
	AgentRunStateCompleted AgentRunState = "completed"
	AgentRunStateFailed    AgentRunState = "failed"
	AgentRunStateRunning   AgentRunState = "running"
)

Defines values for AgentRunState.

func (AgentRunState) Valid

func (e AgentRunState) Valid() bool

Valid indicates whether the value is a known member of the AgentRunState enum.

type CancelResponse

type CancelResponse struct {
	CancelRequested bool `json:"cancelRequested"`
}

CancelResponse defines model for CancelResponse.

type CancelSessionAgentRunParams

type CancelSessionAgentRunParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

CancelSessionAgentRunParams defines parameters for CancelSessionAgentRun.

type CancelSessionAgentRunResponse

type CancelSessionAgentRunResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *AgentRunCancelResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers202 the parsed response headers for an HTTP 202 response
	Headers202 *CancelSessionAgentRunResponse202Headers
}

func ParseCancelSessionAgentRunResponse

func ParseCancelSessionAgentRunResponse(rsp *http.Response) (*CancelSessionAgentRunResponse, error)

ParseCancelSessionAgentRunResponse parses an HTTP response from a CancelSessionAgentRunWithResponse call

func (CancelSessionAgentRunResponse) ContentType

func (r CancelSessionAgentRunResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CancelSessionAgentRunResponse) GetBody

func (r CancelSessionAgentRunResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CancelSessionAgentRunResponse) GetJSON202

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (CancelSessionAgentRunResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CancelSessionAgentRunResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CancelSessionAgentRunResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CancelSessionAgentRunResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CancelSessionAgentRunResponse) Status

Status returns HTTPResponse.Status

func (CancelSessionAgentRunResponse) StatusCode

func (r CancelSessionAgentRunResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CancelSessionAgentRunResponse202Headers

type CancelSessionAgentRunResponse202Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

CancelSessionAgentRunResponse202Headers the declared response headers of an HTTP 202 response for CancelSessionAgentRun

type CancelSessionParams

type CancelSessionParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

CancelSessionParams defines parameters for CancelSession.

type CancelSessionResponse

type CancelSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *CancelResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers202 the parsed response headers for an HTTP 202 response
	Headers202 *CancelSessionResponse202Headers
}

func ParseCancelSessionResponse

func ParseCancelSessionResponse(rsp *http.Response) (*CancelSessionResponse, error)

ParseCancelSessionResponse parses an HTTP response from a CancelSessionWithResponse call

func (CancelSessionResponse) ContentType

func (r CancelSessionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (CancelSessionResponse) GetBody

func (r CancelSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (CancelSessionResponse) GetJSON202

func (r CancelSessionResponse) GetJSON202() *CancelResponse

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (CancelSessionResponse) GetJSON400

func (r CancelSessionResponse) GetJSON400() *ErrorBadRequest

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (CancelSessionResponse) GetJSON401

func (r CancelSessionResponse) GetJSON401() *ErrorUnauthorized

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (CancelSessionResponse) GetJSON404

func (r CancelSessionResponse) GetJSON404() *ErrorNotFound

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (CancelSessionResponse) GetJSON500

func (r CancelSessionResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (CancelSessionResponse) Status

func (r CancelSessionResponse) Status() string

Status returns HTTPResponse.Status

func (CancelSessionResponse) StatusCode

func (r CancelSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type CancelSessionResponse202Headers

type CancelSessionResponse202Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

CancelSessionResponse202Headers the declared response headers of an HTTP 202 response for CancelSession

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) CancelSession

func (c *Client) CancelSession(ctx context.Context, params *CancelSessionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

CancelSession Request cancellation for the active turn

Corresponds with POST /session/cancel (the `CancelSession` operationId).

func (*Client) CancelSessionAgentRun

func (c *Client) CancelSessionAgentRun(ctx context.Context, agentRunId AgentRunID, params *CancelSessionAgentRunParams, reqEditors ...RequestEditorFn) (*http.Response, error)

CancelSessionAgentRun Cancel one child agent run without ending its parent turn

Corresponds with POST /session/agents/{agentRunId}/cancel (the `CancelSessionAgentRun` operationId).

func (*Client) GetSession

func (c *Client) GetSession(ctx context.Context, params *GetSessionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

GetSession Read session details

Corresponds with GET /session (the `GetSession` operationId).

func (*Client) ListMessages

func (c *Client) ListMessages(ctx context.Context, params *ListMessagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListMessages List stored conversation messages

Corresponds with GET /messages (the `ListMessages` operationId).

func (*Client) ListSessionAgentRunEvents

func (c *Client) ListSessionAgentRunEvents(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListSessionAgentRunEvents Follow what one child agent run is doing

Corresponds with GET /session/agents/{agentRunId}/messages (the `ListSessionAgentRunEvents` operationId).

func (*Client) ListSessionAgentRuns

func (c *Client) ListSessionAgentRuns(ctx context.Context, params *ListSessionAgentRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListSessionAgentRuns List the child agent runs this session has started

Corresponds with GET /session/agents (the `ListSessionAgentRuns` operationId).

func (*Client) ListSessionEvents

func (c *Client) ListSessionEvents(ctx context.Context, params *ListSessionEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListSessionEvents List the session's pending events

Corresponds with GET /session/events (the `ListSessionEvents` operationId).

func (*Client) ListSessionJobs

func (c *Client) ListSessionJobs(ctx context.Context, params *ListSessionJobsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ListSessionJobs List the commands this session has started

Corresponds with GET /session/jobs (the `ListSessionJobs` operationId).

func (*Client) PublishSessionEvent

func (c *Client) PublishSessionEvent(ctx context.Context, params *PublishSessionEventParams, body PublishSessionEventJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

PublishSessionEvent Report an event to the session from outside

Takes a body of the `application/json` content type.

Corresponds with POST /session/events (the `PublishSessionEvent` operationId).

func (*Client) PublishSessionEventWithBody

func (c *Client) PublishSessionEventWithBody(ctx context.Context, params *PublishSessionEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

PublishSessionEventWithBody Report an event to the session from outside

Takes any type of body and a specified content type.

Corresponds with POST /session/events (the `PublishSessionEvent` operationId).

func (*Client) ReadSessionJobOutput

func (c *Client) ReadSessionJobOutput(ctx context.Context, jobId JobID, params *ReadSessionJobOutputParams, reqEditors ...RequestEditorFn) (*http.Response, error)

ReadSessionJobOutput Read a bounded window of one job's output

Corresponds with GET /session/jobs/{jobId}/output (the `ReadSessionJobOutput` operationId).

func (*Client) SignalSessionJob

func (c *Client) SignalSessionJob(ctx context.Context, jobId JobID, params *SignalSessionJobParams, body SignalSessionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

SignalSessionJob Stop one running job

Takes a body of the `application/json` content type.

Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).

func (*Client) SignalSessionJobWithBody

func (c *Client) SignalSessionJobWithBody(ctx context.Context, jobId JobID, params *SignalSessionJobParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

SignalSessionJobWithBody Stop one running job

Takes any type of body and a specified content type.

Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).

type ClientInterface

type ClientInterface interface {

	// ListMessages List stored conversation messages
	//
	// Corresponds with GET /messages (the `ListMessages` operationId).
	ListMessages(ctx context.Context, params *ListMessagesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetSession Read session details
	//
	// Corresponds with GET /session (the `GetSession` operationId).
	GetSession(ctx context.Context, params *GetSessionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionAgentRuns List the child agent runs this session has started
	//
	// Corresponds with GET /session/agents (the `ListSessionAgentRuns` operationId).
	ListSessionAgentRuns(ctx context.Context, params *ListSessionAgentRunsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CancelSessionAgentRun Cancel one child agent run without ending its parent turn
	//
	// Corresponds with POST /session/agents/{agentRunId}/cancel (the `CancelSessionAgentRun` operationId).
	CancelSessionAgentRun(ctx context.Context, agentRunId AgentRunID, params *CancelSessionAgentRunParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionAgentRunEvents Follow what one child agent run is doing
	//
	// Corresponds with GET /session/agents/{agentRunId}/messages (the `ListSessionAgentRunEvents` operationId).
	ListSessionAgentRunEvents(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// CancelSession Request cancellation for the active turn
	//
	// Corresponds with POST /session/cancel (the `CancelSession` operationId).
	CancelSession(ctx context.Context, params *CancelSessionParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionEvents List the session's pending events
	//
	// Corresponds with GET /session/events (the `ListSessionEvents` operationId).
	ListSessionEvents(ctx context.Context, params *ListSessionEventsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PublishSessionEventWithBody Report an event to the session from outside
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /session/events (the `PublishSessionEvent` operationId).
	PublishSessionEventWithBody(ctx context.Context, params *PublishSessionEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PublishSessionEvent Report an event to the session from outside
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /session/events (the `PublishSessionEvent` operationId).
	PublishSessionEvent(ctx context.Context, params *PublishSessionEventParams, body PublishSessionEventJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ListSessionJobs List the commands this session has started
	//
	// Corresponds with GET /session/jobs (the `ListSessionJobs` operationId).
	ListSessionJobs(ctx context.Context, params *ListSessionJobsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReadSessionJobOutput Read a bounded window of one job's output
	//
	// Corresponds with GET /session/jobs/{jobId}/output (the `ReadSessionJobOutput` operationId).
	ReadSessionJobOutput(ctx context.Context, jobId JobID, params *ReadSessionJobOutputParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SignalSessionJobWithBody Stop one running job
	//
	// Takes any type of body and a specified content type.
	//
	// Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).
	SignalSessionJobWithBody(ctx context.Context, jobId JobID, params *SignalSessionJobParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SignalSessionJob Stop one running job
	//
	// Takes a body of the `application/json` content type.
	//
	// Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).
	SignalSessionJob(ctx context.Context, jobId JobID, params *SignalSessionJobParams, body SignalSessionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) CancelSessionAgentRunWithResponse

func (c *ClientWithResponses) CancelSessionAgentRunWithResponse(ctx context.Context, agentRunId AgentRunID, params *CancelSessionAgentRunParams, reqEditors ...RequestEditorFn) (*CancelSessionAgentRunResponse, error)

CancelSessionAgentRunWithResponse Cancel one child agent run without ending its parent turn

Returns a wrapper object for the known response body format(s).

Corresponds with POST /session/agents/{agentRunId}/cancel (the `CancelSessionAgentRun` operationId).

func (*ClientWithResponses) CancelSessionWithResponse

func (c *ClientWithResponses) CancelSessionWithResponse(ctx context.Context, params *CancelSessionParams, reqEditors ...RequestEditorFn) (*CancelSessionResponse, error)

CancelSessionWithResponse Request cancellation for the active turn

Returns a wrapper object for the known response body format(s).

Corresponds with POST /session/cancel (the `CancelSession` operationId).

func (*ClientWithResponses) GetSessionWithResponse

func (c *ClientWithResponses) GetSessionWithResponse(ctx context.Context, params *GetSessionParams, reqEditors ...RequestEditorFn) (*GetSessionResponse, error)

GetSessionWithResponse Read session details

Returns a wrapper object for the known response body format(s).

Corresponds with GET /session (the `GetSession` operationId).

func (*ClientWithResponses) ListMessagesWithResponse

func (c *ClientWithResponses) ListMessagesWithResponse(ctx context.Context, params *ListMessagesParams, reqEditors ...RequestEditorFn) (*ListMessagesResponse, error)

ListMessagesWithResponse List stored conversation messages

Returns a wrapper object for the known response body format(s).

Corresponds with GET /messages (the `ListMessages` operationId).

func (*ClientWithResponses) ListSessionAgentRunEventsWithResponse

func (c *ClientWithResponses) ListSessionAgentRunEventsWithResponse(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunEventsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunEventsResponse, error)

ListSessionAgentRunEventsWithResponse Follow what one child agent run is doing

Returns a wrapper object for the known response body format(s).

Corresponds with GET /session/agents/{agentRunId}/messages (the `ListSessionAgentRunEvents` operationId).

func (*ClientWithResponses) ListSessionAgentRunsWithResponse

func (c *ClientWithResponses) ListSessionAgentRunsWithResponse(ctx context.Context, params *ListSessionAgentRunsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunsResponse, error)

ListSessionAgentRunsWithResponse List the child agent runs this session has started

Returns a wrapper object for the known response body format(s).

Corresponds with GET /session/agents (the `ListSessionAgentRuns` operationId).

func (*ClientWithResponses) ListSessionEventsWithResponse

func (c *ClientWithResponses) ListSessionEventsWithResponse(ctx context.Context, params *ListSessionEventsParams, reqEditors ...RequestEditorFn) (*ListSessionEventsResponse, error)

ListSessionEventsWithResponse List the session's pending events

Returns a wrapper object for the known response body format(s).

Corresponds with GET /session/events (the `ListSessionEvents` operationId).

func (*ClientWithResponses) ListSessionJobsWithResponse

func (c *ClientWithResponses) ListSessionJobsWithResponse(ctx context.Context, params *ListSessionJobsParams, reqEditors ...RequestEditorFn) (*ListSessionJobsResponse, error)

ListSessionJobsWithResponse List the commands this session has started

Returns a wrapper object for the known response body format(s).

Corresponds with GET /session/jobs (the `ListSessionJobs` operationId).

func (*ClientWithResponses) PublishSessionEventWithBodyWithResponse

func (c *ClientWithResponses) PublishSessionEventWithBodyWithResponse(ctx context.Context, params *PublishSessionEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PublishSessionEventResponse, error)

PublishSessionEventWithBodyWithResponse Report an event to the session from outside

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /session/events (the `PublishSessionEvent` operationId).

func (*ClientWithResponses) PublishSessionEventWithResponse

PublishSessionEventWithResponse Report an event to the session from outside

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /session/events (the `PublishSessionEvent` operationId).

func (*ClientWithResponses) ReadSessionJobOutputWithResponse

func (c *ClientWithResponses) ReadSessionJobOutputWithResponse(ctx context.Context, jobId JobID, params *ReadSessionJobOutputParams, reqEditors ...RequestEditorFn) (*ReadSessionJobOutputResponse, error)

ReadSessionJobOutputWithResponse Read a bounded window of one job's output

Returns a wrapper object for the known response body format(s).

Corresponds with GET /session/jobs/{jobId}/output (the `ReadSessionJobOutput` operationId).

func (*ClientWithResponses) SignalSessionJobWithBodyWithResponse

func (c *ClientWithResponses) SignalSessionJobWithBodyWithResponse(ctx context.Context, jobId JobID, params *SignalSessionJobParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SignalSessionJobResponse, error)

SignalSessionJobWithBodyWithResponse Stop one running job

Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).

func (*ClientWithResponses) SignalSessionJobWithResponse

func (c *ClientWithResponses) SignalSessionJobWithResponse(ctx context.Context, jobId JobID, params *SignalSessionJobParams, body SignalSessionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*SignalSessionJobResponse, error)

SignalSessionJobWithResponse Stop one running job

Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).

Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {

	// ListMessagesWithResponse List stored conversation messages
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /messages (the `ListMessages` operationId).
	ListMessagesWithResponse(ctx context.Context, params *ListMessagesParams, reqEditors ...RequestEditorFn) (*ListMessagesResponse, error)

	// GetSessionWithResponse Read session details
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session (the `GetSession` operationId).
	GetSessionWithResponse(ctx context.Context, params *GetSessionParams, reqEditors ...RequestEditorFn) (*GetSessionResponse, error)

	// ListSessionAgentRunsWithResponse List the child agent runs this session has started
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/agents (the `ListSessionAgentRuns` operationId).
	ListSessionAgentRunsWithResponse(ctx context.Context, params *ListSessionAgentRunsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunsResponse, error)

	// CancelSessionAgentRunWithResponse Cancel one child agent run without ending its parent turn
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /session/agents/{agentRunId}/cancel (the `CancelSessionAgentRun` operationId).
	CancelSessionAgentRunWithResponse(ctx context.Context, agentRunId AgentRunID, params *CancelSessionAgentRunParams, reqEditors ...RequestEditorFn) (*CancelSessionAgentRunResponse, error)

	// ListSessionAgentRunEventsWithResponse Follow what one child agent run is doing
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/agents/{agentRunId}/messages (the `ListSessionAgentRunEvents` operationId).
	ListSessionAgentRunEventsWithResponse(ctx context.Context, agentRunId AgentRunID, params *ListSessionAgentRunEventsParams, reqEditors ...RequestEditorFn) (*ListSessionAgentRunEventsResponse, error)

	// CancelSessionWithResponse Request cancellation for the active turn
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /session/cancel (the `CancelSession` operationId).
	CancelSessionWithResponse(ctx context.Context, params *CancelSessionParams, reqEditors ...RequestEditorFn) (*CancelSessionResponse, error)

	// ListSessionEventsWithResponse List the session's pending events
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/events (the `ListSessionEvents` operationId).
	ListSessionEventsWithResponse(ctx context.Context, params *ListSessionEventsParams, reqEditors ...RequestEditorFn) (*ListSessionEventsResponse, error)

	// PublishSessionEventWithBodyWithResponse Report an event to the session from outside
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /session/events (the `PublishSessionEvent` operationId).
	PublishSessionEventWithBodyWithResponse(ctx context.Context, params *PublishSessionEventParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PublishSessionEventResponse, error)

	// PublishSessionEventWithResponse Report an event to the session from outside
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /session/events (the `PublishSessionEvent` operationId).
	PublishSessionEventWithResponse(ctx context.Context, params *PublishSessionEventParams, body PublishSessionEventJSONRequestBody, reqEditors ...RequestEditorFn) (*PublishSessionEventResponse, error)

	// ListSessionJobsWithResponse List the commands this session has started
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/jobs (the `ListSessionJobs` operationId).
	ListSessionJobsWithResponse(ctx context.Context, params *ListSessionJobsParams, reqEditors ...RequestEditorFn) (*ListSessionJobsResponse, error)

	// ReadSessionJobOutputWithResponse Read a bounded window of one job's output
	//
	// Returns a wrapper object for the known response body format(s).
	//
	// Corresponds with GET /session/jobs/{jobId}/output (the `ReadSessionJobOutput` operationId).
	ReadSessionJobOutputWithResponse(ctx context.Context, jobId JobID, params *ReadSessionJobOutputParams, reqEditors ...RequestEditorFn) (*ReadSessionJobOutputResponse, error)

	// SignalSessionJobWithBodyWithResponse Stop one running job
	//
	// Takes any type of body and a specified content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).
	SignalSessionJobWithBodyWithResponse(ctx context.Context, jobId JobID, params *SignalSessionJobParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SignalSessionJobResponse, error)

	// SignalSessionJobWithResponse Stop one running job
	//
	// Takes a body of the `application/json` content type, and returns a wrapper object for the known response body format(s).
	//
	// Corresponds with POST /session/jobs/{jobId}/signal (the `SignalSessionJob` operationId).
	SignalSessionJobWithResponse(ctx context.Context, jobId JobID, params *SignalSessionJobParams, body SignalSessionJobJSONRequestBody, reqEditors ...RequestEditorFn) (*SignalSessionJobResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type Error

type Error struct {
	Code    string                  `json:"code"`
	Details *map[string]interface{} `json:"details,omitempty"`
	Message string                  `json:"message"`
}

Error defines model for Error.

type ErrorBadRequest

type ErrorBadRequest = Error

ErrorBadRequest defines model for ErrorBadRequest.

type ErrorInternal

type ErrorInternal = Error

ErrorInternal defines model for ErrorInternal.

type ErrorNotFound

type ErrorNotFound = Error

ErrorNotFound defines model for ErrorNotFound.

type ErrorUnauthorized

type ErrorUnauthorized = Error

ErrorUnauthorized defines model for ErrorUnauthorized.

type GetSessionParams

type GetSessionParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

GetSessionParams defines parameters for GetSession.

type GetSessionResponse

type GetSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *Session
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *GetSessionResponse200Headers
}

func ParseGetSessionResponse

func ParseGetSessionResponse(rsp *http.Response) (*GetSessionResponse, error)

ParseGetSessionResponse parses an HTTP response from a GetSessionWithResponse call

func (GetSessionResponse) ContentType

func (r GetSessionResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (GetSessionResponse) GetBody

func (r GetSessionResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (GetSessionResponse) GetJSON200

func (r GetSessionResponse) GetJSON200() *Session

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (GetSessionResponse) GetJSON400

func (r GetSessionResponse) GetJSON400() *ErrorBadRequest

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (GetSessionResponse) GetJSON401

func (r GetSessionResponse) GetJSON401() *ErrorUnauthorized

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (GetSessionResponse) GetJSON404

func (r GetSessionResponse) GetJSON404() *ErrorNotFound

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (GetSessionResponse) GetJSON500

func (r GetSessionResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (GetSessionResponse) Status

func (r GetSessionResponse) Status() string

Status returns HTTPResponse.Status

func (GetSessionResponse) StatusCode

func (r GetSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetSessionResponse200Headers

type GetSessionResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

GetSessionResponse200Headers the declared response headers of an HTTP 200 response for GetSession

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type Job

type Job struct {
	Command   string     `json:"command"`
	Directory string     `json:"directory"`
	EndedAt   *time.Time `json:"endedAt,omitempty"`

	// ExitCode Exit status once known, or -1 while it is not.
	ExitCode int32              `json:"exitCode"`
	JobId    openapi_types.UUID `json:"jobId"`

	// Pid Operating-system process ID of the job's shell.
	Pid int32 `json:"pid"`

	// Purpose Why the agent said it was running this command.
	Purpose             string    `json:"purpose"`
	StartedAt           time.Time `json:"startedAt"`
	State               JobState  `json:"state"`
	StderrBufferedLines int32     `json:"stderrBufferedLines"`
	StderrDroppedLines  int32     `json:"stderrDroppedLines"`
	StdoutBufferedLines int32     `json:"stdoutBufferedLines"`

	// StdoutDroppedLines Lines evicted because the bounded buffer filled.
	StdoutDroppedLines int32 `json:"stdoutDroppedLines"`

	// ToolCallId The tool call that started this job.
	ToolCallId *string `json:"toolCallId,omitempty"`
}

Job defines model for Job.

type JobID

type JobID = openapi_types.UUID

JobID defines model for JobID.

type JobOutput

type JobOutput struct {
	JobId            openapi_types.UUID `json:"jobId"`
	NextStderrCursor int32              `json:"nextStderrCursor"`

	// NextStdoutCursor Pass back as stdoutCursor to continue from here.
	NextStdoutCursor   int32          `json:"nextStdoutCursor"`
	State              JobOutputState `json:"state"`
	Stderr             string         `json:"stderr"`
	StderrDroppedLines int32          `json:"stderrDroppedLines"`
	Stdout             string         `json:"stdout"`
	StdoutDroppedLines int32          `json:"stdoutDroppedLines"`
}

JobOutput defines model for JobOutput.

type JobOutputState

type JobOutputState string

JobOutputState defines model for JobOutput.State.

const (
	JobOutputStateExited    JobOutputState = "exited"
	JobOutputStateFailed    JobOutputState = "failed"
	JobOutputStateRunning   JobOutputState = "running"
	JobOutputStateSignalled JobOutputState = "signalled"
)

Defines values for JobOutputState.

func (JobOutputState) Valid

func (e JobOutputState) Valid() bool

Valid indicates whether the value is a known member of the JobOutputState enum.

type JobPage

type JobPage struct {
	Jobs      []Job `json:"jobs"`
	Truncated bool  `json:"truncated"`
}

JobPage defines model for JobPage.

type JobSignalRequest

type JobSignalRequest struct {
	// Signal stop sends SIGTERM to the process group then escalates to SIGKILL. kill goes straight to SIGKILL.
	Signal JobSignalRequestSignal `json:"signal"`
}

JobSignalRequest defines model for JobSignalRequest.

type JobSignalRequestSignal

type JobSignalRequestSignal string

JobSignalRequestSignal stop sends SIGTERM to the process group then escalates to SIGKILL. kill goes straight to SIGKILL.

const (
	JobSignalRequestSignalKill JobSignalRequestSignal = "kill"
	JobSignalRequestSignalStop JobSignalRequestSignal = "stop"
)

Defines values for JobSignalRequestSignal.

func (JobSignalRequestSignal) Valid

func (e JobSignalRequestSignal) Valid() bool

Valid indicates whether the value is a known member of the JobSignalRequestSignal enum.

type JobSignalResponse

type JobSignalResponse struct {
	JobId openapi_types.UUID `json:"jobId"`

	// Signalled True when this request found a running job and signalled it. Signalling an unknown, exited, or already signalled job is not an error and reports false with the current state.
	Signalled bool                   `json:"signalled"`
	State     JobSignalResponseState `json:"state"`
}

JobSignalResponse defines model for JobSignalResponse.

type JobSignalResponseState

type JobSignalResponseState string

JobSignalResponseState defines model for JobSignalResponse.State.

const (
	JobSignalResponseStateExited    JobSignalResponseState = "exited"
	JobSignalResponseStateFailed    JobSignalResponseState = "failed"
	JobSignalResponseStateRunning   JobSignalResponseState = "running"
	JobSignalResponseStateSignalled JobSignalResponseState = "signalled"
)

Defines values for JobSignalResponseState.

func (JobSignalResponseState) Valid

func (e JobSignalResponseState) Valid() bool

Valid indicates whether the value is a known member of the JobSignalResponseState enum.

type JobState

type JobState string

JobState defines model for Job.State.

const (
	JobStateExited    JobState = "exited"
	JobStateFailed    JobState = "failed"
	JobStateRunning   JobState = "running"
	JobStateSignalled JobState = "signalled"
)

Defines values for JobState.

func (JobState) Valid

func (e JobState) Valid() bool

Valid indicates whether the value is a known member of the JobState enum.

type Limit

type Limit = int32

Limit defines model for Limit.

type ListMessagesParams

type ListMessagesParams struct {
	Limit      *Limit                   `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset                  `form:"offset,omitempty" json:"offset,omitempty"`
	Order      *ListMessagesParamsOrder `form:"order,omitempty" json:"order,omitempty"`
	XSessionID SessionIDRequired        `json:"X-Session-ID"`
}

ListMessagesParams defines parameters for ListMessages.

type ListMessagesParamsOrder

type ListMessagesParamsOrder string

ListMessagesParamsOrder defines parameters for ListMessages.

const (
	ListMessagesParamsOrderAsc  ListMessagesParamsOrder = "asc"
	ListMessagesParamsOrderDesc ListMessagesParamsOrder = "desc"
)

Defines values for ListMessagesParamsOrder.

func (ListMessagesParamsOrder) Valid

func (e ListMessagesParamsOrder) Valid() bool

Valid indicates whether the value is a known member of the ListMessagesParamsOrder enum.

type ListMessagesResponse

type ListMessagesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *MessagePage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListMessagesResponse200Headers
}

func ParseListMessagesResponse

func ParseListMessagesResponse(rsp *http.Response) (*ListMessagesResponse, error)

ParseListMessagesResponse parses an HTTP response from a ListMessagesWithResponse call

func (ListMessagesResponse) ContentType

func (r ListMessagesResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListMessagesResponse) GetBody

func (r ListMessagesResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListMessagesResponse) GetJSON200

func (r ListMessagesResponse) GetJSON200() *MessagePage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListMessagesResponse) GetJSON400

func (r ListMessagesResponse) GetJSON400() *ErrorBadRequest

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListMessagesResponse) GetJSON401

func (r ListMessagesResponse) GetJSON401() *ErrorUnauthorized

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListMessagesResponse) GetJSON404

func (r ListMessagesResponse) GetJSON404() *ErrorNotFound

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListMessagesResponse) GetJSON500

func (r ListMessagesResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListMessagesResponse) Status

func (r ListMessagesResponse) Status() string

Status returns HTTPResponse.Status

func (ListMessagesResponse) StatusCode

func (r ListMessagesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListMessagesResponse200Headers

type ListMessagesResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListMessagesResponse200Headers the declared response headers of an HTTP 200 response for ListMessages

type ListSessionAgentRunEventsParams

type ListSessionAgentRunEventsParams struct {
	Cursor     *int32            `form:"cursor,omitempty" json:"cursor,omitempty"`
	Limit      *int32            `form:"limit,omitempty" json:"limit,omitempty"`
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionAgentRunEventsParams defines parameters for ListSessionAgentRunEvents.

type ListSessionAgentRunEventsResponse

type ListSessionAgentRunEventsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AgentRunEventPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionAgentRunEventsResponse200Headers
}

func ParseListSessionAgentRunEventsResponse

func ParseListSessionAgentRunEventsResponse(rsp *http.Response) (*ListSessionAgentRunEventsResponse, error)

ParseListSessionAgentRunEventsResponse parses an HTTP response from a ListSessionAgentRunEventsWithResponse call

func (ListSessionAgentRunEventsResponse) ContentType

func (r ListSessionAgentRunEventsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListSessionAgentRunEventsResponse) GetBody

GetBody returns the raw response body bytes

func (ListSessionAgentRunEventsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListSessionAgentRunEventsResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListSessionAgentRunEventsResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListSessionAgentRunEventsResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListSessionAgentRunEventsResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionAgentRunEventsResponse) Status

Status returns HTTPResponse.Status

func (ListSessionAgentRunEventsResponse) StatusCode

func (r ListSessionAgentRunEventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionAgentRunEventsResponse200Headers

type ListSessionAgentRunEventsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionAgentRunEventsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionAgentRunEvents

type ListSessionAgentRunsParams

type ListSessionAgentRunsParams struct {
	Limit      *Limit                           `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset                          `form:"offset,omitempty" json:"offset,omitempty"`
	State      *ListSessionAgentRunsParamsState `form:"state,omitempty" json:"state,omitempty"`
	XSessionID SessionIDRequired                `json:"X-Session-ID"`
}

ListSessionAgentRunsParams defines parameters for ListSessionAgentRuns.

type ListSessionAgentRunsParamsState

type ListSessionAgentRunsParamsState string

ListSessionAgentRunsParamsState defines parameters for ListSessionAgentRuns.

const (
	ListSessionAgentRunsParamsStateCancelled ListSessionAgentRunsParamsState = "cancelled"
	ListSessionAgentRunsParamsStateCompleted ListSessionAgentRunsParamsState = "completed"
	ListSessionAgentRunsParamsStateFailed    ListSessionAgentRunsParamsState = "failed"
	ListSessionAgentRunsParamsStateRunning   ListSessionAgentRunsParamsState = "running"
)

Defines values for ListSessionAgentRunsParamsState.

func (ListSessionAgentRunsParamsState) Valid

Valid indicates whether the value is a known member of the ListSessionAgentRunsParamsState enum.

type ListSessionAgentRunsResponse

type ListSessionAgentRunsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *AgentRunPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionAgentRunsResponse200Headers
}

func ParseListSessionAgentRunsResponse

func ParseListSessionAgentRunsResponse(rsp *http.Response) (*ListSessionAgentRunsResponse, error)

ParseListSessionAgentRunsResponse parses an HTTP response from a ListSessionAgentRunsWithResponse call

func (ListSessionAgentRunsResponse) ContentType

func (r ListSessionAgentRunsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListSessionAgentRunsResponse) GetBody

func (r ListSessionAgentRunsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionAgentRunsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListSessionAgentRunsResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListSessionAgentRunsResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListSessionAgentRunsResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListSessionAgentRunsResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionAgentRunsResponse) Status

Status returns HTTPResponse.Status

func (ListSessionAgentRunsResponse) StatusCode

func (r ListSessionAgentRunsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionAgentRunsResponse200Headers

type ListSessionAgentRunsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionAgentRunsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionAgentRuns

type ListSessionEventsParams

type ListSessionEventsParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

ListSessionEventsParams defines parameters for ListSessionEvents.

type ListSessionEventsResponse

type ListSessionEventsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *SessionEventPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionEventsResponse200Headers
}

func ParseListSessionEventsResponse

func ParseListSessionEventsResponse(rsp *http.Response) (*ListSessionEventsResponse, error)

ParseListSessionEventsResponse parses an HTTP response from a ListSessionEventsWithResponse call

func (ListSessionEventsResponse) ContentType

func (r ListSessionEventsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListSessionEventsResponse) GetBody

func (r ListSessionEventsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionEventsResponse) GetJSON200

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListSessionEventsResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListSessionEventsResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListSessionEventsResponse) GetJSON404

func (r ListSessionEventsResponse) GetJSON404() *ErrorNotFound

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListSessionEventsResponse) GetJSON500

func (r ListSessionEventsResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionEventsResponse) Status

func (r ListSessionEventsResponse) Status() string

Status returns HTTPResponse.Status

func (ListSessionEventsResponse) StatusCode

func (r ListSessionEventsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionEventsResponse200Headers

type ListSessionEventsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionEventsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionEvents

type ListSessionJobsParams

type ListSessionJobsParams struct {
	Limit      *Limit                      `form:"limit,omitempty" json:"limit,omitempty"`
	Offset     *Offset                     `form:"offset,omitempty" json:"offset,omitempty"`
	State      *ListSessionJobsParamsState `form:"state,omitempty" json:"state,omitempty"`
	XSessionID SessionIDRequired           `json:"X-Session-ID"`
}

ListSessionJobsParams defines parameters for ListSessionJobs.

type ListSessionJobsParamsState

type ListSessionJobsParamsState string

ListSessionJobsParamsState defines parameters for ListSessionJobs.

const (
	ListSessionJobsParamsStateExited    ListSessionJobsParamsState = "exited"
	ListSessionJobsParamsStateFailed    ListSessionJobsParamsState = "failed"
	ListSessionJobsParamsStateRunning   ListSessionJobsParamsState = "running"
	ListSessionJobsParamsStateSignalled ListSessionJobsParamsState = "signalled"
)

Defines values for ListSessionJobsParamsState.

func (ListSessionJobsParamsState) Valid

func (e ListSessionJobsParamsState) Valid() bool

Valid indicates whether the value is a known member of the ListSessionJobsParamsState enum.

type ListSessionJobsResponse

type ListSessionJobsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *JobPage
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ListSessionJobsResponse200Headers
}

func ParseListSessionJobsResponse

func ParseListSessionJobsResponse(rsp *http.Response) (*ListSessionJobsResponse, error)

ParseListSessionJobsResponse parses an HTTP response from a ListSessionJobsWithResponse call

func (ListSessionJobsResponse) ContentType

func (r ListSessionJobsResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ListSessionJobsResponse) GetBody

func (r ListSessionJobsResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ListSessionJobsResponse) GetJSON200

func (r ListSessionJobsResponse) GetJSON200() *JobPage

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ListSessionJobsResponse) GetJSON400

func (r ListSessionJobsResponse) GetJSON400() *ErrorBadRequest

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ListSessionJobsResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ListSessionJobsResponse) GetJSON404

func (r ListSessionJobsResponse) GetJSON404() *ErrorNotFound

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ListSessionJobsResponse) GetJSON500

func (r ListSessionJobsResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ListSessionJobsResponse) Status

func (r ListSessionJobsResponse) Status() string

Status returns HTTPResponse.Status

func (ListSessionJobsResponse) StatusCode

func (r ListSessionJobsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ListSessionJobsResponse200Headers

type ListSessionJobsResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ListSessionJobsResponse200Headers the declared response headers of an HTTP 200 response for ListSessionJobs

type Message

type Message struct {
	Content    string             `json:"content"`
	CreatedAt  time.Time          `json:"createdAt"`
	Id         openapi_types.UUID `json:"id"`
	Incomplete *bool              `json:"incomplete,omitempty"`
	IsError    *bool              `json:"isError,omitempty"`
	Model      *string            `json:"model,omitempty"`
	Role       MessageRole        `json:"role"`
	Sequence   int64              `json:"sequence"`
	Thinking   *string            `json:"thinking,omitempty"`
	ToolCallId *string            `json:"toolCallId,omitempty"`
	ToolCalls  *[]MessageToolCall `json:"toolCalls,omitempty"`
	Workspace  string             `json:"workspace"`
}

Message defines model for Message.

type MessagePage

type MessagePage struct {
	HasMore bool      `json:"hasMore"`
	Items   []Message `json:"items"`
	Limit   int32     `json:"limit"`
	Offset  int32     `json:"offset"`
}

MessagePage defines model for MessagePage.

type MessageRole

type MessageRole string

MessageRole defines model for Message.Role.

const (
	MessageRoleAssistant MessageRole = "assistant"
	MessageRoleTool      MessageRole = "tool"
	MessageRoleUser      MessageRole = "user"
)

Defines values for MessageRole.

func (MessageRole) Valid

func (e MessageRole) Valid() bool

Valid indicates whether the value is a known member of the MessageRole enum.

type MessageToolCall

type MessageToolCall struct {
	Arguments map[string]interface{} `json:"arguments"`
	Id        string                 `json:"id"`
	Name      string                 `json:"name"`
}

MessageToolCall defines model for MessageToolCall.

type Offset

type Offset = int32

Offset defines model for Offset.

type Order

type Order string

Order defines model for Order.

const (
	OrderAsc  Order = "asc"
	OrderDesc Order = "desc"
)

Defines values for Order.

func (Order) Valid

func (e Order) Valid() bool

Valid indicates whether the value is a known member of the Order enum.

type PublishSessionEventJSONRequestBody

type PublishSessionEventJSONRequestBody = SessionEventRequest

PublishSessionEventJSONRequestBody defines body for PublishSessionEvent for application/json ContentType.

type PublishSessionEventParams

type PublishSessionEventParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

PublishSessionEventParams defines parameters for PublishSessionEvent.

type PublishSessionEventResponse

type PublishSessionEventResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *SessionEvent
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers202 the parsed response headers for an HTTP 202 response
	Headers202 *PublishSessionEventResponse202Headers
}

func ParsePublishSessionEventResponse

func ParsePublishSessionEventResponse(rsp *http.Response) (*PublishSessionEventResponse, error)

ParsePublishSessionEventResponse parses an HTTP response from a PublishSessionEventWithResponse call

func (PublishSessionEventResponse) ContentType

func (r PublishSessionEventResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (PublishSessionEventResponse) GetBody

func (r PublishSessionEventResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (PublishSessionEventResponse) GetJSON202

func (r PublishSessionEventResponse) GetJSON202() *SessionEvent

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (PublishSessionEventResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (PublishSessionEventResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (PublishSessionEventResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (PublishSessionEventResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (PublishSessionEventResponse) Status

Status returns HTTPResponse.Status

func (PublishSessionEventResponse) StatusCode

func (r PublishSessionEventResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PublishSessionEventResponse202Headers

type PublishSessionEventResponse202Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

PublishSessionEventResponse202Headers the declared response headers of an HTTP 202 response for PublishSessionEvent

type ReadSessionJobOutputParams

type ReadSessionJobOutputParams struct {
	Stream       *ReadSessionJobOutputParamsStream `form:"stream,omitempty" json:"stream,omitempty"`
	StdoutCursor *int32                            `form:"stdoutCursor,omitempty" json:"stdoutCursor,omitempty"`
	StderrCursor *int32                            `form:"stderrCursor,omitempty" json:"stderrCursor,omitempty"`
	MaxLines     *int32                            `form:"maxLines,omitempty" json:"maxLines,omitempty"`
	XSessionID   SessionIDRequired                 `json:"X-Session-ID"`
}

ReadSessionJobOutputParams defines parameters for ReadSessionJobOutput.

type ReadSessionJobOutputParamsStream

type ReadSessionJobOutputParamsStream string

ReadSessionJobOutputParamsStream defines parameters for ReadSessionJobOutput.

const (
	ReadSessionJobOutputParamsStreamBoth   ReadSessionJobOutputParamsStream = "both"
	ReadSessionJobOutputParamsStreamStderr ReadSessionJobOutputParamsStream = "stderr"
	ReadSessionJobOutputParamsStreamStdout ReadSessionJobOutputParamsStream = "stdout"
)

Defines values for ReadSessionJobOutputParamsStream.

func (ReadSessionJobOutputParamsStream) Valid

Valid indicates whether the value is a known member of the ReadSessionJobOutputParamsStream enum.

type ReadSessionJobOutputResponse

type ReadSessionJobOutputResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON200 the response for an HTTP 200 `application/json` response
	JSON200 *JobOutput
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers200 the parsed response headers for an HTTP 200 response
	Headers200 *ReadSessionJobOutputResponse200Headers
}

func ParseReadSessionJobOutputResponse

func ParseReadSessionJobOutputResponse(rsp *http.Response) (*ReadSessionJobOutputResponse, error)

ParseReadSessionJobOutputResponse parses an HTTP response from a ReadSessionJobOutputWithResponse call

func (ReadSessionJobOutputResponse) ContentType

func (r ReadSessionJobOutputResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (ReadSessionJobOutputResponse) GetBody

func (r ReadSessionJobOutputResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (ReadSessionJobOutputResponse) GetJSON200

func (r ReadSessionJobOutputResponse) GetJSON200() *JobOutput

GetJSON200 returns the response for an HTTP 200 `application/json` response

func (ReadSessionJobOutputResponse) GetJSON400

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (ReadSessionJobOutputResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (ReadSessionJobOutputResponse) GetJSON404

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (ReadSessionJobOutputResponse) GetJSON500

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (ReadSessionJobOutputResponse) Status

Status returns HTTPResponse.Status

func (ReadSessionJobOutputResponse) StatusCode

func (r ReadSessionJobOutputResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReadSessionJobOutputResponse200Headers

type ReadSessionJobOutputResponse200Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

ReadSessionJobOutputResponse200Headers the declared response headers of an HTTP 200 response for ReadSessionJobOutput

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type Session

type Session struct {
	ActiveTurn         bool               `json:"activeTurn"`
	Agent              string             `json:"agent"`
	CompletedTurnCount int64              `json:"completedTurnCount"`
	CreatedAt          time.Time          `json:"createdAt"`
	Id                 openapi_types.UUID `json:"id"`
	LastMessageAt      *time.Time         `json:"lastMessageAt,omitempty"`
	MessageCount       int64              `json:"messageCount"`
	Model              string             `json:"model"`
	UpdatedAt          time.Time          `json:"updatedAt"`
}

Session defines model for Session.

type SessionEvent

type SessionEvent struct {
	CreatedAt time.Time               `json:"createdAt"`
	Data      *map[string]interface{} `json:"data,omitempty"`
	Delivery  SessionEventDelivery    `json:"delivery"`
	Id        openapi_types.UUID      `json:"id"`
	Source    string                  `json:"source"`
	Summary   string                  `json:"summary"`
	Type      string                  `json:"type"`
}

SessionEvent defines model for SessionEvent.

type SessionEventDelivery

type SessionEventDelivery string

SessionEventDelivery defines model for SessionEvent.Delivery.

const (
	SessionEventDeliveryQueue SessionEventDelivery = "queue"
	SessionEventDeliveryWake  SessionEventDelivery = "wake"
)

Defines values for SessionEventDelivery.

func (SessionEventDelivery) Valid

func (e SessionEventDelivery) Valid() bool

Valid indicates whether the value is a known member of the SessionEventDelivery enum.

type SessionEventPage

type SessionEventPage struct {
	// Dropped Events dropped before these because the queue was full.
	Dropped int32          `json:"dropped"`
	Events  []SessionEvent `json:"events"`
}

SessionEventPage defines model for SessionEventPage.

type SessionEventRequest

type SessionEventRequest struct {
	// Data Structured payload for programmatic consumers.
	Data *map[string]interface{} `json:"data,omitempty"`

	// Delivery queue waits for the next turn. wake starts a turn when the session is idle and .agents/events declares a handler for this type.
	Delivery *SessionEventRequestDelivery `json:"delivery,omitempty"`

	// Summary The one line describing what happened.
	Summary string `json:"summary"`

	// Type Dotted lowercase namespaced type. The job. and agent. prefixes are reserved for Peen's own producers and are rejected here.
	Type string `json:"type"`
}

SessionEventRequest defines model for SessionEventRequest.

type SessionEventRequestDelivery

type SessionEventRequestDelivery string

SessionEventRequestDelivery queue waits for the next turn. wake starts a turn when the session is idle and .agents/events declares a handler for this type.

const (
	SessionEventRequestDeliveryQueue SessionEventRequestDelivery = "queue"
	SessionEventRequestDeliveryWake  SessionEventRequestDelivery = "wake"
)

Defines values for SessionEventRequestDelivery.

func (SessionEventRequestDelivery) Valid

Valid indicates whether the value is a known member of the SessionEventRequestDelivery enum.

type SessionIDRequired

type SessionIDRequired = openapi_types.UUID

SessionIDRequired defines model for SessionIDRequired.

type SignalSessionJobJSONRequestBody

type SignalSessionJobJSONRequestBody = JobSignalRequest

SignalSessionJobJSONRequestBody defines body for SignalSessionJob for application/json ContentType.

type SignalSessionJobParams

type SignalSessionJobParams struct {
	XSessionID SessionIDRequired `json:"X-Session-ID"`
}

SignalSessionJobParams defines parameters for SignalSessionJob.

type SignalSessionJobResponse

type SignalSessionJobResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	// JSON202 the response for an HTTP 202 `application/json` response
	JSON202 *JobSignalResponse
	// JSON400 the response for an HTTP 400 `application/json` response
	JSON400 *ErrorBadRequest
	// JSON401 the response for an HTTP 401 `application/json` response
	JSON401 *ErrorUnauthorized
	// JSON404 the response for an HTTP 404 `application/json` response
	JSON404 *ErrorNotFound
	// JSON500 the response for an HTTP 500 `application/json` response
	JSON500 *ErrorInternal
	// Headers202 the parsed response headers for an HTTP 202 response
	Headers202 *SignalSessionJobResponse202Headers
}

func ParseSignalSessionJobResponse

func ParseSignalSessionJobResponse(rsp *http.Response) (*SignalSessionJobResponse, error)

ParseSignalSessionJobResponse parses an HTTP response from a SignalSessionJobWithResponse call

func (SignalSessionJobResponse) ContentType

func (r SignalSessionJobResponse) ContentType() string

ContentType is a convenience method to retrieve the Content-Type value from the HTTP response headers

func (SignalSessionJobResponse) GetBody

func (r SignalSessionJobResponse) GetBody() []byte

GetBody returns the raw response body bytes

func (SignalSessionJobResponse) GetJSON202

GetJSON202 returns the response for an HTTP 202 `application/json` response

func (SignalSessionJobResponse) GetJSON400

func (r SignalSessionJobResponse) GetJSON400() *ErrorBadRequest

GetJSON400 returns the response for an HTTP 400 `application/json` response

func (SignalSessionJobResponse) GetJSON401

GetJSON401 returns the response for an HTTP 401 `application/json` response

func (SignalSessionJobResponse) GetJSON404

func (r SignalSessionJobResponse) GetJSON404() *ErrorNotFound

GetJSON404 returns the response for an HTTP 404 `application/json` response

func (SignalSessionJobResponse) GetJSON500

func (r SignalSessionJobResponse) GetJSON500() *ErrorInternal

GetJSON500 returns the response for an HTTP 500 `application/json` response

func (SignalSessionJobResponse) Status

func (r SignalSessionJobResponse) Status() string

Status returns HTTPResponse.Status

func (SignalSessionJobResponse) StatusCode

func (r SignalSessionJobResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SignalSessionJobResponse202Headers

type SignalSessionJobResponse202Headers struct {
	XRequestID openapi_types.UUID
	XSessionID openapi_types.UUID
}

SignalSessionJobResponse202Headers the declared response headers of an HTTP 202 response for SignalSessionJob

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL