sandbox

type APIError struct {
	StatusCode int
	Body       []byte

	// Reqid 是从响应头 X-Reqid 中提取的请求 ID，用于链路追踪和日志排查。
	Reqid string
	// Code 是从响应 body 中解析出的错误码（如果有）。
	Code string
	// Message 是从响应 body 中解析出的错误消息（如果有）。
	Message string
}

type AddOptions struct {
	GitOptions
	// Files 指定要暂存的文件列表，为空时根据 All 决定使用 -A 或 "."。
	Files []string
	// All 控制 Files 为空时是否使用 -A 暂存所有变更。
	// 为 nil 时默认 true（与 E2B 对齐）；显式为 false 则使用 "." 仅暂存当前目录。
	All *bool
}

type AnthropicInjection struct {
	// APIKey API 密钥，可选。
	APIKey *string

	// BaseURL 可选 base URL，未指定时使用 api.anthropic.com。
	BaseURL *string
}

type AssignedTemplateTags struct {
	BuildID string
	Tags    []string
}

type AuthenticateOptions struct {
	GitOptions
	// Username 是 HTTPS 认证的用户名，必填。
	Username string
	// Password 是 HTTPS 认证的密码或 token，必填。
	Password string
	// Host 是要认证的主机，缺省为 "github.com"。
	Host string
	// Protocol 是要认证的协议，缺省为 "https"。
	// 出于安全考虑只允许 "https"，传入其他值会返回 InvalidArgumentError。
	Protocol string
}

type BuildLogEntry struct {
	Level     LogLevel
	Message   string
	Step      *string
	Timestamp time.Time
}

type Client struct {
	// contains filtered or unexported fields
}

type CloneOptions struct {
	GitOptions
	// Path 指定克隆目标路径。
	Path string
	// Branch 指定要检出的分支，设置后会附加 --single-branch。
	Branch string
	// Depth 指定浅克隆深度。
	Depth int
	// Username 是 HTTPS 认证的用户名。
	Username string
	// Password 是 HTTPS 认证的密码或 token。
	Password string
	// DangerouslyStoreCredentials 为 true 时，凭证会持久化在 .git/config 中；
	// 默认会在 clone 完成后通过 remote set-url 清除。
	DangerouslyStoreCredentials bool
}

type CommandHandle struct {
	// contains filtered or unexported fields
}

type CommandOption func(*commandOpts)

type CommandResult struct {
	ExitCode int
	Stdout   string
	Stderr   string
	Error    string
}

type Commands struct {
	// contains filtered or unexported fields
}

type CommitOptions struct {
	GitOptions
	// AuthorName 覆盖提交作者名。
	AuthorName string
	// AuthorEmail 覆盖提交作者邮箱。
	AuthorEmail string
	// AllowEmpty 允许空提交。
	AllowEmpty bool
}

type Config struct {
	// APIKey 是用于身份认证的 API 密钥（必填）。
	APIKey string

	// Credentials 是用于身份认证的七牛凭证对象（可选）。
	// InjectionRule 相关接口会使用 Credentials 进行认证。
	Credentials *auth.Credentials

	// Endpoint 是沙箱 API 服务地址（可选，默认值：DefaultEndpoint）。
	Endpoint string

	// HTTPClient 自定义 HTTP 客户端（可选，默认值：http.DefaultClient）。
	HTTPClient *http.Client
}

type ConfigOptions struct {
	GitOptions
	// Scope 是 git config 作用域，缺省为 GitConfigScopeGlobal。
	Scope GitConfigScope
	// Path 是仓库路径，仅在 Scope 为 GitConfigScopeLocal 时必填。
	Path string
}

type ConnectParams struct {
	// Timeout 超时时间（秒）。
	Timeout int32
}

type CreateInjectionRuleParams struct {
	// Name 规则名称（必填），同一用户下唯一。
	Name string

	// Injection 注入配置（必填）。
	Injection InjectionSpec
}

