bytekit-sdk 0.3.0__py3-none-any.whl

bytekit/api/sitemap/get_sitemap.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.error import Error
+from ...models.sitemap_response import SitemapResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/sitemap/{id}".format(
+            id=id,
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Error, SitemapResponse]]:
+    if response.status_code == 200:
+        response_200 = SitemapResponse.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[Error, SitemapResponse]]:
+    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[Error, SitemapResponse]]:
+    """Get sitemap job status
+
+    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[Error, SitemapResponse]]
+    """
+
+    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[Error, SitemapResponse]]:
+    """Get sitemap job status
+
+    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[Error, SitemapResponse]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[Error, SitemapResponse]]:
+    """Get sitemap job status
+
+    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[Error, SitemapResponse]]
+    """
+
+    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[Error, SitemapResponse]]:
+    """Get sitemap job status
+
+    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[Error, SitemapResponse]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed

bytekit/api/usage/__init__.py

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

bytekit/api/usage/get_usage.py

@@ -0,0 +1,126 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.get_usage_response_200 import GetUsageResponse200
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/usage",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[GetUsageResponse200]:
+    if response.status_code == 200:
+        response_200 = GetUsageResponse200.from_dict(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[GetUsageResponse200]:
+    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],
+) -> Response[GetUsageResponse200]:
+    """Get current billing period usage
+
+    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[GetUsageResponse200]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[GetUsageResponse200]:
+    """Get current billing period usage
+
+    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:
+        GetUsageResponse200
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[GetUsageResponse200]:
+    """Get current billing period usage
+
+    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[GetUsageResponse200]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Optional[GetUsageResponse200]:
+    """Get current billing period usage
+
+    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:
+        GetUsageResponse200
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

bytekit/api/usage/get_usage_by_endpoint.py

