release: 0.12.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.11.0"
+  ".": "0.12.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 193
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-3dcdbd68ce4b336149d28d17ab08f211538ed6630112ae4883af2f6680643159.yml
-openapi_spec_hash: 7e4333995b65cf32663166801e2444bb
-config_hash: 8d7b241284195a8c51f5d670fbbe0ab4
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-6ec0a3dc7648f06e6ab5f66e8b441dae208e3664646194942afab30c2838d754.yml
+openapi_spec_hash: 666f25bc2bafe875f1816feb0efab84f
+config_hash: 25c7c72de891ed240ee62c4fb9a99756

CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 0.12.0 (2026-04-15)
+
+Full Changelog: [v0.11.0...v0.12.0](https://github.com/gitpod-io/gitpod-sdk-python/compare/v0.11.0...v0.12.0)
+
+### Features
+
+* **api:** add integration_id field, make webhook_id required in pull_request trigger ([077b662](https://github.com/gitpod-io/gitpod-sdk-python/commit/077b6622dc4e21a2033c8275c46716286a6515b8))
+* **api:** add old_path field to ContentGitChangedFile ([d79d4d4](https://github.com/gitpod-io/gitpod-sdk-python/commit/d79d4d49ef41a889a81a0d484616fca442849356))
+* **api:** add prebuild trigger value to environments automations ([af2c44e](https://github.com/gitpod-io/gitpod-sdk-python/commit/af2c44e64fac19bf848c4325e0b39b183c998e74))
+* **api:** remove terminal field from RunsOn type ([faca2b2](https://github.com/gitpod-io/gitpod-sdk-python/commit/faca2b27b88f17a759bd91c305e5ea2a856a1e2c))
+
+
+### Bug Fixes
+
+* **client:** preserve hardcoded query params when merging with user params ([b7f0b1d](https://github.com/gitpod-io/gitpod-sdk-python/commit/b7f0b1d27ef51872bf81541dd7f81a8101f856af))
+* ensure file data are only sent as 1 parameter ([5c02854](https://github.com/gitpod-io/gitpod-sdk-python/commit/5c02854efdc2874535d3d7867823048d5e8d4693))
+
+
+### Documentation
+
+* **api:** update trigger usage note in AutomationTrigger ([5a292cb](https://github.com/gitpod-io/gitpod-sdk-python/commit/5a292cb1ef87a0dd73d93445707412d25c0e95e0))
+
 ## 0.11.0 (2026-04-02)
 
 Full Changelog: [v0.10.0...v0.11.0](https://github.com/gitpod-io/gitpod-sdk-python/compare/v0.10.0...v0.11.0)

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitpod-sdk"
-version = "0.11.0"
+version = "0.12.0"
 description = "The official Python library for the gitpod API"
 dynamic = ["readme"]
 license = "Apache-2.0"

src/gitpod/_base_client.py

@@ -540,6 +540,10 @@ def _build_request(
                 files = cast(HttpxRequestFiles, ForceMultipartDict())
 
         prepared_url = self._prepare_url(options.url)
+        # preserve hard-coded query params from the url
+        if params and prepared_url.query:
+            params = {**dict(prepared_url.params.items()), **params}
+            prepared_url = prepared_url.copy_with(raw_path=prepared_url.raw_path.split(b"?", 1)[0])
         if "_" in prepared_url.host:
             # work around https://github.com/encode/httpx/discussions/2880
             kwargs["extensions"] = {"sni_hostname": prepared_url.host.replace("_", "-")}

src/gitpod/_utils/_utils.py

@@ -86,8 +86,9 @@ def _extract_items(
     index += 1
     if is_dict(obj):
         try:
-            # We are at the last entry in the path so we must remove the field
-            if (len(path)) == index:
+            # Remove the field if there are no more dict keys in the path,
+            # only "<array>" traversal markers or end.
+            if all(p == "<array>" for p in path[index:]):
                 item = obj.pop(key)
             else:
                 item = obj[key]

src/gitpod/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "gitpod"
-__version__ = "0.11.0"  # x-release-please-version
+__version__ = "0.12.0"  # x-release-please-version

src/gitpod/types/environment_status.py

@@ -91,6 +91,12 @@ class ContentGitChangedFile(BaseModel):
     ] = FieldInfo(alias="changeType", default=None)
     """ChangeType is the type of change that happened to the file"""
 
+    old_path: Optional[str] = FieldInfo(alias="oldPath", default=None)
+    """
+    old_path is the previous path of the file before a rename or copy. Only set when
+    change_type is RENAMED or COPIED.
+    """
+
     path: Optional[str] = None
     """path is the path of the file"""
 

src/gitpod/types/environments/automations_file_param.py

@@ -54,7 +54,8 @@ class Services(TypedDict, total=False):
     runs_on: Annotated[RunsOn, PropertyInfo(alias="runsOn")]
 
     triggered_by: Annotated[
-        List[Literal["manual", "postEnvironmentStart", "postDevcontainerStart"]], PropertyInfo(alias="triggeredBy")
+        List[Literal["manual", "postEnvironmentStart", "postDevcontainerStart", "prebuild"]],
+        PropertyInfo(alias="triggeredBy"),
     ]
 
 

src/gitpod/types/shared/automation_trigger.py

@@ -20,7 +20,7 @@ class AutomationTrigger(BaseModel):
      The `prebuild` field starts the automation during a prebuild of an environment. This phase does not have user secrets available.
      The `before_snapshot` field triggers the automation after all prebuild tasks complete but before the snapshot is taken.
      This is used for tasks that need to run last during prebuilds, such as IDE warmup.
-     Note: The prebuild and before_snapshot triggers can only be used with tasks, not services.
+     Note: The before_snapshot trigger can only be used with tasks, not services.
     """
 
     before_snapshot: Optional[bool] = FieldInfo(alias="beforeSnapshot", default=None)

src/gitpod/types/shared/runs_on.py

@@ -18,9 +18,3 @@ class RunsOn(BaseModel):
 
     machine: Optional[object] = None
     """Machine runs the service/task directly on the VM/machine level."""
-
-    terminal: Optional[object] = None
-    """
-    Terminal runs the service inside a managed PTY terminal in the devcontainer.
-    Users can attach to the terminal interactively via the terminal API.
-    """

src/gitpod/types/shared_params/automation_trigger.py

@@ -20,7 +20,7 @@ class AutomationTrigger(TypedDict, total=False):
      The `prebuild` field starts the automation during a prebuild of an environment. This phase does not have user secrets available.
      The `before_snapshot` field triggers the automation after all prebuild tasks complete but before the snapshot is taken.
      This is used for tasks that need to run last during prebuilds, such as IDE warmup.
-     Note: The prebuild and before_snapshot triggers can only be used with tasks, not services.
+     Note: The before_snapshot trigger can only be used with tasks, not services.
     """
 
     before_snapshot: Annotated[bool, PropertyInfo(alias="beforeSnapshot")]

src/gitpod/types/shared_params/runs_on.py

@@ -20,9 +20,3 @@ class RunsOn(TypedDict, total=False):
 
     machine: object
     """Machine runs the service/task directly on the VM/machine level."""
-
-    terminal: object
-    """
-    Terminal runs the service inside a managed PTY terminal in the devcontainer.
-    Users can attach to the terminal interactively via the terminal API.
-    """

src/gitpod/types/workflow_trigger.py

@@ -31,6 +31,13 @@ class PullRequest(BaseModel):
         ]
     ] = None
 
+    integration_id: Optional[str] = FieldInfo(alias="integrationId", default=None)
+    """
+    integration_id is the optional ID of an integration that acts as the source of
+    webhook events. When set, the trigger will be activated when the webhook
+    receives events.
+    """
+
     webhook_id: Optional[str] = FieldInfo(alias="webhookId", default=None)
     """
     webhook_id is the optional ID of a webhook that this trigger is bound to. When

src/gitpod/types/workflow_trigger_param.py

@@ -29,6 +29,13 @@ class PullRequest(TypedDict, total=False):
         ]
     ]
 
+    integration_id: Annotated[Optional[str], PropertyInfo(alias="integrationId")]
+    """
+    integration_id is the optional ID of an integration that acts as the source of
+    webhook events. When set, the trigger will be activated when the webhook
+    receives events.
+    """
+
     webhook_id: Annotated[Optional[str], PropertyInfo(alias="webhookId")]
     """
     webhook_id is the optional ID of a webhook that this trigger is bound to. When

tests/api_resources/environments/automations/test_services.py

@@ -75,7 +75,6 @@ def test_method_create_with_all_params(self, client: Gitpod) -> None:
                         "image": "x",
                     },
                     "machine": {},
-                    "terminal": {},
                 },
                 "session": "session",
                 "spec_version": "specVersion",
@@ -188,7 +187,6 @@ def test_method_update_with_all_params(self, client: Gitpod) -> None:
                         "image": "x",
                     },
                     "machine": {},
-                    "terminal": {},
                 },
             },
             status={
@@ -437,7 +435,6 @@ async def test_method_create_with_all_params(self, async_client: AsyncGitpod) ->
                         "image": "x",
                     },
                     "machine": {},
-                    "terminal": {},
                 },
                 "session": "session",
                 "spec_version": "specVersion",
@@ -550,7 +547,6 @@ async def test_method_update_with_all_params(self, async_client: AsyncGitpod) ->
                         "image": "x",
                     },
                     "machine": {},
-                    "terminal": {},
                 },
             },
             status={

tests/api_resources/environments/automations/test_tasks.py

@@ -71,7 +71,6 @@ def test_method_create_with_all_params(self, client: Gitpod) -> None:
                         "image": "x",
                     },
                     "machine": {},
-                    "terminal": {},
                 },
             },
         )
@@ -178,7 +177,6 @@ def test_method_update_with_all_params(self, client: Gitpod) -> None:
                         "image": "x",
                     },
                     "machine": {},
-                    "terminal": {},
                 },
             },
         )