type CreateParams struct {
	// TemplateID 模板 ID（必填）。
	TemplateID string

	// Timeout 沙箱超时时间（秒），可选。
	Timeout *int32

	// AutoPause 超时后自动暂停，可选。
	AutoPause *bool

	// AllowInternetAccess 允许沙箱访问互联网，可选。
	AllowInternetAccess *bool

	// Secure 安全通信模式，可选。
	Secure *bool

	// EnvVars 环境变量，可选。
	EnvVars *map[string]string

	// Metadata 自定义元数据，可选。
	Metadata *Metadata

	// Network 网络配置，可选。
	Network *NetworkConfig

	// Injections 针对出站 HTTPS 请求的注入规则列表，可选。
	// 每项可引用已保存的注入规则 ID，或直接指定注入配置。
	Injections *[]SandboxInjectionSpec

	// Resources 沙箱启动前需挂载的资源列表，可选。
	// 平台会在沙箱启动前完成资源物化（如 GitHub 仓库克隆）。
	Resources *[]SandboxResourceSpec
}

type CreateTemplateParams struct {
	// Alias 模板别名（已废弃，请使用 Name）。
	Alias *string

	// CPUCount 沙箱 CPU 核数。
	CPUCount *int32

	// MemoryMB 沙箱内存大小（MiB）。
	MemoryMB *int32

	// Name 模板名称，可包含标签（如 "my-template" 或 "my-template:v1"）。
	Name *string

	// Tags 分配给模板构建的标签列表。
	Tags *[]string

	// TeamID 团队 ID（已废弃）。
	TeamID *string
}

type DeleteBranchOptions struct {
	GitOptions
	// Force 为 true 时使用 -D 强制删除分支。
	Force bool
}

type DeleteTagsParams struct {
	// Name 模板名称。
	Name string

	// Tags 要删除的标签列表。
	Tags []string
}

type EntryInfo struct {
	Name          string
	Type          FileType
	Path          string
	Size          int64
	Mode          uint32
	Permissions   string
	Owner         string
	Group         string
	ModifiedTime  time.Time
	SymlinkTarget *string
}

type EventType string

type FileType string

type FileURLOption func(*fileURLOpts)

type Filesystem struct {
	// contains filtered or unexported fields
}

type FilesystemEvent struct {
	Name string
	Type EventType
}

type FilesystemOption func(*filesystemOpts)

type FromImageRegistry = json.RawMessage

type GeminiInjection struct {
	// APIKey API 密钥，可选。
	APIKey *string

	// BaseURL 可选 base URL，未指定时使用 generativelanguage.googleapis.com。
	BaseURL *string
}

type GetBuildLogsParams struct {
	// Cursor 起始时间戳（毫秒）。
	Cursor *int64

	// Limit 返回的最大日志条数。
	Limit *int32

	// Direction 日志方向。
	Direction *LogsDirection

	// Level 日志级别过滤。
	Level *LogLevel

	// Source 日志来源过滤。
	Source *LogsSource
}

type GetBuildStatusParams struct {
	// LogsOffset 起始构建日志的索引。
	LogsOffset *int32

	// Limit 返回的最大日志条数。
	Limit *int32

	// Level 日志级别过滤。
	Level *LogLevel
}

type GetLogsParams struct {
	// Start 日志起始时间的毫秒级时间戳。
	Start *int64

	// Limit 返回的最大日志条数。
	Limit *int32
}

type GetMetricsParams struct {
	// Start 起始时间的 Unix 时间戳（秒）。
	Start *int64

	// End 结束时间的 Unix 时间戳（秒）。
	End *int64
}

type GetSandboxesMetricsParams struct {
	// SandboxIds 要获取指标的沙箱 ID 列表。
	SandboxIds []string
}

type GetTemplateParams struct {
	// NextToken 分页游标。
	NextToken *string

	// Limit 每页最大返回数。
	Limit *int32
}

type Git struct {
	// contains filtered or unexported fields
}

type GitAuthError struct {
	// Msg 是错误消息。
	Msg string
	// Err 是底层原始错误（可能是 errors.Join 聚合后的多个错误），用于 errors.Is/As 解包。
	Err error
}

type GitBranches struct {
	// Branches 是所有本地分支名。
	Branches []string
	// CurrentBranch 是当前分支名，HEAD 分离时为空。
	CurrentBranch string
}

type GitConfigScope string

type GitFileStatus struct {
	// Name 是相对于仓库根目录的路径。
	Name string
	// Status 是归一化后的状态字符串，例如 "modified"、"added"、"deleted"、"untracked"、"conflict" 等。
	Status string
	// IndexStatus 是 porcelain 输出中索引位的字符。
	IndexStatus string
	// WorkingTreeStatus 是 porcelain 输出中工作区位的字符。
	WorkingTreeStatus string
	// Staged 表示该文件是否已暂存。
	Staged bool
	// RenamedFrom 在文件被重命名时记录原路径。
	RenamedFrom string
}