@@ -0,0 +1,215 @@
+import datetime
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.get_usage_by_endpoint_response_200 import GetUsageByEndpointResponse200
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    from_: Union[Unset, datetime.date] = UNSET,
+    to: Union[Unset, datetime.date] = UNSET,
+    api_key: Union[Unset, str] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    json_from_: Union[Unset, str] = UNSET
+    if not isinstance(from_, Unset):
+        json_from_ = from_.isoformat()
+    params["from"] = json_from_
+
+    json_to: Union[Unset, str] = UNSET
+    if not isinstance(to, Unset):
+        json_to = to.isoformat()
+    params["to"] = json_to
+
+    params["api_key"] = api_key
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/usage/by-endpoint",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[GetUsageByEndpointResponse200]:
+    if response.status_code == 200:
+        response_200 = GetUsageByEndpointResponse200.from_dict(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[GetUsageByEndpointResponse200]:
+    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],
+    from_: Union[Unset, datetime.date] = UNSET,
+    to: Union[Unset, datetime.date] = UNSET,
+    api_key: Union[Unset, str] = UNSET,
+) -> Response[GetUsageByEndpointResponse200]:
+    """Get per-endpoint bandwidth breakdown
+
+     Returns bandwidth usage broken down by endpoint (screenshots, recordings, scrape, scrape_md, fetch,
+    fetch_md, crawl, crawl_links, sitemap, monitors) for a date range. Each row carries raw bytes, the
+    billing multiplier, and billable bytes. Endpoints with zero raw bytes for the range are omitted from
+    `rows`; `totals` is always present. Default range is the last 30 days; max 366 days.
+
+    Args:
+        from_ (Union[Unset, datetime.date]):
+        to (Union[Unset, datetime.date]):
+        api_key (Union[Unset, 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[GetUsageByEndpointResponse200]
+    """
+
+    kwargs = _get_kwargs(
+        from_=from_,
+        to=to,
+        api_key=api_key,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    from_: Union[Unset, datetime.date] = UNSET,
+    to: Union[Unset, datetime.date] = UNSET,
+    api_key: Union[Unset, str] = UNSET,
+) -> Optional[GetUsageByEndpointResponse200]:
+    """Get per-endpoint bandwidth breakdown
+
+     Returns bandwidth usage broken down by endpoint (screenshots, recordings, scrape, scrape_md, fetch,
+    fetch_md, crawl, crawl_links, sitemap, monitors) for a date range. Each row carries raw bytes, the
+    billing multiplier, and billable bytes. Endpoints with zero raw bytes for the range are omitted from
+    `rows`; `totals` is always present. Default range is the last 30 days; max 366 days.
+
+    Args:
+        from_ (Union[Unset, datetime.date]):
+        to (Union[Unset, datetime.date]):
+        api_key (Union[Unset, 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:
+        GetUsageByEndpointResponse200
+    """
+
+    return sync_detailed(
+        client=client,
+        from_=from_,
+        to=to,
+        api_key=api_key,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    from_: Union[Unset, datetime.date] = UNSET,
+    to: Union[Unset, datetime.date] = UNSET,
+    api_key: Union[Unset, str] = UNSET,
+) -> Response[GetUsageByEndpointResponse200]:
+    """Get per-endpoint bandwidth breakdown
+
+     Returns bandwidth usage broken down by endpoint (screenshots, recordings, scrape, scrape_md, fetch,
+    fetch_md, crawl, crawl_links, sitemap, monitors) for a date range. Each row carries raw bytes, the
+    billing multiplier, and billable bytes. Endpoints with zero raw bytes for the range are omitted from
+    `rows`; `totals` is always present. Default range is the last 30 days; max 366 days.
+
+    Args:
+        from_ (Union[Unset, datetime.date]):
+        to (Union[Unset, datetime.date]):
+        api_key (Union[Unset, 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[GetUsageByEndpointResponse200]
+    """
+
+    kwargs = _get_kwargs(
+        from_=from_,
+        to=to,
+        api_key=api_key,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    from_: Union[Unset, datetime.date] = UNSET,
+    to: Union[Unset, datetime.date] = UNSET,
+    api_key: Union[Unset, str] = UNSET,
+) -> Optional[GetUsageByEndpointResponse200]:
+    """Get per-endpoint bandwidth breakdown
+
+     Returns bandwidth usage broken down by endpoint (screenshots, recordings, scrape, scrape_md, fetch,
+    fetch_md, crawl, crawl_links, sitemap, monitors) for a date range. Each row carries raw bytes, the
+    billing multiplier, and billable bytes. Endpoints with zero raw bytes for the range are omitted from
+    `rows`; `totals` is always present. Default range is the last 30 days; max 366 days.
+
+    Args:
+        from_ (Union[Unset, datetime.date]):
+        to (Union[Unset, datetime.date]):
+        api_key (Union[Unset, 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:
+        GetUsageByEndpointResponse200
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            from_=from_,
+            to=to,
+            api_key=api_key,
+        )
+    ).parsed

bytekit/api/usage/get_usage_daily.py

@@ -0,0 +1,203 @@
+import datetime
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.get_usage_daily_response_200 import GetUsageDailyResponse200
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    from_: Union[Unset, datetime.date] = UNSET,
+    to: Union[Unset, datetime.date] = UNSET,
+    api_key: Union[Unset, str] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    json_from_: Union[Unset, str] = UNSET
+    if not isinstance(from_, Unset):
+        json_from_ = from_.isoformat()
+    params["from"] = json_from_
+
+    json_to: Union[Unset, str] = UNSET
+    if not isinstance(to, Unset):
+        json_to = to.isoformat()
+    params["to"] = json_to
+
+    params["api_key"] = api_key
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/usage/daily",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[GetUsageDailyResponse200]:
+    if response.status_code == 200:
+        response_200 = GetUsageDailyResponse200.from_dict(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[GetUsageDailyResponse200]:
+    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],
+    from_: Union[Unset, datetime.date] = UNSET,
+    to: Union[Unset, datetime.date] = UNSET,
+    api_key: Union[Unset, str] = UNSET,
+) -> Response[GetUsageDailyResponse200]:
+    """Get daily usage breakdown
+
+     Default range is last 30 days. Max range is 366 days.
+
+    Args:
+        from_ (Union[Unset, datetime.date]):
+        to (Union[Unset, datetime.date]):
+        api_key (Union[Unset, 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[GetUsageDailyResponse200]
+    """
+
+    kwargs = _get_kwargs(
+        from_=from_,
+        to=to,
+        api_key=api_key,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    from_: Union[Unset, datetime.date] = UNSET,
+    to: Union[Unset, datetime.date] = UNSET,
+    api_key: Union[Unset, str] = UNSET,
+) -> Optional[GetUsageDailyResponse200]:
+    """Get daily usage breakdown
+
+     Default range is last 30 days. Max range is 366 days.
+
+    Args:
+        from_ (Union[Unset, datetime.date]):
+        to (Union[Unset, datetime.date]):
+        api_key (Union[Unset, 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:
+        GetUsageDailyResponse200
+    """
+
+    return sync_detailed(
+        client=client,
+        from_=from_,
+        to=to,
+        api_key=api_key,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    from_: Union[Unset, datetime.date] = UNSET,
+    to: Union[Unset, datetime.date] = UNSET,
+    api_key: Union[Unset, str] = UNSET,
+) -> Response[GetUsageDailyResponse200]:
+    """Get daily usage breakdown
+
+     Default range is last 30 days. Max range is 366 days.
+
+    Args:
+        from_ (Union[Unset, datetime.date]):
+        to (Union[Unset, datetime.date]):
+        api_key (Union[Unset, 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[GetUsageDailyResponse200]
+    """
+
+    kwargs = _get_kwargs(
+        from_=from_,
+        to=to,
+        api_key=api_key,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    from_: Union[Unset, datetime.date] = UNSET,
+    to: Union[Unset, datetime.date] = UNSET,
+    api_key: Union[Unset, str] = UNSET,
+) -> Optional[GetUsageDailyResponse200]:
+    """Get daily usage breakdown
+
+     Default range is last 30 days. Max range is 366 days.
+
+    Args:
+        from_ (Union[Unset, datetime.date]):
+        to (Union[Unset, datetime.date]):
+        api_key (Union[Unset, 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:
+        GetUsageDailyResponse200
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            from_=from_,
+            to=to,
+            api_key=api_key,
+        )
+    ).parsed

bytekit/api/webhooks/__init__.py

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