2022-04-28 16:59:14 +00:00
|
|
|
// Code generated by 'make coder/scripts/apitypings/main.go'. DO NOT EDIT.
|
2022-04-19 00:45:22 +00:00
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/workspaceagents.go:35:6
|
|
|
|
export interface AWSInstanceIdentityToken {
|
|
|
|
readonly signature: string
|
|
|
|
readonly document: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/gitsshkey.go:21:6
|
2022-04-19 00:45:22 +00:00
|
|
|
export interface AgentGitSSHKey {
|
2022-04-25 05:29:15 +00:00
|
|
|
readonly public_key: string
|
2022-04-19 00:45:22 +00:00
|
|
|
readonly private_key: string
|
|
|
|
}
|
|
|
|
|
2022-05-06 14:20:08 +00:00
|
|
|
// From codersdk/users.go:109:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface AuthMethods {
|
|
|
|
readonly password: boolean
|
|
|
|
readonly github: boolean
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/workspaceagents.go:40:6
|
|
|
|
export interface AzureInstanceIdentityToken {
|
|
|
|
readonly signature: string
|
|
|
|
readonly encoding: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/buildinfo.go:10:6
|
|
|
|
export interface BuildInfoResponse {
|
|
|
|
readonly external_url: string
|
|
|
|
readonly version: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-29 13:29:53 +00:00
|
|
|
// From codersdk/users.go:50:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface CreateFirstUserRequest {
|
|
|
|
readonly email: string
|
|
|
|
readonly username: string
|
|
|
|
readonly password: string
|
|
|
|
readonly organization: string
|
2022-04-25 21:11:03 +00:00
|
|
|
}
|
|
|
|
|
2022-04-29 13:29:53 +00:00
|
|
|
// From codersdk/users.go:58:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface CreateFirstUserResponse {
|
|
|
|
readonly user_id: string
|
|
|
|
readonly organization_id: string
|
|
|
|
}
|
|
|
|
|
2022-05-06 14:20:08 +00:00
|
|
|
// From codersdk/users.go:104:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface CreateOrganizationRequest {
|
2022-04-19 00:45:22 +00:00
|
|
|
readonly name: string
|
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/parameters.go:38:6
|
2022-04-19 00:45:22 +00:00
|
|
|
export interface CreateParameterRequest {
|
|
|
|
readonly name: string
|
|
|
|
readonly source_value: string
|
2022-04-28 16:59:14 +00:00
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterSourceScheme")
|
|
|
|
readonly source_scheme: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterDestinationScheme")
|
|
|
|
readonly destination_scheme: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/organizations.go:38:6
|
|
|
|
export interface CreateTemplateRequest {
|
|
|
|
readonly name: string
|
|
|
|
readonly template_version_id: string
|
|
|
|
readonly parameter_values: CreateParameterRequest[]
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/organizations.go:25:6
|
|
|
|
export interface CreateTemplateVersionRequest {
|
|
|
|
readonly template_id: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ProvisionerStorageMethod")
|
|
|
|
readonly storage_method: string
|
|
|
|
readonly storage_source: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ProvisionerType")
|
|
|
|
readonly provisioner: string
|
|
|
|
readonly parameter_values: CreateParameterRequest[]
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-29 13:29:53 +00:00
|
|
|
// From codersdk/users.go:63:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface CreateUserRequest {
|
|
|
|
readonly email: string
|
|
|
|
readonly username: string
|
|
|
|
readonly password: string
|
|
|
|
readonly organization_id: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/workspaces.go:33:6
|
|
|
|
export interface CreateWorkspaceBuildRequest {
|
|
|
|
readonly template_version_id: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.WorkspaceTransition")
|
|
|
|
readonly transition: string
|
|
|
|
readonly dry_run: boolean
|
2022-05-03 12:48:02 +00:00
|
|
|
readonly state: string
|
2022-04-22 20:27:55 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/organizations.go:52:6
|
|
|
|
export interface CreateWorkspaceRequest {
|
|
|
|
readonly template_id: string
|
|
|
|
readonly name: string
|
|
|
|
readonly parameter_values: CreateParameterRequest[]
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-05-06 14:20:08 +00:00
|
|
|
// From codersdk/users.go:100:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface GenerateAPIKeyResponse {
|
|
|
|
readonly key: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/gitsshkey.go:14:6
|
|
|
|
export interface GitSSHKey {
|
|
|
|
readonly user_id: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly updated_at: string
|
|
|
|
readonly public_key: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/workspaceagents.go:31:6
|
|
|
|
export interface GoogleInstanceIdentityToken {
|
|
|
|
readonly json_web_token: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-05-06 14:20:08 +00:00
|
|
|
// From codersdk/users.go:89:6
|
2022-04-19 00:45:22 +00:00
|
|
|
export interface LoginWithPasswordRequest {
|
|
|
|
readonly email: string
|
|
|
|
readonly password: string
|
|
|
|
}
|
|
|
|
|
2022-05-06 14:20:08 +00:00
|
|
|
// From codersdk/users.go:95:6
|
2022-04-19 00:45:22 +00:00
|
|
|
export interface LoginWithPasswordResponse {
|
|
|
|
readonly session_token: string
|
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/organizations.go:17:6
|
|
|
|
export interface Organization {
|
|
|
|
readonly id: string
|
|
|
|
readonly name: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly updated_at: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-29 14:04:19 +00:00
|
|
|
// From codersdk/organizationmember.go:9:6
|
|
|
|
export interface OrganizationMember {
|
|
|
|
readonly user_id: string
|
|
|
|
readonly organization_id: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly updated_at: string
|
|
|
|
readonly roles: string[]
|
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/parameters.go:26:6
|
|
|
|
export interface Parameter {
|
|
|
|
readonly id: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly updated_at: string
|
|
|
|
readonly scope: ParameterScope
|
|
|
|
readonly scope_id: string
|
2022-04-19 00:45:22 +00:00
|
|
|
readonly name: string
|
2022-04-28 16:59:14 +00:00
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterSourceScheme")
|
|
|
|
readonly source_scheme: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterDestinationScheme")
|
|
|
|
readonly destination_scheme: string
|
|
|
|
}
|
|
|
|
|
|
|
|
// From codersdk/provisionerdaemons.go:23:6
|
|
|
|
export interface ProvisionerDaemon {
|
|
|
|
readonly id: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly updated_at?: string
|
|
|
|
readonly organization_id?: string
|
|
|
|
readonly name: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ProvisionerType")
|
|
|
|
readonly provisioners: string[]
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/provisionerdaemons.go:46:6
|
|
|
|
export interface ProvisionerJob {
|
|
|
|
readonly id: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly started_at?: string
|
|
|
|
readonly completed_at?: string
|
|
|
|
readonly error: string
|
|
|
|
readonly status: ProvisionerJobStatus
|
|
|
|
readonly worker_id?: string
|
2022-04-23 22:58:57 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/provisionerdaemons.go:56:6
|
|
|
|
export interface ProvisionerJobLog {
|
|
|
|
readonly id: string
|
|
|
|
readonly created_at: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.LogSource")
|
|
|
|
readonly log_source: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.LogLevel")
|
|
|
|
readonly log_level: string
|
|
|
|
readonly stage: string
|
|
|
|
readonly output: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/templates.go:17:6
|
|
|
|
export interface Template {
|
|
|
|
readonly id: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly updated_at: string
|
|
|
|
readonly organization_id: string
|
|
|
|
readonly name: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ProvisionerType")
|
|
|
|
readonly provisioner: string
|
|
|
|
readonly active_version_id: string
|
|
|
|
readonly workspace_owner_count: number
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/templateversions.go:17:6
|
|
|
|
export interface TemplateVersion {
|
|
|
|
readonly id: string
|
|
|
|
readonly template_id?: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly updated_at: string
|
|
|
|
readonly name: string
|
|
|
|
readonly job: ProvisionerJob
|
2022-04-19 13:48:13 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/templateversions.go:30:6
|
|
|
|
export interface TemplateVersionParameter {
|
|
|
|
// Named type "github.com/coder/coder/coderd/database.ParameterValue" unknown, using "any"
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
|
|
readonly ParameterValue: any
|
|
|
|
readonly schema_id: string
|
|
|
|
readonly default_source_value: boolean
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/templateversions.go:27:6
|
|
|
|
export interface TemplateVersionParameterSchema {
|
|
|
|
readonly id: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly job_id: string
|
2022-04-19 00:45:22 +00:00
|
|
|
readonly name: string
|
2022-04-28 16:59:14 +00:00
|
|
|
readonly description: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterSourceScheme")
|
|
|
|
readonly default_source_scheme: string
|
|
|
|
readonly default_source_value: string
|
|
|
|
readonly allow_override_source: boolean
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterDestinationScheme")
|
|
|
|
readonly default_destination_scheme: string
|
|
|
|
readonly allow_override_destination: boolean
|
|
|
|
readonly default_refresh: string
|
|
|
|
readonly redisplay_value: boolean
|
|
|
|
readonly validation_error: string
|
|
|
|
readonly validation_condition: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.ParameterTypeSystem")
|
|
|
|
readonly validation_type_system: string
|
|
|
|
readonly validation_value_type: string
|
|
|
|
}
|
|
|
|
|
|
|
|
// From codersdk/templates.go:28:6
|
|
|
|
export interface UpdateActiveTemplateVersion {
|
|
|
|
readonly id: string
|
|
|
|
}
|
|
|
|
|
2022-05-06 14:20:08 +00:00
|
|
|
// From codersdk/users.go:79:6
|
2022-04-29 14:04:19 +00:00
|
|
|
export interface UpdateRoles {
|
|
|
|
readonly roles: string[]
|
|
|
|
}
|
|
|
|
|
2022-05-06 14:20:08 +00:00
|
|
|
// From codersdk/users.go:75:6
|
|
|
|
export interface UpdateUserPasswordRequest {
|
|
|
|
readonly password: string
|
|
|
|
}
|
|
|
|
|
2022-04-29 13:29:53 +00:00
|
|
|
// From codersdk/users.go:70:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface UpdateUserProfileRequest {
|
|
|
|
readonly email: string
|
|
|
|
readonly username: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-05-03 12:48:02 +00:00
|
|
|
// From codersdk/workspaces.go:95:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface UpdateWorkspaceAutostartRequest {
|
|
|
|
readonly schedule: string
|
|
|
|
}
|
|
|
|
|
2022-05-03 12:48:02 +00:00
|
|
|
// From codersdk/workspaces.go:115:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface UpdateWorkspaceAutostopRequest {
|
|
|
|
readonly schedule: string
|
|
|
|
}
|
|
|
|
|
|
|
|
// From codersdk/files.go:16:6
|
|
|
|
export interface UploadResponse {
|
|
|
|
readonly hash: string
|
|
|
|
}
|
|
|
|
|
2022-04-29 13:29:53 +00:00
|
|
|
// From codersdk/users.go:41:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface User {
|
|
|
|
readonly id: string
|
|
|
|
readonly email: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly username: string
|
|
|
|
readonly status: UserStatus
|
|
|
|
readonly organization_ids: string[]
|
|
|
|
}
|
|
|
|
|
2022-05-06 14:20:08 +00:00
|
|
|
// From codersdk/users.go:83:6
|
2022-04-29 14:04:19 +00:00
|
|
|
export interface UserRoles {
|
|
|
|
readonly roles: string[]
|
|
|
|
readonly organization_roles: Record<string, string[]>
|
|
|
|
}
|
|
|
|
|
2022-04-29 13:29:53 +00:00
|
|
|
// From codersdk/users.go:24:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface UsersRequest {
|
|
|
|
readonly after_user: string
|
|
|
|
readonly search: string
|
|
|
|
readonly limit: number
|
|
|
|
readonly offset: number
|
2022-04-29 13:29:53 +00:00
|
|
|
readonly status: string
|
2022-04-28 16:59:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// From codersdk/workspaces.go:18:6
|
|
|
|
export interface Workspace {
|
|
|
|
readonly id: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly updated_at: string
|
|
|
|
readonly owner_id: string
|
|
|
|
readonly template_id: string
|
|
|
|
readonly template_name: string
|
|
|
|
readonly latest_build: WorkspaceBuild
|
|
|
|
readonly outdated: boolean
|
2022-04-19 00:45:22 +00:00
|
|
|
readonly name: string
|
2022-04-28 16:59:14 +00:00
|
|
|
readonly autostart_schedule: string
|
|
|
|
readonly autostop_schedule: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/workspaceresources.go:33:6
|
2022-04-19 00:45:22 +00:00
|
|
|
export interface WorkspaceAgent {
|
2022-04-28 16:59:14 +00:00
|
|
|
readonly id: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly updated_at: string
|
|
|
|
readonly first_connected_at?: string
|
|
|
|
readonly last_connected_at?: string
|
|
|
|
readonly disconnected_at?: string
|
2022-04-19 00:45:22 +00:00
|
|
|
readonly status: WorkspaceAgentStatus
|
|
|
|
readonly name: string
|
2022-04-28 16:59:14 +00:00
|
|
|
readonly resource_id: string
|
2022-04-19 00:45:22 +00:00
|
|
|
readonly instance_id: string
|
|
|
|
readonly architecture: string
|
2022-04-28 16:59:14 +00:00
|
|
|
readonly environment_variables: Record<string, string>
|
2022-04-19 00:45:22 +00:00
|
|
|
readonly operating_system: string
|
|
|
|
readonly startup_script: string
|
2022-05-02 15:27:34 +00:00
|
|
|
readonly directory: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/workspaceagents.go:47:6
|
|
|
|
export interface WorkspaceAgentAuthenticateResponse {
|
|
|
|
readonly session_token: string
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-05-02 15:27:34 +00:00
|
|
|
// From codersdk/workspaceresources.go:59:6
|
2022-04-19 00:45:22 +00:00
|
|
|
export interface WorkspaceAgentInstanceMetadata {
|
|
|
|
readonly jail_orchestrator: string
|
|
|
|
readonly operating_system: string
|
|
|
|
readonly platform: string
|
|
|
|
readonly platform_family: string
|
|
|
|
readonly kernel_version: string
|
|
|
|
readonly kernel_architecture: string
|
|
|
|
readonly cloud: string
|
|
|
|
readonly jail: string
|
|
|
|
readonly vnc: boolean
|
|
|
|
}
|
|
|
|
|
2022-05-02 15:27:34 +00:00
|
|
|
// From codersdk/workspaceresources.go:51:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface WorkspaceAgentResourceMetadata {
|
|
|
|
readonly memory_total: number
|
|
|
|
readonly disk_total: number
|
|
|
|
readonly cpu_cores: number
|
|
|
|
readonly cpu_model: string
|
|
|
|
readonly cpu_mhz: number
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-05-03 12:48:02 +00:00
|
|
|
// From codersdk/workspacebuilds.go:18:6
|
2022-04-28 16:59:14 +00:00
|
|
|
export interface WorkspaceBuild {
|
|
|
|
readonly id: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly updated_at: string
|
|
|
|
readonly workspace_id: string
|
|
|
|
readonly template_version_id: string
|
|
|
|
readonly before_id: string
|
|
|
|
readonly after_id: string
|
|
|
|
readonly name: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.WorkspaceTransition")
|
|
|
|
readonly transition: string
|
|
|
|
readonly initiator_id: string
|
|
|
|
readonly job: ProvisionerJob
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/workspaceresources.go:23:6
|
|
|
|
export interface WorkspaceResource {
|
|
|
|
readonly id: string
|
|
|
|
readonly created_at: string
|
|
|
|
readonly job_id: string
|
|
|
|
// This is likely an enum in an external package ("github.com/coder/coder/coderd/database.WorkspaceTransition")
|
|
|
|
readonly workspace_transition: string
|
|
|
|
readonly type: string
|
|
|
|
readonly name: string
|
|
|
|
readonly agents: WorkspaceAgent[]
|
2022-04-19 00:45:22 +00:00
|
|
|
}
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/parameters.go:16:6
|
2022-04-19 00:45:22 +00:00
|
|
|
export type ParameterScope = "organization" | "template" | "user" | "workspace"
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/provisionerdaemons.go:26:6
|
|
|
|
export type ProvisionerJobStatus = "canceled" | "canceling" | "failed" | "pending" | "running" | "succeeded"
|
2022-04-19 02:03:37 +00:00
|
|
|
|
2022-04-29 13:29:53 +00:00
|
|
|
// From codersdk/users.go:17:6
|
2022-04-26 14:00:07 +00:00
|
|
|
export type UserStatus = "active" | "suspended"
|
|
|
|
|
2022-04-28 16:59:14 +00:00
|
|
|
// From codersdk/workspaceresources.go:15:6
|
|
|
|
export type WorkspaceAgentStatus = "connected" | "connecting" | "disconnected"
|