type GitOptions struct {
	// Envs 是额外的环境变量。SDK 会自动注入 GIT_TERMINAL_PROMPT=0 以禁止交互式提示。
	Envs map[string]string
	// User 指定执行命令的用户，缺省使用 DefaultUser。
	User string
	// Cwd 指定工作目录。
	Cwd string
	// Timeout 指定命令超时时间。
	Timeout time.Duration
}

type GitRepositoryResource struct {
	// Type 仓库托管平台类型（必填）。当前仅支持 GitRepositoryTypeGithub。
	Type GitRepositoryType

	// URL 仓库 URL（HTTPS 或 SSH 形式），如
	// https://github.com/owner/repo.git 或 git@github.com:owner/repo.git。
	URL string

	// MountPath 仓库内容在沙箱内的绝对挂载路径。
	MountPath string

	// AuthorizationToken 用于克隆该仓库的访问 token。
	// 同一沙箱内多个仓库资源当前必须共用同一 token。
	AuthorizationToken *string
}

type GitRepositoryType string

type GitResetMode string

type GitStatus struct {
	// CurrentBranch 是当前分支名，HEAD 分离时为空。
	CurrentBranch string
	// Upstream 是上游分支名，未配置时为空。
	Upstream string
	// Ahead 是当前分支领先上游的提交数。
	Ahead int
	// Behind 是当前分支落后上游的提交数。
	Behind int
	// Detached 表示 HEAD 是否处于分离状态。
	Detached bool
	// FileStatus 是所有有变更的文件状态条目。
	FileStatus []GitFileStatus
}

type GitUpstreamError struct {
	// Msg 是错误消息。
	Msg string
	// Err 是底层原始错误（可能是 errors.Join 聚合后的多个错误），用于 errors.Is/As 解包。
	Err error
}

type GithubInjection struct {
	// Token GitHub token，对所有请求的仓库具备访问权限。
	Token *string
}

type HTTPInjection struct {
	// BaseURL 匹配 HTTPS 请求的 base URL。域名部分用于 host 匹配。
	// 若未指定 scheme 默认为 https。
	BaseURL string

	// Headers 需要注入或覆盖的 HTTP Headers，可选。
	Headers *map[string]string
}

type InitOptions struct {
	GitOptions
	// Bare 为 true 时创建 bare 仓库。
	Bare bool
	// InitialBranch 指定初始分支名（例如 "main"）。
	InitialBranch string
}

type InjectionRule struct {
	// RuleID 规则唯一标识。
	RuleID string

	// Name 规则名称，同一用户下唯一。
	Name string

	// Injection 注入配置。
	Injection InjectionSpec

	// CreatedAt 创建时间。
	CreatedAt time.Time

	// UpdatedAt 最后更新时间。
	UpdatedAt time.Time
}

type InjectionSpec struct {
	// OpenAI OpenAI 兼容 API 注入。
	OpenAI *OpenAIInjection

	// Anthropic Anthropic API 注入。
	Anthropic *AnthropicInjection

	// Gemini Google Gemini API 注入。
	Gemini *GeminiInjection

	// Qiniu 七牛 AI API 注入。
	Qiniu *QiniuInjection

	// Github GitHub 凭证注入。
	Github *GithubInjection

	// HTTP 自定义 HTTP 注入。
	HTTP *HTTPInjection
}

type InvalidArgumentError struct {
	// Msg 是错误消息。
	Msg string
}

type ListOption func(*listOpts)

type ListParams struct {
	// Metadata 用于过滤沙箱的元数据查询（如 "user=abc&app=prod"）。
	Metadata *string

	// State 按一个或多个状态过滤沙箱。
	State *[]SandboxState

	// NextToken 分页游标。
	NextToken *string

	// Limit 每页最大返回数。
	Limit *int32
}

type ListTemplatesParams struct {
	// TeamID 团队 ID。
	TeamID *string
}

type ListedSandbox struct {
	SandboxID   string
	TemplateID  string
	ClientID    string
	Alias       *string
	State       SandboxState
	CPUCount    int32
	MemoryMB    int32
	DiskSizeMB  int32
	EnvdVersion string
	StartedAt   time.Time
	EndAt       time.Time
	Metadata    *Metadata
}

