rpc

type APIKeyAuthInfo struct {
	// The API key. Treat as a secret.
	APIKey string `json:"apiKey"`
	// Snapshot of the authenticated user's Copilot subscription info, if known. Mirrors the
	// GitHub API `/copilot_internal/v2/token` user response shape — the runtime trusts this
	// verbatim and does not re-fetch when set.
	CopilotUser *CopilotUserResponse `json:"copilotUser,omitempty"`
	// Authentication host.
	Host string `json:"host"`
}

type AbortData struct {
	// Finite reason code describing why the current turn was aborted
	Reason AbortReason `json:"reason"`
}

type AbortReason string

type AbortRequest struct {
	// Finite reason code describing why the current turn was aborted
	Reason *AbortReason `json:"reason,omitempty"`
}

type AbortResult struct {
	// Error message if the abort failed
	Error *string `json:"error,omitempty"`
	// Whether the abort completed successfully
	Success bool `json:"success"`
}

type AccountGetQuotaRequest struct {
	// GitHub token for per-user quota lookup. When provided, resolves this token to determine
	// the user's quota instead of using the global auth.
	GitHubToken *string `json:"gitHubToken,omitempty"`
}

type AccountGetQuotaResult struct {
	// Quota snapshots keyed by type (e.g., chat, completions, premium_interactions)
	QuotaSnapshots map[string]AccountQuotaSnapshot `json:"quotaSnapshots"`
}

type AccountQuotaSnapshot struct {
	// Number of requests included in the entitlement, or -1 for unlimited entitlements
	EntitlementRequests int64 `json:"entitlementRequests"`
	// Whether the user has an unlimited usage entitlement
	IsUnlimitedEntitlement bool `json:"isUnlimitedEntitlement"`
	// Number of additional usage requests made this period
	Overage float64 `json:"overage"`
	// Whether additional usage is allowed when quota is exhausted
	OverageAllowedWithExhaustedQuota bool `json:"overageAllowedWithExhaustedQuota"`
	// Percentage of entitlement remaining
	RemainingPercentage float64 `json:"remainingPercentage"`
	// Date when the quota resets (ISO 8601 string)
	ResetDate *time.Time `json:"resetDate,omitempty"`
	// Whether usage is still permitted after quota exhaustion
	UsageAllowedWithExhaustedQuota bool `json:"usageAllowedWithExhaustedQuota"`
	// Number of requests used so far this period
	UsedRequests int64 `json:"usedRequests"`
}

type AgentAPI sessionAPI

type AgentGetCurrentResult struct {
	// Currently selected custom agent, or null if using the default agent
	Agent *AgentInfo `json:"agent,omitempty"`
}

type AgentInfo struct {
	// Description of the agent's purpose
	Description string `json:"description"`
	// Human-readable display name
	DisplayName string `json:"displayName"`
	// Stable identifier for selection. For most agents this is the same as `name`; for
	// plugin/builtin agents it may differ. Always populated; defaults to `name` when no
	// distinct id was assigned.
	ID string `json:"id"`
	// MCP server configurations attached to this agent, keyed by server name. Server config
	// shape mirrors the MCP `mcpServers` schema.
	// Experimental: MCPServers is part of an experimental API and may change or be removed.
	MCPServers map[string]any `json:"mcpServers,omitzero"`
	// Preferred model id for this agent. When omitted, inherits the outer agent's model.
	Model *string `json:"model,omitempty"`
	// Unique identifier of the custom agent
	Name string `json:"name"`
	// Absolute local file path of the agent definition. Only set for file-based agents loaded
	// from disk; remote agents do not have a path.
	Path *string `json:"path,omitempty"`
	// Skill names preloaded into this agent's context. Omitted means none.
	Skills []string `json:"skills,omitzero"`
	// Where the agent definition was loaded from
	Source *AgentInfoSource `json:"source,omitempty"`
	// Allowed tool names for this agent. Empty array means none; omitted means inherit defaults.
	Tools []string `json:"tools,omitzero"`
	// Whether the agent can be selected directly by the user. Agents marked `false` are
	// subagent-only.
	UserInvocable *bool `json:"userInvocable,omitempty"`
}

type AgentInfoSource string

type AgentList struct {
	// Available custom agents
	Agents []AgentInfo `json:"agents"`
}