@@ -377,7 +375,6 @@ async def test_method_create_with_all_params(self, async_client: AsyncGitpod) ->
                         "image": "x",
                     },
                     "machine": {},
-                    "terminal": {},
                 },
             },
         )
@@ -484,7 +481,6 @@ async def test_method_update_with_all_params(self, async_client: AsyncGitpod) ->
                         "image": "x",
                     },
                     "machine": {},
-                    "terminal": {},
                 },
             },
         )

tests/api_resources/environments/test_automations.py

@@ -44,7 +44,6 @@ def test_method_upsert_with_all_params(self, client: Gitpod) -> None:
                                 "image": "x",
                             },
                             "machine": {},
-                            "terminal": {},
                         },
                         "triggered_by": ["postDevcontainerStart"],
                     }
@@ -61,7 +60,6 @@ def test_method_upsert_with_all_params(self, client: Gitpod) -> None:
                                 "image": "x",
                             },
                             "machine": {},
-                            "terminal": {},
                         },
                         "triggered_by": ["postEnvironmentStart"],
                     }
@@ -126,7 +124,6 @@ async def test_method_upsert_with_all_params(self, async_client: AsyncGitpod) ->
                                 "image": "x",
                             },
                             "machine": {},
-                            "terminal": {},
                         },
                         "triggered_by": ["postDevcontainerStart"],
                     }
