kalir-python 0.1.0__tar.gz

kalir_python-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: kalir-python
+Version: 0.1.0
+Summary: Official Python SDK for the Kalir Public API — digital risk intelligence and signed webhooks.
+License-Expression: MIT
+Requires-Dist: httpx>=0.23.1,<0.29.0
+Requires-Dist: attrs>=22.2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# kalir-python
+
+Official Python SDK for the [Kalir](https://kalir.io) Public API: your organization's digital-risk intelligence (incidents, credential and infostealer exposure, phishing impersonation, dark-web and Telegram mentions) plus signed webhooks. Typed with `attrs`, built on `httpx`, sync and async.
+
+```bash
+pip install kalir-python
+```
+
+## Quickstart
+
+Create an API key at **app.kalir.io → Developers → API Keys**.
+
+```python
+from kalir import AuthenticatedClient
+from kalir.api.overview import get_overview
+from kalir.api.phishing import list_phishing
+from kalir.api.incidents import list_incidents
+from kalir.models import ListIncidentsBucket, ListPhishingVerdict
+
+client = AuthenticatedClient(base_url="https://api.kalir.io", token="klr_…")
+
+with client as c:
+    overview = get_overview.sync(client=c)
+    print(overview.risk_score, overview.incidents.open_critical)
+
+    phishing = list_phishing.sync(client=c, verdict=ListPhishingVerdict.CONFIRMED)
+    for d in phishing.data:
+        print(d.domain, "impersonates", d.impersonates)
+
+    incidents = list_incidents.sync(client=c, bucket=ListIncidentsBucket.OPEN, limit=20)
+```
+
+Every endpoint has four functions: `sync`, `sync_detailed` (status + headers), `asyncio` and `asyncio_detailed`.
+
+```python
+async with AuthenticatedClient(base_url="https://api.kalir.io", token="klr_…") as c:
+    overview = await get_overview.asyncio(client=c)
+```
+
+## Errors
+
+Error responses share one envelope: `{"error": {"type", "message", "status", "retry_after"}}`. Use the `*_detailed` functions to inspect `status_code`, or pass `raise_on_unexpected_status=True` to the client.
+
+## Webhooks
+
+```python
+from kalir.webhooks import construct_event, WebhookSignatureError
+
+@app.post("/kalir-webhooks")  # Flask
+def kalir_webhooks():
+    try:
+        event = construct_event(
+            request.get_data(),                     # raw body
+            request.headers.get("X-Kalir-Signature"),
+            KALIR_WEBHOOK_SECRET,                   # whsec_…
+        )
+    except WebhookSignatureError:
+        return "", 400
+    if event["type"] == "incident.created":
+        ...
+    return "", 200
+```
+
+Respond `2xx` within 15 seconds. Failed deliveries are retried with exponential backoff for ~20 hours; deduplicate on the `X-Kalir-Event-Id` header.
+
+Full reference: <https://app.kalir.io/developers/docs>

kalir_python-0.1.0/README.md

@@ -0,0 +1,66 @@
+# kalir-python
+
+Official Python SDK for the [Kalir](https://kalir.io) Public API: your organization's digital-risk intelligence (incidents, credential and infostealer exposure, phishing impersonation, dark-web and Telegram mentions) plus signed webhooks. Typed with `attrs`, built on `httpx`, sync and async.
+
+```bash
+pip install kalir-python
+```
+
+## Quickstart
+
+Create an API key at **app.kalir.io → Developers → API Keys**.
+
+```python
+from kalir import AuthenticatedClient
+from kalir.api.overview import get_overview
+from kalir.api.phishing import list_phishing
+from kalir.api.incidents import list_incidents
+from kalir.models import ListIncidentsBucket, ListPhishingVerdict
+
+client = AuthenticatedClient(base_url="https://api.kalir.io", token="klr_…")
+
+with client as c:
+    overview = get_overview.sync(client=c)
+    print(overview.risk_score, overview.incidents.open_critical)
+
+    phishing = list_phishing.sync(client=c, verdict=ListPhishingVerdict.CONFIRMED)
+    for d in phishing.data:
+        print(d.domain, "impersonates", d.impersonates)
+
+    incidents = list_incidents.sync(client=c, bucket=ListIncidentsBucket.OPEN, limit=20)
+```
+
+Every endpoint has four functions: `sync`, `sync_detailed` (status + headers), `asyncio` and `asyncio_detailed`.
+
+```python
+async with AuthenticatedClient(base_url="https://api.kalir.io", token="klr_…") as c:
+    overview = await get_overview.asyncio(client=c)
+```
+
+## Errors
+
+Error responses share one envelope: `{"error": {"type", "message", "status", "retry_after"}}`. Use the `*_detailed` functions to inspect `status_code`, or pass `raise_on_unexpected_status=True` to the client.
+
+## Webhooks
+
+```python
+from kalir.webhooks import construct_event, WebhookSignatureError
+
+@app.post("/kalir-webhooks")  # Flask
+def kalir_webhooks():
+    try:
+        event = construct_event(
+            request.get_data(),                     # raw body
+            request.headers.get("X-Kalir-Signature"),
+            KALIR_WEBHOOK_SECRET,                   # whsec_…
+        )
+    except WebhookSignatureError:
+        return "", 400
+    if event["type"] == "incident.created":
+        ...
+    return "", 200
+```
+
+Respond `2xx` within 15 seconds. Failed deliveries are retried with exponential backoff for ~20 hours; deduplicate on the `X-Kalir-Event-Id` header.
+
+Full reference: <https://app.kalir.io/developers/docs>

kalir_python-0.1.0/kalir/__init__.py

@@ -0,0 +1,11 @@
+
+""" A client library for accessing Kalir Public API """
+from .client import AuthenticatedClient, Client
+from .webhooks import WebhookSignatureError, construct_event
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+    "WebhookSignatureError",
+    "construct_event",
+)

kalir_python-0.1.0/kalir/api/__init__.py

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

kalir_python-0.1.0/kalir/api/assets/__init__.py

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

kalir_python-0.1.0/kalir/api/assets/create_asset.py

@@ -0,0 +1,193 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.asset import Asset
+from ...models.asset_create import AssetCreate
+from ...models.error import Error
+from typing import cast
+
+
+
+def _get_kwargs(
+    *,
+    body: AssetCreate,
+
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/assets",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Asset | Error | None:
+    if response.status_code == 201:
+        response_201 = Asset.from_dict(response.json())
+
+
+
+        return response_201
+
+    if response.status_code == 401:
+        response_401 = Error.from_dict(response.json())
+
+
+
+        return response_401
+
+    if response.status_code == 429:
+        response_429 = Error.from_dict(response.json())
+
+
+
+        return response_429
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Asset | 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: AuthenticatedClient,
+    body: AssetCreate,
+
+) -> Response[Asset | Error]:
+    """ Create an asset
+
+    Args:
+        body (AssetCreate):
+
+    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[Asset | Error]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: AssetCreate,
+
+) -> Asset | Error | None:
+    """ Create an asset
+
+    Args:
+        body (AssetCreate):
+
+    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:
+        Asset | Error
+     """
+
+
+    return sync_detailed(
+        client=client,
+body=body,
+
+    ).parsed
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: AssetCreate,
+
+) -> Response[Asset | Error]:
+    """ Create an asset
+
+    Args:
+        body (AssetCreate):
+
+    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[Asset | 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: AuthenticatedClient,
+    body: AssetCreate,
+
+) -> Asset | Error | None:
+    """ Create an asset
+
+    Args:
+        body (AssetCreate):
+
+    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:
+        Asset | Error
+     """
+
+
+    return (await asyncio_detailed(
+        client=client,
+body=body,
+
+    )).parsed

kalir_python-0.1.0/kalir/api/assets/delete_asset.py

@@ -0,0 +1,182 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.error import Error
+from typing import cast
+
+
+
+def _get_kwargs(
+    id: str,
+
+) -> dict[str, Any]:
+    
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/v1/assets/{id}".format(id=quote(str(id), safe=""),),
+    }
+
+
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | Error | None:
+    if response.status_code == 204:
+        response_204 = cast(Any, None)
+        return response_204
+
+    if response.status_code == 401:
+        response_401 = Error.from_dict(response.json())
+
+
+
+        return response_401
+
+    if response.status_code == 429:
+        response_429 = Error.from_dict(response.json())
+
+
+
+        return response_429
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Any | 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: AuthenticatedClient,
+
+) -> Response[Any | Error]:
+    """ Delete an asset
+
+    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[Any | 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: AuthenticatedClient,
+
+) -> Any | Error | None:
+    """ Delete an asset
+
+    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:
+        Any | Error
+     """
+
+
+    return sync_detailed(
+        id=id,
+client=client,
+
+    ).parsed
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Response[Any | Error]:
+    """ Delete an asset
+
+    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[Any | 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: AuthenticatedClient,
+
+) -> Any | Error | None:
+    """ Delete an asset
+
+    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:
+        Any | Error
+     """
+
+
+    return (await asyncio_detailed(
+        id=id,
+client=client,
+
+    )).parsed