type AgentRegistryLiveTargetEntry struct {
	// Kind of attention required when status === "attention". Meaningful only when status ===
	// "attention".
	AttentionKind *AgentRegistryLiveTargetEntryAttentionKind `json:"attentionKind,omitempty"`
	// Git branch of the session (when known)
	Branch *string `json:"branch,omitempty"`
	// Copilot CLI version that wrote the entry
	CopilotVersion string `json:"copilotVersion"`
	// Working directory of the session (when known)
	Cwd *string `json:"cwd,omitempty"`
	// Bind host for the entry's JSON-RPC server
	Host string `json:"host"`
	// Process kind tag for the registry entry
	Kind AgentRegistryLiveTargetEntryKind `json:"kind"`
	// Wall-clock milliseconds since the watcher last observed this entry (heartbeat freshness)
	LastSeenMs int64 `json:"lastSeenMs"`
	// How the most recent turn ended (clean vs aborted). Lets the renderer distinguish done
	// from done_cancelled.
	LastTerminalEvent *AgentRegistryLiveTargetEntryLastTerminalEvent `json:"lastTerminalEvent,omitempty"`
	// Model identifier currently selected for the session
	Model *string `json:"model,omitempty"`
	// Operating-system pid of the process owning this entry
	Pid int64 `json:"pid"`
	// TCP port the entry's JSON-RPC server is listening on
	Port int64 `json:"port"`
	// Registry entry schema version (1 = ui-server, 2 = managed-server)
	SchemaVersion int64 `json:"schemaVersion"`
	// Session ID of the foreground session for this entry
	SessionID *string `json:"sessionId,omitempty"`
	// Friendly session name (when set)
	SessionName *string `json:"sessionName,omitempty"`
	// ISO 8601 timestamp captured at registration
	StartedAt string `json:"startedAt"`
	// Coarse lifecycle status of the foreground session
	Status *AgentRegistryLiveTargetEntryStatus `json:"status,omitempty"`
	// Monotonic per-publisher revision counter incremented on every status update. Lets
	// watchers detect transient flips.
	StatusRevision *int64 `json:"statusRevision,omitempty"`
	// Connection token (null when the target is unauthenticated)
	// Internal: Token is part of the SDK's internal API surface and is not intended for
	// external use.
	Token *string `json:"token,omitempty"`
}

type AgentRegistryLiveTargetEntryAttentionKind string

type AgentRegistryLiveTargetEntryKind string

type AgentRegistryLiveTargetEntryLastTerminalEvent string

type AgentRegistryLiveTargetEntryStatus string

type AgentRegistryLogCapture struct {
	// Whether per-spawn log capture is on (false when env-disabled or open failed)
	Enabled bool `json:"enabled"`
	// Human-readable open failure message (only set when enabled === false AND the env-disable
	// opt-out was NOT used)
	OpenError *string `json:"openError,omitempty"`
	// Categorized reason for log-open failure
	OpenErrorReason *AgentRegistryLogCaptureOpenErrorReason `json:"openErrorReason,omitempty"`
	// Absolute path to the per-spawn log file (only set when enabled)
	Path *string `json:"path,omitempty"`
}

type AgentRegistryLogCaptureOpenErrorReason string

type AgentRegistrySpawnError struct {
	// Underlying errno code (e.g. ENOENT, EACCES) when available
	Code *string `json:"code,omitempty"`
	// Human-readable error message
	Message string `json:"message"`
}

type AgentRegistrySpawnPermissionMode string

type AgentRegistrySpawnRegistryTimeout struct {
	// Process ID of the orphaned child (so the caller can offer 'kill the pid' guidance)
	ChildPid int64 `json:"childPid"`
	// Per-spawn log-capture outcome; populated from spawnLiveTarget.
	LogCapture *AgentRegistryLogCapture `json:"logCapture,omitempty"`
}

type AgentRegistrySpawnRequest struct {
	// Custom or built-in agent name (e.g. 'explore'). When omitted, the child uses its own
	// default.
	AgentName *string `json:"agentName,omitempty"`
	// Working directory for the spawned child (must be an existing directory)
	Cwd string `json:"cwd"`
	// Optional first user message. Forwarded to the caller (the CLI's spawn wrapper sends it
	// post-attach via the standard LocalRpcSession.send path).
	InitialPrompt *string `json:"initialPrompt,omitempty"`
	// Model identifier to apply to the new session
	Model *string `json:"model,omitempty"`
	// Friendly session name. Must satisfy validateSessionName: non-empty, no leading/trailing
	// whitespace, <=100 chars, no control chars, no double quotes.
	Name *string `json:"name,omitempty"`
	// Permission posture for the new session. 'yolo' requires the controller-local session to
	// currently be in allow-all mode.
	PermissionMode *AgentRegistrySpawnPermissionMode `json:"permissionMode,omitempty"`
}

type AgentRegistrySpawnResult interface {
	Kind() AgentRegistrySpawnResultKind
	// contains filtered or unexported methods
}

type AgentRegistrySpawnResultKind string

type AgentRegistrySpawnSpawned struct {
	// Full registry entry for the spawned child. Lets the controller call
	// `handleLiveTargetSelected(entry)` directly without re-reading the registry (avoids a
	// TOCTOU window).
	Entry AgentRegistryLiveTargetEntry `json:"entry"`
	// If the delegate attempted to send the initial prompt and failed, the categorized error
	// message.
	InitialPromptError *string `json:"initialPromptError,omitempty"`
	// Whether the delegate already sent the initial prompt. Always omitted in the current
	// wiring: the controller sends the prompt post-attach via the standard LocalRpcSession.send
	// path.
	InitialPromptSent *bool `json:"initialPromptSent,omitempty"`
	// Per-spawn log-capture outcome; populated from spawnLiveTarget.
	LogCapture *AgentRegistryLogCapture `json:"logCapture,omitempty"`
}