@@ -143,7 +140,6 @@ async def test_method_upsert_with_all_params(self, async_client: AsyncGitpod) ->
                                 "image": "x",
                             },
                             "machine": {},
-                            "terminal": {},
                         },
                         "triggered_by": ["postEnvironmentStart"],
                     }

tests/api_resources/test_automations.py

@@ -113,6 +113,7 @@ def test_method_create_with_all_params(self, client: Gitpod) -> None:
                     "manual": {},
                     "pull_request": {
                         "events": ["PULL_REQUEST_EVENT_UNSPECIFIED"],
+                        "integration_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                         "webhook_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                     },
                     "time": {"cron_expression": "cronExpression"},
@@ -256,6 +257,7 @@ def test_method_update_with_all_params(self, client: Gitpod) -> None:
                     "manual": {},
                     "pull_request": {
                         "events": ["PULL_REQUEST_EVENT_UNSPECIFIED"],
+                        "integration_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                         "webhook_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                     },
                     "time": {"cron_expression": "cronExpression"},
@@ -793,6 +795,7 @@ async def test_method_create_with_all_params(self, async_client: AsyncGitpod) ->
                     "manual": {},
                     "pull_request": {
                         "events": ["PULL_REQUEST_EVENT_UNSPECIFIED"],
+                        "integration_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                         "webhook_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                     },
                     "time": {"cron_expression": "cronExpression"},
