hookbase 4.1.0__tar.gz → 4.2.0__tar.gz

{hookbase-4.1.0 → hookbase-4.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: hookbase
-Version: 4.1.0
+Version: 4.2.0
 Summary: Official Python SDK for the Hookbase webhook management platform
 Project-URL: Homepage, https://hookbase.app
 Project-URL: Documentation, https://www.hookbase.app/docs/send/sdk
@@ -145,23 +145,67 @@ for p in client.providers.list(category="payments").providers:
     print(p.hookbase_provider, p.signature_verification and p.signature_verification.secret_source)
 client.providers.get("stripe").signature_verification
 
+# Record the catalog entry a source is made from (create only). Entries with no verifier of
+# their own, such as Salesforce, save as Custom HMAC:
+client.sources.create({"name": "Salesforce", "slug": "salesforce", "provider": "custom",
+                       "catalogProvider": "salesforce"})
+
 # Destinations
 client.destinations.list()
-client.destinations.create({"name": "Backend", "url": "https://..."})
+dest = client.destinations.create({"name": "Backend", "url": "https://..."})
 client.destinations.test("dst_id")
 
+# HTTP destinations sign every delivery (Standard Webhooks headers), so the receiver can check
+# it with Webhook(secret).verify(). Create returns the secret once: put it in your secret store.
+# repr() and str() leave it out, so logging the destination doesn't leak it.
+signing_secret = dest.signing_secret            # whsec_...; dest.has_signing_secret is True
+client.destinations.reveal_secret("dst_id").signing_secret
+rotated = client.destinations.rotate_secret("dst_id", grace_period_seconds=3600)
+rotated.previous_secret_expires_at              # until then the old secret signs too
+
+# Bridge destinations publish each delivery they receive as an outbound event
+from hookbase.models import BridgeConfig, CreateDestinationParams
+
+bridge = client.destinations.create(CreateDestinationParams(
+    name="Orders to customers",
+    type="bridge",
+    config=BridgeConfig(event_type_source="field", event_type_field="type",
+                        event_type_prefix="order."),
+))
+# A bridge's test is a dry run: nothing is published
+result = client.destinations.test(bridge.id, payload={"type": "created"})
+result.event_type, result.event_type_exists, result.matching_endpoints
+
 # Routes
 client.routes.create({"name": "Route", "sourceId": "src_id", "destinationId": "dst_id"})
 client.routes.get_circuit_status("route_id")
 client.routes.reset_circuit("route_id")
 
+# While a route's circuit is open its deliveries are held (status "held", hold_expires_at set)
+# and go out when it closes. hold_on_circuit_open=False dead-letters them as soon as the circuit
+# opens instead.
+client.routes.update("route_id", {"holdOnCircuitOpen": False})
+client.routes.get("route_id").held_count  # get only; held_count_capped past 10,000
+
 # Events & Deliveries
 client.events.list(source_id="src_id", from_date="2024-01-01")  # id or slug; unknown -> 404
 client.events.get("evt_id")  # Includes payload and deliveries
+client.events.debug("evt_id").curl_command  # plus typed deliveries, pattern hints, circuit state
 client.deliveries.replay("del_id")
 client.deliveries.bulk_replay(["del_1", "del_2"])
 
+# Replay with edits. payload_patch is an RFC 7386 merge patch on the stored payload (None
+# removes a key), so it works on sources that mask fields; modified_payload replaces it. An
+# argument left as None is not sent.
+client.deliveries.replay(
+    "del_id",
+    payload_patch={"amount": 10, "coupon": None},
+    destination_override="backup-destination",   # id or slug
+    headers_override={"X-Replay": "1"},
+)
+
 # Transforms & Filters
+client.transforms.engines()  # languages this deployment runs, and which are available
 client.transforms.create({"name": "Extract", "transformType": "jsonata", "code": "$.data"})
 client.transforms.test(code="$.data", payload={"data": {"key": "value"}})  # .result
 client.filters.test(
@@ -189,18 +233,26 @@ client.outbound.endpoints.rotate_secret("ep_id", grace_period=3600)
 # this". Name the setting in `clear` to send an explicit null for it:
 client.outbound.endpoints.update("ep_id", {"clear": ["retryDelays"]})
 
+# While an endpoint's circuit is open its messages are held (status "held") and go out when it
+# recovers; hold_on_circuit_open=False dead-letters them instead. FIFO endpoints never hold.
+client.outbound.endpoints.update("ep_id", {"holdOnCircuitOpen": False})
+client.outbound.endpoints.get("ep_id").held_count
+
 # Event Types & Subscriptions
 client.outbound.event_types.create({"name": "order.created", "category": "orders"})
 client.outbound.subscriptions.create({"endpointId": "ep_id", "eventTypeId": "et_id"})
 client.outbound.subscriptions.bulk_create("ep_id", ["et_1", "et_2"])
 
 # Send Events
-client.outbound.messages.send("app_id", event_type="order.created", payload={"orderId": "ord_1"})
+sent = client.outbound.messages.send("app_id", event_type="order.created",
+                                     payload={"orderId": "ord_1"})
+sent.messages_held  # of messages_queued, those held behind an open circuit (None if none)
 
 # Message Log
-client.outbound.message_log.list(application_id="app_id")
+client.outbound.message_log.list(application_id="app_id", status="held")  # .hold_expires_at
+client.outbound.message_log.get("msg_id").bridge  # set when a bridge destination published it
 client.outbound.message_log.list_attempts("msg_id")
-client.outbound.message_log.stats()
+client.outbound.message_log.stats()  # .held among the counts
 
 # Dead Letter Queue
 client.outbound.dlq.list()
@@ -385,6 +437,56 @@ source = client.sources.create({"name": "GitHub", "slug": "github", "provider":
 # source with a provider newer than this package still parses.
 ```
 
+## Upgrading to 4.2
+
+- **Fix:** `destinations.list()` and `get()` raised a `ValidationError` when the organization had
+  a destination of a type other than `http`, `s3`, `r2`, `gcs` or `azure_blob` (`sqs`,
+  `eventbridge`, `servicebus`, `pubsub`, `oci_queue`, `bridge`). `DestinationType`,
+  `TransformType` and `ContentFormat` now accept any string, as `MessageStatus` does, so types
+  added later parse too. `"form"`, which the API never accepted, is gone from `ContentFormat`.
+- **Fix:** `events.debug()` returned an empty `curl_command`, `event.headers` and
+  `event.payload`; they are filled in now. Its `deliveries` are typed (`EventDebugDelivery`).
+- `destinations.create()` returns a `DestinationWithSecret`, whose `signing_secret` is the only
+  time the secret is returned; afterwards use `reveal_secret()`. `rotate_secret()` takes
+  `grace_period_seconds`. `Destination.has_signing_secret` says whether deliveries are signed.
+- Bridge destinations: `BridgeConfig` for `config`, `Destination.bridge_config` to read it,
+  `destinations.test(id, payload=...)` for a dry run, and the dry-run fields on `TestResult`.
+- `deliveries.replay()` takes `modified_payload`, `payload_patch`, `destination_override`,
+  `transform_override`, `headers_override` and `persist_transform`; `ReplayResult` reports what
+  changed. Passing both payload edits raises `ValueError`. An argument left as None is not sent,
+  so `modified_payload` can be any JSON value but null. The same goes for `payload` on
+  `destinations.test()`.
+- Holds: the `held` status on deliveries and outbound messages, with `hold_expires_at`;
+  `hold_on_circuit_open`, `held_count` and `held_count_capped` on routes and webhook endpoints;
+  `messages_held` on `SendEventResponse` and `held` on `StatsSummary`. `MessageStatus` also
+  gains `awaiting_pull` and `fifo_waiting`.
+- `transforms.engines()` lists the transform languages the deployment runs.
+- `catalog_provider` on sources (set on create only).
+- `sources.export()` returns a raw dict, and the API now sends its `ipAllowlist`, `ipDenylist`,
+  `encryptFields` and `maskFields` as JSON arrays; they used to be JSON-encoded strings. Code
+  that calls `json.loads` on them must stop. The `Source` model already read either form.
+- Secrets and credentials no longer appear in `repr()` or `str()`:
+  - The secrets the API returns, on `DestinationWithSecret`, `DestinationSecret`,
+    `SourceWithSecret`, `PendingVerification`, `WebhookEndpoint`, `EndpointWithSecret`,
+    `RotateSecretResult`, `ApiKeyWithSecret`, `Tunnel`, `TunnelToken` and `PortalToken`.
+  - The headers and auth configs the API returns in full to a key with the `write` scope:
+    `Destination.headers` and `auth_config`, `WebhookEndpoint.headers` (and each
+    `CustomHeader.value`), and `CronJob.headers`.
+  - The credentials you pass in: `signing_secret` and `verify_token` on `CreateSourceParams`
+    and `UpdateSourceParams`; `headers`, `auth_config` and `config` on `CreateDestinationParams`
+    and `UpdateDestinationParams`; `headers` on the endpoint and cron job params; and the keys
+    on `S3Config`, `GCSConfig` and `AzureBlobConfig`.
+
+  A `pydantic.ValidationError` from one of these models, or from a list of them, leaves out the
+  input it was given. The values are still sent and still readable from their attributes
+  (`dest.signing_secret`).
+- **Typing:** `CreateDestinationParams.config` and `UpdateDestinationParams.config` are now
+  `dict[str, Any] | BridgeConfig | None`, so `params.config["bucket"]` no longer type-checks
+  until you narrow it with `isinstance(params.config, dict)`. Because `DestinationType`,
+  `TransformType` and `ContentFormat` now include `str`, mypy reads `Destination.type`,
+  `Transform.transform_type`, `input_format` and `output_format` as plain `str`. An exhaustive
+  `match` or `assert_never` over their literals no longer type-checks.
+
 ## Upgrading to 4.1
 
 - `APIError.code` now carries the API's `code` from the response body (for example

{hookbase-4.1.0 → hookbase-4.2.0}/README.md

@@ -107,23 +107,67 @@ for p in client.providers.list(category="payments").providers:
     print(p.hookbase_provider, p.signature_verification and p.signature_verification.secret_source)
 client.providers.get("stripe").signature_verification
 
+# Record the catalog entry a source is made from (create only). Entries with no verifier of
+# their own, such as Salesforce, save as Custom HMAC:
+client.sources.create({"name": "Salesforce", "slug": "salesforce", "provider": "custom",
+                       "catalogProvider": "salesforce"})
+
 # Destinations
 client.destinations.list()
-client.destinations.create({"name": "Backend", "url": "https://..."})
+dest = client.destinations.create({"name": "Backend", "url": "https://..."})
 client.destinations.test("dst_id")
 
+# HTTP destinations sign every delivery (Standard Webhooks headers), so the receiver can check
+# it with Webhook(secret).verify(). Create returns the secret once: put it in your secret store.
+# repr() and str() leave it out, so logging the destination doesn't leak it.
+signing_secret = dest.signing_secret            # whsec_...; dest.has_signing_secret is True
+client.destinations.reveal_secret("dst_id").signing_secret
+rotated = client.destinations.rotate_secret("dst_id", grace_period_seconds=3600)
+rotated.previous_secret_expires_at              # until then the old secret signs too
+
+# Bridge destinations publish each delivery they receive as an outbound event
+from hookbase.models import BridgeConfig, CreateDestinationParams
+
+bridge = client.destinations.create(CreateDestinationParams(
+    name="Orders to customers",
+    type="bridge",
+    config=BridgeConfig(event_type_source="field", event_type_field="type",
+                        event_type_prefix="order."),
+))
+# A bridge's test is a dry run: nothing is published
+result = client.destinations.test(bridge.id, payload={"type": "created"})
+result.event_type, result.event_type_exists, result.matching_endpoints
+
 # Routes
 client.routes.create({"name": "Route", "sourceId": "src_id", "destinationId": "dst_id"})
 client.routes.get_circuit_status("route_id")
 client.routes.reset_circuit("route_id")
 
+# While a route's circuit is open its deliveries are held (status "held", hold_expires_at set)
+# and go out when it closes. hold_on_circuit_open=False dead-letters them as soon as the circuit
+# opens instead.
+client.routes.update("route_id", {"holdOnCircuitOpen": False})
+client.routes.get("route_id").held_count  # get only; held_count_capped past 10,000
+
 # Events & Deliveries
 client.events.list(source_id="src_id", from_date="2024-01-01")  # id or slug; unknown -> 404
 client.events.get("evt_id")  # Includes payload and deliveries
+client.events.debug("evt_id").curl_command  # plus typed deliveries, pattern hints, circuit state
 client.deliveries.replay("del_id")
 client.deliveries.bulk_replay(["del_1", "del_2"])
 
+# Replay with edits. payload_patch is an RFC 7386 merge patch on the stored payload (None
+# removes a key), so it works on sources that mask fields; modified_payload replaces it. An
+# argument left as None is not sent.
+client.deliveries.replay(
+    "del_id",
+    payload_patch={"amount": 10, "coupon": None},
+    destination_override="backup-destination",   # id or slug
+    headers_override={"X-Replay": "1"},
+)
+
 # Transforms & Filters
+client.transforms.engines()  # languages this deployment runs, and which are available
 client.transforms.create({"name": "Extract", "transformType": "jsonata", "code": "$.data"})
 client.transforms.test(code="$.data", payload={"data": {"key": "value"}})  # .result
 client.filters.test(
@@ -151,18 +195,26 @@ client.outbound.endpoints.rotate_secret("ep_id", grace_period=3600)
 # this". Name the setting in `clear` to send an explicit null for it:
 client.outbound.endpoints.update("ep_id", {"clear": ["retryDelays"]})
 
+# While an endpoint's circuit is open its messages are held (status "held") and go out when it
+# recovers; hold_on_circuit_open=False dead-letters them instead. FIFO endpoints never hold.
+client.outbound.endpoints.update("ep_id", {"holdOnCircuitOpen": False})
+client.outbound.endpoints.get("ep_id").held_count
+
 # Event Types & Subscriptions
 client.outbound.event_types.create({"name": "order.created", "category": "orders"})
 client.outbound.subscriptions.create({"endpointId": "ep_id", "eventTypeId": "et_id"})
 client.outbound.subscriptions.bulk_create("ep_id", ["et_1", "et_2"])
 
 # Send Events
-client.outbound.messages.send("app_id", event_type="order.created", payload={"orderId": "ord_1"})
+sent = client.outbound.messages.send("app_id", event_type="order.created",
+                                     payload={"orderId": "ord_1"})
+sent.messages_held  # of messages_queued, those held behind an open circuit (None if none)
 
 # Message Log
-client.outbound.message_log.list(application_id="app_id")
+client.outbound.message_log.list(application_id="app_id", status="held")  # .hold_expires_at
+client.outbound.message_log.get("msg_id").bridge  # set when a bridge destination published it
 client.outbound.message_log.list_attempts("msg_id")
-client.outbound.message_log.stats()
+client.outbound.message_log.stats()  # .held among the counts
 
 # Dead Letter Queue
 client.outbound.dlq.list()
@@ -347,6 +399,56 @@ source = client.sources.create({"name": "GitHub", "slug": "github", "provider":
 # source with a provider newer than this package still parses.
 ```
 
+## Upgrading to 4.2
+
+- **Fix:** `destinations.list()` and `get()` raised a `ValidationError` when the organization had
+  a destination of a type other than `http`, `s3`, `r2`, `gcs` or `azure_blob` (`sqs`,
+  `eventbridge`, `servicebus`, `pubsub`, `oci_queue`, `bridge`). `DestinationType`,
+  `TransformType` and `ContentFormat` now accept any string, as `MessageStatus` does, so types
+  added later parse too. `"form"`, which the API never accepted, is gone from `ContentFormat`.
+- **Fix:** `events.debug()` returned an empty `curl_command`, `event.headers` and
+  `event.payload`; they are filled in now. Its `deliveries` are typed (`EventDebugDelivery`).
+- `destinations.create()` returns a `DestinationWithSecret`, whose `signing_secret` is the only
+  time the secret is returned; afterwards use `reveal_secret()`. `rotate_secret()` takes
+  `grace_period_seconds`. `Destination.has_signing_secret` says whether deliveries are signed.
+- Bridge destinations: `BridgeConfig` for `config`, `Destination.bridge_config` to read it,
+  `destinations.test(id, payload=...)` for a dry run, and the dry-run fields on `TestResult`.
+- `deliveries.replay()` takes `modified_payload`, `payload_patch`, `destination_override`,
+  `transform_override`, `headers_override` and `persist_transform`; `ReplayResult` reports what
+  changed. Passing both payload edits raises `ValueError`. An argument left as None is not sent,
+  so `modified_payload` can be any JSON value but null. The same goes for `payload` on
+  `destinations.test()`.
+- Holds: the `held` status on deliveries and outbound messages, with `hold_expires_at`;
+  `hold_on_circuit_open`, `held_count` and `held_count_capped` on routes and webhook endpoints;
+  `messages_held` on `SendEventResponse` and `held` on `StatsSummary`. `MessageStatus` also
+  gains `awaiting_pull` and `fifo_waiting`.
+- `transforms.engines()` lists the transform languages the deployment runs.
+- `catalog_provider` on sources (set on create only).
+- `sources.export()` returns a raw dict, and the API now sends its `ipAllowlist`, `ipDenylist`,
+  `encryptFields` and `maskFields` as JSON arrays; they used to be JSON-encoded strings. Code
+  that calls `json.loads` on them must stop. The `Source` model already read either form.
+- Secrets and credentials no longer appear in `repr()` or `str()`:
+  - The secrets the API returns, on `DestinationWithSecret`, `DestinationSecret`,
+    `SourceWithSecret`, `PendingVerification`, `WebhookEndpoint`, `EndpointWithSecret`,
+    `RotateSecretResult`, `ApiKeyWithSecret`, `Tunnel`, `TunnelToken` and `PortalToken`.
+  - The headers and auth configs the API returns in full to a key with the `write` scope:
+    `Destination.headers` and `auth_config`, `WebhookEndpoint.headers` (and each
+    `CustomHeader.value`), and `CronJob.headers`.
+  - The credentials you pass in: `signing_secret` and `verify_token` on `CreateSourceParams`
+    and `UpdateSourceParams`; `headers`, `auth_config` and `config` on `CreateDestinationParams`
+    and `UpdateDestinationParams`; `headers` on the endpoint and cron job params; and the keys
+    on `S3Config`, `GCSConfig` and `AzureBlobConfig`.
+
+  A `pydantic.ValidationError` from one of these models, or from a list of them, leaves out the
+  input it was given. The values are still sent and still readable from their attributes
+  (`dest.signing_secret`).
+- **Typing:** `CreateDestinationParams.config` and `UpdateDestinationParams.config` are now
+  `dict[str, Any] | BridgeConfig | None`, so `params.config["bucket"]` no longer type-checks
+  until you narrow it with `isinstance(params.config, dict)`. Because `DestinationType`,
+  `TransformType` and `ContentFormat` now include `str`, mypy reads `Destination.type`,
+  `Transform.transform_type`, `input_format` and `output_format` as plain `str`. An exhaustive
+  `match` or `assert_never` over their literals no longer type-checks.
+
 ## Upgrading to 4.1
 
 - `APIError.code` now carries the API's `code` from the response body (for example

{hookbase-4.1.0 → hookbase-4.2.0}/examples/basic_inbound.py

@@ -13,7 +13,9 @@ source = client.sources.create({
 })
 print(f"Source created: {source.id}")
 print(f"Ingest URL: {source.ingest_url}")
-print(f"Signing secret: {source.signing_secret}")
+# The signing secret is returned this once. Put it in your secret store (and GitHub's webhook
+# settings) instead of printing or logging it; client.sources.reveal_secret() shows it again.
+github_signing_secret = source.signing_secret
 
 # Create a destination to forward webhooks to
 dest = client.destinations.create({

{hookbase-4.1.0 → hookbase-4.2.0}/examples/send_webhooks.py

@@ -18,7 +18,9 @@ endpoint = client.outbound.endpoints.create(app.id, {
     "description": "Production webhook endpoint",
 })
 print(f"Endpoint: {endpoint.id}")
-print(f"Endpoint secret: {endpoint.secret}")
+# The endpoint's signing secret is returned this once. Put it in your secret store, and hand it to
+# the customer to verify deliveries with, instead of printing or logging it.
+endpoint_secret = endpoint.secret
 
 # Create event types
 order_type = client.outbound.event_types.create({

{hookbase-4.1.0 → hookbase-4.2.0}/src/hookbase/_pagination.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from collections.abc import AsyncIterator, Iterator
 from typing import Any, Generic, TypeVar
 
-from pydantic import TypeAdapter
+from pydantic import ConfigDict, TypeAdapter
 
 from ._client import AsyncTransport, SyncTransport
 
@@ -360,7 +360,11 @@ class AsyncLimitOffsetPage(Generic[T]):
 
 
 def _parse_list(raw: Any, model: type[T]) -> list[T]:
-    adapter = TypeAdapter(list[model])  # type: ignore[valid-type]
+    # pydantic takes hide_input_in_errors from the outermost type, so a list of a model that
+    # carries a secret has to ask for it too (models/_base.py SECRET_MODEL_CONFIG).
+    hides_input = getattr(model, "model_config", {}).get("hide_input_in_errors", False)
+    config = ConfigDict(hide_input_in_errors=True) if hides_input else None
+    adapter = TypeAdapter(list[model], config=config)  # type: ignore[valid-type]
     return adapter.validate_python(raw)
 
 

hookbase-4.2.0/src/hookbase/_version.py

@@ -0,0 +1 @@
+__version__ = "4.2.0"

{hookbase-4.1.0 → hookbase-4.2.0}/src/hookbase/models/__init__.py

@@ -63,9 +63,13 @@ from .deliveries import (
 from .destinations import (
     AuthType,
     AzureBlobConfig,
+    BridgeConfig,
+    BridgeEventTypeSource,
     CreateDestinationParams,
     Destination,
+    DestinationSecret,
     DestinationType,
+    DestinationWithSecret,
     FieldMapping,
     FieldMappingType,
     FileFormat,
@@ -109,8 +113,12 @@ from .event_types import CreateEventTypeParams, EventType, UpdateEventTypeParams
 from .events import (
     DeliveryStats,
     Event,
+    EventDebugDelivery,
+    EventDebugDestination,
     EventDebugEvent,
     EventDebugInfo,
+    EventDebugPatternHint,
+    EventDebugRouteCircuit,
     EventDelivery,
     EventDetail,
     InboundEventStatus,
@@ -127,6 +135,7 @@ from .messages import (
     MessageStatus,
     OutboundAttempt,
     OutboundMessage,
+    OutboundMessageBridge,
     SendEventEndpoint,
     SendEventParams,
     SendEventResponse,
@@ -176,6 +185,8 @@ from .transforms import (
     ContentFormat,
     CreateTransformParams,
     Transform,
+    TransformEngine,
+    TransformEnginesResponse,
     TransformTestResult,
     TransformType,
     UpdateTransformParams,
@@ -249,9 +260,13 @@ __all__ = [
     # Destinations
     "AuthType",
     "AzureBlobConfig",
+    "BridgeConfig",
+    "BridgeEventTypeSource",
     "CreateDestinationParams",
     "Destination",
+    "DestinationSecret",
     "DestinationType",
+    "DestinationWithSecret",
     "FieldMapping",
     "GCSConfig",
     "HttpMethod",
@@ -299,6 +314,10 @@ __all__ = [
     "EventDetail",
     "InboundEventStatus",
     "EventDebugEvent",
+    "EventDebugDelivery",
+    "EventDebugDestination",
+    "EventDebugPatternHint",
+    "EventDebugRouteCircuit",
     "EventDelivery",
     # Filters
     "CreateFilterParams",
@@ -311,6 +330,7 @@ __all__ = [
     "MessageStatus",
     "OutboundAttempt",
     "OutboundMessage",
+    "OutboundMessageBridge",
     "OutboundReplayResult",
     "SendEventParams",
     "SendEventResponse",
@@ -360,6 +380,8 @@ __all__ = [
     "ContentFormat",
     "CreateTransformParams",
     "Transform",
+    "TransformEngine",
+    "TransformEnginesResponse",
     "TransformTestResult",
     "TransformType",
     "UpdateTransformParams",

hookbase-4.2.0/src/hookbase/models/_base.py

@@ -0,0 +1,20 @@
+from __future__ import annotations
+
+from pydantic import BaseModel, ConfigDict
+from pydantic.alias_generators import to_camel
+
+#: `model_config` for a model that carries a secret or credential; pydantic merges it over
+#: HookbaseModel's. A validation error then leaves out its input, which pydantic otherwise prints
+#: truncated and whose tail can be the secret; `_pagination._parse_list` does the same for a list
+#: of one. Give the secret field `Field(repr=False)` too, for repr() and str().
+SECRET_MODEL_CONFIG = ConfigDict(hide_input_in_errors=True)
+
+
+class HookbaseModel(BaseModel):
+    """Base model with camelCase alias support for API compatibility."""
+
+    model_config = ConfigDict(
+        alias_generator=to_camel,
+        populate_by_name=True,
+        extra="ignore",
+    )

{hookbase-4.1.0 → hookbase-4.2.0}/src/hookbase/models/api_keys.py

@@ -3,9 +3,9 @@ from __future__ import annotations
 import json
 from typing import Any
 
-from pydantic import field_validator
+from pydantic import Field, field_validator
 
-from ._base import HookbaseModel
+from ._base import SECRET_MODEL_CONFIG, HookbaseModel
 
 
 class ApiKey(HookbaseModel):
@@ -27,7 +27,9 @@ class ApiKey(HookbaseModel):
 
 
 class ApiKeyWithSecret(ApiKey):
-    key: str = ""
+    model_config = SECRET_MODEL_CONFIG
+
+    key: str = Field(default="", repr=False)
 
 
 class CreateApiKeyParams(HookbaseModel):

{hookbase-4.1.0 → hookbase-4.2.0}/src/hookbase/models/cron_jobs.py

@@ -3,21 +3,25 @@ from __future__ import annotations
 import json
 from typing import Literal
 
-from pydantic import field_validator
+from pydantic import Field, field_validator
 
-from ._base import HookbaseModel
+from ._base import SECRET_MODEL_CONFIG, HookbaseModel
 
 CronJobExecutionStatus = Literal["success", "failed", "running"]
 
 
 class CronJob(HookbaseModel):
+    # The API returns headers, which hold the job's credentials, in full to a key with the write
+    # scope.
+    model_config = SECRET_MODEL_CONFIG
+
     id: str
     organization_id: str | None = None
     name: str
     description: str | None = None
     url: str = ""
     method: str = "GET"
-    headers: dict[str, str] | None = None
+    headers: dict[str, str] | None = Field(default=None, repr=False)
     payload: str | None = None
     cron_expression: str = ""
     timezone: str = "UTC"
@@ -66,11 +70,13 @@ class CronJobExecution(HookbaseModel):
 
 
 class CreateCronJobParams(HookbaseModel):
+    model_config = SECRET_MODEL_CONFIG
+
     name: str
     description: str | None = None
     url: str
     method: str | None = None
-    headers: dict[str, str] | None = None
+    headers: dict[str, str] | None = Field(default=None, repr=False)
     payload: str | None = None
     cron_expression: str
     timezone: str | None = None
@@ -84,11 +90,13 @@ class CreateCronJobParams(HookbaseModel):
 
 
 class UpdateCronJobParams(HookbaseModel):
+    model_config = SECRET_MODEL_CONFIG
+
     name: str | None = None
     description: str | None = None
     url: str | None = None
     method: str | None = None
-    headers: dict[str, str] | None = None
+    headers: dict[str, str] | None = Field(default=None, repr=False)
     payload: str | None = None
     cron_expression: str | None = None
     timezone: str | None = None

{hookbase-4.1.0 → hookbase-4.2.0}/src/hookbase/models/deliveries.py

@@ -8,8 +8,9 @@ from pydantic.alias_generators import to_camel
 
 from ._base import HookbaseModel
 
-# API may return: pending, success, failed, retrying, delivered,
-# failed_over, schema_failed, exhausted, etc.
+# The API stores: pending, delivered, failed, failed_over, schema_failed, throttled,
+# awaiting_retry (a retry scheduled for later; see `next_retry_at`) and held (parked while the
+# route's circuit is open; see `hold_expires_at`). Any string, so a status added later still parses.
 DeliveryStatus = str
 
 
@@ -23,6 +24,11 @@ class Delivery(HookbaseModel):
     attempt_count: int = 0
     max_attempts: int = 5
     next_retry_at: str | None = None
+    """When the next retry is due. None for a held delivery: see `hold_expires_at`."""
+    hold_expires_at: str | None = None
+    """For a `held` delivery (parked because the route's circuit is open and the route has
+    `hold_on_circuit_open`): when the hold ends and the delivery fails if the circuit has not
+    closed. None for every other status."""
     response_status: int | None = None
     response_key: str | None = None
     response_headers: dict[str, Any] | None = None
@@ -121,8 +127,22 @@ class DeliveryDetail(Delivery):
 
 
 class ReplayResult(HookbaseModel):
+    """The result of `deliveries.replay`. The replay is a new delivery; the original keeps its
+    status."""
+
     delivery_id: str
+    """The new delivery's id."""
     message: str = ""
+    modified: bool = False
+    """Whether the replay sent an edited payload (`modified_payload` or `payload_patch`)."""
+    destination_overridden: bool = False
+    transform_overridden: bool = False
+    transform_persisted: bool = False
+    """Whether the transform override was also saved as the route's transform."""
+    headers_overridden: bool = False
+    target_destination_id: str | None = None
+    """The destination the replay goes to: the override when one was given, otherwise the
+    original's."""
 
 
 class BulkReplayResult(HookbaseModel):