type AgentRegistrySpawnValidationError struct {
	// Which parameter field was invalid. Omitted when the rejection is not field-specific.
	Field *AgentRegistrySpawnValidationErrorField `json:"field,omitempty"`
	// Human-readable explanation; safe to surface in the UI banner. Never logged to
	// unrestricted telemetry.
	Message string `json:"message"`
	// Categorized reason for the rejection. Low-cardinality enum so telemetry can aggregate by
	// reason without leaking raw paths or agent/model names.
	Reason AgentRegistrySpawnValidationErrorReason `json:"reason"`
}

type AgentRegistrySpawnValidationErrorField string

type AgentRegistrySpawnValidationErrorReason string

type AgentReloadResult struct {
	// Reloaded custom agents
	Agents []AgentInfo `json:"agents"`
}

type AgentSelectRequest struct {
	// Name of the custom agent to select
	Name string `json:"name"`
}

type AgentSelectResult struct {
	// The newly selected custom agent
	Agent AgentInfo `json:"agent"`
}

type AgentsDiscoverRequest struct {
	// When true, omit the host's agents (the `<COPILOT_HOME>/agents` directory and all plugin
	// agents), leaving only project and remote agents. For multitenant deployments.
	ExcludeHostAgents *bool `json:"excludeHostAgents,omitempty"`
	// Optional list of project directory paths to scan for project-scoped agents. When omitted
	// or empty, only user/plugin/remote-independent agents are returned (no project scan).
	ProjectPaths []string `json:"projectPaths,omitzero"`
}

type AllowAllPermissionSetResult struct {
	// Authoritative allow-all state after the mutation
	Enabled bool `json:"enabled"`
	// Whether the operation succeeded
	Success bool `json:"success"`
}

type AllowAllPermissionState struct {
	// Whether full allow-all permissions are currently active
	Enabled bool `json:"enabled"`
}

type AssistantIntentData struct {
	// Short description of what the agent is currently doing or planning to do
	Intent string `json:"intent"`
}

type AssistantMessageData struct {
	// Raw Anthropic content array with advisor blocks (server_tool_use, advisor_tool_result) for verbatim round-tripping
	// Experimental: AnthropicAdvisorBlocks is part of an experimental API and may change or be removed.
	AnthropicAdvisorBlocks []any `json:"anthropicAdvisorBlocks,omitzero"`
	// Anthropic advisor model ID used for this response, for timeline display on replay
	// Experimental: AnthropicAdvisorModel is part of an experimental API and may change or be removed.
	AnthropicAdvisorModel *string `json:"anthropicAdvisorModel,omitempty"`
	// Provider's completion / response identifier; shared across all chunks of a single API call. Used to group multi-chunk assistant utterances.
	APICallID *string `json:"apiCallId,omitempty"`
	// The assistant's text response content
	Content string `json:"content"`
	// Encrypted reasoning content from OpenAI models. Session-bound and stripped on resume.
	EncryptedContent *string `json:"encryptedContent,omitempty"`
	// CAPI interaction ID for correlating this message with upstream telemetry
	InteractionID *string `json:"interactionId,omitempty"`
	// Unique identifier for this assistant message
	MessageID string `json:"messageId"`
	// Model that produced this assistant message, if known
	Model *string `json:"model,omitempty"`
	// Actual output token count from the API response (completion_tokens), used for accurate token accounting
	OutputTokens *int64 `json:"outputTokens,omitempty"`
	// Tool call ID of the parent tool invocation when this event originates from a sub-agent
	// Deprecated: ParentToolCallID is deprecated.
	ParentToolCallID *string `json:"parentToolCallId,omitempty"`
	// Generation phase for phased-output models (e.g., thinking vs. response phases)
	Phase *string `json:"phase,omitempty"`
	// Opaque/encrypted extended thinking data from Anthropic models. Session-bound and stripped on resume.
	ReasoningOpaque *string `json:"reasoningOpaque,omitempty"`
	// Readable reasoning text from the model's extended thinking
	ReasoningText *string `json:"reasoningText,omitempty"`
	// GitHub request tracing ID (x-github-request-id header) for correlating with server-side logs
	RequestID *string `json:"requestId,omitempty"`
	// Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation
	ServiceRequestID *string `json:"serviceRequestId,omitempty"`
	// Tool invocations requested by the assistant in this message
	ToolRequests []AssistantMessageToolRequest `json:"toolRequests,omitzero"`
	// Identifier for the agent loop turn that produced this message, matching the corresponding assistant.turn_start event
	TurnID *string `json:"turnId,omitempty"`
}

type AssistantMessageDeltaData struct {
	// Incremental text chunk to append to the message content
	DeltaContent string `json:"deltaContent"`
	// Message ID this delta belongs to, matching the corresponding assistant.message event
	MessageID string `json:"messageId"`
	// Tool call ID of the parent tool invocation when this event originates from a sub-agent
	// Deprecated: ParentToolCallID is deprecated.
	ParentToolCallID *string `json:"parentToolCallId,omitempty"`
}

type AssistantMessageStartData struct {
	// Message ID this start event belongs to, matching subsequent deltas and assistant.message
	MessageID string `json:"messageId"`
	// Generation phase this message belongs to for phased-output models
	Phase *string `json:"phase,omitempty"`
}

