Skip to content

Commit 3fb199d

Browse files
stainless-app[bot]stainless-app[bot]
authored
release: 0.1.4 (#47)
* feat(api): manual updates (#46) * release: 0.1.4 --------- Co-authored-by: stainless-app[bot] <142633134+stainless-app[bot]@users.noreply.github.com>
1 parent e388ba1 commit 3fb199d

32 files changed

+1968
-263
lines changed

‎.release-please-manifest.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
".": "0.1.3"
2+
".": "0.1.4"
33
}

‎.stats.yml

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

‎CHANGELOG.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# Changelog
22

3+
## 0.1.4 (2025-02-18)
4+
5+
Full Changelog: [v0.1.3...v0.1.4](https://github.com/gitpod-io/gitpod-sdk-python/compare/v0.1.3...v0.1.4)
6+
7+
### Features
8+
9+
* **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))
10+
311
## 0.1.3 (2025-02-14)
412

513
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-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "gitpod-sdk"
3-
version = "0.1.3"
3+
version = "0.1.4"
44
description = "The official Python library for the gitpod API"
55
dynamic = ["readme"]
66
license = "Apache-2.0"

‎src/gitpod/_version.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

33
__title__ = "gitpod"
4-
__version__ = "0.1.3" # x-release-please-version
4+
__version__ = "0.1.4" # x-release-please-version

‎src/gitpod/resources/accounts.py

