bytekit-sdk 0.3.0__py3-none-any.whl

bytekit/api/screenshots/get_screenshot.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.error import Error
+from ...models.screenshot_response import ScreenshotResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/screenshots/{id}".format(
+            id=id,
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Union[Error, ScreenshotResponse, Union["Error", "ScreenshotResponse"]]]:
+    if response.status_code == 200:
+
+        def _parse_response_200(data: object) -> Union["Error", "ScreenshotResponse"]:
+            try:
+                if not isinstance(data, dict):
+                    raise TypeError()
+                response_200_type_0 = ScreenshotResponse.from_dict(data)
+
+                return response_200_type_0
+            except:  # noqa: E722
+                pass
+            if not isinstance(data, dict):
+                raise TypeError()
+            response_200_type_1 = Error.from_dict(data)
+
+            return response_200_type_1
+
+        response_200 = _parse_response_200(response.json())
+
+        return response_200
+    if response.status_code == 202:
+        response_202 = ScreenshotResponse.from_dict(response.json())
+
+        return response_202
+    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, ScreenshotResponse, Union["Error", "ScreenshotResponse"]]]:
+    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, ScreenshotResponse, Union["Error", "ScreenshotResponse"]]]:
+    """Get screenshot 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, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]]
+    """
+
+    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, ScreenshotResponse, Union["Error", "ScreenshotResponse"]]]:
+    """Get screenshot 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, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: Union[AuthenticatedClient, Client],
+) -> Response[Union[Error, ScreenshotResponse, Union["Error", "ScreenshotResponse"]]]:
+    """Get screenshot 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, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]]
+    """
+
+    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, ScreenshotResponse, Union["Error", "ScreenshotResponse"]]]:
+    """Get screenshot 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, ScreenshotResponse, Union['Error', 'ScreenshotResponse']]
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed

bytekit/api/search/__init__.py

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

bytekit/api/search/create_search.py

@@ -0,0 +1,225 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.create_search_body import CreateSearchBody
+from ...models.create_search_response_200 import CreateSearchResponse200
+from ...models.create_search_response_502 import CreateSearchResponse502
+from ...models.error import Error
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: CreateSearchBody,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/search",
+    }
+
+    _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[CreateSearchResponse200, CreateSearchResponse502, Error]]:
+    if response.status_code == 200:
+        response_200 = CreateSearchResponse200.from_dict(response.json())
+
+        return response_200
+    if response.status_code == 400:
+        response_400 = Error.from_dict(response.json())
+
+        return response_400
+    if response.status_code == 402:
+        response_402 = Error.from_dict(response.json())
+
+        return response_402
+    if response.status_code == 429:
+        response_429 = Error.from_dict(response.json())
+
+        return response_429
+    if response.status_code == 500:
+        response_500 = Error.from_dict(response.json())
+
+        return response_500
+    if response.status_code == 502:
+        response_502 = CreateSearchResponse502.from_dict(response.json())
+
+        return response_502
+    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[CreateSearchResponse200, CreateSearchResponse502, 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: CreateSearchBody,
+) -> Response[Union[CreateSearchResponse200, CreateSearchResponse502, Error]]:
+    """Search the web
+
+     Runs a web search for `query` and returns ranked organic results with
+    contiguous `position` values from 1.
+
+    Use `limit` (1–100, default 10) to request more results in a single
+    call. Results are fetched in pages of 10, so a call consumes
+    `ceil(limit / 10)` credits (capped at 10) from the account's monthly
+    credits bucket — for example `limit=10` costs 1 credit and `limit=35`
+    costs 4. Credits are charged for every page fetched regardless of how
+    many results a page returns. The credit count is reported as
+    `credits_used` in the response.
+
+    Args:
+        body (CreateSearchBody):
+
+    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[CreateSearchResponse200, CreateSearchResponse502, 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: CreateSearchBody,
+) -> Optional[Union[CreateSearchResponse200, CreateSearchResponse502, Error]]:
+    """Search the web
+
+     Runs a web search for `query` and returns ranked organic results with
+    contiguous `position` values from 1.
+
+    Use `limit` (1–100, default 10) to request more results in a single
+    call. Results are fetched in pages of 10, so a call consumes
+    `ceil(limit / 10)` credits (capped at 10) from the account's monthly
+    credits bucket — for example `limit=10` costs 1 credit and `limit=35`
+    costs 4. Credits are charged for every page fetched regardless of how
+    many results a page returns. The credit count is reported as
+    `credits_used` in the response.
+
+    Args:
+        body (CreateSearchBody):
+
+    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[CreateSearchResponse200, CreateSearchResponse502, Error]
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: CreateSearchBody,
+) -> Response[Union[CreateSearchResponse200, CreateSearchResponse502, Error]]:
+    """Search the web
+
+     Runs a web search for `query` and returns ranked organic results with
+    contiguous `position` values from 1.
+
+    Use `limit` (1–100, default 10) to request more results in a single
+    call. Results are fetched in pages of 10, so a call consumes
+    `ceil(limit / 10)` credits (capped at 10) from the account's monthly
+    credits bucket — for example `limit=10` costs 1 credit and `limit=35`
+    costs 4. Credits are charged for every page fetched regardless of how
+    many results a page returns. The credit count is reported as
+    `credits_used` in the response.
+
+    Args:
+        body (CreateSearchBody):
+
+    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[CreateSearchResponse200, CreateSearchResponse502, 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: CreateSearchBody,
+) -> Optional[Union[CreateSearchResponse200, CreateSearchResponse502, Error]]:
+    """Search the web
+
+     Runs a web search for `query` and returns ranked organic results with
+    contiguous `position` values from 1.
+
+    Use `limit` (1–100, default 10) to request more results in a single
+    call. Results are fetched in pages of 10, so a call consumes
+    `ceil(limit / 10)` credits (capped at 10) from the account's monthly
+    credits bucket — for example `limit=10` costs 1 credit and `limit=35`
+    costs 4. Credits are charged for every page fetched regardless of how
+    many results a page returns. The credit count is reported as
+    `credits_used` in the response.
+
+    Args:
+        body (CreateSearchBody):
+
+    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[CreateSearchResponse200, CreateSearchResponse502, Error]
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