type AssistantMessageToolRequest struct {
	// Arguments to pass to the tool, format depends on the tool
	Arguments any `json:"arguments,omitempty"`
	// Resolved intention summary describing what this specific call does
	IntentionSummary *string `json:"intentionSummary,omitempty"`
	// Name of the MCP server hosting this tool, when the tool is an MCP tool
	MCPServerName *string `json:"mcpServerName,omitempty"`
	// Original tool name on the MCP server, when the tool is an MCP tool
	MCPToolName *string `json:"mcpToolName,omitempty"`
	// Name of the tool being invoked
	Name string `json:"name"`
	// Unique identifier for this tool call
	ToolCallID string `json:"toolCallId"`
	// Human-readable display title for the tool
	ToolTitle *string `json:"toolTitle,omitempty"`
	// Tool call type: "function" for standard tool calls, "custom" for grammar-based tool calls. Defaults to "function" when absent.
	Type *AssistantMessageToolRequestType `json:"type,omitempty"`
}

type AssistantMessageToolRequestType string

type AssistantReasoningData struct {
	// The complete extended thinking text from the model
	Content string `json:"content"`
	// Unique identifier for this reasoning block
	ReasoningID string `json:"reasoningId"`
}

type AssistantReasoningDeltaData struct {
	// Incremental text chunk to append to the reasoning content
	DeltaContent string `json:"deltaContent"`
	// Reasoning block ID this delta belongs to, matching the corresponding assistant.reasoning event
	ReasoningID string `json:"reasoningId"`
}

type AssistantStreamingDeltaData struct {
	// Cumulative total bytes received from the streaming response so far
	TotalResponseSizeBytes int64 `json:"totalResponseSizeBytes"`
}

type AssistantTurnEndData struct {
	// Identifier of the turn that has ended, matching the corresponding assistant.turn_start event
	TurnID string `json:"turnId"`
}

type AssistantTurnStartData struct {
	// CAPI interaction ID for correlating this turn with upstream telemetry
	InteractionID *string `json:"interactionId,omitempty"`
	// Identifier for this turn within the agentic loop, typically a stringified turn number
	TurnID string `json:"turnId"`
}

type AssistantUsageAPIEndpoint string

type AssistantUsageCopilotUsage struct {
	// Itemized token usage breakdown
	TokenDetails []AssistantUsageCopilotUsageTokenDetail `json:"tokenDetails"`
	// Total cost in nano-AI units for this request
	TotalNanoAiu float64 `json:"totalNanoAiu"`
}

type AssistantUsageCopilotUsageTokenDetail struct {
	// Number of tokens in this billing batch
	BatchSize int64 `json:"batchSize"`
	// Cost per batch of tokens
	CostPerBatch int64 `json:"costPerBatch"`
	// Total token count for this entry
	TokenCount int64 `json:"tokenCount"`
	// Token category (e.g., "input", "output")
	TokenType string `json:"tokenType"`
}

type AssistantUsageData struct {
	// Completion ID from the model provider (e.g., chatcmpl-abc123)
	APICallID *string `json:"apiCallId,omitempty"`
	// API endpoint used for this model call, matching CAPI supported_endpoints vocabulary
	APIEndpoint *AssistantUsageAPIEndpoint `json:"apiEndpoint,omitempty"`
	// Number of tokens read from prompt cache
	CacheReadTokens *int64 `json:"cacheReadTokens,omitempty"`
	// Number of tokens written to prompt cache
	CacheWriteTokens *int64 `json:"cacheWriteTokens,omitempty"`
	// Per-request cost and usage data from the CAPI copilot_usage response field
	// Internal: CopilotUsage is part of the SDK's internal API surface and is not intended for external use.
	CopilotUsage *AssistantUsageCopilotUsage `json:"copilotUsage,omitempty"`
	// Model multiplier cost for billing purposes
	// Experimental: Cost is part of an experimental API and may change or be removed.
	Cost *float64 `json:"cost,omitempty"`
	// Duration of the API call in milliseconds
	Duration *int64 `json:"duration,omitempty"`
	// What initiated this API call (e.g., "sub-agent", "mcp-sampling"); absent for user-initiated calls
	Initiator *string `json:"initiator,omitempty"`
	// Number of input tokens consumed
	InputTokens *int64 `json:"inputTokens,omitempty"`
	// Average inter-token latency in milliseconds. Only available for streaming requests
	InterTokenLatencyMs *float64 `json:"interTokenLatencyMs,omitempty"`
	// Model identifier used for this API call
	Model string `json:"model"`
	// Number of output tokens produced
	OutputTokens *int64 `json:"outputTokens,omitempty"`
	// Parent tool call ID when this usage originates from a sub-agent
	// Deprecated: ParentToolCallID is deprecated.
	ParentToolCallID *string `json:"parentToolCallId,omitempty"`
	// GitHub request tracing ID (x-github-request-id header) for server-side log correlation
	ProviderCallID *string `json:"providerCallId,omitempty"`
	// Per-quota resource usage snapshots, keyed by quota identifier
	// Internal: QuotaSnapshots is part of the SDK's internal API surface and is not intended for external use.
	QuotaSnapshots map[string]AssistantUsageQuotaSnapshot `json:"quotaSnapshots,omitzero"`
	// Reasoning effort level used for model calls, if applicable (e.g. "none", "low", "medium", "high", "xhigh", "max")
	ReasoningEffort *string `json:"reasoningEffort,omitempty"`
	// Number of output tokens used for reasoning (e.g., chain-of-thought)
	ReasoningTokens *int64 `json:"reasoningTokens,omitempty"`
	// Copilot service request ID (x-copilot-service-request-id header) for CAPI log correlation
	ServiceRequestID *string `json:"serviceRequestId,omitempty"`
	// Time to first token in milliseconds. Only available for streaming requests
	TimeToFirstTokenMs *int64 `json:"timeToFirstTokenMs,omitempty"`
}

