feat(cli): add --name flag to environment create command

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 170
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-2423c089f280cdf34a987d40531692097a69f4aa971c6adf9aeec4fd7984cec2.yml
-openapi_spec_hash: 24037c3ab9ceca689150d07ecec7aa80
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-b43acdb0d7e591ca6dc119778dfc405afa6c4d5aeb43d06fc6aff9f941c552b6.yml
+openapi_spec_hash: f52b33b13c9efa8f5941d40dc6315e80
 config_hash: d726afb2a92132197e4eae04303e8041

src/gitpod/resources/environments/environments.py

@@ -91,6 +91,7 @@ def with_streaming_response(self) -> EnvironmentsResourceWithStreamingResponse:
     def create(
         self,
         *,
+        name: Optional[str] | Omit = omit,
         spec: EnvironmentSpecParam | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -164,6 +165,9 @@ def create(
           ```
 
         Args:
+          name: name is a user-defined identifier for the environment. If not specified, the
+              system will generate a name.
+
           spec: spec is the configuration of the environment that's required for the to start
               the environment
 
@@ -177,7 +181,13 @@ def create(
         """
         return self._post(
             "/gitpod.v1.EnvironmentService/CreateEnvironment",
-            body=maybe_transform({"spec": spec}, environment_create_params.EnvironmentCreateParams),
+            body=maybe_transform(
+                {
+                    "name": name,
+                    "spec": spec,
+                },
+                environment_create_params.EnvironmentCreateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -549,6 +559,7 @@ def create_environment_token(
     def create_from_project(
         self,
         *,
+        name: Optional[str] | Omit = omit,
         project_id: str | Omit = omit,
         spec: EnvironmentSpecParam | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -591,6 +602,9 @@ def create_from_project(
           ```
 
         Args:
+          name: name is a user-defined identifier for the environment. If not specified, the
+              system will generate a name.
+
           spec: Spec is the configuration of the environment that's required for the runner to
               start the environment Configuration already defined in the Project will override
               parts of the spec, if set
@@ -607,6 +621,7 @@ def create_from_project(
             "/gitpod.v1.EnvironmentService/CreateEnvironmentFromProject",
             body=maybe_transform(
                 {
+                    "name": name,
                     "project_id": project_id,
                     "spec": spec,
                 },
@@ -905,6 +920,7 @@ def with_streaming_response(self) -> AsyncEnvironmentsResourceWithStreamingRespo
     async def create(
         self,
         *,
+        name: Optional[str] | Omit = omit,
         spec: EnvironmentSpecParam | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -978,6 +994,9 @@ async def create(
           ```
 
         Args:
+          name: name is a user-defined identifier for the environment. If not specified, the
+              system will generate a name.
+
           spec: spec is the configuration of the environment that's required for the to start
               the environment
 
@@ -991,7 +1010,13 @@ async def create(
         """
         return await self._post(
             "/gitpod.v1.EnvironmentService/CreateEnvironment",
-            body=await async_maybe_transform({"spec": spec}, environment_create_params.EnvironmentCreateParams),
+            body=await async_maybe_transform(
+                {
+                    "name": name,
+                    "spec": spec,
+                },
+                environment_create_params.EnvironmentCreateParams,
+            ),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -1363,6 +1388,7 @@ async def create_environment_token(
     async def create_from_project(
         self,
         *,
+        name: Optional[str] | Omit = omit,
         project_id: str | Omit = omit,
         spec: EnvironmentSpecParam | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
@@ -1405,6 +1431,9 @@ async def create_from_project(
           ```
 
         Args:
+          name: name is a user-defined identifier for the environment. If not specified, the
+              system will generate a name.
+
           spec: Spec is the configuration of the environment that's required for the runner to
               start the environment Configuration already defined in the Project will override
               parts of the spec, if set
@@ -1421,6 +1450,7 @@ async def create_from_project(
             "/gitpod.v1.EnvironmentService/CreateEnvironmentFromProject",
             body=await async_maybe_transform(
                 {
+                    "name": name,
                     "project_id": project_id,
                     "spec": spec,
                 },

src/gitpod/types/environment_create_from_project_params.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Optional
 from typing_extensions import Annotated, TypedDict
 
 from .._utils import PropertyInfo
@@ -11,6 +12,12 @@
 
 
 class EnvironmentCreateFromProjectParams(TypedDict, total=False):
+    name: Optional[str]
+    """
+    name is a user-defined identifier for the environment. If not specified, the
+    system will generate a name.
+    """
+
     project_id: Annotated[str, PropertyInfo(alias="projectId")]
 
     spec: EnvironmentSpecParam

src/gitpod/types/environment_create_params.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from typing import Optional
 from typing_extensions import TypedDict
 
 from .environment_spec_param import EnvironmentSpecParam
@@ -10,6 +11,12 @@
 
 
 class EnvironmentCreateParams(TypedDict, total=False):
+    name: Optional[str]
+    """
+    name is a user-defined identifier for the environment. If not specified, the
+    system will generate a name.
+    """
+
     spec: EnvironmentSpecParam
     """
     spec is the configuration of the environment that's required for the to start

tests/api_resources/test_environments.py

@@ -36,6 +36,7 @@ def test_method_create(self, client: Gitpod) -> None:
     @parametrize
     def test_method_create_with_all_params(self, client: Gitpod) -> None:
         environment = client.environments.create(
+            name="name",
             spec={
                 "admission": "ADMISSION_LEVEL_UNSPECIFIED",
                 "automations_file": {
@@ -387,6 +388,7 @@ def test_method_create_from_project(self, client: Gitpod) -> None:
     @parametrize
     def test_method_create_from_project_with_all_params(self, client: Gitpod) -> None:
         environment = client.environments.create_from_project(
+            name="name",
             project_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
             spec={
                 "admission": "ADMISSION_LEVEL_UNSPECIFIED",
@@ -692,6 +694,7 @@ async def test_method_create(self, async_client: AsyncGitpod) -> None:
     @parametrize
     async def test_method_create_with_all_params(self, async_client: AsyncGitpod) -> None:
         environment = await async_client.environments.create(
+            name="name",
             spec={
                 "admission": "ADMISSION_LEVEL_UNSPECIFIED",
                 "automations_file": {
@@ -1043,6 +1046,7 @@ async def test_method_create_from_project(self, async_client: AsyncGitpod) -> No
     @parametrize
     async def test_method_create_from_project_with_all_params(self, async_client: AsyncGitpod) -> None:
         environment = await async_client.environments.create_from_project(
+            name="name",
             project_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
             spec={
                 "admission": "ADMISSION_LEVEL_UNSPECIFIED",