daknode 0.3.2__tar.gz → 0.3.3__tar.gz

{daknode-0.3.2 → daknode-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: daknode
-Version: 0.3.2
+Version: 0.3.3
 Summary: A client library for accessing DakNode
 Requires-Python: >=3.9,<4.0
 Classifier: Programming Language :: Python :: 3

daknode-0.3.3/daknode/api/messages/download_raw_message.py

@@ -0,0 +1,187 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.http_validation_error import HTTPValidationError
+from ...types import File, FileTypes
+from io import BytesIO
+from typing import cast
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    message_id: UUID,
+
+) -> dict[str, Any]:
+
+
+
+
+
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/messages/{message_id}/raw".format(message_id=message_id,),
+    }
+
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Union[File, HTTPValidationError]]:
+    if response.status_code == 200:
+        response_200 = File(
+             payload = BytesIO(response.content)
+        )
+
+
+
+        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: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Union[File, 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(
+    message_id: UUID,
+    *,
+    client: AuthenticatedClient,
+
+) -> Response[Union[File, HTTPValidationError]]:
+    """ Download Raw Message
+
+     Download retained original MIME, only with confirmed PASS scan evidence.
+
+    Args:
+        message_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[Union[File, HTTPValidationError]]
+     """
+
+
+    kwargs = _get_kwargs(
+        message_id=message_id,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    message_id: UUID,
+    *,
+    client: AuthenticatedClient,
+
+) -> Optional[Union[File, HTTPValidationError]]:
+    """ Download Raw Message
+
+     Download retained original MIME, only with confirmed PASS scan evidence.
+
+    Args:
+        message_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:
+        Union[File, HTTPValidationError]
+     """
+
+
+    return sync_detailed(
+        message_id=message_id,
+client=client,
+
+    ).parsed
+
+async def asyncio_detailed(
+    message_id: UUID,
+    *,
+    client: AuthenticatedClient,
+
+) -> Response[Union[File, HTTPValidationError]]:
+    """ Download Raw Message
+
+     Download retained original MIME, only with confirmed PASS scan evidence.
+
+    Args:
+        message_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[Union[File, HTTPValidationError]]
+     """
+
+
+    kwargs = _get_kwargs(
+        message_id=message_id,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    message_id: UUID,
+    *,
+    client: AuthenticatedClient,
+
+) -> Optional[Union[File, HTTPValidationError]]:
+    """ Download Raw Message
+
+     Download retained original MIME, only with confirmed PASS scan evidence.
+
+    Args:
+        message_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:
+        Union[File, HTTPValidationError]
+     """
+
+
+    return (await asyncio_detailed(
+        message_id=message_id,
+client=client,
+
+    )).parsed

daknode-0.3.3/daknode/api/metrics/inbox_metrics.py

@@ -0,0 +1,222 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.http_validation_error import HTTPValidationError
+from ...models.metrics_out import MetricsOut
+from ...types import UNSET, Unset
+from typing import cast
+from typing import Union
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    inbox_id: UUID,
+    *,
+    days: Union[Unset, int] = 30,
+    include_today: Union[Unset, bool] = True,
+
+) -> dict[str, Any]:
+
+
+
+
+    params: dict[str, Any] = {}
+
+    params["days"] = days
+
+    params["include_today"] = include_today
+
+
+    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": "/v1/inboxes/{inbox_id}/metrics".format(inbox_id=inbox_id,),
+        "params": params,
+    }
+
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Union[HTTPValidationError, MetricsOut]]:
+    if response.status_code == 200:
+        response_200 = MetricsOut.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: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Union[HTTPValidationError, MetricsOut]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    inbox_id: UUID,
+    *,
+    client: AuthenticatedClient,
+    days: Union[Unset, int] = 30,
+    include_today: Union[Unset, bool] = True,
+
+) -> Response[Union[HTTPValidationError, MetricsOut]]:
+    """ Inbox Metrics
+
+     Metrics for an own live inbox, with the same UTC window as workspace metrics.
+
+    Args:
+        inbox_id (UUID):
+        days (Union[Unset, int]):  Default: 30.
+        include_today (Union[Unset, bool]):  Default: True.
+
+    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[Union[HTTPValidationError, MetricsOut]]
+     """
+
+
+    kwargs = _get_kwargs(
+        inbox_id=inbox_id,
+days=days,
+include_today=include_today,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    inbox_id: UUID,
+    *,
+    client: AuthenticatedClient,
+    days: Union[Unset, int] = 30,
+    include_today: Union[Unset, bool] = True,
+
+) -> Optional[Union[HTTPValidationError, MetricsOut]]:
+    """ Inbox Metrics
+
+     Metrics for an own live inbox, with the same UTC window as workspace metrics.
+
+    Args:
+        inbox_id (UUID):
+        days (Union[Unset, int]):  Default: 30.
+        include_today (Union[Unset, bool]):  Default: True.
+
+    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:
+        Union[HTTPValidationError, MetricsOut]
+     """
+
+
+    return sync_detailed(
+        inbox_id=inbox_id,
+client=client,
+days=days,
+include_today=include_today,
+
+    ).parsed
+
+async def asyncio_detailed(
+    inbox_id: UUID,
+    *,
+    client: AuthenticatedClient,
+    days: Union[Unset, int] = 30,
+    include_today: Union[Unset, bool] = True,
+
+) -> Response[Union[HTTPValidationError, MetricsOut]]:
+    """ Inbox Metrics
+
+     Metrics for an own live inbox, with the same UTC window as workspace metrics.
+
+    Args:
+        inbox_id (UUID):
+        days (Union[Unset, int]):  Default: 30.
+        include_today (Union[Unset, bool]):  Default: True.
+
+    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[Union[HTTPValidationError, MetricsOut]]
+     """
+
+
+    kwargs = _get_kwargs(
+        inbox_id=inbox_id,
+days=days,
+include_today=include_today,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    inbox_id: UUID,
+    *,
+    client: AuthenticatedClient,
+    days: Union[Unset, int] = 30,
+    include_today: Union[Unset, bool] = True,
+
+) -> Optional[Union[HTTPValidationError, MetricsOut]]:
+    """ Inbox Metrics
+
+     Metrics for an own live inbox, with the same UTC window as workspace metrics.
+
+    Args:
+        inbox_id (UUID):
+        days (Union[Unset, int]):  Default: 30.
+        include_today (Union[Unset, bool]):  Default: True.
+
+    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:
+        Union[HTTPValidationError, MetricsOut]
+     """
+
+
+    return (await asyncio_detailed(
+        inbox_id=inbox_id,
+client=client,
+days=days,
+include_today=include_today,
+
+    )).parsed

