bump version to v1.0.11 (#4574)

This commit is contained in:
Shuchang Zheng
2026-01-28 16:47:21 -08:00
committed by GitHub
parent adf9ad3467
commit 34aadb8c09
82 changed files with 3077 additions and 304 deletions

View File

@@ -13,12 +13,20 @@ from .environment import SkyvernEnvironment
from .raw_client import AsyncRawSkyvern, RawSkyvern
from .types.artifact import Artifact
from .types.artifact_type import ArtifactType
from .types.billing_state_response import BillingStateResponse
from .types.browser_profile import BrowserProfile
from .types.browser_session_response import BrowserSessionResponse
from .types.change_tier_response import ChangeTierResponse
from .types.checkout_session_response import CheckoutSessionResponse
from .types.create_credential_request_credential import CreateCredentialRequestCredential
from .types.create_script_response import CreateScriptResponse
from .types.credential_response import CredentialResponse
from .types.extensions import Extensions
from .types.get_run_response import GetRunResponse
from .types.otp_type import OtpType
from .types.persistent_browser_type import PersistentBrowserType
from .types.plan_tier import PlanTier
from .types.portal_session_response import PortalSessionResponse
from .types.proxy_location import ProxyLocation
from .types.retry_run_webhook_request import RetryRunWebhookRequest
from .types.run_engine import RunEngine
@@ -185,15 +193,16 @@ class Skyvern:
- RESIDENTIAL_FR: France
- RESIDENTIAL_DE: Germany
- RESIDENTIAL_NZ: New Zealand
- RESIDENTIAL_PH: Philippines
- RESIDENTIAL_ZA: South Africa
- RESIDENTIAL_AR: Argentina
- RESIDENTIAL_AU: Australia
- RESIDENTIAL_ISP: ISP proxy
- US-CA: California
- US-NY: New York
- US-TX: Texas
- US-FL: Florida
- US-WA: Washington
- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
- NONE: No proxy
Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
@@ -344,15 +353,16 @@ class Skyvern:
- RESIDENTIAL_FR: France
- RESIDENTIAL_DE: Germany
- RESIDENTIAL_NZ: New Zealand
- RESIDENTIAL_PH: Philippines
- RESIDENTIAL_ZA: South Africa
- RESIDENTIAL_AR: Argentina
- RESIDENTIAL_AU: Australia
- RESIDENTIAL_ISP: ISP proxy
- US-CA: California
- US-NY: New York
- US-TX: Texas
- US-FL: Florida
- US-WA: Washington
- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
- NONE: No proxy
Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
@@ -1079,6 +1089,8 @@ class Skyvern:
*,
timeout: typing.Optional[int] = OMIT,
proxy_location: typing.Optional[ProxyLocation] = OMIT,
extensions: typing.Optional[typing.Sequence[Extensions]] = OMIT,
browser_type: typing.Optional[PersistentBrowserType] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> BrowserSessionResponse:
"""
@@ -1103,17 +1115,24 @@ class Skyvern:
- RESIDENTIAL_FR: France
- RESIDENTIAL_DE: Germany
- RESIDENTIAL_NZ: New Zealand
- RESIDENTIAL_PH: Philippines
- RESIDENTIAL_ZA: South Africa
- RESIDENTIAL_AR: Argentina
- RESIDENTIAL_AU: Australia
- RESIDENTIAL_ISP: ISP proxy
- US-CA: California
- US-NY: New York
- US-TX: Texas
- US-FL: Florida
- US-WA: Washington
- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
- NONE: No proxy
extensions : typing.Optional[typing.Sequence[Extensions]]
A list of extensions to install in the browser session.
browser_type : typing.Optional[PersistentBrowserType]
The type of browser to use for the session.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -1132,7 +1151,11 @@ class Skyvern:
client.create_browser_session()
"""
_response = self._raw_client.create_browser_session(
timeout=timeout, proxy_location=proxy_location, request_options=request_options
timeout=timeout,
proxy_location=proxy_location,
extensions=extensions,
browser_type=browser_type,
request_options=request_options,
)
return _response.data
@@ -1212,6 +1235,7 @@ class Skyvern:
workflow_run_id: typing.Optional[str] = OMIT,
source: typing.Optional[str] = OMIT,
expired_at: typing.Optional[dt.datetime] = OMIT,
type: typing.Optional[OtpType] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> TotpCode:
"""
@@ -1240,6 +1264,9 @@ class Skyvern:
expired_at : typing.Optional[dt.datetime]
The timestamp when the TOTP code expires
type : typing.Optional[OtpType]
Optional. If provided, forces extraction of this specific OTP type (totp or magic_link). Use this when the content contains multiple OTP types and you want to specify which one to extract.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -1268,6 +1295,7 @@ class Skyvern:
workflow_run_id=workflow_run_id,
source=source,
expired_at=expired_at,
type=type,
request_options=request_options,
)
return _response.data
@@ -1893,6 +1921,144 @@ class Skyvern:
)
return _response.data
def create_checkout_session_api_v1billing_checkout_post(
self, *, tier: PlanTier, request_options: typing.Optional[RequestOptions] = None
) -> CheckoutSessionResponse:
"""
Create a Stripe Checkout Session for subscribing to a tier.
Frontend should redirect the user to the returned URL.
After successful checkout, Stripe will send a webhook that we handle
to store the subscription and initialize billing state.
Returns 400 if org already has an active subscription (use portal instead).
Parameters
----------
tier : PlanTier
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
CheckoutSessionResponse
Successful Response
Examples
--------
from skyvern import Skyvern
client = Skyvern(
api_key="YOUR_API_KEY",
)
client.create_checkout_session_api_v1billing_checkout_post(
tier="free",
)
"""
_response = self._raw_client.create_checkout_session_api_v1billing_checkout_post(
tier=tier, request_options=request_options
)
return _response.data
def create_portal_session_api_v1billing_portal_post(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> PortalSessionResponse:
"""
Create a Stripe Customer Portal session for managing subscription.
Frontend should redirect the user to the returned URL.
The portal allows users to:
- Update payment methods
- Upgrade/downgrade plans
- Cancel subscription
- View invoices
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
PortalSessionResponse
Successful Response
Examples
--------
from skyvern import Skyvern
client = Skyvern(
api_key="YOUR_API_KEY",
)
client.create_portal_session_api_v1billing_portal_post()
"""
_response = self._raw_client.create_portal_session_api_v1billing_portal_post(request_options=request_options)
return _response.data
def get_organization_billing_api_v1billing_state_get(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> typing.Optional[BillingStateResponse]:
"""
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.Optional[BillingStateResponse]
Successful Response
Examples
--------
from skyvern import Skyvern
client = Skyvern(
api_key="YOUR_API_KEY",
)
client.get_organization_billing_api_v1billing_state_get()
"""
_response = self._raw_client.get_organization_billing_api_v1billing_state_get(request_options=request_options)
return _response.data
def change_tier_api_v1billing_change_tier_post(
self, *, tier: PlanTier, request_options: typing.Optional[RequestOptions] = None
) -> ChangeTierResponse:
"""
Redirect to Stripe Portal for tier changes.
Portal handles proration based on configured settings:
- Upgrades: Immediate proration charge
- Downgrades: Apply at end of billing period
Parameters
----------
tier : PlanTier
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ChangeTierResponse
Successful Response
Examples
--------
from skyvern import Skyvern
client = Skyvern(
api_key="YOUR_API_KEY",
)
client.change_tier_api_v1billing_change_tier_post(
tier="free",
)
"""
_response = self._raw_client.change_tier_api_v1billing_change_tier_post(
tier=tier, request_options=request_options
)
return _response.data
@property
def scripts(self):
if self._scripts is None:
@@ -2041,15 +2207,16 @@ class AsyncSkyvern:
- RESIDENTIAL_FR: France
- RESIDENTIAL_DE: Germany
- RESIDENTIAL_NZ: New Zealand
- RESIDENTIAL_PH: Philippines
- RESIDENTIAL_ZA: South Africa
- RESIDENTIAL_AR: Argentina
- RESIDENTIAL_AU: Australia
- RESIDENTIAL_ISP: ISP proxy
- US-CA: California
- US-NY: New York
- US-TX: Texas
- US-FL: Florida
- US-WA: Washington
- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
- NONE: No proxy
Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
@@ -2208,15 +2375,16 @@ class AsyncSkyvern:
- RESIDENTIAL_FR: France
- RESIDENTIAL_DE: Germany
- RESIDENTIAL_NZ: New Zealand
- RESIDENTIAL_PH: Philippines
- RESIDENTIAL_ZA: South Africa
- RESIDENTIAL_AR: Argentina
- RESIDENTIAL_AU: Australia
- RESIDENTIAL_ISP: ISP proxy
- US-CA: California
- US-NY: New York
- US-TX: Texas
- US-FL: Florida
- US-WA: Washington
- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
- NONE: No proxy
Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
@@ -3081,6 +3249,8 @@ class AsyncSkyvern:
*,
timeout: typing.Optional[int] = OMIT,
proxy_location: typing.Optional[ProxyLocation] = OMIT,
extensions: typing.Optional[typing.Sequence[Extensions]] = OMIT,
browser_type: typing.Optional[PersistentBrowserType] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> BrowserSessionResponse:
"""
@@ -3105,17 +3275,24 @@ class AsyncSkyvern:
- RESIDENTIAL_FR: France
- RESIDENTIAL_DE: Germany
- RESIDENTIAL_NZ: New Zealand
- RESIDENTIAL_PH: Philippines
- RESIDENTIAL_ZA: South Africa
- RESIDENTIAL_AR: Argentina
- RESIDENTIAL_AU: Australia
- RESIDENTIAL_ISP: ISP proxy
- US-CA: California
- US-NY: New York
- US-TX: Texas
- US-FL: Florida
- US-WA: Washington
- US-CA: California (deprecated, routes through RESIDENTIAL_ISP)
- US-NY: New York (deprecated, routes through RESIDENTIAL_ISP)
- US-TX: Texas (deprecated, routes through RESIDENTIAL_ISP)
- US-FL: Florida (deprecated, routes through RESIDENTIAL_ISP)
- US-WA: Washington (deprecated, routes through RESIDENTIAL_ISP)
- NONE: No proxy
extensions : typing.Optional[typing.Sequence[Extensions]]
A list of extensions to install in the browser session.
browser_type : typing.Optional[PersistentBrowserType]
The type of browser to use for the session.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -3142,7 +3319,11 @@ class AsyncSkyvern:
asyncio.run(main())
"""
_response = await self._raw_client.create_browser_session(
timeout=timeout, proxy_location=proxy_location, request_options=request_options
timeout=timeout,
proxy_location=proxy_location,
extensions=extensions,
browser_type=browser_type,
request_options=request_options,
)
return _response.data
@@ -3238,6 +3419,7 @@ class AsyncSkyvern:
workflow_run_id: typing.Optional[str] = OMIT,
source: typing.Optional[str] = OMIT,
expired_at: typing.Optional[dt.datetime] = OMIT,
type: typing.Optional[OtpType] = OMIT,
request_options: typing.Optional[RequestOptions] = None,
) -> TotpCode:
"""
@@ -3266,6 +3448,9 @@ class AsyncSkyvern:
expired_at : typing.Optional[dt.datetime]
The timestamp when the TOTP code expires
type : typing.Optional[OtpType]
Optional. If provided, forces extraction of this specific OTP type (totp or magic_link). Use this when the content contains multiple OTP types and you want to specify which one to extract.
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
@@ -3302,6 +3487,7 @@ class AsyncSkyvern:
workflow_run_id=workflow_run_id,
source=source,
expired_at=expired_at,
type=type,
request_options=request_options,
)
return _response.data
@@ -4019,6 +4205,180 @@ class AsyncSkyvern:
)
return _response.data
async def create_checkout_session_api_v1billing_checkout_post(
self, *, tier: PlanTier, request_options: typing.Optional[RequestOptions] = None
) -> CheckoutSessionResponse:
"""
Create a Stripe Checkout Session for subscribing to a tier.
Frontend should redirect the user to the returned URL.
After successful checkout, Stripe will send a webhook that we handle
to store the subscription and initialize billing state.
Returns 400 if org already has an active subscription (use portal instead).
Parameters
----------
tier : PlanTier
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
CheckoutSessionResponse
Successful Response
Examples
--------
import asyncio
from skyvern import AsyncSkyvern
client = AsyncSkyvern(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.create_checkout_session_api_v1billing_checkout_post(
tier="free",
)
asyncio.run(main())
"""
_response = await self._raw_client.create_checkout_session_api_v1billing_checkout_post(
tier=tier, request_options=request_options
)
return _response.data
async def create_portal_session_api_v1billing_portal_post(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> PortalSessionResponse:
"""
Create a Stripe Customer Portal session for managing subscription.
Frontend should redirect the user to the returned URL.
The portal allows users to:
- Update payment methods
- Upgrade/downgrade plans
- Cancel subscription
- View invoices
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
PortalSessionResponse
Successful Response
Examples
--------
import asyncio
from skyvern import AsyncSkyvern
client = AsyncSkyvern(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.create_portal_session_api_v1billing_portal_post()
asyncio.run(main())
"""
_response = await self._raw_client.create_portal_session_api_v1billing_portal_post(
request_options=request_options
)
return _response.data
async def get_organization_billing_api_v1billing_state_get(
self, *, request_options: typing.Optional[RequestOptions] = None
) -> typing.Optional[BillingStateResponse]:
"""
Parameters
----------
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
typing.Optional[BillingStateResponse]
Successful Response
Examples
--------
import asyncio
from skyvern import AsyncSkyvern
client = AsyncSkyvern(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.get_organization_billing_api_v1billing_state_get()
asyncio.run(main())
"""
_response = await self._raw_client.get_organization_billing_api_v1billing_state_get(
request_options=request_options
)
return _response.data
async def change_tier_api_v1billing_change_tier_post(
self, *, tier: PlanTier, request_options: typing.Optional[RequestOptions] = None
) -> ChangeTierResponse:
"""
Redirect to Stripe Portal for tier changes.
Portal handles proration based on configured settings:
- Upgrades: Immediate proration charge
- Downgrades: Apply at end of billing period
Parameters
----------
tier : PlanTier
request_options : typing.Optional[RequestOptions]
Request-specific configuration.
Returns
-------
ChangeTierResponse
Successful Response
Examples
--------
import asyncio
from skyvern import AsyncSkyvern
client = AsyncSkyvern(
api_key="YOUR_API_KEY",
)
async def main() -> None:
await client.change_tier_api_v1billing_change_tier_post(
tier="free",
)
asyncio.run(main())
"""
_response = await self._raw_client.change_tier_api_v1billing_change_tier_post(
tier=tier, request_options=request_options
)
return _response.data
@property
def scripts(self):
if self._scripts is None: