daknode 0.3.3__tar.gz → 0.3.4__tar.gz

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

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

daknode-0.3.4/daknode/api/events/poll_inbox_events.py

@@ -0,0 +1,279 @@
+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.inbox_event_page import InboxEventPage
+from ...models.poll_inbox_events_start import PollInboxEventsStart
+from ...types import UNSET, Unset
+from typing import cast
+from typing import cast, Union
+from typing import Union
+from uuid import UUID
+
+
+
+def _get_kwargs(
+    inbox_id: UUID,
+    *,
+    cursor: Union[None, Unset, str] = UNSET,
+    start: Union[Unset, PollInboxEventsStart] = PollInboxEventsStart.BEGINNING,
+    limit: Union[Unset, int] = 25,
+    wait_seconds: Union[Unset, int] = 0,
+
+) -> dict[str, Any]:
+
+
+
+
+    params: dict[str, Any] = {}
+
+    json_cursor: Union[None, Unset, str]
+    if isinstance(cursor, Unset):
+        json_cursor = UNSET
+    else:
+        json_cursor = cursor
+    params["cursor"] = json_cursor
+
+    json_start: Union[Unset, str] = UNSET
+    if not isinstance(start, Unset):
+        json_start = start.value
+
+    params["start"] = json_start
+
+    params["limit"] = limit
+
+    params["wait_seconds"] = wait_seconds
+
+
+    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}/events".format(inbox_id=inbox_id,),
+        "params": params,
+    }
+
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Union[HTTPValidationError, InboxEventPage]]:
+    if response.status_code == 200:
+        response_200 = InboxEventPage.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, InboxEventPage]]:
+    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,
+    cursor: Union[None, Unset, str] = UNSET,
+    start: Union[Unset, PollInboxEventsStart] = PollInboxEventsStart.BEGINNING,
+    limit: Union[Unset, int] = 25,
+    wait_seconds: Union[Unset, int] = 0,
+
+) -> Response[Union[HTTPValidationError, InboxEventPage]]:
+    """ Poll Inbox Events
+
+     Poll retained inbound message availability; persist next_cursor and deduplicate IDs.
+
+    No webhook registration needed. An empty response still has a tail cursor.
+    Cursors expire after one hour: restart from beginning and deduplicate on id.
+    This is not a complete webhook/audit catalogue; fetch content via the message API.
+
+    Args:
+        inbox_id (UUID):
+        cursor (Union[None, Unset, str]):
+        start (Union[Unset, PollInboxEventsStart]):  Default: PollInboxEventsStart.BEGINNING.
+        limit (Union[Unset, int]):  Default: 25.
+        wait_seconds (Union[Unset, int]):  Default: 0.
+
+    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, InboxEventPage]]
+     """
+
+
+    kwargs = _get_kwargs(
+        inbox_id=inbox_id,
+cursor=cursor,
+start=start,
+limit=limit,
+wait_seconds=wait_seconds,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    inbox_id: UUID,
+    *,
+    client: AuthenticatedClient,
+    cursor: Union[None, Unset, str] = UNSET,
+    start: Union[Unset, PollInboxEventsStart] = PollInboxEventsStart.BEGINNING,
+    limit: Union[Unset, int] = 25,
+    wait_seconds: Union[Unset, int] = 0,
+
+) -> Optional[Union[HTTPValidationError, InboxEventPage]]:
+    """ Poll Inbox Events
+
+     Poll retained inbound message availability; persist next_cursor and deduplicate IDs.
+
+    No webhook registration needed. An empty response still has a tail cursor.
+    Cursors expire after one hour: restart from beginning and deduplicate on id.
+    This is not a complete webhook/audit catalogue; fetch content via the message API.
+
+    Args:
+        inbox_id (UUID):
+        cursor (Union[None, Unset, str]):
+        start (Union[Unset, PollInboxEventsStart]):  Default: PollInboxEventsStart.BEGINNING.
+        limit (Union[Unset, int]):  Default: 25.
+        wait_seconds (Union[Unset, int]):  Default: 0.
+
+    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, InboxEventPage]
+     """
+
+
+    return sync_detailed(
+        inbox_id=inbox_id,
+client=client,
+cursor=cursor,
+start=start,
+limit=limit,
+wait_seconds=wait_seconds,
+
+    ).parsed
+
+async def asyncio_detailed(
+    inbox_id: UUID,
+    *,
+    client: AuthenticatedClient,
+    cursor: Union[None, Unset, str] = UNSET,
+    start: Union[Unset, PollInboxEventsStart] = PollInboxEventsStart.BEGINNING,
+    limit: Union[Unset, int] = 25,
+    wait_seconds: Union[Unset, int] = 0,
+
+) -> Response[Union[HTTPValidationError, InboxEventPage]]:
+    """ Poll Inbox Events
+
+     Poll retained inbound message availability; persist next_cursor and deduplicate IDs.
+
+    No webhook registration needed. An empty response still has a tail cursor.
+    Cursors expire after one hour: restart from beginning and deduplicate on id.
+    This is not a complete webhook/audit catalogue; fetch content via the message API.
+
+    Args:
+        inbox_id (UUID):
+        cursor (Union[None, Unset, str]):
+        start (Union[Unset, PollInboxEventsStart]):  Default: PollInboxEventsStart.BEGINNING.
+        limit (Union[Unset, int]):  Default: 25.
+        wait_seconds (Union[Unset, int]):  Default: 0.
+
+    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, InboxEventPage]]
+     """
+
+
+    kwargs = _get_kwargs(
+        inbox_id=inbox_id,
+cursor=cursor,
+start=start,
+limit=limit,
+wait_seconds=wait_seconds,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    inbox_id: UUID,
+    *,
+    client: AuthenticatedClient,
+    cursor: Union[None, Unset, str] = UNSET,
+    start: Union[Unset, PollInboxEventsStart] = PollInboxEventsStart.BEGINNING,
+    limit: Union[Unset, int] = 25,
+    wait_seconds: Union[Unset, int] = 0,
+
+) -> Optional[Union[HTTPValidationError, InboxEventPage]]:
+    """ Poll Inbox Events
+
+     Poll retained inbound message availability; persist next_cursor and deduplicate IDs.
+
+    No webhook registration needed. An empty response still has a tail cursor.
+    Cursors expire after one hour: restart from beginning and deduplicate on id.
+    This is not a complete webhook/audit catalogue; fetch content via the message API.
+
+    Args:
+        inbox_id (UUID):
+        cursor (Union[None, Unset, str]):
+        start (Union[Unset, PollInboxEventsStart]):  Default: PollInboxEventsStart.BEGINNING.
+        limit (Union[Unset, int]):  Default: 25.
+        wait_seconds (Union[Unset, int]):  Default: 0.
+
+    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, InboxEventPage]
+     """
+
+
+    return (await asyncio_detailed(
+        inbox_id=inbox_id,
+client=client,
+cursor=cursor,
+start=start,
+limit=limit,
+wait_seconds=wait_seconds,
+
+    )).parsed

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

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

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