daknode-0.3.3/daknode/api/metrics/workspace_metrics.py

@@ -0,0 +1,208 @@
+from http import HTTPStatus
+from typing import Any, Optional, Union, cast
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.http_validation_error import HTTPValidationError
+from ...models.metrics_out import MetricsOut
+from ...types import UNSET, Unset
+from typing import cast
+from typing import Union
+
+
+
+def _get_kwargs(
+    *,
+    days: Union[Unset, int] = 30,
+    include_today: Union[Unset, bool] = True,
+
+) -> dict[str, Any]:
+
+
+
+
+    params: dict[str, Any] = {}
+
+    params["days"] = days
+
+    params["include_today"] = include_today
+
+
+    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": "/v1/metrics",
+        "params": params,
+    }
+
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Union[HTTPValidationError, MetricsOut]]:
+    if response.status_code == 200:
+        response_200 = MetricsOut.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: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Union[HTTPValidationError, MetricsOut]]:
+    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,
+    days: Union[Unset, int] = 30,
+    include_today: Union[Unset, bool] = True,
+
+) -> Response[Union[HTTPValidationError, MetricsOut]]:
+    """ Workspace Metrics
+
+     Usage facts and observed delivery outcomes; inbox keys see only their inbox.
+
+    Args:
+        days (Union[Unset, int]):  Default: 30.
+        include_today (Union[Unset, bool]):  Default: True.
+
+    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[Union[HTTPValidationError, MetricsOut]]
+     """
+
+
+    kwargs = _get_kwargs(
+        days=days,
+include_today=include_today,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    days: Union[Unset, int] = 30,
+    include_today: Union[Unset, bool] = True,
+
+) -> Optional[Union[HTTPValidationError, MetricsOut]]:
+    """ Workspace Metrics
+
+     Usage facts and observed delivery outcomes; inbox keys see only their inbox.
+
+    Args:
+        days (Union[Unset, int]):  Default: 30.
+        include_today (Union[Unset, bool]):  Default: True.
+
+    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:
+        Union[HTTPValidationError, MetricsOut]
+     """
+
+
+    return sync_detailed(
+        client=client,
+days=days,
+include_today=include_today,
+
+    ).parsed
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    days: Union[Unset, int] = 30,
+    include_today: Union[Unset, bool] = True,
+
+) -> Response[Union[HTTPValidationError, MetricsOut]]:
+    """ Workspace Metrics
+
+     Usage facts and observed delivery outcomes; inbox keys see only their inbox.
+
+    Args:
+        days (Union[Unset, int]):  Default: 30.
+        include_today (Union[Unset, bool]):  Default: True.
+
+    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[Union[HTTPValidationError, MetricsOut]]
+     """
+
+
+    kwargs = _get_kwargs(
+        days=days,
+include_today=include_today,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    days: Union[Unset, int] = 30,
+    include_today: Union[Unset, bool] = True,
+
+) -> Optional[Union[HTTPValidationError, MetricsOut]]:
+    """ Workspace Metrics
+
+     Usage facts and observed delivery outcomes; inbox keys see only their inbox.
+
+    Args:
+        days (Union[Unset, int]):  Default: 30.
+        include_today (Union[Unset, bool]):  Default: True.
+
+    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:
+        Union[HTTPValidationError, MetricsOut]
+     """
+
+
+    return (await asyncio_detailed(
+        client=client,
+days=days,
+include_today=include_today,
+
+    )).parsed