kalir_python-0.1.0/kalir/api/assets/get_asset.py

@@ -0,0 +1,186 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.asset import Asset
+from ...models.error import Error
+from typing import cast
+
+
+
+def _get_kwargs(
+    id: str,
+
+) -> dict[str, Any]:
+    
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/assets/{id}".format(id=quote(str(id), safe=""),),
+    }
+
+
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Asset | Error | None:
+    if response.status_code == 200:
+        response_200 = Asset.from_dict(response.json())
+
+
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = Error.from_dict(response.json())
+
+
+
+        return response_401
+
+    if response.status_code == 429:
+        response_429 = Error.from_dict(response.json())
+
+
+
+        return response_429
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Asset | 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: AuthenticatedClient,
+
+) -> Response[Asset | Error]:
+    """ Get an asset
+
+    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[Asset | 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: AuthenticatedClient,
+
+) -> Asset | Error | None:
+    """ Get an asset
+
+    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:
+        Asset | Error
+     """
+
+
+    return sync_detailed(
+        id=id,
+client=client,
+
+    ).parsed
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Response[Asset | Error]:
+    """ Get an asset
+
+    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[Asset | 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: AuthenticatedClient,
+
+) -> Asset | Error | None:
+    """ Get an asset
+
+    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:
+        Asset | Error
+     """
+
+
+    return (await asyncio_detailed(
+        id=id,
+client=client,
+
+    )).parsed