aceapi-v2-client 2.0.0__py3-none-any.whl

aceapi_v2_client/__init__.py

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

aceapi_v2_client/api/__init__.py

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

aceapi_v2_client/api/alerts/__init__.py

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

aceapi_v2_client/api/alerts/bulk_add_observable_alerts_bulk_add_observable_post.py

@@ -0,0 +1,174 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.bulk_add_observable_request import BulkAddObservableRequest
+from ...models.bulk_add_observable_result import BulkAddObservableResult
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+    *,
+    body: BulkAddObservableRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/alerts/bulk-add-observable",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> BulkAddObservableResult | HTTPValidationError | None:
+    if response.status_code == 200:
+        response_200 = BulkAddObservableResult.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.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: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[BulkAddObservableResult | HTTPValidationError]:
+    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: BulkAddObservableRequest,
+) -> Response[BulkAddObservableResult | HTTPValidationError]:
+    """Bulk Add Observable
+
+     Add an observable to multiple alerts at once.
+
+    Args:
+        body (BulkAddObservableRequest):
+
+    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[BulkAddObservableResult | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: BulkAddObservableRequest,
+) -> BulkAddObservableResult | HTTPValidationError | None:
+    """Bulk Add Observable
+
+     Add an observable to multiple alerts at once.
+
+    Args:
+        body (BulkAddObservableRequest):
+
+    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:
+        BulkAddObservableResult | HTTPValidationError
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: BulkAddObservableRequest,
+) -> Response[BulkAddObservableResult | HTTPValidationError]:
+    """Bulk Add Observable
+
+     Add an observable to multiple alerts at once.
+
+    Args:
+        body (BulkAddObservableRequest):
+
+    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[BulkAddObservableResult | HTTPValidationError]
+    """
+
+    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: BulkAddObservableRequest,
+) -> BulkAddObservableResult | HTTPValidationError | None:
+    """Bulk Add Observable
+
+     Add an observable to multiple alerts at once.
+
+    Args:
+        body (BulkAddObservableRequest):
+
+    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:
+        BulkAddObservableResult | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+        )
+    ).parsed

aceapi_v2_client/api/alerts/download_alert_alerts_alert_uuid_download_get.py

@@ -0,0 +1,167 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+    alert_uuid: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/alerts/{alert_uuid}/download".format(
+            alert_uuid=quote(str(alert_uuid), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | HTTPValidationError | None:
+    if response.status_code == 200:
+        response_200 = response.json()
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.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: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    alert_uuid: str,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Any | HTTPValidationError]:
+    """Download Alert
+
+     Download the full alert storage directory as a zip encrypted with password 'infected'.
+
+    Args:
+        alert_uuid (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 | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        alert_uuid=alert_uuid,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    alert_uuid: str,
+    *,
+    client: AuthenticatedClient,
+) -> Any | HTTPValidationError | None:
+    """Download Alert
+
+     Download the full alert storage directory as a zip encrypted with password 'infected'.
+
+    Args:
+        alert_uuid (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 | HTTPValidationError
+    """
+
+    return sync_detailed(
+        alert_uuid=alert_uuid,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    alert_uuid: str,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Any | HTTPValidationError]:
+    """Download Alert
+
+     Download the full alert storage directory as a zip encrypted with password 'infected'.
+
+    Args:
+        alert_uuid (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 | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        alert_uuid=alert_uuid,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    alert_uuid: str,
+    *,
+    client: AuthenticatedClient,
+) -> Any | HTTPValidationError | None:
+    """Download Alert
+
+     Download the full alert storage directory as a zip encrypted with password 'infected'.
+
+    Args:
+        alert_uuid (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 | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            alert_uuid=alert_uuid,
+            client=client,
+        )
+    ).parsed

aceapi_v2_client/api/alerts/view_alert_logs_alerts_alert_uuid_logs_get.py

@@ -0,0 +1,200 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    alert_uuid: str,
+    *,
+    download: bool | Unset = False,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    params["download"] = download
+
+    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": "/alerts/{alert_uuid}/logs".format(
+            alert_uuid=quote(str(alert_uuid), safe=""),
+        ),
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Any | HTTPValidationError | None:
+    if response.status_code == 200:
+        response_200 = response.json()
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.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: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[Any | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    alert_uuid: str,
+    *,
+    client: AuthenticatedClient,
+    download: bool | Unset = False,
+) -> Response[Any | HTTPValidationError]:
+    """View Alert Logs
+
+     Return the alert's raw saq.log file.
+
+    Default: text/plain with inline disposition (renders in browser).
+    With ?download=true, served as an attachment download.
+
+    Args:
+        alert_uuid (str):
+        download (bool | Unset):  Default: False.
+
+    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 | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        alert_uuid=alert_uuid,
+        download=download,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    alert_uuid: str,
+    *,
+    client: AuthenticatedClient,
+    download: bool | Unset = False,
+) -> Any | HTTPValidationError | None:
+    """View Alert Logs
+
+     Return the alert's raw saq.log file.
+
+    Default: text/plain with inline disposition (renders in browser).
+    With ?download=true, served as an attachment download.
+
+    Args:
+        alert_uuid (str):
+        download (bool | Unset):  Default: False.
+
+    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 | HTTPValidationError
+    """
+
+    return sync_detailed(
+        alert_uuid=alert_uuid,
+        client=client,
+        download=download,
+    ).parsed
+
+
+async def asyncio_detailed(
+    alert_uuid: str,
+    *,
+    client: AuthenticatedClient,
+    download: bool | Unset = False,
+) -> Response[Any | HTTPValidationError]:
+    """View Alert Logs
+
+     Return the alert's raw saq.log file.
+
+    Default: text/plain with inline disposition (renders in browser).
+    With ?download=true, served as an attachment download.
+
+    Args:
+        alert_uuid (str):
+        download (bool | Unset):  Default: False.
+
+    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 | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        alert_uuid=alert_uuid,
+        download=download,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    alert_uuid: str,
+    *,
+    client: AuthenticatedClient,
+    download: bool | Unset = False,
+) -> Any | HTTPValidationError | None:
+    """View Alert Logs
+
+     Return the alert's raw saq.log file.
+
+    Default: text/plain with inline disposition (renders in browser).
+    With ?download=true, served as an attachment download.
+
+    Args:
+        alert_uuid (str):
+        download (bool | Unset):  Default: False.
+
+    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 | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            alert_uuid=alert_uuid,
+            client=client,
+            download=download,
+        )
+    ).parsed

aceapi_v2_client/api/authentication/__init__.py

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