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

aceapi_v2_client/api/threats/get_threat_type_threat_types_threat_type_id_get.py

@@ -0,0 +1,161 @@
+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 ...models.threat_type_read import ThreatTypeRead
+from ...types import Response
+
+
+def _get_kwargs(
+    threat_type_id: int,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/threat-types/{threat_type_id}".format(
+            threat_type_id=quote(str(threat_type_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | ThreatTypeRead | None:
+    if response.status_code == 200:
+        response_200 = ThreatTypeRead.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[HTTPValidationError | ThreatTypeRead]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    threat_type_id: int,
+    *,
+    client: AuthenticatedClient,
+) -> Response[HTTPValidationError | ThreatTypeRead]:
+    """Get Threat Type
+
+    Args:
+        threat_type_id (int):
+
+    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[HTTPValidationError | ThreatTypeRead]
+    """
+
+    kwargs = _get_kwargs(
+        threat_type_id=threat_type_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    threat_type_id: int,
+    *,
+    client: AuthenticatedClient,
+) -> HTTPValidationError | ThreatTypeRead | None:
+    """Get Threat Type
+
+    Args:
+        threat_type_id (int):
+
+    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:
+        HTTPValidationError | ThreatTypeRead
+    """
+
+    return sync_detailed(
+        threat_type_id=threat_type_id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    threat_type_id: int,
+    *,
+    client: AuthenticatedClient,
+) -> Response[HTTPValidationError | ThreatTypeRead]:
+    """Get Threat Type
+
+    Args:
+        threat_type_id (int):
+
+    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[HTTPValidationError | ThreatTypeRead]
+    """
+
+    kwargs = _get_kwargs(
+        threat_type_id=threat_type_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    threat_type_id: int,
+    *,
+    client: AuthenticatedClient,
+) -> HTTPValidationError | ThreatTypeRead | None:
+    """Get Threat Type
+
+    Args:
+        threat_type_id (int):
+
+    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:
+        HTTPValidationError | ThreatTypeRead
+    """
+
+    return (
+        await asyncio_detailed(
+            threat_type_id=threat_type_id,
+            client=client,
+        )
+    ).parsed

aceapi_v2_client/api/threats/list_threat_types_threat_types_get.py

@@ -0,0 +1,128 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.list_response_threat_type_read import ListResponseThreatTypeRead
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/threat-types/",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> ListResponseThreatTypeRead | None:
+    if response.status_code == 200:
+        response_200 = ListResponseThreatTypeRead.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: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[ListResponseThreatTypeRead]:
+    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[ListResponseThreatTypeRead]:
+    """List Threat Types
+
+    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[ListResponseThreatTypeRead]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+) -> ListResponseThreatTypeRead | None:
+    """List Threat Types
+
+    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:
+        ListResponseThreatTypeRead
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[ListResponseThreatTypeRead]:
+    """List Threat Types
+
+    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[ListResponseThreatTypeRead]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+) -> ListResponseThreatTypeRead | None:
+    """List Threat Types
+
+    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:
+        ListResponseThreatTypeRead
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

aceapi_v2_client/api/threats/list_threats_threats_get.py

@@ -0,0 +1,171 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...models.list_response_threat_read import ListResponseThreatRead
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    malware_id: int | None | Unset = UNSET,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    json_malware_id: int | None | Unset
+    if isinstance(malware_id, Unset):
+        json_malware_id = UNSET
+    else:
+        json_malware_id = malware_id
+    params["malware_id"] = json_malware_id
+
+    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": "/threats/",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | ListResponseThreatRead | None:
+    if response.status_code == 200:
+        response_200 = ListResponseThreatRead.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[HTTPValidationError | ListResponseThreatRead]:
+    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,
+    malware_id: int | None | Unset = UNSET,
+) -> Response[HTTPValidationError | ListResponseThreatRead]:
+    """List Threats
+
+    Args:
+        malware_id (int | None | Unset):
+
+    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[HTTPValidationError | ListResponseThreatRead]
+    """
+
+    kwargs = _get_kwargs(
+        malware_id=malware_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    malware_id: int | None | Unset = UNSET,
+) -> HTTPValidationError | ListResponseThreatRead | None:
+    """List Threats
+
+    Args:
+        malware_id (int | None | Unset):
+
+    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:
+        HTTPValidationError | ListResponseThreatRead
+    """
+
+    return sync_detailed(
+        client=client,
+        malware_id=malware_id,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    malware_id: int | None | Unset = UNSET,
+) -> Response[HTTPValidationError | ListResponseThreatRead]:
+    """List Threats
+
+    Args:
+        malware_id (int | None | Unset):
+
+    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[HTTPValidationError | ListResponseThreatRead]
+    """
+
+    kwargs = _get_kwargs(
+        malware_id=malware_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    malware_id: int | None | Unset = UNSET,
+) -> HTTPValidationError | ListResponseThreatRead | None:
+    """List Threats
+
+    Args:
+        malware_id (int | None | Unset):
+
+    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:
+        HTTPValidationError | ListResponseThreatRead
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            malware_id=malware_id,
+        )
+    ).parsed

aceapi_v2_client/api/threats/update_threat_type_threat_types_threat_type_id_patch.py

@@ -0,0 +1,182 @@
+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 ...models.threat_type_read import ThreatTypeRead
+from ...models.threat_type_update import ThreatTypeUpdate
+from ...types import Response
+
+
+def _get_kwargs(
+    threat_type_id: int,
+    *,
+    body: ThreatTypeUpdate,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "patch",
+        "url": "/threat-types/{threat_type_id}".format(
+            threat_type_id=quote(str(threat_type_id), safe=""),
+        ),
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | ThreatTypeRead | None:
+    if response.status_code == 200:
+        response_200 = ThreatTypeRead.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[HTTPValidationError | ThreatTypeRead]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    threat_type_id: int,
+    *,
+    client: AuthenticatedClient,
+    body: ThreatTypeUpdate,
+) -> Response[HTTPValidationError | ThreatTypeRead]:
+    """Update Threat Type
+
+    Args:
+        threat_type_id (int):
+        body (ThreatTypeUpdate):
+
+    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[HTTPValidationError | ThreatTypeRead]
+    """
+
+    kwargs = _get_kwargs(
+        threat_type_id=threat_type_id,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    threat_type_id: int,
+    *,
+    client: AuthenticatedClient,
+    body: ThreatTypeUpdate,
+) -> HTTPValidationError | ThreatTypeRead | None:
+    """Update Threat Type
+
+    Args:
+        threat_type_id (int):
+        body (ThreatTypeUpdate):
+
+    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:
+        HTTPValidationError | ThreatTypeRead
+    """
+
+    return sync_detailed(
+        threat_type_id=threat_type_id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    threat_type_id: int,
+    *,
+    client: AuthenticatedClient,
+    body: ThreatTypeUpdate,
+) -> Response[HTTPValidationError | ThreatTypeRead]:
+    """Update Threat Type
+
+    Args:
+        threat_type_id (int):
+        body (ThreatTypeUpdate):
+
+    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[HTTPValidationError | ThreatTypeRead]
+    """
+
+    kwargs = _get_kwargs(
+        threat_type_id=threat_type_id,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    threat_type_id: int,
+    *,
+    client: AuthenticatedClient,
+    body: ThreatTypeUpdate,
+) -> HTTPValidationError | ThreatTypeRead | None:
+    """Update Threat Type
+
+    Args:
+        threat_type_id (int):
+        body (ThreatTypeUpdate):
+
+    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:
+        HTTPValidationError | ThreatTypeRead
+    """
+
+    return (
+        await asyncio_detailed(
+            threat_type_id=threat_type_id,
+            client=client,
+            body=body,
+        )
+    ).parsed

aceapi_v2_client/auth.py

@@ -0,0 +1,56 @@
+"""convenience helpers for authenticating against the ACE API v2
+
+this module is hand-maintained and is NOT overwritten when the rest of the
+package is regenerated from the openapi schema (see ../scripts/regenerate.sh).
+
+the generated ``AuthenticatedClient`` only knows how to send ``Authorization:
+Bearer <token>``. the ACE API v2 primary auth is an api key sent in the custom
+``x-ace-auth`` header, so the helpers below build a plain ``Client`` with that
+header pre-populated.
+"""
+
+from .client import AuthenticatedClient, Client
+
+# header name the ACE API v2 expects for machine-to-machine api key auth
+API_KEY_HEADER = "x-ace-auth"
+
+
+def authenticated_client(base_url, api_key, *, verify_ssl=True, **kwargs):
+    """build a ``Client`` that authenticates with an ACE api key
+
+    args:
+        base_url: full base url including the ``/api/v2`` prefix, e.g.
+            ``https://localhost:8443/api/v2``
+        api_key: the ACE api key (sent in the ``x-ace-auth`` header)
+        verify_ssl: verify the server tls certificate. set to ``False`` when
+            talking to a development instance using a self-signed certificate.
+        **kwargs: any other keyword argument accepted by ``Client`` (``timeout``,
+            ``headers``, ``httpx_args``, etc). extra ``headers`` are merged with
+            the api key header.
+
+    returns:
+        a configured ``Client`` ready to pass to the functions under
+        ``aceapi_v2_client.api``.
+    """
+    headers = {API_KEY_HEADER: api_key, **kwargs.pop("headers", {})}
+    return Client(base_url=base_url, headers=headers, verify_ssl=verify_ssl, **kwargs)
+
+
+def token_client(base_url, access_token, *, verify_ssl=True, **kwargs):
+    """build an ``AuthenticatedClient`` that authenticates with a jwt access token
+
+    use this after obtaining a token from the ``/auth/token`` endpoint. the token
+    is sent as ``Authorization: Bearer <access_token>``.
+
+    args:
+        base_url: full base url including the ``/api/v2`` prefix
+        access_token: a jwt access token issued by the api
+        verify_ssl: verify the server tls certificate (``False`` for dev)
+        **kwargs: any other keyword argument accepted by ``AuthenticatedClient``
+
+    returns:
+        a configured ``AuthenticatedClient``.
+    """
+    return AuthenticatedClient(
+        base_url=base_url, token=access_token, verify_ssl=verify_ssl, **kwargs
+    )