type AssistantUsageQuotaSnapshot struct {
	// Total requests allowed by the entitlement
	// Internal: EntitlementRequests is part of the SDK's internal API surface and is not intended for external use.
	EntitlementRequests int64 `json:"entitlementRequests"`
	// Whether the user has an unlimited usage entitlement
	// Internal: IsUnlimitedEntitlement is part of the SDK's internal API surface and is not intended for external use.
	IsUnlimitedEntitlement bool `json:"isUnlimitedEntitlement"`
	// Number of additional usage requests made this period
	// Internal: Overage is part of the SDK's internal API surface and is not intended for external use.
	Overage float64 `json:"overage"`
	// Whether additional usage is allowed when quota is exhausted
	// Internal: OverageAllowedWithExhaustedQuota is part of the SDK's internal API surface and is not intended for external use.
	OverageAllowedWithExhaustedQuota bool `json:"overageAllowedWithExhaustedQuota"`
	// Percentage of quota remaining (0 to 100)
	// Internal: RemainingPercentage is part of the SDK's internal API surface and is not intended for external use.
	RemainingPercentage float64 `json:"remainingPercentage"`
	// Date when the quota resets
	// Internal: ResetDate is part of the SDK's internal API surface and is not intended for external use.
	ResetDate *time.Time `json:"resetDate,omitempty"`
	// Whether usage is still permitted after quota exhaustion
	// Internal: UsageAllowedWithExhaustedQuota is part of the SDK's internal API surface and is not intended for external use.
	UsageAllowedWithExhaustedQuota bool `json:"usageAllowedWithExhaustedQuota"`
	// Number of requests already consumed
	// Internal: UsedRequests is part of the SDK's internal API surface and is not intended for external use.
	UsedRequests int64 `json:"usedRequests"`
}

type Attachment interface {
	Type() AttachmentType
	// contains filtered or unexported methods
}

type AttachmentBlob struct {
	// Base64-encoded content
	Data string `json:"data"`
	// User-facing display name for the attachment
	DisplayName *string `json:"displayName,omitempty"`
	// MIME type of the inline data
	MIMEType string `json:"mimeType"`
}

type AttachmentDirectory struct {
	// User-facing display name for the attachment
	DisplayName string `json:"displayName"`
	// Absolute directory path
	Path string `json:"path"`
}

type AttachmentExtensionContext struct {
	// Provider-local canvas identifier when the push was bound to a canvas instance
	CanvasID *string `json:"canvasId,omitempty"`
	// ISO 8601 timestamp captured by the runtime when the push was accepted
	CapturedAt time.Time `json:"capturedAt"`
	// Owning extension identifier. Runtime-derived from the caller's connection when produced
	// via session.extensions.sendAttachmentsToMessage; preserved verbatim on subsequent
	// transports.
	ExtensionID string `json:"extensionId"`
	// Open canvas instance identifier when the push was bound to a canvas instance
	InstanceID *string `json:"instanceId,omitempty"`
	// Caller-supplied JSON payload
	Payload any `json:"payload,omitempty"`
	// Human-readable composer pill label
	Title string `json:"title"`
}

type AttachmentFile struct {
	// User-facing display name for the attachment
	DisplayName string `json:"displayName"`
	// Optional line range to scope the attachment to a specific section of the file
	LineRange *AttachmentFileLineRange `json:"lineRange,omitempty"`
	// Absolute file path
	Path string `json:"path"`
}

type AttachmentFileLineRange struct {
	// End line number (1-based, inclusive)
	End int64 `json:"end"`
	// Start line number (1-based)
	Start int64 `json:"start"`
}

type AttachmentGitHubReference struct {
	// Issue, pull request, or discussion number
	Number int64 `json:"number"`
	// Type of GitHub reference
	ReferenceType AttachmentGitHubReferenceType `json:"referenceType"`
	// Current state of the referenced item (e.g., open, closed, merged)
	State string `json:"state"`
	// Title of the referenced item
	Title string `json:"title"`
	// URL to the referenced item on GitHub
	URL string `json:"url"`
}

type AttachmentGitHubReferenceType string

type AttachmentSelection struct {
	// User-facing display name for the selection
	DisplayName string `json:"displayName"`
	// Absolute path to the file containing the selection
	FilePath string `json:"filePath"`
	// Position range of the selection within the file
	Selection AttachmentSelectionDetails `json:"selection"`
	// The selected text content
	Text string `json:"text"`
}