daknode-0.3.3/daknode/api/send/__init__.py

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

{daknode-0.3.2 → daknode-0.3.3}/daknode/models/__init__.py

@@ -9,7 +9,11 @@ from .consent_request import ConsentRequest
 from .consent_response import ConsentResponse
 from .create_erasure_request_response_create_erasure_request import CreateErasureRequestResponseCreateErasureRequest
 from .create_in import CreateIn
+from .daily_usage import DailyUsage
 from .dead_letter_response import DeadLetterResponse
+from .delivery_cohort import DeliveryCohort
+from .delivery_cohort_current_status import DeliveryCohortCurrentStatus
+from .delivery_cohort_provider_outcomes import DeliveryCohortProviderOutcomes
 from .dns_record import DnsRecord
 from .domain_out import DomainOut
 from .domain_page import DomainPage
@@ -25,6 +29,8 @@ from .inbox_response import InboxResponse
 from .inbox_update_request import InboxUpdateRequest
 from .message_out import MessageOut
 from .message_page import MessagePage
+from .metrics_out import MetricsOut
+from .metrics_window import MetricsWindow
 from .outgoing_attachment import OutgoingAttachment
 from .read_erasure_request_response_read_erasure_request import ReadErasureRequestResponseReadErasureRequest
 from .register_domain_request import RegisterDomainRequest
@@ -43,6 +49,7 @@ from .thread_out import ThreadOut
 from .thread_page import ThreadPage
 from .timeline_item_out import TimelineItemOut
 from .update_in import UpdateIn
+from .usage_counts import UsageCounts
 from .validation_error import ValidationError
 from .validation_error_context import ValidationErrorContext
 from .verify_in import VerifyIn
@@ -61,7 +68,11 @@ __all__ = (
     "ConsentResponse",
     "CreateErasureRequestResponseCreateErasureRequest",
     "CreateIn",
+    "DailyUsage",
     "DeadLetterResponse",
+    "DeliveryCohort",
+    "DeliveryCohortCurrentStatus",
+    "DeliveryCohortProviderOutcomes",
     "DnsRecord",
     "DomainOut",
     "DomainPage",
@@ -77,6 +88,8 @@ __all__ = (
     "InboxUpdateRequest",
     "MessageOut",
     "MessagePage",
+    "MetricsOut",
+    "MetricsWindow",
     "OutgoingAttachment",
     "ReadErasureRequestResponseReadErasureRequest",
     "RegisterDomainRequest",
@@ -95,6 +108,7 @@ __all__ = (
     "ThreadPage",
     "TimelineItemOut",
     "UpdateIn",
+    "UsageCounts",
     "ValidationError",
     "ValidationErrorContext",
     "VerifyIn",