hackagent 0.3.1__py3-none-any.whl

hackagent/api/attack/attack_partial_update.py

@@ -0,0 +1,289 @@
+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.attack import Attack
+from ...models.patched_attack_request import PatchedAttackRequest
+from ...types import Response
+
+
+def _get_kwargs(
+    id: UUID,
+    *,
+    body: PatchedAttackRequest,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    _kwargs: dict[str, Any] = {
+        "method": "patch",
+        "url": f"/attack/{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[Attack]:
+    if response.status_code == 200:
+        response_200 = Attack.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[Attack]:
+    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: PatchedAttackRequest,
+) -> Response[Attack]:
+    """Manages Attack configurations through standard CRUD operations.
+
+    This ViewSet allows clients to:
+    - Create new Attack configurations.
+    - List existing Attack configurations (with filtering based on user/org).
+    - Retrieve details of a specific Attack configuration.
+    - Update an existing Attack configuration.
+    - Delete an Attack configuration.
+
+    The actual execution of an attack based on these configurations, and the
+    management of run statuses or results, are handled by other parts of the API
+    (e.g., potentially a RunViewSet or similar).
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+
+    Attributes:
+        queryset: The base queryset, retrieving all Attack objects with related
+                  entities (agent, owner, organization) pre-fetched.
+        serializer_class: The serializer (`AttackSerializer`) used for data
+                          conversion for Attack configurations.
+        authentication_classes: API Key (primary) + Auth0 (fallback) authentication.
+        permission_classes: List of permission enforcement classes.
+        parser_classes: List of parsers for request data (JSONParser).
+        lookup_field: The model field used for looking up individual instances ('id').
+
+    Args:
+        id (UUID):
+        body (PatchedAttackRequest): Serializer for the Attack model, which represents an Attack
+            configuration.
+
+            Handles the conversion of Attack configuration instances to JSON (and vice-versa)
+            for API requests and responses. It includes read-only fields for related
+            object names (like agent_name, owner_username) for convenience in API outputs.
+
+    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[Attack]
+    """
+
+    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: PatchedAttackRequest,
+) -> Optional[Attack]:
+    """Manages Attack configurations through standard CRUD operations.
+
+    This ViewSet allows clients to:
+    - Create new Attack configurations.
+    - List existing Attack configurations (with filtering based on user/org).
+    - Retrieve details of a specific Attack configuration.
+    - Update an existing Attack configuration.
+    - Delete an Attack configuration.
+
+    The actual execution of an attack based on these configurations, and the
+    management of run statuses or results, are handled by other parts of the API
+    (e.g., potentially a RunViewSet or similar).
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+
+    Attributes:
+        queryset: The base queryset, retrieving all Attack objects with related
+                  entities (agent, owner, organization) pre-fetched.
+        serializer_class: The serializer (`AttackSerializer`) used for data
+                          conversion for Attack configurations.
+        authentication_classes: API Key (primary) + Auth0 (fallback) authentication.
+        permission_classes: List of permission enforcement classes.
+        parser_classes: List of parsers for request data (JSONParser).
+        lookup_field: The model field used for looking up individual instances ('id').
+
+    Args:
+        id (UUID):
+        body (PatchedAttackRequest): Serializer for the Attack model, which represents an Attack
+            configuration.
+
+            Handles the conversion of Attack configuration instances to JSON (and vice-versa)
+            for API requests and responses. It includes read-only fields for related
+            object names (like agent_name, owner_username) for convenience in API outputs.
+
+    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:
+        Attack
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        body=body,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+    body: PatchedAttackRequest,
+) -> Response[Attack]:
+    """Manages Attack configurations through standard CRUD operations.
+
+    This ViewSet allows clients to:
+    - Create new Attack configurations.
+    - List existing Attack configurations (with filtering based on user/org).
+    - Retrieve details of a specific Attack configuration.
+    - Update an existing Attack configuration.
+    - Delete an Attack configuration.
+
+    The actual execution of an attack based on these configurations, and the
+    management of run statuses or results, are handled by other parts of the API
+    (e.g., potentially a RunViewSet or similar).
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+
+    Attributes:
+        queryset: The base queryset, retrieving all Attack objects with related
+                  entities (agent, owner, organization) pre-fetched.
+        serializer_class: The serializer (`AttackSerializer`) used for data
+                          conversion for Attack configurations.
+        authentication_classes: API Key (primary) + Auth0 (fallback) authentication.
+        permission_classes: List of permission enforcement classes.
+        parser_classes: List of parsers for request data (JSONParser).
+        lookup_field: The model field used for looking up individual instances ('id').
+
+    Args:
+        id (UUID):
+        body (PatchedAttackRequest): Serializer for the Attack model, which represents an Attack
+            configuration.
+
+            Handles the conversion of Attack configuration instances to JSON (and vice-versa)
+            for API requests and responses. It includes read-only fields for related
+            object names (like agent_name, owner_username) for convenience in API outputs.
+
+    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[Attack]
+    """
+
+    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: PatchedAttackRequest,
+) -> Optional[Attack]:
+    """Manages Attack configurations through standard CRUD operations.
+
+    This ViewSet allows clients to:
+    - Create new Attack configurations.
+    - List existing Attack configurations (with filtering based on user/org).
+    - Retrieve details of a specific Attack configuration.
+    - Update an existing Attack configuration.
+    - Delete an Attack configuration.
+
+    The actual execution of an attack based on these configurations, and the
+    management of run statuses or results, are handled by other parts of the API
+    (e.g., potentially a RunViewSet or similar).
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+
+    Attributes:
+        queryset: The base queryset, retrieving all Attack objects with related
+                  entities (agent, owner, organization) pre-fetched.
+        serializer_class: The serializer (`AttackSerializer`) used for data
+                          conversion for Attack configurations.
+        authentication_classes: API Key (primary) + Auth0 (fallback) authentication.
+        permission_classes: List of permission enforcement classes.
+        parser_classes: List of parsers for request data (JSONParser).
+        lookup_field: The model field used for looking up individual instances ('id').
+
+    Args:
+        id (UUID):
+        body (PatchedAttackRequest): Serializer for the Attack model, which represents an Attack
+            configuration.
+
+            Handles the conversion of Attack configuration instances to JSON (and vice-versa)
+            for API requests and responses. It includes read-only fields for related
+            object names (like agent_name, owner_username) for convenience in API outputs.
+
+    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:
+        Attack
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            body=body,
+        )
+    ).parsed

