release: 0.1.4

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.3"
+  ".": "0.1.4"
 }

.stats.yml

@@ -1,2 +1,2 @@
 configured_endpoints: 111
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-0c37e687e2a070abfe49501156af6d906ff166b6eaad779ee6c2b568515f2b7e.yml
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/gitpod%2Fgitpod-f6598ab5d6827f66b642201769e92590ea32af84ebbf24b18cc32b33dee5107e.yml

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.4 (2025-02-18)
+
+Full Changelog: [v0.1.3...v0.1.4](https://github.com/gitpod-io/gitpod-sdk-python/compare/v0.1.3...v0.1.4)
+
+### Features
+
+* **api:** manual updates ([#46](https://github.com/gitpod-io/gitpod-sdk-python/issues/46)) ([50e6697](https://github.com/gitpod-io/gitpod-sdk-python/commit/50e669758fceea61ffd62bd0e463f9b588c11000))
+
 ## 0.1.3 (2025-02-14)
 
 Full Changelog: [v0.1.2...v0.1.3](https://github.com/gitpod-io/gitpod-sdk-python/compare/v0.1.2...v0.1.3)

pyproject.toml

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

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.1.3"  # x-release-please-version
+__version__ = "0.1.4"  # x-release-please-version

src/gitpod/resources/accounts.py

@@ -66,7 +66,24 @@ def retrieve(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AccountRetrieveResponse:
         """
-        GetAccount retrieves a single Account.
+        Gets information about the currently authenticated account.
+
+        Use this method to:
+
+        - Retrieve account profile information
+        - Check organization memberships
+        - View account settings
+        - Get joinable organizations
+
+        ### Examples
+
+        - Get account details:
+
+          Retrieves information about the authenticated account.
+
+          ```yaml
+          {}
+          ```
 
         Args:
           extra_headers: Send extra headers
@@ -97,10 +114,26 @@ def delete(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> object:
-        """DeleteAccount deletes an Account.
+        """
+        Deletes an account permanently.
+
+        Use this method to:
 
-        To Delete an Account, the Account must not be
-        an active member of any Organization.
+        - Remove unused accounts
+        - Clean up test accounts
+        - Complete account deletion requests
+
+        The account must not be an active member of any organization.
+
+        ### Examples
+
+        - Delete account:
+
+          Permanently removes an account.
+
+          ```yaml
+          accountId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
+          ```
 
         Args:
           extra_headers: Send extra headers
@@ -133,7 +166,32 @@ def get_sso_login_url(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AccountGetSSOLoginURLResponse:
         """
-        GetSSOLoginURL returns the URL to redirect the user to for SSO login.
+        Gets the SSO login URL for a specific email domain.
+
+        Use this method to:
+
+        - Initiate SSO authentication
+        - Get organization-specific login URLs
+        - Handle SSO redirects
+
+        ### Examples
+
+        - Get login URL:
+
+          Retrieves SSO URL for email domain.
+
+          ```yaml
+          email: "[email protected]"
+          ```
+
+        - Get URL with return path:
+
+          Gets SSO URL with specific return location.
+
+          ```yaml
+          email: "[email protected]"
+          returnTo: "https://gitpod.io/workspaces"
+          ```
 
         Args:
           email: email is the email the user wants to login with
@@ -178,8 +236,35 @@ def list_login_providers(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> SyncLoginProvidersPage[LoginProvider]:
         """
-        ListLoginProviders returns the list of login providers matching the provided
-        filters.
+        Lists available login providers with optional filtering.
+
+        Use this method to:
+
+        - View supported authentication methods
+        - Get provider-specific login URLs
+        - Filter providers by invite
+
+        ### Examples
+
+        - List all providers:
+
+          Shows all available login providers.
+
+          ```yaml
+          pagination:
+            pageSize: 20
+          ```
+
+        - List for specific invite:
+
+          Shows providers available for an invite.
+
+          ```yaml
+          filter:
+            inviteId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
+          pagination:
+            pageSize: 20
+          ```
 
         Args:
           filter: filter contains the filter options for listing login methods
@@ -254,7 +339,24 @@ async def retrieve(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AccountRetrieveResponse:
         """
-        GetAccount retrieves a single Account.
+        Gets information about the currently authenticated account.
+
+        Use this method to:
+
+        - Retrieve account profile information
+        - Check organization memberships
+        - View account settings
+        - Get joinable organizations
+
+        ### Examples
+
+        - Get account details:
+
+          Retrieves information about the authenticated account.
+
+          ```yaml
+          {}
+          ```
 
         Args:
           extra_headers: Send extra headers
@@ -285,10 +387,26 @@ async def delete(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> object:
-        """DeleteAccount deletes an Account.
+        """
+        Deletes an account permanently.
+
+        Use this method to:
 
-        To Delete an Account, the Account must not be
-        an active member of any Organization.
+        - Remove unused accounts
+        - Clean up test accounts
+        - Complete account deletion requests
+
+        The account must not be an active member of any organization.
+
+        ### Examples
+
+        - Delete account:
+
+          Permanently removes an account.
+
+          ```yaml
+          accountId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
+          ```
 
         Args:
           extra_headers: Send extra headers
@@ -321,7 +439,32 @@ async def get_sso_login_url(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AccountGetSSOLoginURLResponse:
         """
-        GetSSOLoginURL returns the URL to redirect the user to for SSO login.
+        Gets the SSO login URL for a specific email domain.
+
+        Use this method to:
+
+        - Initiate SSO authentication
+        - Get organization-specific login URLs
+        - Handle SSO redirects
+
+        ### Examples
+
+        - Get login URL:
+
+          Retrieves SSO URL for email domain.
+
+          ```yaml
+          email: "[email protected]"
+          ```
+
+        - Get URL with return path:
+
+          Gets SSO URL with specific return location.
+
+          ```yaml
+          email: "[email protected]"
+          returnTo: "https://gitpod.io/workspaces"
+          ```
 
         Args:
           email: email is the email the user wants to login with
@@ -366,8 +509,35 @@ def list_login_providers(
         timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
     ) -> AsyncPaginator[LoginProvider, AsyncLoginProvidersPage[LoginProvider]]:
         """
-        ListLoginProviders returns the list of login providers matching the provided
-        filters.
+        Lists available login providers with optional filtering.
+
+        Use this method to:
+
+        - View supported authentication methods
+        - Get provider-specific login URLs
+        - Filter providers by invite
+
+        ### Examples
+
+        - List all providers:
+
+          Shows all available login providers.
+
+          ```yaml
+          pagination:
+            pageSize: 20
+          ```
+
+        - List for specific invite:
+
+          Shows providers available for an invite.
+
+          ```yaml
+          filter:
+            inviteId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
+          pagination:
+            pageSize: 20
+          ```
 
         Args:
           filter: filter contains the filter options for listing login methods