type AttachmentSelectionDetails struct {
	// End position of the selection
	End AttachmentSelectionDetailsEnd `json:"end"`
	// Start position of the selection
	Start AttachmentSelectionDetailsStart `json:"start"`
}

type AttachmentSelectionDetailsEnd struct {
	// End character offset within the line (0-based)
	Character int64 `json:"character"`
	// End line number (0-based)
	Line int64 `json:"line"`
}

type AttachmentSelectionDetailsStart struct {
	// Start character offset within the line (0-based)
	Character int64 `json:"character"`
	// Start line number (0-based)
	Line int64 `json:"line"`
}

type AttachmentType string

type AuthAPI sessionAPI

type AuthInfo interface {
	Type() AuthInfoType
	// contains filtered or unexported methods
}

type AuthInfoType string

type AutoModeSwitchCompletedData struct {
	// Request ID of the resolved request; clients should dismiss any UI for this request
	RequestID string `json:"requestId"`
	// The user's auto-mode-switch choice
	Response AutoModeSwitchResponse `json:"response"`
}

type AutoModeSwitchRequestedData struct {
	// The rate limit error code that triggered this request
	ErrorCode *string `json:"errorCode,omitempty"`
	// Unique identifier for this request; used to respond via session.respondToAutoModeSwitch()
	RequestID string `json:"requestId"`
	// Seconds until the rate limit resets, when known. Lets clients render a humanized reset time alongside the prompt.
	RetryAfterSeconds *int64 `json:"retryAfterSeconds,omitempty"`
}

type AutoModeSwitchResponse string

type AutopilotObjectiveChangedOperation string

type AutopilotObjectiveChangedStatus string

type CancelUserRequestedShellCommandResult struct {
	// Whether an in-flight execution was found and signalled to cancel
	Cancelled bool `json:"cancelled"`
}

type CanvasAPI sessionAPI

type CanvasAction struct {
	// Description of the action
	Description *string `json:"description,omitempty"`
	// JSON Schema for the action input
	InputSchema any `json:"inputSchema,omitempty"`
	// Action name exposed by the canvas provider
	Name string `json:"name"`
}

type CanvasActionAPI sessionAPI

type CanvasActionInvokeRequest struct {
	// Action name to invoke
	ActionName string `json:"actionName"`
	// Action input
	Input any `json:"input,omitempty"`
	// Open canvas instance identifier
	InstanceID string `json:"instanceId"`
}

type CanvasActionInvokeResult struct {
	// Provider-supplied action result
	Result any `json:"result,omitempty"`
}

type CanvasCloseRequest struct {
	// Open canvas instance identifier
	InstanceID string `json:"instanceId"`
}

type CanvasCloseResult struct {
}

type CanvasHandler interface {
	// Closes a canvas instance on the provider.
	//
	// RPC method: canvas.close.
	//
	// Parameters: Canvas close parameters sent to the provider.
	Close(request *CanvasProviderCloseRequest) (*CanvasCloseResult, error)
	// Invokes an action on an open canvas instance via the provider.
	//
	// RPC method: canvas.action.invoke.
	//
	// Parameters: Canvas action invocation parameters sent to the provider.
	//
	// Returns: Provider-supplied action result.
	Invoke(request *CanvasProviderInvokeActionRequest) (any, error)
	// Opens a canvas instance on the provider.
	//
	// RPC method: canvas.open.
	//
	// Parameters: Canvas open parameters sent to the provider.
	//
	// Returns: Canvas open result returned by the provider.
	Open(request *CanvasProviderOpenRequest) (*CanvasProviderOpenResult, error)
}

type CanvasHostContext struct {
	// Host capabilities
	Capabilities *CanvasHostContextCapabilities `json:"capabilities,omitempty"`
}

type CanvasHostContextCapabilities struct {
	// Whether canvas rendering is supported
	Canvases *bool `json:"canvases,omitempty"`
}

type CanvasInstanceAvailability string

type CanvasJSONSchema any

type CanvasList struct {
	// Declared canvases available in this session
	Canvases []DiscoveredCanvas `json:"canvases"`
}

type CanvasListOpenResult struct {
	// Currently open canvas instances
	OpenCanvases []OpenCanvasInstance `json:"openCanvases"`
}

type CanvasOpenRequest struct {
	// Provider-local canvas identifier
	CanvasID string `json:"canvasId"`
	// Owning provider identifier. Optional when the canvasId is unique across providers;
	// required to disambiguate when multiple providers register the same canvasId.
	ExtensionID *string `json:"extensionId,omitempty"`
	// Canvas open input
	Input any `json:"input,omitempty"`
	// Caller-supplied stable instance identifier
	InstanceID string `json:"instanceId"`
}

type CanvasOpenedAvailability string

type CanvasProviderCloseRequest struct {
	// Provider-local canvas identifier
	CanvasID string `json:"canvasId"`
	// Owning provider identifier
	ExtensionID string `json:"extensionId"`
	// Host context supplied by the runtime.
	Host *CanvasHostContext `json:"host,omitempty"`
	// Canvas instance identifier
	InstanceID string `json:"instanceId"`
	// Session context supplied by the runtime.
	Session *CanvasSessionContext `json:"session,omitempty"`
	// Target session identifier
	SessionID string `json:"sessionId"`
}

type CanvasProviderInvokeActionRequest struct {
	// Action name to invoke
	ActionName string `json:"actionName"`
	// Provider-local canvas identifier
	CanvasID string `json:"canvasId"`
	// Owning provider identifier
	ExtensionID string `json:"extensionId"`
	// Host context supplied by the runtime.
	Host *CanvasHostContext `json:"host,omitempty"`
	// Action input
	Input any `json:"input,omitempty"`
	// Canvas instance identifier
	InstanceID string `json:"instanceId"`
	// Session context supplied by the runtime.
	Session *CanvasSessionContext `json:"session,omitempty"`
	// Target session identifier
	SessionID string `json:"sessionId"`
}

type CanvasProviderOpenRequest struct {
	// Provider-local canvas identifier
	CanvasID string `json:"canvasId"`
	// Owning provider identifier
	ExtensionID string `json:"extensionId"`
	// Host context supplied by the runtime.
	Host *CanvasHostContext `json:"host,omitempty"`
	// Canvas open input
	Input any `json:"input,omitempty"`
	// Stable caller-supplied canvas instance identifier
	InstanceID string `json:"instanceId"`
	// Session context supplied by the runtime.
	Session *CanvasSessionContext `json:"session,omitempty"`
	// Target session identifier
	SessionID string `json:"sessionId"`
}

type CanvasProviderOpenResult struct {
	// Provider-supplied status text
	Status *string `json:"status,omitempty"`
	// Provider-supplied title
	Title *string `json:"title,omitempty"`
	// URL for web-rendered canvases
	URL *string `json:"url,omitempty"`
}

type CanvasRegistryChangedCanvas struct {
	// Actions the agent or host may invoke
	Actions []CanvasRegistryChangedCanvasAction `json:"actions,omitzero"`
	// Provider-local canvas identifier
	CanvasID string `json:"canvasId"`
	// Short, single-sentence description shown to the agent in canvas catalogs.
	Description string `json:"description"`
	// Human-readable canvas name
	DisplayName string `json:"displayName"`
	// Owning provider identifier
	ExtensionID string `json:"extensionId"`
	// Owning extension display name, when available
	ExtensionName *string `json:"extensionName,omitempty"`
	// JSON Schema for canvas open input
	InputSchema map[string]any `json:"inputSchema,omitzero"`
}

type CanvasRegistryChangedCanvasAction struct {
	// Action description
	Description *string `json:"description,omitempty"`
	// JSON Schema for action input
	InputSchema map[string]any `json:"inputSchema,omitzero"`
	// Action name
	Name string `json:"name"`
}

type CanvasSessionContext struct {
	// Active session working directory, when known.
	WorkingDirectory *string `json:"workingDirectory,omitempty"`
}

type CapabilitiesChangedData struct {
	// UI capability changes
	UI *CapabilitiesChangedUI `json:"ui,omitempty"`
}

type CapabilitiesChangedUI struct {
	// Whether canvas rendering is now supported
	Canvases *bool `json:"canvases,omitempty"`
	// Whether elicitation is now supported
	Elicitation *bool `json:"elicitation,omitempty"`
	// Whether MCP Apps (SEP-1865) UI passthrough is now supported
	MCPApps *bool `json:"mcpApps,omitempty"`
}

type ClientSessionAPIHandlers struct {
	Canvas    CanvasHandler
	SessionFS SessionFSHandler
}

type CommandCompletedData struct {
	// Request ID of the resolved command request; clients should dismiss any UI for this request
	RequestID string `json:"requestId"`
}

type CommandExecuteData struct {
	// Raw argument string after the command name
	Args string `json:"args"`
	// The full command text (e.g., /deploy production)
	Command string `json:"command"`
	// Command name without leading /
	CommandName string `json:"commandName"`
	// Unique identifier; used to respond via session.commands.handlePendingCommand()
	RequestID string `json:"requestId"`
}

type CommandList struct {
	// Commands available in this session
	Commands []SlashCommandInfo `json:"commands"`
}

type CommandQueuedData struct {
	// The slash command text to be executed (e.g., /help, /clear)
	Command string `json:"command"`
	// Unique identifier for this request; used to respond via session.respondToQueuedCommand()
	RequestID string `json:"requestId"`
}

type CommandsAPI sessionAPI

type CommandsChangedCommand struct {
	// Optional human-readable command description.
	Description *string `json:"description,omitempty"`
	// Slash command name without the leading slash.
	Name string `json:"name"`
}

type CommandsChangedData struct {
	// Current list of registered SDK commands
	Commands []CommandsChangedCommand `json:"commands"`
}

type CommandsHandlePendingCommandRequest struct {
	// Error message if the command handler failed
	Error *string `json:"error,omitempty"`
	// Request ID from the command invocation event
	RequestID string `json:"requestId"`
}

