trafficmorph 0.3.0__py3-none-any.whl

trafficmorph/__init__.py

@@ -0,0 +1,30 @@
+
+""" A client library for accessing TrafficMorph API """
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)
+
+# === TM-WRAPPER-BLOCK-v1 === (managed by Makefile regen-client; do not hand-edit)
+from . import api, errors, models, types  # noqa: F401
+from .sdk import (  # noqa: E402, F401
+    Client,
+    SPEC_VERSION,
+    DEFAULT_USER_AGENT,
+    DEFAULT_TIMEOUT,
+    EnvBaseURL,
+    EnvAPIKey,
+)
+
+__all__ = (
+    "Client",
+    "AuthenticatedClient",
+    "SPEC_VERSION",
+    "DEFAULT_USER_AGENT",
+    "DEFAULT_TIMEOUT",
+    "EnvBaseURL",
+    "EnvAPIKey",
+)
+# === END TM-WRAPPER-BLOCK-v1 ===

trafficmorph/api/__init__.py

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

trafficmorph/api/captures/__init__.py

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

trafficmorph/api/captures/analyse.py

@@ -0,0 +1,132 @@
+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.analyse_body import AnalyseBody
+from ...types import UNSET, Unset
+from typing import cast
+
+
+
+def _get_kwargs(
+    *,
+    body: AnalyseBody | Unset = UNSET,
+
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/captures/analyse",
+    }
+
+    if not isinstance(body, Unset):
+        _kwargs["files"] = body.to_multipart()
+
+
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | None:
+    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]:
+    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 | Client,
+    body: AnalyseBody | Unset = UNSET,
+
+) -> Response[Any]:
+    """ Analyse a JSONL capture and preview the proposed profiles
+
+     Uploads a JSONL traffic capture and returns a structured preview — per detected endpoint: the
+    proposed URL skeleton, derived RPS curve, extracted URL + body variables (with cardinality buckets
+    and sample values), and a few sample request URLs. **No state is persisted.** Pair with `/import` to
+    commit the selections you want.
+
+    Args:
+        body (AnalyseBody | 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[Any]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AnalyseBody | Unset = UNSET,
+
+) -> Response[Any]:
+    """ Analyse a JSONL capture and preview the proposed profiles
+
+     Uploads a JSONL traffic capture and returns a structured preview — per detected endpoint: the
+    proposed URL skeleton, derived RPS curve, extracted URL + body variables (with cardinality buckets
+    and sample values), and a few sample request URLs. **No state is persisted.** Pair with `/import` to
+    commit the selections you want.
+
+    Args:
+        body (AnalyseBody | 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[Any]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+

trafficmorph/api/captures/import_capture.py

@@ -0,0 +1,158 @@
+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.import_capture_body import ImportCaptureBody
+from ...types import UNSET, Unset
+from typing import cast
+
+
+
+def _get_kwargs(
+    *,
+    body: ImportCaptureBody | Unset = UNSET,
+    selections: str,
+
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+
+    
+
+    params: dict[str, Any] = {}
+
+    params["selections"] = selections
+
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/captures/import",
+        "params": params,
+    }
+
+    if not isinstance(body, Unset):
+        _kwargs["files"] = body.to_multipart()
+
+
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | None:
+    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]:
+    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 | Client,
+    body: ImportCaptureBody | Unset = UNSET,
+    selections: str,
+
+) -> Response[Any]:
+    """ Import selected endpoints from a JSONL capture as profiles
+
+     Atomic commit. Re-derives the analysis from the uploaded file (no server-side state is kept between
+    `/analyse` and `/import`), picks the groups named in the `selections` JSON, and persists each one as
+    a TrafficMorph profile — plus a variables set whenever the group has variable positions. Either
+    every selection lands or none. Re-upload the same JSONL file you analysed; selections key by
+    `(method, urlSkeleton)` so re-analysis matches the same groups.
+
+    **Name collisions are NOT errors.** If a chosen `profileName` is already taken for this user, the
+    importer auto-suffixes with `(2)`, `(3)`, … until unique. The created entity in the response
+    carries the final name, so the client can show what actually landed. (Same convention applies to
+    variables-set names.)
+
+    Args:
+        selections (str):
+        body (ImportCaptureBody | 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[Any]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+selections=selections,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: ImportCaptureBody | Unset = UNSET,
+    selections: str,
+
+) -> Response[Any]:
+    """ Import selected endpoints from a JSONL capture as profiles
+
+     Atomic commit. Re-derives the analysis from the uploaded file (no server-side state is kept between
+    `/analyse` and `/import`), picks the groups named in the `selections` JSON, and persists each one as
+    a TrafficMorph profile — plus a variables set whenever the group has variable positions. Either
+    every selection lands or none. Re-upload the same JSONL file you analysed; selections key by
+    `(method, urlSkeleton)` so re-analysis matches the same groups.
+
+    **Name collisions are NOT errors.** If a chosen `profileName` is already taken for this user, the
+    importer auto-suffixes with `(2)`, `(3)`, … until unique. The created entity in the response
+    carries the final name, so the client can show what actually landed. (Same convention applies to
+    variables-set names.)
+
+    Args:
+        selections (str):
+        body (ImportCaptureBody | 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[Any]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+selections=selections,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+

trafficmorph/api/domains/__init__.py

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

trafficmorph/api/domains/add.py

@@ -0,0 +1,131 @@
+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.add_domain_request import AddDomainRequest
+from typing import cast
+
+
+
+def _get_kwargs(
+    *,
+    body: AddDomainRequest,
+
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/api/v1/domains",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | None:
+    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]:
+    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 | Client,
+    body: AddDomainRequest,
+
+) -> Response[Any]:
+    """ Register a new domain for verification
+
+     Idempotent. On first call, generates the verification token and creates the record. On subsequent
+    calls for the same `(user, domain)`, returns the existing record with the same token — clients can
+    safely retry without producing duplicates. The response carries the challenge values the user must
+    install before calling `/verify/dns` or `/verify/http`.
+
+    Args:
+        body (AddDomainRequest):
+
+    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]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: AddDomainRequest,
+
+) -> Response[Any]:
+    """ Register a new domain for verification
+
+     Idempotent. On first call, generates the verification token and creates the record. On subsequent
+    calls for the same `(user, domain)`, returns the existing record with the same token — clients can
+    safely retry without producing duplicates. The response carries the challenge values the user must
+    install before calling `/verify/dns` or `/verify/http`.
+
+    Args:
+        body (AddDomainRequest):
+
+    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]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+

