bytekit-sdk 0.3.0__py3-none-any.whl

bytekit/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing ByteKit API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

bytekit/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

bytekit/api/account/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

bytekit/api/account/get_account.py

@@ -0,0 +1,157 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.account_bearer_response import AccountBearerResponse
+from ...models.account_session_response import AccountSessionResponse
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/account",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union["AccountBearerResponse", "AccountSessionResponse"]]:
+    if response.status_code == 200:
+
+        def _parse_response_200(
+            data: object,
+        ) -> Union["AccountBearerResponse", "AccountSessionResponse"]:
+            try:
+                if not isinstance(data, dict):
+                    raise TypeError()
+                response_200_type_0 = AccountBearerResponse.from_dict(data)
+
+                return response_200_type_0
+            except:  # noqa: E722
+                pass
+            if not isinstance(data, dict):
+                raise TypeError()
+            response_200_type_1 = AccountSessionResponse.from_dict(data)
+
+            return response_200_type_1
+
+        response_200 = _parse_response_200(response.json())
+
+        return response_200
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union["AccountBearerResponse", "AccountSessionResponse"]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union["AccountBearerResponse", "AccountSessionResponse"]]:
+    """Get account details
+
+     Returns account, plan, and current API key details, including the
+    `api_key` and `subscription` fields.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union['AccountBearerResponse', 'AccountSessionResponse']]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union["AccountBearerResponse", "AccountSessionResponse"]]:
+    """Get account details
+
+     Returns account, plan, and current API key details, including the
+    `api_key` and `subscription` fields.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union['AccountBearerResponse', 'AccountSessionResponse']
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[Union["AccountBearerResponse", "AccountSessionResponse"]]:
+    """Get account details
+
+     Returns account, plan, and current API key details, including the
+    `api_key` and `subscription` fields.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union['AccountBearerResponse', 'AccountSessionResponse']]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Union["AccountBearerResponse", "AccountSessionResponse"]]:
+    """Get account details
+
+     Returns account, plan, and current API key details, including the
+    `api_key` and `subscription` fields.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union['AccountBearerResponse', 'AccountSessionResponse']
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

bytekit/api/bulk/__init__.py

@@ -0,0 +1 @@
+"""Contains endpoint functions for accessing the API"""

bytekit/api/bulk/create_bulk.py

@@ -0,0 +1,204 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.create_bulk_body import CreateBulkBody
+from ...models.create_bulk_response_202 import CreateBulkResponse202
+from ...models.error import Error
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: CreateBulkBody,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/bulk",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[CreateBulkResponse202, Error]]:
+    if response.status_code == 202:
+        response_202 = CreateBulkResponse202.from_dict(response.json())
+
+        return response_202
+    if response.status_code == 400:
+        response_400 = Error.from_dict(response.json())
+
+        return response_400
+    if response.status_code == 422:
+        response_422 = Error.from_dict(response.json())
+
+        return response_422
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[CreateBulkResponse202, Error]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateBulkBody,
+) -> Response[Union[CreateBulkResponse202, Error]]:
+    """Create mixed bulk job
+
+     Enqueues screenshots or scrapes in a single batch.
+    Provide `urls` (simple list) or `items` (per-item config), not both.
+    Webhook deliveries include `X-ByteKit-Event: bulk.completed` so
+    receivers can dispatch on the header without parsing the body shape.
+
+    Args:
+        body (CreateBulkBody): Provide `urls` (simple list) OR `items` (per-item config), not
+            both. `type` selects the capture kind per entry — only
+            `screenshot` and `scrape` are accepted (`recording` is
+            deactivated). Behaviour fields may be set per item or via
+            `defaults`; a per-item value overrides the matching default.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[CreateBulkResponse202, Error]]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateBulkBody,
+) -> Optional[Union[CreateBulkResponse202, Error]]:
+    """Create mixed bulk job
+
+     Enqueues screenshots or scrapes in a single batch.
+    Provide `urls` (simple list) or `items` (per-item config), not both.
+    Webhook deliveries include `X-ByteKit-Event: bulk.completed` so
+    receivers can dispatch on the header without parsing the body shape.
+
+    Args:
+        body (CreateBulkBody): Provide `urls` (simple list) OR `items` (per-item config), not
+            both. `type` selects the capture kind per entry — only
+            `screenshot` and `scrape` are accepted (`recording` is
+            deactivated). Behaviour fields may be set per item or via
+            `defaults`; a per-item value overrides the matching default.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[CreateBulkResponse202, Error]
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateBulkBody,
+) -> Response[Union[CreateBulkResponse202, Error]]:
+    """Create mixed bulk job
+
+     Enqueues screenshots or scrapes in a single batch.
+    Provide `urls` (simple list) or `items` (per-item config), not both.
+    Webhook deliveries include `X-ByteKit-Event: bulk.completed` so
+    receivers can dispatch on the header without parsing the body shape.
+
+    Args:
+        body (CreateBulkBody): Provide `urls` (simple list) OR `items` (per-item config), not
+            both. `type` selects the capture kind per entry — only
+            `screenshot` and `scrape` are accepted (`recording` is
+            deactivated). Behaviour fields may be set per item or via
+            `defaults`; a per-item value overrides the matching default.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[CreateBulkResponse202, Error]]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateBulkBody,
+) -> Optional[Union[CreateBulkResponse202, Error]]:
+    """Create mixed bulk job
+
+     Enqueues screenshots or scrapes in a single batch.
+    Provide `urls` (simple list) or `items` (per-item config), not both.
+    Webhook deliveries include `X-ByteKit-Event: bulk.completed` so
+    receivers can dispatch on the header without parsing the body shape.
+
+    Args:
+        body (CreateBulkBody): Provide `urls` (simple list) OR `items` (per-item config), not
+            both. `type` selects the capture kind per entry — only
+            `screenshot` and `scrape` are accepted (`recording` is
+            deactivated). Behaviour fields may be set per item or via
+            `defaults`; a per-item value overrides the matching default.
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[CreateBulkResponse202, Error]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