type LogLevel string

type LogsDirection string

type LogsSource string

type ManageTagsParams struct {
	// Tags 要分配给模板的标签列表。
	Tags []string

	// Target 目标模板（格式："name:tag"）。
	Target string
}

type Metadata map[string]string

type NetworkConfig struct {
	// AllowOut 允许的出站流量 CIDR 列表。
	AllowOut *[]string

	// AllowPublicTraffic 是否允许公共流量访问沙箱 URL。
	AllowPublicTraffic *bool

	// DenyOut 拒绝的出站流量 CIDR 列表。
	DenyOut *[]string

	// MaskRequestHost 用于沙箱请求的 host 掩码。
	MaskRequestHost *string
}

type OpenAIInjection struct {
	// APIKey API 密钥，可选。
	APIKey *string

	// BaseURL 可选 base URL，未指定时使用 api.openai.com。
	BaseURL *string
}

type PollOption func(*pollOpts)

type ProcessInfo struct {
	PID  uint32
	Tag  *string
	Cmd  string
	Args []string
	Envs map[string]string
	Cwd  *string
}

type Pty struct {
	// contains filtered or unexported fields
}

type PtySize struct {
	Cols uint32
	Rows uint32
}

type PullOptions struct {
	GitOptions
	// Remote 指定远程名。
	Remote string
	// Branch 指定要拉取的分支名。
	Branch string
	// Username 是 HTTPS 认证的用户名。
	Username string
	// Password 是 HTTPS 认证的密码或 token。
	Password string
}

type PushOptions struct {
	GitOptions
	// Remote 指定远程名（例如 "origin"）。
	Remote string
	// Branch 指定要推送的分支名。
	Branch string
	// SetUpstream 控制是否附加 --set-upstream。
	// 为 nil 时按 SDK 默认（true，与 E2B 对齐）；显式设置为 false 可关闭。
	SetUpstream *bool
	// Username 是 HTTPS 认证的用户名。
	Username string
	// Password 是 HTTPS 认证的密码或 token。
	Password string
}

type QiniuInjection struct {
	// APIKey API 密钥。
	APIKey *string

	// BaseURL 可选 base URL，未指定时使用 api.qnaigc.com。
	BaseURL *string
}

type RebuildTemplateParams struct {
	// Dockerfile 必填，模板使用的 Dockerfile 内容。
	Dockerfile string

	// Alias 模板别名。
	Alias *string

	// CPUCount 沙箱 CPU 核数。
	CPUCount *int32

	// MemoryMB 沙箱内存大小（MiB）。
	MemoryMB *int32

	// StartCmd 构建完成后执行的启动命令。
	StartCmd *string

	// ReadyCmd 就绪检查命令。
	ReadyCmd *string

	// TeamID 团队 ID（已废弃）。
	TeamID *string
}

type RefreshParams struct {
	// Duration 延长的秒数，可选。
	Duration *int
}

type RemoteAddOptions struct {
	GitOptions
	// Fetch 为 true 时在添加 remote 后立即执行 fetch。
	Fetch bool
	// Overwrite 为 true 时，若 remote 已存在则覆盖其 URL。
	Overwrite bool
}

type ResetOptions struct {
	GitOptions
	// Mode 是重置模式，缺省时不传 --<mode> 参数。
	Mode GitResetMode
	// Target 是要重置到的提交、分支或引用，缺省为 HEAD。
	Target string
	// Paths 是要重置的路径列表。
	Paths []string
}

type RestoreOptions struct {
	GitOptions
	// Paths 是要恢复的路径列表，至少一个。
	Paths []string
	// Staged 为非 nil 时显式控制是否恢复索引。
	Staged *bool
	// Worktree 为非 nil 时显式控制是否恢复工作区。
	Worktree *bool
	// Source 指定从该提交或引用恢复。
	Source string
}

type Sandbox struct {
	// contains filtered or unexported fields
}

type SandboxInfo struct {
	SandboxID   string
	TemplateID  string
	ClientID    string
	Alias       *string
	Domain      *string
	State       SandboxState
	CPUCount    int32
	MemoryMB    int32
	DiskSizeMB  int32
	EnvdVersion string
	StartedAt   time.Time
	EndAt       time.Time
	Metadata    *Metadata
}