trafficmorph/api/domains/list_domains.py

@@ -0,0 +1,107 @@
+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
+
+
+
+
+def _get_kwargs(
+    
+) -> dict[str, Any]:
+    
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/api/v1/domains",
+    }
+
+
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | None:
+    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]:
+    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 | Client,
+
+) -> Response[Any]:
+    """ List the user's domains and their verification status
+
+     Returns all domains the user has added, with each domain's current verification state (`PENDING` /
+    `VERIFIED`) and the challenge tokens still in play.
+
+    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]
+     """
+
+
+    kwargs = _get_kwargs(
+        
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+
+) -> Response[Any]:
+    """ List the user's domains and their verification status
+
+     Returns all domains the user has added, with each domain's current verification state (`PENDING` /
+    `VERIFIED`) and the challenge tokens still in play.
+
+    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]
+     """
+
+
+    kwargs = _get_kwargs(
+        
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+

trafficmorph/api/domains/remove.py

@@ -0,0 +1,124 @@
+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
+
+
+
+
+def _get_kwargs(
+    id: int,
+
+) -> dict[str, Any]:
+    
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/api/v1/domains/{id}".format(id=quote(str(id), safe=""),),
+    }
+
+
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | None:
+    if response.status_code == 204:
+        return None
+
+    if response.status_code == 400:
+        return None
+
+    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]:
+    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: int,
+    *,
+    client: AuthenticatedClient | Client,
+
+) -> Response[Any]:
+    """ Remove a domain
+
+     Deletes the domain and its challenges. Profiles targeting this domain remain saved but won't be
+    runnable until another verified domain covers the target host.
+
+    Args:
+        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[Any]
+     """
+
+
+    kwargs = _get_kwargs(
+        id=id,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    id: int,
+    *,
+    client: AuthenticatedClient | Client,
+
+) -> Response[Any]:
+    """ Remove a domain
+
+     Deletes the domain and its challenges. Profiles targeting this domain remain saved but won't be
+    runnable until another verified domain covers the target host.
+
+    Args:
+        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[Any]
+     """
+
+
+    kwargs = _get_kwargs(
+        id=id,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+