type CommandsHandlePendingCommandResult struct {
	// Whether the command was handled successfully
	Success bool `json:"success"`
}

type CommandsInvokeRequest struct {
	// Raw input after the command name
	Input *string `json:"input,omitempty"`
	// Command name. Leading slashes are stripped and the name is matched case-insensitively.
	Name string `json:"name"`
}

type CommandsListRequest struct {
	// Include runtime built-in commands
	IncludeBuiltins *bool `json:"includeBuiltins,omitempty"`
	// Include commands registered by protocol clients, including SDK clients and extensions
	IncludeClientCommands *bool `json:"includeClientCommands,omitempty"`
	// Include enabled user-invocable skills and commands
	IncludeSkills *bool `json:"includeSkills,omitempty"`
}

type CommandsRespondToQueuedCommandRequest struct {
	// Request ID from the `command.queued` event the host is responding to.
	RequestID string `json:"requestId"`
	// Result of the queued command execution.
	Result QueuedCommandResult `json:"result"`
}

type CommandsRespondToQueuedCommandResult struct {
	// Whether a pending queued command with the given request ID was found and resolved. False
	// when the request was already resolved, cancelled, or unknown.
	Success bool `json:"success"`
}

type CompactionCompleteCompactionTokensUsed struct {
	// Cached input tokens reused in the compaction LLM call
	CacheReadTokens *int64 `json:"cacheReadTokens,omitempty"`
	// Tokens written to prompt cache in the compaction LLM call
	CacheWriteTokens *int64 `json:"cacheWriteTokens,omitempty"`
	// Per-request cost and usage data from the CAPI copilot_usage response field
	// Internal: CopilotUsage is part of the SDK's internal API surface and is not intended for external use.
	CopilotUsage *CompactionCompleteCompactionTokensUsedCopilotUsage `json:"copilotUsage,omitempty"`
	// Duration of the compaction LLM call in milliseconds
	Duration *int64 `json:"duration,omitempty"`
	// Input tokens consumed by the compaction LLM call
	InputTokens *int64 `json:"inputTokens,omitempty"`
	// Model identifier used for the compaction LLM call
	Model *string `json:"model,omitempty"`
	// Output tokens produced by the compaction LLM call
	OutputTokens *int64 `json:"outputTokens,omitempty"`
}

type CompactionCompleteCompactionTokensUsedCopilotUsage struct {
	// Itemized token usage breakdown
	TokenDetails []CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail `json:"tokenDetails"`
	// Total cost in nano-AI units for this request
	TotalNanoAiu float64 `json:"totalNanoAiu"`
}

type CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail struct {
	// Number of tokens in this billing batch
	BatchSize int64 `json:"batchSize"`
	// Cost per batch of tokens
	CostPerBatch int64 `json:"costPerBatch"`
	// Total token count for this entry
	TokenCount int64 `json:"tokenCount"`
	// Token category (e.g., "input", "output")
	TokenType string `json:"tokenType"`
}

type ConfigureSessionExtensionsParams struct {
	// In-process ExtensionController delegate (CLI-only optimization). Marked internal: this
	// field is excluded from the public SDK surface. The post-SDK extension surface exposes
	// list/enable/disable/reload via dedicated RPCs served by the runtime.
	// Internal: Controller is part of the SDK's internal API surface and is not intended for
	// external use.
	Controller any `json:"controller,omitempty"`
	// Session to attach the extension controller delegate to.
	SessionID string `json:"sessionId"`
}

type ConnectRemoteSessionParams struct {
	// Session ID to connect to.
	SessionID string `json:"sessionId"`
}

type ConnectRequest struct {
	// Connection token; required when the server was started with COPILOT_CONNECTION_TOKEN
	Token *string `json:"token,omitempty"`
}

type ConnectResult struct {
	// Always true on success
	Ok bool `json:"ok"`
	// Server protocol version number
	ProtocolVersion int64 `json:"protocolVersion"`
	// Server package version
	Version string `json:"version"`
}

type ConnectedRemoteSessionMetadata struct {
	// Neutral SDK discriminator for the connected remote session kind.
	Kind ConnectedRemoteSessionMetadataKind `json:"kind"`
	// Last session update time as an ISO 8601 string.
	ModifiedTime time.Time `json:"modifiedTime"`
	// Optional friendly session name.
	Name *string `json:"name,omitempty"`
	// Pull request number associated with the session.
	PullRequestNumber *int64 `json:"pullRequestNumber,omitempty"`
	// Repository associated with the connected remote session.
	Repository ConnectedRemoteSessionMetadataRepository `json:"repository"`
	// Original remote resource identifier.
	ResourceID *string `json:"resourceId,omitempty"`
	// SDK session ID for the connected remote session.
	SessionID string `json:"sessionId"`
	// Remote session staleness deadline as an ISO 8601 string.
	StaleAt *time.Time `json:"staleAt,omitempty"`
	// Session start time as an ISO 8601 string.
	StartTime time.Time `json:"startTime"`
	// Remote session state returned by the backing service.
	State *string `json:"state,omitempty"`
	// Optional session summary.
	Summary *string `json:"summary,omitempty"`
}