type SandboxInjectionSpec struct {
	// ByID 引用已保存的注入规则 ID。
	ByID *string

	// OpenAI OpenAI 兼容 API 注入。
	OpenAI *OpenAIInjection

	// Anthropic Anthropic API 注入。
	Anthropic *AnthropicInjection

	// Gemini Google Gemini API 注入。
	Gemini *GeminiInjection

	// Qiniu 七牛 AI API 注入。
	Qiniu *QiniuInjection

	// Github GitHub 凭证注入。
	Github *GithubInjection

	// HTTP 自定义 HTTP 注入。
	HTTP *HTTPInjection
}

type SandboxLog struct {
	Line      string
	Timestamp time.Time
}

type SandboxLogEntry struct {
	Level     LogLevel
	Message   string
	Fields    map[string]string
	Timestamp time.Time
}

type SandboxLogs struct {
	Logs       []SandboxLog
	LogEntries []SandboxLogEntry
}

type SandboxMetric struct {
	CPUCount      int32
	CPUUsedPct    float32
	MemTotal      int64
	MemUsed       int64
	DiskTotal     int64
	DiskUsed      int64
	Timestamp     time.Time
	TimestampUnix int64
}

type SandboxResourceSpec struct {
	// GitRepository GitHub 仓库资源。
	GitRepository *GitRepositoryResource
}

type SandboxState string

type SandboxesWithMetrics struct {
	Sandboxes map[string]SandboxMetric
}

type StartTemplateBuildParams struct {
	// Force 是否强制完整构建（忽略缓存）。
	Force *bool

	// FromImage 用作模板构建基础的镜像。
	FromImage *string

	// FromImageRegistry 镜像仓库认证配置。
	FromImageRegistry *FromImageRegistry

	// FromTemplate 用作模板构建基础的模板。
	FromTemplate *string

	// ReadyCmd 构建完成后执行的就绪检查命令。
	ReadyCmd *string

	// StartCmd 构建完成后执行的启动命令。
	StartCmd *string

	// Steps 模板构建步骤列表。
	Steps *[]TemplateStep
}

type Template struct {
	TemplateID    string
	Aliases       []string
	BuildID       string
	BuildStatus   TemplateBuildStatus
	BuildCount    int32
	CPUCount      int32
	MemoryMB      int32
	DiskSizeMB    int32
	EnvdVersion   string
	Public        bool
	SpawnCount    int64
	CreatedAt     time.Time
	UpdatedAt     time.Time
	LastSpawnedAt *time.Time
}

type TemplateAliasResponse struct {
	TemplateID string
	Public     bool
}

type TemplateBuild struct {
	BuildID     string
	Status      TemplateBuildStatus
	CPUCount    int32
	MemoryMB    int32
	DiskSizeMB  *int32
	EnvdVersion *string
	CreatedAt   time.Time
	UpdatedAt   time.Time
	FinishedAt  *time.Time
}

type TemplateBuildFileUpload struct {
	// Present 文件是否已存在。
	Present bool
	// URL 上传地址。
	URL *string
}

type TemplateBuildInfo struct {
	TemplateID string
	BuildID    string
	Status     TemplateBuildStatus
	Logs       []string
}

type TemplateBuildLogs struct {
	Logs []BuildLogEntry
}

type TemplateBuildStatus string

type TemplateCreateResponse struct {
	TemplateID string
	BuildID    string
	Aliases    []string
	Names      []string
	Tags       []string
	Public     bool
}

type TemplateStep struct {
	// Args 步骤参数。
	Args *[]string

	// FilesHash 步骤中使用文件的哈希值。
	FilesHash *string

	// Force 是否强制执行（忽略缓存）。
	Force *bool

	// Type 步骤类型。
	Type string
}

type TemplateWithBuilds struct {
	TemplateID    string
	Aliases       []string
	Public        bool
	SpawnCount    int64
	CreatedAt     time.Time
	UpdatedAt     time.Time
	LastSpawnedAt *time.Time
	Builds        []TemplateBuild
}

type UpdateInjectionRuleParams struct {
	// Name 规则名称，可选。
	Name *string

	// Injection 注入配置，可选。
	Injection *InjectionSpec
}

type UpdateTemplateParams struct {
	// Public 模板是否公开。
	Public *bool
}

type WatchHandle struct {
	// contains filtered or unexported fields
}

type WatchOption func(*watchOpts)

type WriteEntry struct {
	Path string
	Data []byte
}