bytekit/api/sitemap/__init__.py

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

bytekit/api/sitemap/create_sitemap.py

@@ -0,0 +1,192 @@
+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_request import SitemapRequest
+from ...models.sitemap_response import SitemapResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: SitemapRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/sitemap",
+    }
+
+    _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[Error, SitemapResponse]]:
+    if response.status_code == 202:
+        response_202 = SitemapResponse.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[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(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: SitemapRequest,
+) -> Response[Union[Error, SitemapResponse]]:
+    """Discover URLs on a domain
+
+     Crawls a domain to build a sitemap. Returns cached results if available
+    within cache_ttl. Results delivered via webhook and downloadable from results_url.
+    Webhook deliveries include `X-ByteKit-Event: sitemap.completed` or
+    `X-ByteKit-Event: sitemap.failed` so receivers can dispatch on the
+    header without parsing the body shape.
+
+    Args:
+        body (SitemapRequest):
+
+    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(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: SitemapRequest,
+) -> Optional[Union[Error, SitemapResponse]]:
+    """Discover URLs on a domain
+
+     Crawls a domain to build a sitemap. Returns cached results if available
+    within cache_ttl. Results delivered via webhook and downloadable from results_url.
+    Webhook deliveries include `X-ByteKit-Event: sitemap.completed` or
+    `X-ByteKit-Event: sitemap.failed` so receivers can dispatch on the
+    header without parsing the body shape.
+
+    Args:
+        body (SitemapRequest):
+
+    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(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: Union[AuthenticatedClient, Client],
+    body: SitemapRequest,
+) -> Response[Union[Error, SitemapResponse]]:
+    """Discover URLs on a domain
+
+     Crawls a domain to build a sitemap. Returns cached results if available
+    within cache_ttl. Results delivered via webhook and downloadable from results_url.
+    Webhook deliveries include `X-ByteKit-Event: sitemap.completed` or
+    `X-ByteKit-Event: sitemap.failed` so receivers can dispatch on the
+    header without parsing the body shape.
+
+    Args:
+        body (SitemapRequest):
+
+    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(
+        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: SitemapRequest,
+) -> Optional[Union[Error, SitemapResponse]]:
+    """Discover URLs on a domain
+
+     Crawls a domain to build a sitemap. Returns cached results if available
+    within cache_ttl. Results delivered via webhook and downloadable from results_url.
+    Webhook deliveries include `X-ByteKit-Event: sitemap.completed` or
+    `X-ByteKit-Event: sitemap.failed` so receivers can dispatch on the
+    header without parsing the body shape.
+
+    Args:
+        body (SitemapRequest):
+
+    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(
+            client=client,
+            body=body,
+        )
+    ).parsed