+184-14
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,24 @@ def retrieve(
6666
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
6767
) -> AccountRetrieveResponse:
6868
"""
69-
GetAccount retrieves a single Account.
69+
Gets information about the currently authenticated account.
70+
71+
Use this method to:
72+
73+
- Retrieve account profile information
74+
- Check organization memberships
75+
- View account settings
76+
- Get joinable organizations
77+
78+
### Examples
79+
80+
- Get account details:
81+
82+
Retrieves information about the authenticated account.
83+
84+
```yaml
85+
{}
86+
```
7087
7188
Args:
7289
extra_headers: Send extra headers
@@ -97,10 +114,26 @@ def delete(
97114
extra_body: Body | None = None,
98115
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
99116
) -> object:
100-
"""DeleteAccount deletes an Account.
117+
"""
118+
Deletes an account permanently.
119+
120+
Use this method to:
101121
102-
To Delete an Account, the Account must not be
103-
an active member of any Organization.
122+
- Remove unused accounts
123+
- Clean up test accounts
124+
- Complete account deletion requests
125+
126+
The account must not be an active member of any organization.
127+
128+
### Examples
129+
130+
- Delete account:
131+
132+
Permanently removes an account.
133+
134+
```yaml
135+
accountId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
136+
```
104137
105138
Args:
106139
extra_headers: Send extra headers
@@ -133,7 +166,32 @@ def get_sso_login_url(
133166
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
134167
) -> AccountGetSSOLoginURLResponse:
135168
"""
136-
GetSSOLoginURL returns the URL to redirect the user to for SSO login.
169+
Gets the SSO login URL for a specific email domain.
170+
171+
Use this method to:
172+
173+
- Initiate SSO authentication
174+
- Get organization-specific login URLs
175+
- Handle SSO redirects
176+
177+
### Examples
178+
179+
- Get login URL:
180+
181+
Retrieves SSO URL for email domain.
182+
183+
```yaml
184+
email: "user@company.com"
185+
```
186+
187+
- Get URL with return path:
188+
189+
Gets SSO URL with specific return location.
190+
191+
```yaml
192+
email: "user@company.com"
193+
returnTo: "https://gitpod.io/workspaces"
194+
```
137195
138196
Args:
139197
email: email is the email the user wants to login with
@@ -178,8 +236,35 @@ def list_login_providers(
178236
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
179237
) -> SyncLoginProvidersPage[LoginProvider]:
180238
"""
181-
ListLoginProviders returns the list of login providers matching the provided
182-
filters.
239+
Lists available login providers with optional filtering.
240+
241+
Use this method to:
242+
243+
- View supported authentication methods
244+
- Get provider-specific login URLs
245+
- Filter providers by invite
246+
247+
### Examples
248+
249+
- List all providers:
250+
251+
Shows all available login providers.
252+
253+
```yaml
254+
pagination:
255+
pageSize: 20
256+
```
257+
258+
- List for specific invite:
259+
260+
Shows providers available for an invite.
261+
262+
```yaml
263+
filter:
264+
inviteId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
265+
pagination:
266+
pageSize: 20
267+
```
183268
184269
Args:
185270
filter: filter contains the filter options for listing login methods
@@ -254,7 +339,24 @@ async def retrieve(
254339
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
255340
) -> AccountRetrieveResponse:
256341
"""
257-
GetAccount retrieves a single Account.
342+
Gets information about the currently authenticated account.
343+
344+
Use this method to:
345+
346+
- Retrieve account profile information
347+
- Check organization memberships
348+
- View account settings
349+
- Get joinable organizations
350+
351+
### Examples
352+
353+
- Get account details:
354+
355+
Retrieves information about the authenticated account.
356+
357+
```yaml
358+
{}
359+
```
258360
259361
Args:
260362
extra_headers: Send extra headers
@@ -285,10 +387,26 @@ async def delete(
285387
extra_body: Body | None = None,
286388
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
287389
) -> object:
288-
"""DeleteAccount deletes an Account.
390+
"""
391+
Deletes an account permanently.
392+
393+
Use this method to:
289394
290-
To Delete an Account, the Account must not be
291-
an active member of any Organization.
395+
- Remove unused accounts
396+
- Clean up test accounts
397+
- Complete account deletion requests
398+
399+
The account must not be an active member of any organization.
400+
401+
### Examples
402+
403+
- Delete account:
404+
405+
Permanently removes an account.
406+
407+
```yaml
408+
accountId: "f53d2330-3795-4c5d-a1f3-453121af9c60"
409+
```
292410
293411
Args:
294412
extra_headers: Send extra headers
@@ -321,7 +439,32 @@ async def get_sso_login_url(
321439
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
322440
) -> AccountGetSSOLoginURLResponse:
323441
"""
324-
GetSSOLoginURL returns the URL to redirect the user to for SSO login.
442+
Gets the SSO login URL for a specific email domain.
443+
444+
Use this method to:
445+
446+
- Initiate SSO authentication
447+
- Get organization-specific login URLs
448+
- Handle SSO redirects
449+
450+
### Examples
451+
452+
- Get login URL:
453+
454+
Retrieves SSO URL for email domain.
455+
456+
```yaml
457+
email: "user@company.com"
458+
```
459+
460+
- Get URL with return path:
461+
462+
Gets SSO URL with specific return location.
463+
464+
```yaml
465+
email: "user@company.com"
466+
returnTo: "https://gitpod.io/workspaces"
467+
```
325468
326469
Args:
327470
email: email is the email the user wants to login with
@@ -366,8 +509,35 @@ def list_login_providers(
366509
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
367510
) -> AsyncPaginator[LoginProvider, AsyncLoginProvidersPage[LoginProvider]]:
368511
"""
369-
ListLoginProviders returns the list of login providers matching the provided
370-
filters.
512+
Lists available login providers with optional filtering.
513+
514+
Use this method to:
515+
516+
- View supported authentication methods
517+
- Get provider-specific login URLs
518+
- Filter providers by invite
519+
520+
### Examples
521+
522+
- List all providers:
523+
524+
Shows all available login providers.
525+
526+
```yaml
527+
pagination:
528+
pageSize: 20
529+
```
530+
531+
- List for specific invite:
532+
533+
Shows providers available for an invite.
534+
535+
```yaml
536+
filter:
537+
inviteId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
538+
pagination:
539+
pageSize: 20
540+
```
371541
372542
Args:
373543
filter: filter contains the filter options for listing login methods

0 commit comments

Comments
 (0)