bytekit/api/bulk/delete_bulk.py

@@ -0,0 +1,177 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.delete_bulk_response_200 import DeleteBulkResponse200
+from ...models.error import Error
+from ...types import Response
+
+
+def _get_kwargs(
+    id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/v1/bulk/{id}".format(
+            id=id,
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[DeleteBulkResponse200, Error]]:
+    if response.status_code == 200:
+        response_200 = DeleteBulkResponse200.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 404:
+        response_404 = Error.from_dict(response.json())
+
+        return response_404
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Response[Union[DeleteBulkResponse200, Error]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[DeleteBulkResponse200, Error]]:
+    """Cancel a bulk job
+
+     Cancels an in-flight bulk job: drains its still-queued (pending) child jobs and refunds the quota
+    held for exactly those drained children. Children already completed, failed, or in progress are
+    untouched and keep their charge. Idempotent — cancelling an already-terminal job (completed, failed,
+    or cancelled) is a no-op that returns 200 with the job's real, unchanged status and refunds nothing.
+
+    Args:
+        id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[DeleteBulkResponse200, Error]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[DeleteBulkResponse200, Error]]:
+    """Cancel a bulk job
+
+     Cancels an in-flight bulk job: drains its still-queued (pending) child jobs and refunds the quota
+    held for exactly those drained children. Children already completed, failed, or in progress are
+    untouched and keep their charge. Idempotent — cancelling an already-terminal job (completed, failed,
+    or cancelled) is a no-op that returns 200 with the job's real, unchanged status and refunds nothing.
+
+    Args:
+        id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[DeleteBulkResponse200, Error]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[DeleteBulkResponse200, Error]]:
+    """Cancel a bulk job
+
+     Cancels an in-flight bulk job: drains its still-queued (pending) child jobs and refunds the quota
+    held for exactly those drained children. Children already completed, failed, or in progress are
+    untouched and keep their charge. Idempotent — cancelling an already-terminal job (completed, failed,
+    or cancelled) is a no-op that returns 200 with the job's real, unchanged status and refunds nothing.
+
+    Args:
+        id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Union[DeleteBulkResponse200, Error]]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[Union[DeleteBulkResponse200, Error]]:
+    """Cancel a bulk job
+
+     Cancels an in-flight bulk job: drains its still-queued (pending) child jobs and refunds the quota
+    held for exactly those drained children. Children already completed, failed, or in progress are
+    untouched and keep their charge. Idempotent — cancelling an already-terminal job (completed, failed,
+    or cancelled) is a no-op that returns 200 with the job's real, unchanged status and refunds nothing.
+
+    Args:
+        id (str):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Union[DeleteBulkResponse200, Error]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed