add fern sdk (#1786)
This commit is contained in:
134
skyvern/client/client.py
Normal file
134
skyvern/client/client.py
Normal file
@@ -0,0 +1,134 @@
|
||||
# This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
import typing
|
||||
from .environment import SkyvernEnvironment
|
||||
import httpx
|
||||
from .core.client_wrapper import SyncClientWrapper
|
||||
from .server.client import ServerClient
|
||||
from .agent.client import AgentClient
|
||||
from .core.client_wrapper import AsyncClientWrapper
|
||||
from .server.client import AsyncServerClient
|
||||
from .agent.client import AsyncAgentClient
|
||||
|
||||
|
||||
class Skyvern:
|
||||
"""
|
||||
Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
base_url : typing.Optional[str]
|
||||
The base url to use for requests from the client.
|
||||
|
||||
environment : SkyvernEnvironment
|
||||
The environment to use for requests from the client. from .environment import SkyvernEnvironment
|
||||
|
||||
|
||||
|
||||
Defaults to SkyvernEnvironment.PRODUCTION
|
||||
|
||||
|
||||
|
||||
timeout : typing.Optional[float]
|
||||
The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
|
||||
|
||||
follow_redirects : typing.Optional[bool]
|
||||
Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
|
||||
|
||||
httpx_client : typing.Optional[httpx.Client]
|
||||
The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
|
||||
|
||||
Examples
|
||||
--------
|
||||
from skyverndocs import Skyvern
|
||||
|
||||
client = Skyvern()
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
*,
|
||||
base_url: typing.Optional[str] = None,
|
||||
environment: SkyvernEnvironment = SkyvernEnvironment.PRODUCTION,
|
||||
timeout: typing.Optional[float] = None,
|
||||
follow_redirects: typing.Optional[bool] = True,
|
||||
httpx_client: typing.Optional[httpx.Client] = None,
|
||||
):
|
||||
_defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
|
||||
self._client_wrapper = SyncClientWrapper(
|
||||
base_url=_get_base_url(base_url=base_url, environment=environment),
|
||||
httpx_client=httpx_client
|
||||
if httpx_client is not None
|
||||
else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
|
||||
if follow_redirects is not None
|
||||
else httpx.Client(timeout=_defaulted_timeout),
|
||||
timeout=_defaulted_timeout,
|
||||
)
|
||||
self.server = ServerClient(client_wrapper=self._client_wrapper)
|
||||
self.agent = AgentClient(client_wrapper=self._client_wrapper)
|
||||
|
||||
|
||||
class AsyncSkyvern:
|
||||
"""
|
||||
Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
base_url : typing.Optional[str]
|
||||
The base url to use for requests from the client.
|
||||
|
||||
environment : SkyvernEnvironment
|
||||
The environment to use for requests from the client. from .environment import SkyvernEnvironment
|
||||
|
||||
|
||||
|
||||
Defaults to SkyvernEnvironment.PRODUCTION
|
||||
|
||||
|
||||
|
||||
timeout : typing.Optional[float]
|
||||
The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
|
||||
|
||||
follow_redirects : typing.Optional[bool]
|
||||
Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
|
||||
|
||||
httpx_client : typing.Optional[httpx.AsyncClient]
|
||||
The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
|
||||
|
||||
Examples
|
||||
--------
|
||||
from skyverndocs import AsyncSkyvern
|
||||
|
||||
client = AsyncSkyvern()
|
||||
"""
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
*,
|
||||
base_url: typing.Optional[str] = None,
|
||||
environment: SkyvernEnvironment = SkyvernEnvironment.PRODUCTION,
|
||||
timeout: typing.Optional[float] = None,
|
||||
follow_redirects: typing.Optional[bool] = True,
|
||||
httpx_client: typing.Optional[httpx.AsyncClient] = None,
|
||||
):
|
||||
_defaulted_timeout = timeout if timeout is not None else 60 if httpx_client is None else None
|
||||
self._client_wrapper = AsyncClientWrapper(
|
||||
base_url=_get_base_url(base_url=base_url, environment=environment),
|
||||
httpx_client=httpx_client
|
||||
if httpx_client is not None
|
||||
else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
|
||||
if follow_redirects is not None
|
||||
else httpx.AsyncClient(timeout=_defaulted_timeout),
|
||||
timeout=_defaulted_timeout,
|
||||
)
|
||||
self.server = AsyncServerClient(client_wrapper=self._client_wrapper)
|
||||
self.agent = AsyncAgentClient(client_wrapper=self._client_wrapper)
|
||||
|
||||
|
||||
def _get_base_url(*, base_url: typing.Optional[str] = None, environment: SkyvernEnvironment) -> str:
|
||||
if base_url is not None:
|
||||
return base_url
|
||||
elif environment is not None:
|
||||
return environment.value
|
||||
else:
|
||||
raise Exception("Please pass in either base_url or environment to construct the client")
|
||||
Reference in New Issue
Block a user