599 lines
19 KiB
Python
599 lines
19 KiB
Python
# This file was auto-generated by Fern from our API Definition.
|
|
|
|
import typing
|
|
from ..core.client_wrapper import SyncClientWrapper
|
|
from ..core.request_options import RequestOptions
|
|
from ..types.credential_response import CredentialResponse
|
|
from ..core.pydantic_utilities import parse_obj_as
|
|
from ..errors.unprocessable_entity_error import UnprocessableEntityError
|
|
from json.decoder import JSONDecodeError
|
|
from ..core.api_error import ApiError
|
|
from ..types.credential_type import CredentialType
|
|
from .types.create_credential_request_credential import CreateCredentialRequestCredential
|
|
from ..core.serialization import convert_and_respect_annotation_metadata
|
|
from ..core.jsonable_encoder import jsonable_encoder
|
|
from ..core.client_wrapper import AsyncClientWrapper
|
|
|
|
# this is used as the default value for optional parameters
|
|
OMIT = typing.cast(typing.Any, ...)
|
|
|
|
|
|
class CredentialsClient:
|
|
def __init__(self, *, client_wrapper: SyncClientWrapper):
|
|
self._client_wrapper = client_wrapper
|
|
|
|
def get_credentials(
|
|
self,
|
|
*,
|
|
page: typing.Optional[int] = None,
|
|
page_size: typing.Optional[int] = None,
|
|
request_options: typing.Optional[RequestOptions] = None,
|
|
) -> typing.List[CredentialResponse]:
|
|
"""
|
|
Retrieves a paginated list of credentials for the current organization
|
|
|
|
Parameters
|
|
----------
|
|
page : typing.Optional[int]
|
|
Page number for pagination
|
|
|
|
page_size : typing.Optional[int]
|
|
Number of items per page
|
|
|
|
request_options : typing.Optional[RequestOptions]
|
|
Request-specific configuration.
|
|
|
|
Returns
|
|
-------
|
|
typing.List[CredentialResponse]
|
|
Successful Response
|
|
|
|
Examples
|
|
--------
|
|
from skyvern import Skyvern
|
|
|
|
client = Skyvern(
|
|
api_key="YOUR_API_KEY",
|
|
authorization="YOUR_AUTHORIZATION",
|
|
)
|
|
client.credentials.get_credentials()
|
|
"""
|
|
_response = self._client_wrapper.httpx_client.request(
|
|
"v1/credentials",
|
|
method="GET",
|
|
params={
|
|
"page": page,
|
|
"page_size": page_size,
|
|
},
|
|
request_options=request_options,
|
|
)
|
|
try:
|
|
if 200 <= _response.status_code < 300:
|
|
return typing.cast(
|
|
typing.List[CredentialResponse],
|
|
parse_obj_as(
|
|
type_=typing.List[CredentialResponse], # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
if _response.status_code == 422:
|
|
raise UnprocessableEntityError(
|
|
typing.cast(
|
|
typing.Optional[typing.Any],
|
|
parse_obj_as(
|
|
type_=typing.Optional[typing.Any], # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
)
|
|
_response_json = _response.json()
|
|
except JSONDecodeError:
|
|
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
|
|
def create_credential(
|
|
self,
|
|
*,
|
|
name: str,
|
|
credential_type: CredentialType,
|
|
credential: CreateCredentialRequestCredential,
|
|
request_options: typing.Optional[RequestOptions] = None,
|
|
) -> CredentialResponse:
|
|
"""
|
|
Creates a new credential for the current organization
|
|
|
|
Parameters
|
|
----------
|
|
name : str
|
|
Name of the credential
|
|
|
|
credential_type : CredentialType
|
|
Type of credential to create
|
|
|
|
credential : CreateCredentialRequestCredential
|
|
The credential data to store
|
|
|
|
request_options : typing.Optional[RequestOptions]
|
|
Request-specific configuration.
|
|
|
|
Returns
|
|
-------
|
|
CredentialResponse
|
|
Successful Response
|
|
|
|
Examples
|
|
--------
|
|
from skyvern import NonEmptyPasswordCredential, Skyvern
|
|
|
|
client = Skyvern(
|
|
api_key="YOUR_API_KEY",
|
|
authorization="YOUR_AUTHORIZATION",
|
|
)
|
|
client.credentials.create_credential(
|
|
name="My Credential",
|
|
credential_type="password",
|
|
credential=NonEmptyPasswordCredential(
|
|
password="securepassword123",
|
|
username="user@example.com",
|
|
totp="JBSWY3DPEHPK3PXP",
|
|
),
|
|
)
|
|
"""
|
|
_response = self._client_wrapper.httpx_client.request(
|
|
"v1/credentials",
|
|
method="POST",
|
|
json={
|
|
"name": name,
|
|
"credential_type": credential_type,
|
|
"credential": convert_and_respect_annotation_metadata(
|
|
object_=credential, annotation=CreateCredentialRequestCredential, direction="write"
|
|
),
|
|
},
|
|
headers={
|
|
"content-type": "application/json",
|
|
},
|
|
request_options=request_options,
|
|
omit=OMIT,
|
|
)
|
|
try:
|
|
if 200 <= _response.status_code < 300:
|
|
return typing.cast(
|
|
CredentialResponse,
|
|
parse_obj_as(
|
|
type_=CredentialResponse, # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
if _response.status_code == 422:
|
|
raise UnprocessableEntityError(
|
|
typing.cast(
|
|
typing.Optional[typing.Any],
|
|
parse_obj_as(
|
|
type_=typing.Optional[typing.Any], # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
)
|
|
_response_json = _response.json()
|
|
except JSONDecodeError:
|
|
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
|
|
def get_credential(
|
|
self, credential_id: str, *, request_options: typing.Optional[RequestOptions] = None
|
|
) -> CredentialResponse:
|
|
"""
|
|
Retrieves a specific credential by its ID
|
|
|
|
Parameters
|
|
----------
|
|
credential_id : str
|
|
The unique identifier of the credential
|
|
|
|
request_options : typing.Optional[RequestOptions]
|
|
Request-specific configuration.
|
|
|
|
Returns
|
|
-------
|
|
CredentialResponse
|
|
Successful Response
|
|
|
|
Examples
|
|
--------
|
|
from skyvern import Skyvern
|
|
|
|
client = Skyvern(
|
|
api_key="YOUR_API_KEY",
|
|
authorization="YOUR_AUTHORIZATION",
|
|
)
|
|
client.credentials.get_credential(
|
|
credential_id="cred_1234567890",
|
|
)
|
|
"""
|
|
_response = self._client_wrapper.httpx_client.request(
|
|
f"v1/credentials/{jsonable_encoder(credential_id)}",
|
|
method="GET",
|
|
request_options=request_options,
|
|
)
|
|
try:
|
|
if 200 <= _response.status_code < 300:
|
|
return typing.cast(
|
|
CredentialResponse,
|
|
parse_obj_as(
|
|
type_=CredentialResponse, # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
if _response.status_code == 422:
|
|
raise UnprocessableEntityError(
|
|
typing.cast(
|
|
typing.Optional[typing.Any],
|
|
parse_obj_as(
|
|
type_=typing.Optional[typing.Any], # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
)
|
|
_response_json = _response.json()
|
|
except JSONDecodeError:
|
|
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
|
|
def delete_credential(self, credential_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None:
|
|
"""
|
|
Deletes a specific credential by its ID
|
|
|
|
Parameters
|
|
----------
|
|
credential_id : str
|
|
The unique identifier of the credential to delete
|
|
|
|
request_options : typing.Optional[RequestOptions]
|
|
Request-specific configuration.
|
|
|
|
Returns
|
|
-------
|
|
None
|
|
|
|
Examples
|
|
--------
|
|
from skyvern import Skyvern
|
|
|
|
client = Skyvern(
|
|
api_key="YOUR_API_KEY",
|
|
authorization="YOUR_AUTHORIZATION",
|
|
)
|
|
client.credentials.delete_credential(
|
|
credential_id="cred_1234567890",
|
|
)
|
|
"""
|
|
_response = self._client_wrapper.httpx_client.request(
|
|
f"v1/credentials/{jsonable_encoder(credential_id)}/delete",
|
|
method="POST",
|
|
request_options=request_options,
|
|
)
|
|
try:
|
|
if 200 <= _response.status_code < 300:
|
|
return
|
|
if _response.status_code == 422:
|
|
raise UnprocessableEntityError(
|
|
typing.cast(
|
|
typing.Optional[typing.Any],
|
|
parse_obj_as(
|
|
type_=typing.Optional[typing.Any], # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
)
|
|
_response_json = _response.json()
|
|
except JSONDecodeError:
|
|
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
|
|
|
|
class AsyncCredentialsClient:
|
|
def __init__(self, *, client_wrapper: AsyncClientWrapper):
|
|
self._client_wrapper = client_wrapper
|
|
|
|
async def get_credentials(
|
|
self,
|
|
*,
|
|
page: typing.Optional[int] = None,
|
|
page_size: typing.Optional[int] = None,
|
|
request_options: typing.Optional[RequestOptions] = None,
|
|
) -> typing.List[CredentialResponse]:
|
|
"""
|
|
Retrieves a paginated list of credentials for the current organization
|
|
|
|
Parameters
|
|
----------
|
|
page : typing.Optional[int]
|
|
Page number for pagination
|
|
|
|
page_size : typing.Optional[int]
|
|
Number of items per page
|
|
|
|
request_options : typing.Optional[RequestOptions]
|
|
Request-specific configuration.
|
|
|
|
Returns
|
|
-------
|
|
typing.List[CredentialResponse]
|
|
Successful Response
|
|
|
|
Examples
|
|
--------
|
|
import asyncio
|
|
|
|
from skyvern import AsyncSkyvern
|
|
|
|
client = AsyncSkyvern(
|
|
api_key="YOUR_API_KEY",
|
|
authorization="YOUR_AUTHORIZATION",
|
|
)
|
|
|
|
|
|
async def main() -> None:
|
|
await client.credentials.get_credentials()
|
|
|
|
|
|
asyncio.run(main())
|
|
"""
|
|
_response = await self._client_wrapper.httpx_client.request(
|
|
"v1/credentials",
|
|
method="GET",
|
|
params={
|
|
"page": page,
|
|
"page_size": page_size,
|
|
},
|
|
request_options=request_options,
|
|
)
|
|
try:
|
|
if 200 <= _response.status_code < 300:
|
|
return typing.cast(
|
|
typing.List[CredentialResponse],
|
|
parse_obj_as(
|
|
type_=typing.List[CredentialResponse], # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
if _response.status_code == 422:
|
|
raise UnprocessableEntityError(
|
|
typing.cast(
|
|
typing.Optional[typing.Any],
|
|
parse_obj_as(
|
|
type_=typing.Optional[typing.Any], # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
)
|
|
_response_json = _response.json()
|
|
except JSONDecodeError:
|
|
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
|
|
async def create_credential(
|
|
self,
|
|
*,
|
|
name: str,
|
|
credential_type: CredentialType,
|
|
credential: CreateCredentialRequestCredential,
|
|
request_options: typing.Optional[RequestOptions] = None,
|
|
) -> CredentialResponse:
|
|
"""
|
|
Creates a new credential for the current organization
|
|
|
|
Parameters
|
|
----------
|
|
name : str
|
|
Name of the credential
|
|
|
|
credential_type : CredentialType
|
|
Type of credential to create
|
|
|
|
credential : CreateCredentialRequestCredential
|
|
The credential data to store
|
|
|
|
request_options : typing.Optional[RequestOptions]
|
|
Request-specific configuration.
|
|
|
|
Returns
|
|
-------
|
|
CredentialResponse
|
|
Successful Response
|
|
|
|
Examples
|
|
--------
|
|
import asyncio
|
|
|
|
from skyvern import AsyncSkyvern, NonEmptyPasswordCredential
|
|
|
|
client = AsyncSkyvern(
|
|
api_key="YOUR_API_KEY",
|
|
authorization="YOUR_AUTHORIZATION",
|
|
)
|
|
|
|
|
|
async def main() -> None:
|
|
await client.credentials.create_credential(
|
|
name="My Credential",
|
|
credential_type="password",
|
|
credential=NonEmptyPasswordCredential(
|
|
password="securepassword123",
|
|
username="user@example.com",
|
|
totp="JBSWY3DPEHPK3PXP",
|
|
),
|
|
)
|
|
|
|
|
|
asyncio.run(main())
|
|
"""
|
|
_response = await self._client_wrapper.httpx_client.request(
|
|
"v1/credentials",
|
|
method="POST",
|
|
json={
|
|
"name": name,
|
|
"credential_type": credential_type,
|
|
"credential": convert_and_respect_annotation_metadata(
|
|
object_=credential, annotation=CreateCredentialRequestCredential, direction="write"
|
|
),
|
|
},
|
|
headers={
|
|
"content-type": "application/json",
|
|
},
|
|
request_options=request_options,
|
|
omit=OMIT,
|
|
)
|
|
try:
|
|
if 200 <= _response.status_code < 300:
|
|
return typing.cast(
|
|
CredentialResponse,
|
|
parse_obj_as(
|
|
type_=CredentialResponse, # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
if _response.status_code == 422:
|
|
raise UnprocessableEntityError(
|
|
typing.cast(
|
|
typing.Optional[typing.Any],
|
|
parse_obj_as(
|
|
type_=typing.Optional[typing.Any], # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
)
|
|
_response_json = _response.json()
|
|
except JSONDecodeError:
|
|
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
|
|
async def get_credential(
|
|
self, credential_id: str, *, request_options: typing.Optional[RequestOptions] = None
|
|
) -> CredentialResponse:
|
|
"""
|
|
Retrieves a specific credential by its ID
|
|
|
|
Parameters
|
|
----------
|
|
credential_id : str
|
|
The unique identifier of the credential
|
|
|
|
request_options : typing.Optional[RequestOptions]
|
|
Request-specific configuration.
|
|
|
|
Returns
|
|
-------
|
|
CredentialResponse
|
|
Successful Response
|
|
|
|
Examples
|
|
--------
|
|
import asyncio
|
|
|
|
from skyvern import AsyncSkyvern
|
|
|
|
client = AsyncSkyvern(
|
|
api_key="YOUR_API_KEY",
|
|
authorization="YOUR_AUTHORIZATION",
|
|
)
|
|
|
|
|
|
async def main() -> None:
|
|
await client.credentials.get_credential(
|
|
credential_id="cred_1234567890",
|
|
)
|
|
|
|
|
|
asyncio.run(main())
|
|
"""
|
|
_response = await self._client_wrapper.httpx_client.request(
|
|
f"v1/credentials/{jsonable_encoder(credential_id)}",
|
|
method="GET",
|
|
request_options=request_options,
|
|
)
|
|
try:
|
|
if 200 <= _response.status_code < 300:
|
|
return typing.cast(
|
|
CredentialResponse,
|
|
parse_obj_as(
|
|
type_=CredentialResponse, # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
if _response.status_code == 422:
|
|
raise UnprocessableEntityError(
|
|
typing.cast(
|
|
typing.Optional[typing.Any],
|
|
parse_obj_as(
|
|
type_=typing.Optional[typing.Any], # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
)
|
|
_response_json = _response.json()
|
|
except JSONDecodeError:
|
|
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
raise ApiError(status_code=_response.status_code, body=_response_json)
|
|
|
|
async def delete_credential(
|
|
self, credential_id: str, *, request_options: typing.Optional[RequestOptions] = None
|
|
) -> None:
|
|
"""
|
|
Deletes a specific credential by its ID
|
|
|
|
Parameters
|
|
----------
|
|
credential_id : str
|
|
The unique identifier of the credential to delete
|
|
|
|
request_options : typing.Optional[RequestOptions]
|
|
Request-specific configuration.
|
|
|
|
Returns
|
|
-------
|
|
None
|
|
|
|
Examples
|
|
--------
|
|
import asyncio
|
|
|
|
from skyvern import AsyncSkyvern
|
|
|
|
client = AsyncSkyvern(
|
|
api_key="YOUR_API_KEY",
|
|
authorization="YOUR_AUTHORIZATION",
|
|
)
|
|
|
|
|
|
async def main() -> None:
|
|
await client.credentials.delete_credential(
|
|
credential_id="cred_1234567890",
|
|
)
|
|
|
|
|
|
asyncio.run(main())
|
|
"""
|
|
_response = await self._client_wrapper.httpx_client.request(
|
|
f"v1/credentials/{jsonable_encoder(credential_id)}/delete",
|
|
method="POST",
|
|
request_options=request_options,
|
|
)
|
|
try:
|
|
if 200 <= _response.status_code < 300:
|
|
return
|
|
if _response.status_code == 422:
|
|
raise UnprocessableEntityError(
|
|
typing.cast(
|
|
typing.Optional[typing.Any],
|
|
parse_obj_as(
|
|
type_=typing.Optional[typing.Any], # type: ignore
|
|
object_=_response.json(),
|
|
),
|
|
)
|
|
)
|
|
_response_json = _response.json()
|
|
except JSONDecodeError:
|
|
raise ApiError(status_code=_response.status_code, body=_response.text)
|
|
raise ApiError(status_code=_response.status_code, body=_response_json)
|