@@ -23,6 +23,8 @@ from .forward_request import ForwardRequest
 from .http_validation_error import HTTPValidationError
 from .inbox_create_request import InboxCreateRequest
 from .inbox_deleted import InboxDeleted
+from .inbox_event import InboxEvent
+from .inbox_event_page import InboxEventPage
 from .inbox_out import InboxOut
 from .inbox_page import InboxPage
 from .inbox_response import InboxResponse
@@ -32,6 +34,7 @@ from .message_page import MessagePage
 from .metrics_out import MetricsOut
 from .metrics_window import MetricsWindow
 from .outgoing_attachment import OutgoingAttachment
+from .poll_inbox_events_start import PollInboxEventsStart
 from .read_erasure_request_response_read_erasure_request import ReadErasureRequestResponseReadErasureRequest
 from .register_domain_request import RegisterDomainRequest
 from .replay_response import ReplayResponse
@@ -82,6 +85,8 @@ __all__ = (
     "HTTPValidationError",
     "InboxCreateRequest",
     "InboxDeleted",
+    "InboxEvent",
+    "InboxEventPage",
     "InboxOut",
     "InboxPage",
     "InboxResponse",
@@ -91,6 +96,7 @@ __all__ = (
     "MetricsOut",
     "MetricsWindow",
     "OutgoingAttachment",
+    "PollInboxEventsStart",
     "ReadErasureRequestResponseReadErasureRequest",
     "RegisterDomainRequest",
     "ReplayResponse",

daknode-0.3.4/daknode/models/inbox_event.py

@@ -0,0 +1,154 @@
+from collections.abc import Mapping
+from typing import Any, TypeVar, Optional, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from ..types import UNSET, Unset
+from dateutil.parser import isoparse
+from typing import cast
+from typing import Literal, Union, cast
+from uuid import UUID
+import datetime
+
+
+
+
+
+
+T = TypeVar("T", bound="InboxEvent")
+
+
+
+@_attrs_define
+class InboxEvent:
+    """
+        Attributes:
+            channel (str):
+            id (UUID):
+            inbox_id (UUID):
+            message_id (UUID):
+            occurred_at (datetime.datetime):
+            sequence_number (int):
+            thread_id (UUID):
+            type_ (Union[Literal['message.received'], Unset]):  Default: 'message.received'.
+     """
+
+    channel: str
+    id: UUID
+    inbox_id: UUID
+    message_id: UUID
+    occurred_at: datetime.datetime
+    sequence_number: int
+    thread_id: UUID
+    type_: Union[Literal['message.received'], Unset] = 'message.received'
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+
+
+
+
+    def to_dict(self) -> dict[str, Any]:
+        channel = self.channel
+
+        id = str(self.id)
+
+        inbox_id = str(self.inbox_id)
+
+        message_id = str(self.message_id)
+
+        occurred_at = self.occurred_at.isoformat()
+
+        sequence_number = self.sequence_number
+
+        thread_id = str(self.thread_id)
+
+        type_ = self.type_
+
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({
+            "channel": channel,
+            "id": id,
+            "inbox_id": inbox_id,
+            "message_id": message_id,
+            "occurred_at": occurred_at,
+            "sequence_number": sequence_number,
+            "thread_id": thread_id,
+        })
+        if type_ is not UNSET:
+            field_dict["type"] = type_
+
+        return field_dict
+
+
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        channel = d.pop("channel")
+
+        id = UUID(d.pop("id"))
+
+
+
+
+        inbox_id = UUID(d.pop("inbox_id"))
+
+
+
+
+        message_id = UUID(d.pop("message_id"))
+
+
+
+
+        occurred_at = isoparse(d.pop("occurred_at"))
+
+
+
+
+        sequence_number = d.pop("sequence_number")
+
+        thread_id = UUID(d.pop("thread_id"))
+
+
+
+
+        type_ = cast(Union[Literal['message.received'], Unset] , d.pop("type", UNSET))
+        if type_ != 'message.received'and not isinstance(type_, Unset):
+            raise ValueError(f"type must match const 'message.received', got '{type_}'")
+
+        inbox_event = cls(
+            channel=channel,
+            id=id,
+            inbox_id=inbox_id,
+            message_id=message_id,
+            occurred_at=occurred_at,
+            sequence_number=sequence_number,
+            thread_id=thread_id,
+            type_=type_,
+        )
+
+
+        inbox_event.additional_properties = d
+        return inbox_event
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

daknode-0.3.4/daknode/models/inbox_event_page.py

@@ -0,0 +1,116 @@
+from collections.abc import Mapping
+from typing import Any, TypeVar, Optional, BinaryIO, TextIO, TYPE_CHECKING, Generator
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+from typing import cast
+
+if TYPE_CHECKING:
+  from ..models.inbox_event import InboxEvent
+
+
+
+
+
+T = TypeVar("T", bound="InboxEventPage")
+
+
+
+@_attrs_define
+class InboxEventPage:
+    """
+        Attributes:
+            has_more (bool):
+            items (list['InboxEvent']):
+            next_cursor (str):
+            poll_after_seconds (int):
+     """
+
+    has_more: bool
+    items: list['InboxEvent']
+    next_cursor: str
+    poll_after_seconds: int
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+
+
+
+
+    def to_dict(self) -> dict[str, Any]:
+        from ..models.inbox_event import InboxEvent
+        has_more = self.has_more
+
+        items = []
+        for items_item_data in self.items:
+            items_item = items_item_data.to_dict()
+            items.append(items_item)
+
+
+
+        next_cursor = self.next_cursor
+
+        poll_after_seconds = self.poll_after_seconds
+
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({
+            "has_more": has_more,
+            "items": items,
+            "next_cursor": next_cursor,
+            "poll_after_seconds": poll_after_seconds,
+        })
+
+        return field_dict
+
+
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.inbox_event import InboxEvent
+        d = dict(src_dict)
+        has_more = d.pop("has_more")
+
+        items = []
+        _items = d.pop("items")
+        for items_item_data in (_items):
+            items_item = InboxEvent.from_dict(items_item_data)
+
+
+
+            items.append(items_item)
+
+
+        next_cursor = d.pop("next_cursor")
+
+        poll_after_seconds = d.pop("poll_after_seconds")
+
+        inbox_event_page = cls(
+            has_more=has_more,
+            items=items,
+            next_cursor=next_cursor,
+            poll_after_seconds=poll_after_seconds,
+        )
+
+
+        inbox_event_page.additional_properties = d
+        return inbox_event_page
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

daknode-0.3.4/daknode/models/poll_inbox_events_start.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+class PollInboxEventsStart(str, Enum):
+    BEGINNING = "beginning"
+    LATEST = "latest"
+
+    def __str__(self) -> str:
+        return str(self.value)

{daknode-0.3.3 → daknode-0.3.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "daknode"
-version = "0.3.3"
+version = "0.3.4"
 description = "A client library for accessing DakNode"
 authors = []
 readme = "README.md"

{daknode-0.3.3 → daknode-0.3.4}/daknode/models/delivery_cohort.py

@@ -14,8 +14,8 @@ from typing import Union
 import datetime
 
 if TYPE_CHECKING:
-  from ..models.delivery_cohort_provider_outcomes import DeliveryCohortProviderOutcomes
   from ..models.delivery_cohort_current_status import DeliveryCohortCurrentStatus
+  from ..models.delivery_cohort_provider_outcomes import DeliveryCohortProviderOutcomes
 
 
 
@@ -54,8 +54,8 @@ class DeliveryCohort:
 
 
     def to_dict(self) -> dict[str, Any]:
-        from ..models.delivery_cohort_provider_outcomes import DeliveryCohortProviderOutcomes
         from ..models.delivery_cohort_current_status import DeliveryCohortCurrentStatus
+        from ..models.delivery_cohort_provider_outcomes import DeliveryCohortProviderOutcomes
         accepted_sends = self.accepted_sends
 
         current_status = self.current_status.to_dict()
@@ -96,8 +96,8 @@ class DeliveryCohort:
 
     @classmethod
     def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
-        from ..models.delivery_cohort_provider_outcomes import DeliveryCohortProviderOutcomes
         from ..models.delivery_cohort_current_status import DeliveryCohortCurrentStatus
+        from ..models.delivery_cohort_provider_outcomes import DeliveryCohortProviderOutcomes
         d = dict(src_dict)
         accepted_sends = d.pop("accepted_sends")
 

{daknode-0.3.3 → daknode-0.3.4}/daknode/models/metrics_out.py

@@ -13,10 +13,10 @@ from typing import Union
 from uuid import UUID
 
 if TYPE_CHECKING:
-  from ..models.usage_counts import UsageCounts
   from ..models.delivery_cohort import DeliveryCohort
   from ..models.daily_usage import DailyUsage
   from ..models.metrics_window import MetricsWindow
+  from ..models.usage_counts import UsageCounts
 
 
 
@@ -53,10 +53,10 @@ class MetricsOut:
 
 
     def to_dict(self) -> dict[str, Any]:
-        from ..models.usage_counts import UsageCounts
         from ..models.delivery_cohort import DeliveryCohort
         from ..models.daily_usage import DailyUsage
         from ..models.metrics_window import MetricsWindow
+        from ..models.usage_counts import UsageCounts
         daily = []
         for daily_item_data in self.daily:
             daily_item = daily_item_data.to_dict()
@@ -104,10 +104,10 @@ class MetricsOut:
 
     @classmethod
     def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
-        from ..models.usage_counts import UsageCounts
         from ..models.delivery_cohort import DeliveryCohort
         from ..models.daily_usage import DailyUsage
         from ..models.metrics_window import MetricsWindow
+        from ..models.usage_counts import UsageCounts
         d = dict(src_dict)
         daily = []
         _daily = d.pop("daily")