dex-connector-postmark 0.1.0__tar.gz

dex_connector_postmark-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+/.dex-local/dexcli
+/.dex-local/dex-server-zd
+/.dex-local/data/
+/.dex-local/cli.log
+/.dex-local/visualize.json
+/.dex-local/visualize.err

dex_connector_postmark-0.1.0/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.5
+Name: dex-connector-postmark
+Version: 0.1.0
+Summary: Postmark connector for Dex Flows
+License-Expression: MIT
+Requires-Python: >=3.11
+Requires-Dist: dex-connectors-sdk==0.1.0
+Requires-Dist: dex-python-sdk>=1.28.0
+Requires-Dist: httpx>=0.27
+Description-Content-Type: text/markdown
+
+# Postmark connector for Python
+
+Install with `pip install dex-connector-postmark==0.1.0`. The package requires
+`dex-connectors-sdk==0.1.0` and `dex-python-sdk>=1.28.0`, and implements the
+manifest Queries `listOutboundMessages` and `getMessageDetails` with the same
+branches, defaults, and failure classification as the Go module.
+
+## Operations
+
+| Operation | Factory | Happy branch | Optional branches |
+| --- | --- | --- | --- |
+| `listOutboundMessages` | `new_list_outbound_messages_step` | `listed` | `providerRejected`, `invalidResponse`, `defect` |
+| `getMessageDetails` | `new_get_message_details_step` | `found` | `notFound`, `providerRejected`, `invalidResponse`, `defect` |
+
+`listOutboundMessages` sends `count` (zero means 50, at most 500) and `offset`;
+`count + offset` must stay within Postmark's 10,000-message search window.
+`getMessageDetails` selects `notFound` for HTTP 404 or Postmark error code 701.
+408, 429, 5xx, and transport failures retry; other 4xx responses select
+`providerRejected`.
+
+## Authorization
+
+Create a Dex Web connection named `postmark` as described in the
+[connector README](../README.md#authorization). The Server API token travels
+only in the `X-Postmark-Server-Token` header and is resolved for every attempt.
+
+## Example
+
+[`examples/outbound_lookup`](examples/outbound_lookup/flow.py) checks the page
+window, lists outbound messages with `new_list_outbound_messages_step`, and
+records the page. Run the Worker with
+`uv run python -m examples.outbound_lookup.worker` after `dexcli dev` has
+loaded a project containing the `postmark` connection.
+
+## Tests
+
+`postmarkmock.Mock` scripts both Queries and defaults to the manifest mock
+answers. Run `uv run pytest tests` for provider parity and manifest contract
+checks.

dex_connector_postmark-0.1.0/README.md

@@ -0,0 +1,39 @@
+# Postmark connector for Python
+
+Install with `pip install dex-connector-postmark==0.1.0`. The package requires
+`dex-connectors-sdk==0.1.0` and `dex-python-sdk>=1.28.0`, and implements the
+manifest Queries `listOutboundMessages` and `getMessageDetails` with the same
+branches, defaults, and failure classification as the Go module.
+
+## Operations
+
+| Operation | Factory | Happy branch | Optional branches |
+| --- | --- | --- | --- |
+| `listOutboundMessages` | `new_list_outbound_messages_step` | `listed` | `providerRejected`, `invalidResponse`, `defect` |
+| `getMessageDetails` | `new_get_message_details_step` | `found` | `notFound`, `providerRejected`, `invalidResponse`, `defect` |
+
+`listOutboundMessages` sends `count` (zero means 50, at most 500) and `offset`;
+`count + offset` must stay within Postmark's 10,000-message search window.
+`getMessageDetails` selects `notFound` for HTTP 404 or Postmark error code 701.
+408, 429, 5xx, and transport failures retry; other 4xx responses select
+`providerRejected`.
+
+## Authorization
+
+Create a Dex Web connection named `postmark` as described in the
+[connector README](../README.md#authorization). The Server API token travels
+only in the `X-Postmark-Server-Token` header and is resolved for every attempt.
+
+## Example
+
+[`examples/outbound_lookup`](examples/outbound_lookup/flow.py) checks the page
+window, lists outbound messages with `new_list_outbound_messages_step`, and
+records the page. Run the Worker with
+`uv run python -m examples.outbound_lookup.worker` after `dexcli dev` has
+loaded a project containing the `postmark` connection.
+
+## Tests
+
+`postmarkmock.Mock` scripts both Queries and defaults to the manifest mock
+answers. Run `uv run pytest tests` for provider parity and manifest contract
+checks.

dex_connector_postmark-0.1.0/examples/outbound_lookup/__init__.py

@@ -0,0 +1,3 @@
+# Copyright (c) 2026 Super Durable
+# SPDX-License-Identifier: MIT
+"""Postmark outbound lookup example Flow."""

dex_connector_postmark-0.1.0/examples/outbound_lookup/flow.py

@@ -0,0 +1,81 @@
+# Copyright (c) 2026 Super Durable
+# SPDX-License-Identifier: MIT
+"""Runnable outbound lookup Flow using the Postmark listOutboundMessages Query."""
+
+import dex
+from dex_connectors.sdk import QueryResult
+
+from dex_connectors.postmark import (
+    Connection,
+    ListOutboundMessagesInput,
+    MessagePage,
+    new_list_outbound_messages_step,
+)
+
+FLOW_TYPE = "PostmarkOutboundLookup"
+CONNECTION_NAME = "postmark"
+_LIST_STEP_TYPE = "ListOutboundMessages"
+_OUTCOME = dex.Attribute("postmark-outbound-lookup-outcome", MessagePage)
+
+
+def map_to_list_outbound_messages_input(request: ListOutboundMessagesInput) -> ListOutboundMessagesInput:
+    """Search with the requested page window unchanged."""
+    return request
+
+
+# dex:group group-id:outbound-lookup group-label:"Outbound lookup"
+# dex:explanation text:"Check the requested page window before calling Postmark."
+class _PrepareRequest(dex.Step[ListOutboundMessagesInput]):
+    def get_step_type(self) -> str:
+        return "PrepareRequest"
+
+    def execute(self, context: dex.Context, input: ListOutboundMessagesInput) -> dex.StepDecision:
+        if input.count < 0 or input.offset < 0:
+            return dex.force_fail("count and offset must not be negative")
+        return dex.go_to(dex.StepRef(_LIST_STEP_TYPE), input)
+
+
+# dex:group group-id:outbound-lookup group-label:"Outbound lookup"
+# dex:explanation text:"Record the outbound message page and complete the Flow."
+class _CompleteRequest(dex.Step[QueryResult[MessagePage]]):
+    def get_step_type(self) -> str:
+        return "CompleteRequest"
+
+    def execute(self, context: dex.Context, input: QueryResult[MessagePage]) -> dex.StepDecision:
+        _OUTCOME.set(context, input.value)
+        return dex.graceful_complete(input.value)
+
+
+class OutboundLookupFlow(dex.Flow[ListOutboundMessagesInput]):
+    """List one page of outbound messages through the static postmark connection."""
+
+    def __init__(self, connection: Connection) -> None:
+        if connection.reference.name != CONNECTION_NAME:
+            raise ValueError("outbound lookup requires the static postmark connection")
+        self._prepare = _PrepareRequest()
+        self._complete = _CompleteRequest()
+        self._list = new_list_outbound_messages_step(
+            step_type=_LIST_STEP_TYPE,
+            step_input_type=ListOutboundMessagesInput,
+            annotations={
+                "groupId": "postmark",
+                "groupLabel": "Postmark",
+                "explanation": "List recent outbound messages from Postmark.",
+            },
+            connection=connection,
+            connection_name=CONNECTION_NAME,
+            map_to_operation_input=map_to_list_outbound_messages_input,
+            listed=self._complete,
+        )
+
+    def get_flow_type(self) -> str:
+        """Return the stable Flow identity used in Dex Web."""
+        return FLOW_TYPE
+
+    def get_steps(self) -> dex.StepList[ListOutboundMessagesInput]:
+        """Register request check, provider search, and completion Steps."""
+        return dex.StepList.start_step(self._prepare).other_steps(self._list, self._complete)
+
+    def get_persistence_schema(self) -> dex.PersistenceSchema:
+        """Persist the outbound message page."""
+        return dex.PersistenceSchema.of(_OUTCOME)

dex_connector_postmark-0.1.0/examples/outbound_lookup/worker.py

@@ -0,0 +1,51 @@
+# Copyright (c) 2026 Super Durable
+# SPDX-License-Identifier: MIT
+"""Worker entrypoint for the Postmark outbound lookup Flow."""
+
+import asyncio
+import os
+import tempfile
+from pathlib import Path
+
+import dex
+from dex_connectors.sdk.projectconfig import load_from_environment
+
+from dex_connectors.postmark import new_project_connection
+
+from .flow import CONNECTION_NAME, OutboundLookupFlow
+
+
+async def run_worker() -> None:
+    """Load the named Dex Web connection and serve outbound lookups."""
+    project = await load_from_environment()
+    connection = None
+    cache = None
+    try:
+        connection = new_project_connection(project, CONNECTION_NAME)
+        registry = dex.Registry([OutboundLookupFlow(connection)], allow_async_handlers=True)
+        cache_directory = os.environ.get(
+            "DEX_BLOB_CACHE_DIR", str(Path(tempfile.gettempdir()) / "dex-postmark-outbound-lookup-blobs")
+        )
+        cache = dex.open_blob_cache(dex.BlobCacheConfig(cache_directory, 1 << 30))
+        worker = dex.AsyncWorker(
+            registry,
+            cache,
+            dex.WorkerOptions(server_address=os.environ.get("DEX_FLOW_SERVICE_ADDRESS", "localhost:8801")),
+        )
+        async with worker:
+            await worker.start()
+    finally:
+        if connection is not None:
+            await connection.aclose()
+        if cache is not None:
+            cache.close()
+        await project.close()
+
+
+def main() -> None:
+    """Run until the Worker stops or the process receives an interrupt."""
+    asyncio.run(run_worker())
+
+
+if __name__ == "__main__":
+    main()

dex_connector_postmark-0.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "dex-connector-postmark"
+version = "0.1.0"
+description = "Postmark connector for Dex Flows"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+dependencies = ["dex-connectors-sdk==0.1.0", "dex-python-sdk>=1.28.0", "httpx>=0.27"]
+
+[dependency-groups]
+dev = ["pytest>=8", "pytest-asyncio>=0.24", "mypy>=1.13", "ruff>=0.7", "pyyaml>=6", "types-PyYAML>=6"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/dex_connectors"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = [".", "src"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+mypy_path = "src"
+explicit_package_bases = true
+
+[tool.ruff]
+target-version = "py311"
+line-length = 110
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]

dex_connector_postmark-0.1.0/src/dex_connectors/postmark/__init__.py

@@ -0,0 +1,50 @@
+# Copyright (c) 2026 Super Durable
+# SPDX-License-Identifier: MIT
+"""Postmark outbound message operations for Dex connector Steps."""
+
+from .client import (
+    CONNECTOR_ID,
+    DEFECT,
+    FOUND,
+    GET_MESSAGE_DETAILS_DEFINITION,
+    INVALID_RESPONSE,
+    LIST_OUTBOUND_MESSAGES_DEFINITION,
+    LISTED,
+    NOT_FOUND,
+    PROVIDER_REJECTED,
+    Client,
+    Config,
+    Credentials,
+    GetMessageDetailsOperation,
+    ListOutboundMessagesOperation,
+)
+from .connection import Connection, new_connection, new_connection_with_operations, new_project_connection
+from .models import GetMessageDetailsInput, ListOutboundMessagesInput, MessageDetails, MessagePage
+from .steps import new_get_message_details_step, new_list_outbound_messages_step
+
+__all__ = [
+    "Client",
+    "Config",
+    "Connection",
+    "Credentials",
+    "GetMessageDetailsInput",
+    "GetMessageDetailsOperation",
+    "ListOutboundMessagesInput",
+    "ListOutboundMessagesOperation",
+    "MessageDetails",
+    "MessagePage",
+    "new_connection",
+    "new_connection_with_operations",
+    "new_get_message_details_step",
+    "new_list_outbound_messages_step",
+    "new_project_connection",
+    "CONNECTOR_ID",
+    "DEFECT",
+    "FOUND",
+    "GET_MESSAGE_DETAILS_DEFINITION",
+    "INVALID_RESPONSE",
+    "LIST_OUTBOUND_MESSAGES_DEFINITION",
+    "LISTED",
+    "NOT_FOUND",
+    "PROVIDER_REJECTED",
+]