@@ -936,6 +939,7 @@ async def test_method_update_with_all_params(self, async_client: AsyncGitpod) ->
                     "manual": {},
                     "pull_request": {
                         "events": ["PULL_REQUEST_EVENT_UNSPECIFIED"],
+                        "integration_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                         "webhook_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
                     },
                     "time": {"cron_expression": "cronExpression"},

tests/test_client.py

@@ -438,6 +438,30 @@ def test_default_query_option(self) -> None:
 
         client.close()
 
+    def test_hardcoded_query_params_in_url(self, client: Gitpod) -> None:
+        request = client._build_request(FinalRequestOptions(method="get", url="/foo?beta=true"))
+        url = httpx.URL(request.url)
+        assert dict(url.params) == {"beta": "true"}
+
+        request = client._build_request(
+            FinalRequestOptions(
+                method="get",
+                url="/foo?beta=true",
+                params={"limit": "10", "page": "abc"},
+            )
+        )
+        url = httpx.URL(request.url)
+        assert dict(url.params) == {"beta": "true", "limit": "10", "page": "abc"}
+
+        request = client._build_request(
+            FinalRequestOptions(
+                method="get",
+                url="/files/a%2Fb?beta=true",
+                params={"limit": "10"},
+            )
+        )
+        assert request.url.raw_path == b"/files/a%2Fb?beta=true&limit=10"
+
     def test_request_extra_json(self, client: Gitpod) -> None:
         request = client._build_request(
             FinalRequestOptions(
@@ -1363,6 +1387,30 @@ async def test_default_query_option(self) -> None:
 
         await client.close()
 
+    async def test_hardcoded_query_params_in_url(self, async_client: AsyncGitpod) -> None:
+        request = async_client._build_request(FinalRequestOptions(method="get", url="/foo?beta=true"))
+        url = httpx.URL(request.url)
+        assert dict(url.params) == {"beta": "true"}
+
+        request = async_client._build_request(
+            FinalRequestOptions(
+                method="get",
+                url="/foo?beta=true",
+                params={"limit": "10", "page": "abc"},
+            )
+        )
+        url = httpx.URL(request.url)
+        assert dict(url.params) == {"beta": "true", "limit": "10", "page": "abc"}
+
+        request = async_client._build_request(
+            FinalRequestOptions(
+                method="get",
+                url="/files/a%2Fb?beta=true",
+                params={"limit": "10"},
+            )
+        )
+        assert request.url.raw_path == b"/files/a%2Fb?beta=true&limit=10"
+
     def test_request_extra_json(self, client: Gitpod) -> None:
         request = client._build_request(
             FinalRequestOptions(

tests/test_extract_files.py

@@ -35,6 +35,15 @@ def test_multiple_files() -> None:
     assert query == {"documents": [{}, {}]}
 
 
+def test_top_level_file_array() -> None:
+    query = {"files": [b"file one", b"file two"], "title": "hello"}
+    assert extract_files(query, paths=[["files", "<array>"]]) == [
+        ("files[]", b"file one"),
+        ("files[]", b"file two"),
+    ]
+    assert query == {"title": "hello"}
+
+
 @pytest.mark.parametrize(
     "query,paths,expected",
     [