feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 111
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-3655d5ad0ac3e228c1519af70dbf3d0bfa3c47a2d06d4cac92a650da051b49a6.yml
-openapi_spec_hash: 5dbb5577e6a7cae7db615b1b06c9d23e
-config_hash: 719ad411c0ec7402a7a4c1f95515280c
+configured_endpoints: 115
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-d854bc81e0a99171716893e6790a87ba350bb6fc778f8e3244abdd47d5c252c3.yml
+openapi_spec_hash: 5189220e4712a7b0cdd35beba2ebb47d
+config_hash: 981e43e8b1e3ddabd435d350aeeed417

api.md

@@ -57,7 +57,8 @@ func (r *EditorService) Get(ctx context.Context, body EditorGetParams, opts ...o
 	return
 }
 
-// Lists all available code editors.
+// Lists all available code editors, optionally filtered to those allowed in an
+// organization.
 //
 // Use this method to:
 //
@@ -76,6 +77,18 @@ func (r *EditorService) Get(ctx context.Context, body EditorGetParams, opts ...o
 //	pagination:
 //	  pageSize: 20
 //	```
+//
+// - List editors available to the organization:
+//
+//	Shows all available editors that are allowed by the policies enforced in the
+//	organization with pagination.
+//
+//	```yaml
+//	pagination:
+//	  pageSize: 20
+//	filter:
+//	  allowedByPolicy: true
+//	```
 func (r *EditorService) List(ctx context.Context, params EditorListParams, opts ...option.RequestOption) (res *pagination.EditorsPage[Editor], err error) {
 	var raw *http.Response
 	opts = append(r.Options[:], opts...)
@@ -93,7 +106,8 @@ func (r *EditorService) List(ctx context.Context, params EditorListParams, opts
 	return res, nil
 }
 
-// Lists all available code editors.
+// Lists all available code editors, optionally filtered to those allowed in an
+// organization.
 //
 // Use this method to:
 //
@@ -112,6 +126,18 @@ func (r *EditorService) List(ctx context.Context, params EditorListParams, opts
 //	pagination:
 //	  pageSize: 20
 //	```
+//
+// - List editors available to the organization:
+//
+//	Shows all available editors that are allowed by the policies enforced in the
+//	organization with pagination.
+//
+//	```yaml
+//	pagination:
+//	  pageSize: 20
+//	filter:
+//	  allowedByPolicy: true
+//	```
 func (r *EditorService) ListAutoPaging(ctx context.Context, params EditorListParams, opts ...option.RequestOption) *pagination.EditorsPageAutoPager[Editor] {
 	return pagination.NewEditorsPageAutoPager(r.List(ctx, params, opts...))
 }
@@ -231,6 +257,8 @@ func (r EditorGetParams) MarshalJSON() (data []byte, err error) {
 type EditorListParams struct {
 	Token    param.Field[string] `query:"token"`
 	PageSize param.Field[int64]  `query:"pageSize"`
+	// filter contains the filter options for listing editors
+	Filter param.Field[EditorListParamsFilter] `json:"filter"`
 	// pagination contains the pagination options for listing environments
 	Pagination param.Field[EditorListParamsPagination] `json:"pagination"`
 }
@@ -247,6 +275,17 @@ func (r EditorListParams) URLQuery() (v url.Values) {
 	})
 }
 
+// filter contains the filter options for listing editors
+type EditorListParamsFilter struct {
+	// allowed_by_policy filters the response to only editors that are allowed by the
+	// policies enforced in the organization
+	AllowedByPolicy param.Field[bool] `json:"allowedByPolicy"`
+}
+
+func (r EditorListParamsFilter) MarshalJSON() (data []byte, err error) {
+	return apijson.MarshalRoot(r)
+}
+
 // pagination contains the pagination options for listing environments
 type EditorListParamsPagination struct {
 	// Token for the next set of results that was returned as next_token of a

editor.go

@@ -54,6 +54,9 @@ func TestEditorListWithOptionalParams(t *testing.T) {
 	_, err := client.Editors.List(context.TODO(), gitpod.EditorListParams{
 		Token:    gitpod.F("token"),
 		PageSize: gitpod.F(int64(0)),
+		Filter: gitpod.F(gitpod.EditorListParamsFilter{
+			AllowedByPolicy: gitpod.F(true),
+		}),
 		Pagination: gitpod.F(gitpod.EditorListParamsPagination{
 			Token:    gitpod.F("token"),
 			PageSize: gitpod.F(int64(20)),

editor_test.go

@@ -318,6 +318,27 @@ func (r *EnvironmentService) Delete(ctx context.Context, body EnvironmentDeleteP
 	return
 }
 
+// Creates an access token for the environment.
+//
+// Generated tokens are valid for one hour and provide environment-specific access
+// permissions. The token is scoped to a specific environment.
+//
+// ### Examples
+//
+// - Generate environment token:
+//
+//	Creates a temporary access token for accessing an environment.
+//
+//	```yaml
+//	environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048"
+//	```
+func (r *EnvironmentService) NewEnvironmentToken(ctx context.Context, body EnvironmentNewEnvironmentTokenParams, opts ...option.RequestOption) (res *EnvironmentNewEnvironmentTokenResponse, err error) {
+	opts = append(r.Options[:], opts...)
+	path := "gitpod.v1.EnvironmentService/CreateEnvironmentAccessToken"
+	err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
+	return
+}
+
 // Creates an environment from an existing project configuration and starts it.
 //
 // This method uses project settings as defaults but allows overriding specific
@@ -731,6 +752,9 @@ func (r environmentSpecContentJSON) RawJSON() string {
 
 // devcontainer is the devcontainer spec of the environment
 type EnvironmentSpecDevcontainer struct {
+	// default_devcontainer_image is the default image that is used to start the
+	// devcontainer if no devcontainer config file is found
+	DefaultDevcontainerImage string `json:"defaultDevcontainerImage"`
 	// devcontainer_file_path is the path to the devcontainer file relative to the repo
 	// root path must not be absolute (start with a /):
 	//
@@ -747,11 +771,12 @@ type EnvironmentSpecDevcontainer struct {
 // environmentSpecDevcontainerJSON contains the JSON metadata for the struct
 // [EnvironmentSpecDevcontainer]
 type environmentSpecDevcontainerJSON struct {
-	DevcontainerFilePath apijson.Field
-	Dotfiles             apijson.Field
-	Session              apijson.Field
-	raw                  string
-	ExtraFields          map[string]apijson.Field
+	DefaultDevcontainerImage apijson.Field
+	DevcontainerFilePath     apijson.Field
+	Dotfiles                 apijson.Field
+	Session                  apijson.Field
+	raw                      string
+	ExtraFields              map[string]apijson.Field
 }
 
 func (r *EnvironmentSpecDevcontainer) UnmarshalJSON(data []byte) (err error) {
@@ -839,6 +864,8 @@ func (r environmentSpecPortJSON) RawJSON() string {
 }
 
 type EnvironmentSpecSecret struct {
+	// id is the unique identifier of the secret.
+	ID string `json:"id"`
 	// container_registry_basic_auth_host is the hostname of the container registry
 	// that supports basic auth
 	ContainerRegistryBasicAuthHost string `json:"containerRegistryBasicAuthHost"`
@@ -861,6 +888,7 @@ type EnvironmentSpecSecret struct {
 // environmentSpecSecretJSON contains the JSON metadata for the struct
 // [EnvironmentSpecSecret]
 type environmentSpecSecretJSON struct {
+	ID                             apijson.Field
 	ContainerRegistryBasicAuthHost apijson.Field
 	EnvironmentVariable            apijson.Field
 	FilePath                       apijson.Field
@@ -997,6 +1025,9 @@ func (r EnvironmentSpecContentParam) MarshalJSON() (data []byte, err error) {
 
 // devcontainer is the devcontainer spec of the environment
 type EnvironmentSpecDevcontainerParam struct {
+	// default_devcontainer_image is the default image that is used to start the
+	// devcontainer if no devcontainer config file is found
+	DefaultDevcontainerImage param.Field[string] `json:"defaultDevcontainerImage"`
 	// devcontainer_file_path is the path to the devcontainer file relative to the repo
 	// root path must not be absolute (start with a /):
 	//
@@ -1048,6 +1079,8 @@ func (r EnvironmentSpecPortParam) MarshalJSON() (data []byte, err error) {
 }
 
 type EnvironmentSpecSecretParam struct {
+	// id is the unique identifier of the secret.
+	ID param.Field[string] `json:"id"`
 	// container_registry_basic_auth_host is the hostname of the container registry
 	// that supports basic auth
 	ContainerRegistryBasicAuthHost param.Field[string] `json:"containerRegistryBasicAuthHost"`
@@ -1176,8 +1209,11 @@ type EnvironmentStatusAutomationsFile struct {
 	Phase EnvironmentStatusAutomationsFilePhase `json:"phase"`
 	// session is the automations file session that is currently applied in the
 	// environment.
-	Session string                               `json:"session"`
-	JSON    environmentStatusAutomationsFileJSON `json:"-"`
+	Session string `json:"session"`
+	// warning_message contains warnings, e.g. when no triggers are defined in the
+	// automations file.
+	WarningMessage string                               `json:"warningMessage"`
+	JSON           environmentStatusAutomationsFileJSON `json:"-"`
 }
 
 // environmentStatusAutomationsFileJSON contains the JSON metadata for the struct
@@ -1188,6 +1224,7 @@ type environmentStatusAutomationsFileJSON struct {
 	FailureMessage          apijson.Field
 	Phase                   apijson.Field
 	Session                 apijson.Field
+	WarningMessage          apijson.Field
 	raw                     string
 	ExtraFields             map[string]apijson.Field
 }
@@ -1700,6 +1737,8 @@ func (r EnvironmentStatusRunnerAckStatusCode) IsKnown() bool {
 }
 
 type EnvironmentStatusSecret struct {
+	// id is the unique identifier of the secret.
+	ID string `json:"id"`
 	// failure_message contains the reason the secret failed to be materialize.
 	FailureMessage string                        `json:"failureMessage"`
 	Phase          EnvironmentStatusSecretsPhase `json:"phase"`
@@ -1715,6 +1754,7 @@ type EnvironmentStatusSecret struct {
 // environmentStatusSecretJSON contains the JSON metadata for the struct
 // [EnvironmentStatusSecret]
 type environmentStatusSecretJSON struct {
+	ID             apijson.Field
 	FailureMessage apijson.Field
 	Phase          apijson.Field
 	SecretName     apijson.Field
@@ -1844,6 +1884,28 @@ type EnvironmentUpdateResponse = interface{}
 
 type EnvironmentDeleteResponse = interface{}
 
+type EnvironmentNewEnvironmentTokenResponse struct {
+	// access_token is the token that can be used for environment authentication
+	AccessToken string                                     `json:"accessToken,required"`
+	JSON        environmentNewEnvironmentTokenResponseJSON `json:"-"`
+}
+
+// environmentNewEnvironmentTokenResponseJSON contains the JSON metadata for the
+// struct [EnvironmentNewEnvironmentTokenResponse]
+type environmentNewEnvironmentTokenResponseJSON struct {
+	AccessToken apijson.Field
+	raw         string
+	ExtraFields map[string]apijson.Field
+}
+
+func (r *EnvironmentNewEnvironmentTokenResponse) UnmarshalJSON(data []byte) (err error) {
+	return apijson.UnmarshalRoot(data, r)
+}
+
+func (r environmentNewEnvironmentTokenResponseJSON) RawJSON() string {
+	return r.raw
+}
+
 type EnvironmentNewFromProjectResponse struct {
 	// +resource get environment
 	Environment Environment                           `json:"environment,required"`
@@ -2099,6 +2161,16 @@ func (r EnvironmentDeleteParams) MarshalJSON() (data []byte, err error) {
 	return apijson.MarshalRoot(r)
 }
 
+type EnvironmentNewEnvironmentTokenParams struct {
+	// environment_id specifies the environment for which the access token should be
+	// created.
+	EnvironmentID param.Field[string] `json:"environmentId,required" format:"uuid"`
+}
+
+func (r EnvironmentNewEnvironmentTokenParams) MarshalJSON() (data []byte, err error) {
+	return apijson.MarshalRoot(r)
+}
+
 type EnvironmentNewFromProjectParams struct {
 	ProjectID param.Field[string] `json:"projectId" format:"uuid"`
 	// Spec is the configuration of the environment that's required for the runner to

environment.go

@@ -55,7 +55,8 @@ func TestEnvironmentNewWithOptionalParams(t *testing.T) {
 			}),
 			DesiredPhase: gitpod.F(gitpod.EnvironmentPhaseUnspecified),
 			Devcontainer: gitpod.F(gitpod.EnvironmentSpecDevcontainerParam{
-				DevcontainerFilePath: gitpod.F("devcontainerFilePath"),
+				DefaultDevcontainerImage: gitpod.F("defaultDevcontainerImage"),
+				DevcontainerFilePath:     gitpod.F("devcontainerFilePath"),
 				Dotfiles: gitpod.F(gitpod.EnvironmentSpecDevcontainerDotfilesParam{
 					Repository: gitpod.F("https://example.com"),
 				}),
@@ -71,6 +72,7 @@ func TestEnvironmentNewWithOptionalParams(t *testing.T) {
 				Port:      gitpod.F(int64(1)),
 			}}),
 			Secrets: gitpod.F([]gitpod.EnvironmentSpecSecretParam{{
+				ID:                             gitpod.F("id"),
 				ContainerRegistryBasicAuthHost: gitpod.F("containerRegistryBasicAuthHost"),
 				EnvironmentVariable:            gitpod.F("environmentVariable"),
 				FilePath:                       gitpod.F("filePath"),
@@ -254,6 +256,31 @@ func TestEnvironmentDeleteWithOptionalParams(t *testing.T) {
 	}
 }
 
+func TestEnvironmentNewEnvironmentToken(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
+	baseURL := "http://localhost:4010"
+	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
+		baseURL = envURL
+	}
+	if !testutil.CheckTestServer(t, baseURL) {
+		return
+	}
+	client := gitpod.NewClient(
+		option.WithBaseURL(baseURL),
+		option.WithBearerToken("My Bearer Token"),
+	)
+	_, err := client.Environments.NewEnvironmentToken(context.TODO(), gitpod.EnvironmentNewEnvironmentTokenParams{
+		EnvironmentID: gitpod.F("07e03a28-65a5-4d98-b532-8ea67b188048"),
+	})
+	if err != nil {
+		var apierr *gitpod.Error
+		if errors.As(err, &apierr) {
+			t.Log(string(apierr.DumpRequest(true)))
+		}
+		t.Fatalf("err should be nil: %s", err.Error())
+	}
+}
+
 func TestEnvironmentNewFromProjectWithOptionalParams(t *testing.T) {
 	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
@@ -296,7 +323,8 @@ func TestEnvironmentNewFromProjectWithOptionalParams(t *testing.T) {
 			}),
 			DesiredPhase: gitpod.F(gitpod.EnvironmentPhaseUnspecified),
 			Devcontainer: gitpod.F(gitpod.EnvironmentSpecDevcontainerParam{
-				DevcontainerFilePath: gitpod.F("devcontainerFilePath"),
+				DefaultDevcontainerImage: gitpod.F("defaultDevcontainerImage"),
+				DevcontainerFilePath:     gitpod.F("devcontainerFilePath"),
 				Dotfiles: gitpod.F(gitpod.EnvironmentSpecDevcontainerDotfilesParam{
 					Repository: gitpod.F("https://example.com"),
 				}),
@@ -312,6 +340,7 @@ func TestEnvironmentNewFromProjectWithOptionalParams(t *testing.T) {
 				Port:      gitpod.F(int64(1)),
 			}}),
 			Secrets: gitpod.F([]gitpod.EnvironmentSpecSecretParam{{
+				ID:                             gitpod.F("id"),
 				ContainerRegistryBasicAuthHost: gitpod.F("containerRegistryBasicAuthHost"),
 				EnvironmentVariable:            gitpod.F("environmentVariable"),
 				FilePath:                       gitpod.F("filePath"),

environment_test.go

@@ -577,6 +577,9 @@ type ServiceStatus struct {
 	FailureMessage string `json:"failureMessage"`
 	// log_url contains the URL at which the service logs can be accessed.
 	LogURL string `json:"logUrl"`
+	// output contains the output of the service. setting an output field to empty
+	// string will unset it.
+	Output map[string]string `json:"output"`
 	// phase is the current phase of the service.
 	Phase ServicePhase `json:"phase"`
 	// session is the current session of the service.
@@ -594,6 +597,7 @@ type ServiceStatus struct {
 type serviceStatusJSON struct {
 	FailureMessage apijson.Field
 	LogURL         apijson.Field
+	Output         apijson.Field
 	Phase          apijson.Field
 	Session        apijson.Field
 	StatusVersion  apijson.Field
@@ -738,10 +742,12 @@ func (r EnvironmentAutomationServiceUpdateParamsSpecCommands) MarshalJSON() (dat
 // client of this API you are not expected to provide this field. Updating this
 // field requires the `environmentservice:update_status` permission.
 type EnvironmentAutomationServiceUpdateParamsStatus struct {
-	FailureMessage param.Field[string]       `json:"failureMessage"`
-	LogURL         param.Field[string]       `json:"logUrl"`
-	Phase          param.Field[ServicePhase] `json:"phase"`
-	Session        param.Field[string]       `json:"session"`
+	FailureMessage param.Field[string] `json:"failureMessage"`
+	LogURL         param.Field[string] `json:"logUrl"`
+	// setting an output field to empty string will unset it.
+	Output  param.Field[map[string]string] `json:"output"`
+	Phase   param.Field[ServicePhase]      `json:"phase"`
+	Session param.Field[string]            `json:"session"`
 }
 
 func (r EnvironmentAutomationServiceUpdateParamsStatus) MarshalJSON() (data []byte, err error) {

environmentautomationservice.go

@@ -138,8 +138,11 @@ func TestEnvironmentAutomationServiceUpdateWithOptionalParams(t *testing.T) {
 		Status: gitpod.F(gitpod.EnvironmentAutomationServiceUpdateParamsStatus{
 			FailureMessage: gitpod.F("failureMessage"),
 			LogURL:         gitpod.F("logUrl"),
-			Phase:          gitpod.F(gitpod.ServicePhaseUnspecified),
-			Session:        gitpod.F("session"),
+			Output: gitpod.F(map[string]string{
+				"foo": "string",
+			}),
+			Phase:   gitpod.F(gitpod.ServicePhaseUnspecified),
+			Session: gitpod.F("session"),
 		}),
 	})
 	if err != nil {