hackagent 0.3.1__py3-none-any.whl

hackagent/api/run/run_list.py

@@ -0,0 +1,291 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+from uuid import UUID
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.paginated_run_list import PaginatedRunList
+from ...models.run_list_status import RunListStatus
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    agent: Union[Unset, UUID] = UNSET,
+    attack: Union[Unset, UUID] = UNSET,
+    is_client_executed: Union[Unset, bool] = UNSET,
+    organization: Union[Unset, UUID] = UNSET,
+    page: Union[Unset, int] = UNSET,
+    page_size: Union[Unset, int] = UNSET,
+    status: Union[Unset, RunListStatus] = UNSET,
+) -> dict[str, Any]:
+    params: dict[str, Any] = {}
+
+    json_agent: Union[Unset, str] = UNSET
+    if not isinstance(agent, Unset):
+        json_agent = str(agent)
+    params["agent"] = json_agent
+
+    json_attack: Union[Unset, str] = UNSET
+    if not isinstance(attack, Unset):
+        json_attack = str(attack)
+    params["attack"] = json_attack
+
+    params["is_client_executed"] = is_client_executed
+
+    json_organization: Union[Unset, str] = UNSET
+    if not isinstance(organization, Unset):
+        json_organization = str(organization)
+    params["organization"] = json_organization
+
+    params["page"] = page
+
+    params["page_size"] = page_size
+
+    json_status: Union[Unset, str] = UNSET
+    if not isinstance(status, Unset):
+        json_status = status.value
+
+    params["status"] = json_status
+
+    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": "/run",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[PaginatedRunList]:
+    if response.status_code == 200:
+        response_200 = PaginatedRunList.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[PaginatedRunList]:
+    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,
+    agent: Union[Unset, UUID] = UNSET,
+    attack: Union[Unset, UUID] = UNSET,
+    is_client_executed: Union[Unset, bool] = UNSET,
+    organization: Union[Unset, UUID] = UNSET,
+    page: Union[Unset, int] = UNSET,
+    page_size: Union[Unset, int] = UNSET,
+    status: Union[Unset, RunListStatus] = UNSET,
+) -> Response[PaginatedRunList]:
+    """ViewSet for managing Run instances.
+    Primarily for listing/retrieving runs.
+    Creation of server-side runs is handled by custom actions.
+    Runs initiated from Attack definitions are created via AttackViewSet.
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+    This is a core SDK operation for executing and monitoring security tests.
+
+    Args:
+        agent (Union[Unset, UUID]):
+        attack (Union[Unset, UUID]):
+        is_client_executed (Union[Unset, bool]):
+        organization (Union[Unset, UUID]):
+        page (Union[Unset, int]):
+        page_size (Union[Unset, int]):
+        status (Union[Unset, RunListStatus]):
+
+    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[PaginatedRunList]
+    """
+
+    kwargs = _get_kwargs(
+        agent=agent,
+        attack=attack,
+        is_client_executed=is_client_executed,
+        organization=organization,
+        page=page,
+        page_size=page_size,
+        status=status,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    agent: Union[Unset, UUID] = UNSET,
+    attack: Union[Unset, UUID] = UNSET,
+    is_client_executed: Union[Unset, bool] = UNSET,
+    organization: Union[Unset, UUID] = UNSET,
+    page: Union[Unset, int] = UNSET,
+    page_size: Union[Unset, int] = UNSET,
+    status: Union[Unset, RunListStatus] = UNSET,
+) -> Optional[PaginatedRunList]:
+    """ViewSet for managing Run instances.
+    Primarily for listing/retrieving runs.
+    Creation of server-side runs is handled by custom actions.
+    Runs initiated from Attack definitions are created via AttackViewSet.
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+    This is a core SDK operation for executing and monitoring security tests.
+
+    Args:
+        agent (Union[Unset, UUID]):
+        attack (Union[Unset, UUID]):
+        is_client_executed (Union[Unset, bool]):
+        organization (Union[Unset, UUID]):
+        page (Union[Unset, int]):
+        page_size (Union[Unset, int]):
+        status (Union[Unset, RunListStatus]):
+
+    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:
+        PaginatedRunList
+    """
+
+    return sync_detailed(
+        client=client,
+        agent=agent,
+        attack=attack,
+        is_client_executed=is_client_executed,
+        organization=organization,
+        page=page,
+        page_size=page_size,
+        status=status,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    agent: Union[Unset, UUID] = UNSET,
+    attack: Union[Unset, UUID] = UNSET,
+    is_client_executed: Union[Unset, bool] = UNSET,
+    organization: Union[Unset, UUID] = UNSET,
+    page: Union[Unset, int] = UNSET,
+    page_size: Union[Unset, int] = UNSET,
+    status: Union[Unset, RunListStatus] = UNSET,
+) -> Response[PaginatedRunList]:
+    """ViewSet for managing Run instances.
+    Primarily for listing/retrieving runs.
+    Creation of server-side runs is handled by custom actions.
+    Runs initiated from Attack definitions are created via AttackViewSet.
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+    This is a core SDK operation for executing and monitoring security tests.
+
+    Args:
+        agent (Union[Unset, UUID]):
+        attack (Union[Unset, UUID]):
+        is_client_executed (Union[Unset, bool]):
+        organization (Union[Unset, UUID]):
+        page (Union[Unset, int]):
+        page_size (Union[Unset, int]):
+        status (Union[Unset, RunListStatus]):
+
+    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[PaginatedRunList]
+    """
+
+    kwargs = _get_kwargs(
+        agent=agent,
+        attack=attack,
+        is_client_executed=is_client_executed,
+        organization=organization,
+        page=page,
+        page_size=page_size,
+        status=status,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    agent: Union[Unset, UUID] = UNSET,
+    attack: Union[Unset, UUID] = UNSET,
+    is_client_executed: Union[Unset, bool] = UNSET,
+    organization: Union[Unset, UUID] = UNSET,
+    page: Union[Unset, int] = UNSET,
+    page_size: Union[Unset, int] = UNSET,
+    status: Union[Unset, RunListStatus] = UNSET,
+) -> Optional[PaginatedRunList]:
+    """ViewSet for managing Run instances.
+    Primarily for listing/retrieving runs.
+    Creation of server-side runs is handled by custom actions.
+    Runs initiated from Attack definitions are created via AttackViewSet.
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+    This is a core SDK operation for executing and monitoring security tests.
+
+    Args:
+        agent (Union[Unset, UUID]):
+        attack (Union[Unset, UUID]):
+        is_client_executed (Union[Unset, bool]):
+        organization (Union[Unset, UUID]):
+        page (Union[Unset, int]):
+        page_size (Union[Unset, int]):
+        status (Union[Unset, RunListStatus]):
+
+    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:
+        PaginatedRunList
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            agent=agent,
+            attack=attack,
+            is_client_executed=is_client_executed,
+            organization=organization,
+            page=page,
+            page_size=page_size,
+            status=status,
+        )
+    ).parsed

hackagent/api/run/run_partial_update.py

@@ -0,0 +1,201 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+from uuid import UUID
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.patched_run_request import PatchedRunRequest
+from ...models.run import Run
+from ...types import Response
+
+
+def _get_kwargs(
+    id: UUID,
+    *,
+    body: PatchedRunRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "patch",
+        "url": f"/run/{id}",
+    }
+
+    _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[Run]:
+    if response.status_code == 200:
+        response_200 = Run.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[Run]:
+    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: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: PatchedRunRequest,
+) -> Response[Run]:
+    """ViewSet for managing Run instances.
+    Primarily for listing/retrieving runs.
+    Creation of server-side runs is handled by custom actions.
+    Runs initiated from Attack definitions are created via AttackViewSet.
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+    This is a core SDK operation for executing and monitoring security tests.
+
+    Args:
+        id (UUID):
+        body (PatchedRunRequest): Serializer for the Run model, used for both input and output.
+
+    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[Run]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: PatchedRunRequest,
+) -> Optional[Run]:
+    """ViewSet for managing Run instances.
+    Primarily for listing/retrieving runs.
+    Creation of server-side runs is handled by custom actions.
+    Runs initiated from Attack definitions are created via AttackViewSet.
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+    This is a core SDK operation for executing and monitoring security tests.
+
+    Args:
+        id (UUID):
+        body (PatchedRunRequest): Serializer for the Run model, used for both input and output.
+
+    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:
+        Run
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: PatchedRunRequest,
+) -> Response[Run]:
+    """ViewSet for managing Run instances.
+    Primarily for listing/retrieving runs.
+    Creation of server-side runs is handled by custom actions.
+    Runs initiated from Attack definitions are created via AttackViewSet.
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+    This is a core SDK operation for executing and monitoring security tests.
+
+    Args:
+        id (UUID):
+        body (PatchedRunRequest): Serializer for the Run model, used for both input and output.
+
+    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[Run]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: PatchedRunRequest,
+) -> Optional[Run]:
+    """ViewSet for managing Run instances.
+    Primarily for listing/retrieving runs.
+    Creation of server-side runs is handled by custom actions.
+    Runs initiated from Attack definitions are created via AttackViewSet.
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+    This is a core SDK operation for executing and monitoring security tests.
+
+    Args:
+        id (UUID):
+        body (PatchedRunRequest): Serializer for the Run model, used for both input and output.
+
+    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:
+        Run
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            body=body,
+        )
+    ).parsed

hackagent/api/run/run_result_create.py

@@ -0,0 +1,177 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union
+from uuid import UUID
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.result import Result
+from ...models.result_request import ResultRequest
+from ...types import Response
+
+
+def _get_kwargs(
+    id: UUID,
+    *,
+    body: ResultRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": f"/run/{id}/result",
+    }
+
+    _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[Result]:
+    if response.status_code == 200:
+        response_200 = Result.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[Result]:
+    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: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: ResultRequest,
+) -> Response[Result]:
+    """Creates a new Result associated with this Run.
+    The run instance is fetched using the 'id' (the lookup_field) from the URL.
+
+    Args:
+        id (UUID):
+        body (ResultRequest): Serializer for the Result model, often nested in RunSerializer.
+
+    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[Result]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: ResultRequest,
+) -> Optional[Result]:
+    """Creates a new Result associated with this Run.
+    The run instance is fetched using the 'id' (the lookup_field) from the URL.
+
+    Args:
+        id (UUID):
+        body (ResultRequest): Serializer for the Result model, often nested in RunSerializer.
+
+    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:
+        Result
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: ResultRequest,
+) -> Response[Result]:
+    """Creates a new Result associated with this Run.
+    The run instance is fetched using the 'id' (the lookup_field) from the URL.
+
+    Args:
+        id (UUID):
+        body (ResultRequest): Serializer for the Result model, often nested in RunSerializer.
+
+    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[Result]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        body=body,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: ResultRequest,
+) -> Optional[Result]:
+    """Creates a new Result associated with this Run.
+    The run instance is fetched using the 'id' (the lookup_field) from the URL.
+
+    Args:
+        id (UUID):
+        body (ResultRequest): Serializer for the Result model, often nested in RunSerializer.
+
+    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:
+        Result
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            body=body,
+        )
+    ).parsed