forked from coder/coder
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtypesGenerated.ts
More file actions
1304 lines (1153 loc) · 34.6 KB
/
typesGenerated.ts
File metadata and controls
1304 lines (1153 loc) · 34.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by 'make site/src/api/typesGenerated.ts'. DO NOT EDIT.
// From codersdk/apikey.go
export interface APIKey {
readonly id: string
readonly user_id: string
readonly last_used: string
readonly expires_at: string
readonly created_at: string
readonly updated_at: string
readonly login_type: LoginType
readonly scope: APIKeyScope
readonly lifetime_seconds: number
}
// From codersdk/licenses.go
export interface AddLicenseRequest {
readonly license: string
}
// From codersdk/templates.go
export interface AgentStatsReportResponse {
readonly num_comms: number
readonly rx_bytes: number
readonly tx_bytes: number
}
// From codersdk/deployment.go
export interface AppHostResponse {
readonly host: string
}
// From codersdk/deployment.go
export interface AppearanceConfig {
readonly logo_url: string
readonly service_banner: ServiceBannerConfig
}
// From codersdk/roles.go
export interface AssignableRoles extends Role {
readonly assignable: boolean
}
// From codersdk/audit.go
export type AuditDiff = Record<string, AuditDiffField>
// From codersdk/audit.go
export interface AuditDiffField {
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO explain why this is needed
readonly old?: any
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO explain why this is needed
readonly new?: any
readonly secret: boolean
}
// From codersdk/audit.go
export interface AuditLog {
readonly id: string
readonly request_id: string
readonly time: string
readonly organization_id: string
// Named type "net/netip.Addr" unknown, using "any"
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO explain why this is needed
readonly ip: any
readonly user_agent: string
readonly resource_type: ResourceType
readonly resource_id: string
readonly resource_target: string
readonly resource_icon: string
readonly action: AuditAction
readonly diff: AuditDiff
readonly status_code: number
readonly additional_fields: Record<string, string>
readonly description: string
readonly resource_link: string
readonly is_deleted: boolean
readonly user?: User
}
// From codersdk/audit.go
export interface AuditLogResponse {
readonly audit_logs: AuditLog[]
readonly count: number
}
// From codersdk/audit.go
export interface AuditLogsRequest extends Pagination {
readonly q?: string
}
// From codersdk/users.go
export interface AuthMethod {
readonly enabled: boolean
}
// From codersdk/users.go
export interface AuthMethods {
readonly password: AuthMethod
readonly github: AuthMethod
readonly oidc: OIDCAuthMethod
}
// From codersdk/authorization.go
export interface AuthorizationCheck {
readonly object: AuthorizationObject
readonly action: string
}
// From codersdk/authorization.go
export interface AuthorizationObject {
readonly resource_type: string
readonly owner_id?: string
readonly organization_id?: string
readonly resource_id?: string
}
// From codersdk/authorization.go
export interface AuthorizationRequest {
readonly checks: Record<string, AuthorizationCheck>
}
// From codersdk/authorization.go
export type AuthorizationResponse = Record<string, boolean>
// From codersdk/deployment.go
export interface BuildInfoResponse {
readonly external_url: string
readonly version: string
}
// From codersdk/parameters.go
export interface ComputedParameter extends Parameter {
readonly source_value: string
readonly schema_id: string
readonly default_source_value: boolean
}
// From codersdk/users.go
export interface CreateFirstUserRequest {
readonly email: string
readonly username: string
readonly password: string
readonly trial: boolean
}
// From codersdk/users.go
export interface CreateFirstUserResponse {
readonly user_id: string
readonly organization_id: string
}
// From codersdk/groups.go
export interface CreateGroupRequest {
readonly name: string
readonly avatar_url: string
readonly quota_allowance: number
}
// From codersdk/users.go
export interface CreateOrganizationRequest {
readonly name: string
}
// From codersdk/parameters.go
export interface CreateParameterRequest {
readonly copy_from_parameter?: string
readonly name: string
readonly source_value: string
readonly source_scheme: ParameterSourceScheme
readonly destination_scheme: ParameterDestinationScheme
}
// From codersdk/organizations.go
export interface CreateTemplateRequest {
readonly name: string
readonly display_name?: string
readonly description?: string
readonly icon?: string
readonly template_version_id: string
readonly parameter_values?: CreateParameterRequest[]
readonly default_ttl_ms?: number
readonly allow_user_cancel_workspace_jobs?: boolean
}
// From codersdk/templateversions.go
export interface CreateTemplateVersionDryRunRequest {
readonly workspace_name: string
readonly parameter_values: CreateParameterRequest[]
readonly rich_parameter_values: WorkspaceBuildParameter[]
}
// From codersdk/organizations.go
export interface CreateTemplateVersionRequest {
readonly name?: string
readonly template_id?: string
readonly storage_method: ProvisionerStorageMethod
readonly file_id?: string
readonly example_id?: string
readonly provisioner: ProvisionerType
readonly tags: Record<string, string>
readonly parameter_values?: CreateParameterRequest[]
}
// From codersdk/audit.go
export interface CreateTestAuditLogRequest {
readonly action?: AuditAction
readonly resource_type?: ResourceType
readonly resource_id?: string
readonly additional_fields?: Record<string, string>
readonly time?: string
readonly build_reason?: BuildReason
}
// From codersdk/apikey.go
export interface CreateTokenRequest {
// This is likely an enum in an external package ("time.Duration")
readonly lifetime: number
readonly scope: APIKeyScope
}
// From codersdk/users.go
export interface CreateUserRequest {
readonly email: string
readonly username: string
readonly password: string
readonly organization_id: string
}
// From codersdk/workspaces.go
export interface CreateWorkspaceBuildRequest {
readonly template_version_id?: string
readonly transition: WorkspaceTransition
readonly dry_run?: boolean
readonly state?: string
readonly orphan?: boolean
readonly parameter_values?: CreateParameterRequest[]
readonly rich_parameter_values?: WorkspaceBuildParameter[]
}
// From codersdk/organizations.go
export interface CreateWorkspaceRequest {
readonly template_id: string
readonly name: string
readonly autostart_schedule?: string
readonly ttl_ms?: number
readonly parameter_values?: CreateParameterRequest[]
readonly rich_parameter_values?: WorkspaceBuildParameter[]
}
// From codersdk/templates.go
export interface DAUEntry {
readonly date: string
readonly amount: number
}
// From codersdk/deployment.go
export interface DERP {
readonly server: DERPServerConfig
readonly config: DERPConfig
}
// From codersdk/deployment.go
export interface DERPConfig {
readonly url: DeploymentConfigField<string>
readonly path: DeploymentConfigField<string>
}
// From codersdk/workspaceagents.go
export interface DERPRegion {
readonly preferred: boolean
readonly latency_ms: number
}
// From codersdk/deployment.go
export interface DERPServerConfig {
readonly enable: DeploymentConfigField<boolean>
readonly region_id: DeploymentConfigField<number>
readonly region_code: DeploymentConfigField<string>
readonly region_name: DeploymentConfigField<string>
readonly stun_addresses: DeploymentConfigField<string[]>
readonly relay_url: DeploymentConfigField<string>
}
// From codersdk/deployment.go
export interface DangerousConfig {
readonly allow_path_app_sharing: DeploymentConfigField<boolean>
readonly allow_path_app_site_owner_access: DeploymentConfigField<boolean>
}
// From codersdk/deployment.go
export interface DeploymentConfig {
readonly access_url: DeploymentConfigField<string>
readonly wildcard_access_url: DeploymentConfigField<string>
readonly redirect_to_access_url: DeploymentConfigField<boolean>
readonly http_address: DeploymentConfigField<string>
readonly autobuild_poll_interval: DeploymentConfigField<number>
readonly derp: DERP
readonly gitauth: DeploymentConfigField<GitAuthConfig[]>
readonly prometheus: PrometheusConfig
readonly pprof: PprofConfig
readonly proxy_trusted_headers: DeploymentConfigField<string[]>
readonly proxy_trusted_origins: DeploymentConfigField<string[]>
readonly cache_directory: DeploymentConfigField<string>
readonly in_memory_database: DeploymentConfigField<boolean>
readonly pg_connection_url: DeploymentConfigField<string>
readonly oauth2: OAuth2Config
readonly oidc: OIDCConfig
readonly telemetry: TelemetryConfig
readonly tls: TLSConfig
readonly trace: TraceConfig
readonly secure_auth_cookie: DeploymentConfigField<boolean>
readonly ssh_keygen_algorithm: DeploymentConfigField<string>
readonly metrics_cache_refresh_interval: DeploymentConfigField<number>
readonly agent_stat_refresh_interval: DeploymentConfigField<number>
readonly agent_fallback_troubleshooting_url: DeploymentConfigField<string>
readonly audit_logging: DeploymentConfigField<boolean>
readonly browser_only: DeploymentConfigField<boolean>
readonly scim_api_key: DeploymentConfigField<string>
readonly provisioner: ProvisionerConfig
readonly rate_limit: RateLimitConfig
readonly experiments: DeploymentConfigField<string[]>
readonly update_check: DeploymentConfigField<boolean>
readonly max_token_lifetime: DeploymentConfigField<number>
readonly swagger: SwaggerConfig
readonly logging: LoggingConfig
readonly dangerous: DangerousConfig
readonly disable_path_apps: DeploymentConfigField<boolean>
readonly max_session_expiry: DeploymentConfigField<number>
readonly disable_session_expiry_refresh: DeploymentConfigField<boolean>
readonly disable_password_auth: DeploymentConfigField<boolean>
readonly address: DeploymentConfigField<string>
readonly experimental: DeploymentConfigField<boolean>
}
// From codersdk/deployment.go
export interface DeploymentConfigField<T extends Flaggable> {
readonly name: string
readonly usage: string
readonly flag: string
readonly shorthand: string
readonly enterprise: boolean
readonly hidden: boolean
readonly secret: boolean
readonly default: T
readonly value: T
}
// From codersdk/deployment.go
export interface DeploymentDAUsResponse {
readonly entries: DAUEntry[]
}
// From codersdk/deployment.go
export interface Entitlements {
readonly features: Record<FeatureName, Feature>
readonly warnings: string[]
readonly errors: string[]
readonly has_license: boolean
readonly trial: boolean
readonly experimental: boolean
}
// From codersdk/deployment.go
export type Experiments = Experiment[]
// From codersdk/deployment.go
export interface Feature {
readonly entitlement: Entitlement
readonly enabled: boolean
readonly limit?: number
readonly actual?: number
}
// From codersdk/apikey.go
export interface GenerateAPIKeyResponse {
readonly key: string
}
// From codersdk/users.go
export interface GetUsersResponse {
readonly users: User[]
readonly count: number
}
// From codersdk/deployment.go
export interface GitAuthConfig {
readonly id: string
readonly type: string
readonly client_id: string
readonly auth_url: string
readonly token_url: string
readonly validate_url: string
readonly regex: string
readonly no_refresh: boolean
readonly scopes: string[]
}
// From codersdk/gitsshkey.go
export interface GitSSHKey {
readonly user_id: string
readonly created_at: string
readonly updated_at: string
readonly public_key: string
}
// From codersdk/groups.go
export interface Group {
readonly id: string
readonly name: string
readonly organization_id: string
readonly members: User[]
readonly avatar_url: string
readonly quota_allowance: number
}
// From codersdk/workspaceapps.go
export interface Healthcheck {
readonly url: string
readonly interval: number
readonly threshold: number
}
// From codersdk/licenses.go
export interface License {
readonly id: number
readonly uuid: string
readonly uploaded_at: string
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO explain why this is needed
readonly claims: Record<string, any>
}
// From codersdk/deployment.go
export interface LoggingConfig {
readonly human: DeploymentConfigField<string>
readonly json: DeploymentConfigField<string>
readonly stackdriver: DeploymentConfigField<string>
}
// From codersdk/users.go
export interface LoginWithPasswordRequest {
readonly email: string
readonly password: string
}
// From codersdk/users.go
export interface LoginWithPasswordResponse {
readonly session_token: string
}
// From codersdk/deployment.go
export interface OAuth2Config {
readonly github: OAuth2GithubConfig
}
// From codersdk/deployment.go
export interface OAuth2GithubConfig {
readonly client_id: DeploymentConfigField<string>
readonly client_secret: DeploymentConfigField<string>
readonly allowed_orgs: DeploymentConfigField<string[]>
readonly allowed_teams: DeploymentConfigField<string[]>
readonly allow_signups: DeploymentConfigField<boolean>
readonly allow_everyone: DeploymentConfigField<boolean>
readonly enterprise_base_url: DeploymentConfigField<string>
}
// From codersdk/users.go
export interface OIDCAuthMethod extends AuthMethod {
readonly signInText: string
readonly iconUrl: string
}
// From codersdk/deployment.go
export interface OIDCConfig {
readonly allow_signups: DeploymentConfigField<boolean>
readonly client_id: DeploymentConfigField<string>
readonly client_secret: DeploymentConfigField<string>
readonly email_domain: DeploymentConfigField<string[]>
readonly issuer_url: DeploymentConfigField<string>
readonly scopes: DeploymentConfigField<string[]>
readonly ignore_email_verified: DeploymentConfigField<boolean>
readonly username_field: DeploymentConfigField<string>
readonly sign_in_text: DeploymentConfigField<string>
readonly icon_url: DeploymentConfigField<string>
}
// From codersdk/organizations.go
export interface Organization {
readonly id: string
readonly name: string
readonly created_at: string
readonly updated_at: string
}
// From codersdk/organizations.go
export interface OrganizationMember {
readonly user_id: string
readonly organization_id: string
readonly created_at: string
readonly updated_at: string
readonly roles: Role[]
}
// From codersdk/pagination.go
export interface Pagination {
readonly after_id?: string
readonly limit?: number
readonly offset?: number
}
// From codersdk/parameters.go
export interface Parameter {
readonly id: string
readonly scope: ParameterScope
readonly scope_id: string
readonly name: string
readonly source_scheme: ParameterSourceScheme
readonly destination_scheme: ParameterDestinationScheme
readonly created_at: string
readonly updated_at: string
}
// From codersdk/parameters.go
export interface ParameterSchema {
readonly id: string
readonly created_at: string
readonly job_id: string
readonly name: string
readonly description: string
readonly default_source_scheme: ParameterSourceScheme
readonly default_source_value: string
readonly allow_override_source: boolean
readonly default_destination_scheme: ParameterDestinationScheme
readonly allow_override_destination: boolean
readonly default_refresh: string
readonly redisplay_value: boolean
readonly validation_error: string
readonly validation_condition: string
readonly validation_type_system: string
readonly validation_value_type: string
readonly validation_contains?: string[]
}
// From codersdk/groups.go
export interface PatchGroupRequest {
readonly add_users: string[]
readonly remove_users: string[]
readonly name: string
readonly avatar_url?: string
readonly quota_allowance?: number
}
// From codersdk/deployment.go
export interface PprofConfig {
readonly enable: DeploymentConfigField<boolean>
readonly address: DeploymentConfigField<string>
}
// From codersdk/deployment.go
export interface PrometheusConfig {
readonly enable: DeploymentConfigField<boolean>
readonly address: DeploymentConfigField<string>
}
// From codersdk/deployment.go
export interface ProvisionerConfig {
readonly daemons: DeploymentConfigField<number>
readonly daemon_poll_interval: DeploymentConfigField<number>
readonly daemon_poll_jitter: DeploymentConfigField<number>
readonly force_cancel_interval: DeploymentConfigField<number>
}
// From codersdk/provisionerdaemons.go
export interface ProvisionerDaemon {
readonly id: string
readonly created_at: string
readonly updated_at?: string
readonly name: string
readonly provisioners: ProvisionerType[]
readonly tags: Record<string, string>
}
// From codersdk/provisionerdaemons.go
export interface ProvisionerJob {
readonly id: string
readonly created_at: string
readonly started_at?: string
readonly completed_at?: string
readonly canceled_at?: string
readonly error?: string
readonly status: ProvisionerJobStatus
readonly worker_id?: string
readonly file_id: string
readonly tags: Record<string, string>
}
// From codersdk/provisionerdaemons.go
export interface ProvisionerJobLog {
readonly id: number
readonly created_at: string
readonly log_source: LogSource
readonly log_level: LogLevel
readonly stage: string
readonly output: string
}
// From codersdk/workspaces.go
export interface PutExtendWorkspaceRequest {
readonly deadline: string
}
// From codersdk/deployment.go
export interface RateLimitConfig {
readonly disable_all: DeploymentConfigField<boolean>
readonly api: DeploymentConfigField<number>
}
// From codersdk/replicas.go
export interface Replica {
readonly id: string
readonly hostname: string
readonly created_at: string
readonly relay_address: string
readonly region_id: number
readonly error: string
readonly database_latency: number
}
// From codersdk/client.go
export interface Response {
readonly message: string
readonly detail?: string
readonly validations?: ValidationError[]
}
// From codersdk/roles.go
export interface Role {
readonly name: string
readonly display_name: string
}
// From codersdk/serversentevents.go
export interface ServerSentEvent {
readonly type: ServerSentEventType
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- TODO explain why this is needed
readonly data: any
}
// From codersdk/deployment.go
export interface ServiceBannerConfig {
readonly enabled: boolean
readonly message?: string
readonly background_color?: string
}
// From codersdk/deployment.go
export interface SwaggerConfig {
readonly enable: DeploymentConfigField<boolean>
}
// From codersdk/deployment.go
export interface TLSConfig {
readonly enable: DeploymentConfigField<boolean>
readonly address: DeploymentConfigField<string>
readonly redirect_http: DeploymentConfigField<boolean>
readonly cert_file: DeploymentConfigField<string[]>
readonly client_auth: DeploymentConfigField<string>
readonly client_ca_file: DeploymentConfigField<string>
readonly key_file: DeploymentConfigField<string[]>
readonly min_version: DeploymentConfigField<string>
readonly client_cert_file: DeploymentConfigField<string>
readonly client_key_file: DeploymentConfigField<string>
}
// From codersdk/deployment.go
export interface TelemetryConfig {
readonly enable: DeploymentConfigField<boolean>
readonly trace: DeploymentConfigField<boolean>
readonly url: DeploymentConfigField<string>
}
// From codersdk/templates.go
export interface Template {
readonly id: string
readonly created_at: string
readonly updated_at: string
readonly organization_id: string
readonly name: string
readonly display_name: string
readonly provisioner: ProvisionerType
readonly active_version_id: string
readonly active_user_count: number
readonly build_time_stats: TemplateBuildTimeStats
readonly description: string
readonly icon: string
readonly default_ttl_ms: number
readonly created_by_id: string
readonly created_by_name: string
readonly allow_user_cancel_workspace_jobs: boolean
}
// From codersdk/templates.go
export interface TemplateACL {
readonly users: TemplateUser[]
readonly group: TemplateGroup[]
}
// From codersdk/templates.go
export type TemplateBuildTimeStats = Record<
WorkspaceTransition,
TransitionStats
>
// From codersdk/templates.go
export interface TemplateDAUsResponse {
readonly entries: DAUEntry[]
}
// From codersdk/templates.go
export interface TemplateExample {
readonly id: string
readonly url: string
readonly name: string
readonly description: string
readonly icon: string
readonly tags: string[]
readonly markdown: string
}
// From codersdk/templates.go
export interface TemplateGroup extends Group {
readonly role: TemplateRole
}
// From codersdk/templates.go
export interface TemplateUser extends User {
readonly role: TemplateRole
}
// From codersdk/templateversions.go
export interface TemplateVersion {
readonly id: string
readonly template_id?: string
readonly organization_id?: string
readonly created_at: string
readonly updated_at: string
readonly name: string
readonly job: ProvisionerJob
readonly readme: string
readonly created_by: User
}
// From codersdk/templateversions.go
export interface TemplateVersionParameter {
readonly name: string
readonly description: string
readonly type: string
readonly mutable: boolean
readonly default_value: string
readonly icon: string
readonly options: TemplateVersionParameterOption[]
readonly validation_error?: string
readonly validation_regex?: string
readonly validation_min?: number
readonly validation_max?: number
readonly validation_monotonic?: ValidationMonotonicOrder
}
// From codersdk/templateversions.go
export interface TemplateVersionParameterOption {
readonly name: string
readonly description: string
readonly value: string
readonly icon: string
}
// From codersdk/templates.go
export interface TemplateVersionsByTemplateRequest extends Pagination {
readonly template_id: string
}
// From codersdk/deployment.go
export interface TraceConfig {
readonly enable: DeploymentConfigField<boolean>
readonly honeycomb_api_key: DeploymentConfigField<string>
readonly capture_logs: DeploymentConfigField<boolean>
}
// From codersdk/templates.go
export interface TransitionStats {
readonly P50?: number
readonly P95?: number
}
// From codersdk/templates.go
export interface UpdateActiveTemplateVersion {
readonly id: string
}
// From codersdk/updatecheck.go
export interface UpdateCheckResponse {
readonly current: boolean
readonly version: string
readonly url: string
}
// From codersdk/users.go
export interface UpdateRoles {
readonly roles: string[]
}
// From codersdk/templates.go
export interface UpdateTemplateACL {
readonly user_perms?: Record<string, TemplateRole>
readonly group_perms?: Record<string, TemplateRole>
}
// From codersdk/templates.go
export interface UpdateTemplateMeta {
readonly name?: string
readonly display_name?: string
readonly description?: string
readonly icon?: string
readonly default_ttl_ms?: number
readonly allow_user_cancel_workspace_jobs?: boolean
}
// From codersdk/users.go
export interface UpdateUserPasswordRequest {
readonly old_password: string
readonly password: string
}
// From codersdk/users.go
export interface UpdateUserProfileRequest {
readonly username: string
}
// From codersdk/workspaces.go
export interface UpdateWorkspaceAutostartRequest {
readonly schedule?: string
}
// From codersdk/workspaces.go
export interface UpdateWorkspaceRequest {
readonly name?: string
}
// From codersdk/workspaces.go
export interface UpdateWorkspaceTTLRequest {
readonly ttl_ms?: number
}
// From codersdk/files.go
export interface UploadResponse {
readonly hash: string
}
// From codersdk/users.go
export interface User {
readonly id: string
readonly username: string
readonly email: string
readonly created_at: string
readonly last_seen_at: string
readonly status: UserStatus
readonly organization_ids: string[]
readonly roles: Role[]
readonly avatar_url: string
}
// From codersdk/users.go
export interface UserRoles {
readonly roles: string[]
readonly organization_roles: Record<string, string[]>
}
// From codersdk/users.go
export interface UsersRequest extends Pagination {
readonly q?: string
}
// From codersdk/client.go
export interface ValidationError {
readonly field: string
readonly detail: string
}
// From codersdk/workspaces.go
export interface Workspace {
readonly id: string
readonly created_at: string
readonly updated_at: string
readonly owner_id: string
readonly owner_name: string
readonly template_id: string
readonly template_name: string
readonly template_display_name: string
readonly template_icon: string
readonly template_allow_user_cancel_workspace_jobs: boolean
readonly latest_build: WorkspaceBuild
readonly outdated: boolean
readonly name: string
readonly autostart_schedule?: string
readonly ttl_ms?: number
readonly last_used_at: string
}
// From codersdk/workspaceagents.go
export interface WorkspaceAgent {
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
readonly status: WorkspaceAgentStatus
readonly lifecycle_state: WorkspaceAgentLifecycle
readonly name: string
readonly resource_id: string
readonly instance_id?: string
readonly architecture: string
readonly environment_variables: Record<string, string>
readonly operating_system: string
readonly startup_script?: string
readonly directory?: string
readonly expanded_directory?: string
readonly version: string
readonly apps: WorkspaceApp[]
readonly latency?: Record<string, DERPRegion>
readonly connection_timeout_seconds: number
readonly troubleshooting_url: string
readonly login_before_ready: boolean
readonly startup_script_timeout_seconds: number
}
// From codersdk/workspaceagentconn.go
export interface WorkspaceAgentListeningPort {
readonly process_name: string
readonly network: string
readonly port: number
}
// From codersdk/workspaceagentconn.go
export interface WorkspaceAgentListeningPortsResponse {
readonly ports: WorkspaceAgentListeningPort[]
}
// From codersdk/workspaceapps.go
export interface WorkspaceApp {
readonly id: string
readonly url: string
readonly external: boolean
readonly slug: string
readonly display_name: string
readonly command?: string
readonly icon?: string
readonly subdomain: boolean
readonly sharing_level: WorkspaceAppSharingLevel
readonly healthcheck: Healthcheck
readonly health: WorkspaceAppHealth
}
// From codersdk/workspacebuilds.go
export interface WorkspaceBuild {
readonly id: string
readonly created_at: string
readonly updated_at: string
readonly workspace_id: string
readonly workspace_name: string
readonly workspace_owner_id: string
readonly workspace_owner_name: string
readonly template_version_id: string
readonly template_version_name: string
readonly build_number: number
readonly transition: WorkspaceTransition
readonly initiator_id: string
readonly initiator_name: string
readonly job: ProvisionerJob
readonly reason: BuildReason
readonly resources: WorkspaceResource[]
readonly deadline?: string
readonly status: WorkspaceStatus
readonly daily_cost: number
}
// From codersdk/workspacebuilds.go
export interface WorkspaceBuildParameter {
readonly name: string
readonly value: string
}
// From codersdk/workspaces.go
export interface WorkspaceBuildsRequest extends Pagination {
readonly WorkspaceID: string
readonly Since: string
}
// From codersdk/workspaces.go
export interface WorkspaceFilter {
readonly q?: string