hackagent/api/attack/attack_retrieve.py

@@ -0,0 +1,247 @@
+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.attack import Attack
+from ...types import Response
+
+
+def _get_kwargs(
+    id: UUID,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": f"/attack/{id}",
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: Union[AuthenticatedClient, Client], response: httpx.Response
+) -> Optional[Attack]:
+    if response.status_code == 200:
+        response_200 = Attack.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[Attack]:
+    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,
+) -> Response[Attack]:
+    """Manages Attack configurations through standard CRUD operations.
+
+    This ViewSet allows clients to:
+    - Create new Attack configurations.
+    - List existing Attack configurations (with filtering based on user/org).
+    - Retrieve details of a specific Attack configuration.
+    - Update an existing Attack configuration.
+    - Delete an Attack configuration.
+
+    The actual execution of an attack based on these configurations, and the
+    management of run statuses or results, are handled by other parts of the API
+    (e.g., potentially a RunViewSet or similar).
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+
+    Attributes:
+        queryset: The base queryset, retrieving all Attack objects with related
+                  entities (agent, owner, organization) pre-fetched.
+        serializer_class: The serializer (`AttackSerializer`) used for data
+                          conversion for Attack configurations.
+        authentication_classes: API Key (primary) + Auth0 (fallback) authentication.
+        permission_classes: List of permission enforcement classes.
+        parser_classes: List of parsers for request data (JSONParser).
+        lookup_field: The model field used for looking up individual instances ('id').
+
+    Args:
+        id (UUID):
+
+    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[Attack]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Attack]:
+    """Manages Attack configurations through standard CRUD operations.
+
+    This ViewSet allows clients to:
+    - Create new Attack configurations.
+    - List existing Attack configurations (with filtering based on user/org).
+    - Retrieve details of a specific Attack configuration.
+    - Update an existing Attack configuration.
+    - Delete an Attack configuration.
+
+    The actual execution of an attack based on these configurations, and the
+    management of run statuses or results, are handled by other parts of the API
+    (e.g., potentially a RunViewSet or similar).
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+
+    Attributes:
+        queryset: The base queryset, retrieving all Attack objects with related
+                  entities (agent, owner, organization) pre-fetched.
+        serializer_class: The serializer (`AttackSerializer`) used for data
+                          conversion for Attack configurations.
+        authentication_classes: API Key (primary) + Auth0 (fallback) authentication.
+        permission_classes: List of permission enforcement classes.
+        parser_classes: List of parsers for request data (JSONParser).
+        lookup_field: The model field used for looking up individual instances ('id').
+
+    Args:
+        id (UUID):
+
+    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:
+        Attack
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Response[Attack]:
+    """Manages Attack configurations through standard CRUD operations.
+
+    This ViewSet allows clients to:
+    - Create new Attack configurations.
+    - List existing Attack configurations (with filtering based on user/org).
+    - Retrieve details of a specific Attack configuration.
+    - Update an existing Attack configuration.
+    - Delete an Attack configuration.
+
+    The actual execution of an attack based on these configurations, and the
+    management of run statuses or results, are handled by other parts of the API
+    (e.g., potentially a RunViewSet or similar).
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+
+    Attributes:
+        queryset: The base queryset, retrieving all Attack objects with related
+                  entities (agent, owner, organization) pre-fetched.
+        serializer_class: The serializer (`AttackSerializer`) used for data
+                          conversion for Attack configurations.
+        authentication_classes: API Key (primary) + Auth0 (fallback) authentication.
+        permission_classes: List of permission enforcement classes.
+        parser_classes: List of parsers for request data (JSONParser).
+        lookup_field: The model field used for looking up individual instances ('id').
+
+    Args:
+        id (UUID):
+
+    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[Attack]
+    """
+
+    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: UUID,
+    *,
+    client: AuthenticatedClient,
+) -> Optional[Attack]:
+    """Manages Attack configurations through standard CRUD operations.
+
+    This ViewSet allows clients to:
+    - Create new Attack configurations.
+    - List existing Attack configurations (with filtering based on user/org).
+    - Retrieve details of a specific Attack configuration.
+    - Update an existing Attack configuration.
+    - Delete an Attack configuration.
+
+    The actual execution of an attack based on these configurations, and the
+    management of run statuses or results, are handled by other parts of the API
+    (e.g., potentially a RunViewSet or similar).
+
+    SDK-primary endpoint - API Key authentication is recommended for programmatic access.
+    Auth0 authentication is supported as fallback for web dashboard use.
+
+    Attributes:
+        queryset: The base queryset, retrieving all Attack objects with related
+                  entities (agent, owner, organization) pre-fetched.
+        serializer_class: The serializer (`AttackSerializer`) used for data
+                          conversion for Attack configurations.
+        authentication_classes: API Key (primary) + Auth0 (fallback) authentication.
+        permission_classes: List of permission enforcement classes.
+        parser_classes: List of parsers for request data (JSONParser).
+        lookup_field: The model field used for looking up individual instances ('id').
+
+    Args:
+        id (UUID):
+
+    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:
+        Attack
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed