hookbridge 2.1.0__tar.gz → 2.1.1__tar.gz

{hookbridge-2.1.0 → hookbridge-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: hookbridge
-Version: 2.1.0
+Version: 2.1.1
 Summary: Official HookBridge SDK for Python
 Project-URL: Homepage, https://hookbridge.io
 Project-URL: Documentation, https://hookbridge.io/docs/sdks/python

{hookbridge-2.1.0 → hookbridge-2.1.1}/hookbridge/__init__.py

@@ -98,7 +98,7 @@ from hookbridge.types import (
     UsageHistoryRow,
 )
 
-__version__ = "2.1.0"
+__version__ = "2.1.1"
 
 __all__ = [
     "HookBridge",

{hookbridge-2.1.0 → hookbridge-2.1.1}/hookbridge/types.py

@@ -423,19 +423,77 @@ class PullEndpoint:
     token_query_param: Optional[str] = None
     verify_hmac: Optional[bool] = None
     hmac_header_name: Optional[str] = None
-    hmac_signature_encoding: Optional[HMACSignatureEncoding] = None
     timestamp_header_name: Optional[str] = None
     timestamp_ttl_seconds: Optional[int] = None
     verify_ip_allowlist: Optional[bool] = None
     allowed_cidrs: Optional[list[str]] = None
     ingest_response_code: Optional[int] = None
     idempotency_header_names: Optional[list[str]] = None
+    hmac_signature_encoding: Optional[HMACSignatureEncoding] = None
 
 
-@dataclass(frozen=True)
+@dataclass(frozen=True, init=False)
 class CreatePullEndpointResponse(PullEndpoint):
     secret_token: Optional[str] = None
 
+    def __init__(
+        self,
+        id: str,
+        mode: PullEndpointMode,
+        ingest_url: str,
+        active: bool,
+        paused: bool,
+        created_at: datetime,
+        updated_at: datetime,
+        name: Optional[str] = None,
+        description: Optional[str] = None,
+        retention_days: Optional[int] = None,
+        event_type_source: Optional[PullEventTypeSource] = None,
+        event_type_path: Optional[str] = None,
+        counts: Optional[PullEndpointCounts] = None,
+        verify_static_token: Optional[bool] = None,
+        token_header_name: Optional[str] = None,
+        token_query_param: Optional[str] = None,
+        verify_hmac: Optional[bool] = None,
+        hmac_header_name: Optional[str] = None,
+        timestamp_header_name: Optional[str] = None,
+        timestamp_ttl_seconds: Optional[int] = None,
+        verify_ip_allowlist: Optional[bool] = None,
+        allowed_cidrs: Optional[list[str]] = None,
+        ingest_response_code: Optional[int] = None,
+        idempotency_header_names: Optional[list[str]] = None,
+        secret_token: Optional[str] = None,
+        hmac_signature_encoding: Optional[HMACSignatureEncoding] = None,
+    ) -> None:
+        super().__init__(
+            id=id,
+            mode=mode,
+            ingest_url=ingest_url,
+            active=active,
+            paused=paused,
+            created_at=created_at,
+            updated_at=updated_at,
+            name=name,
+            description=description,
+            retention_days=retention_days,
+            event_type_source=event_type_source,
+            event_type_path=event_type_path,
+            counts=counts,
+            verify_static_token=verify_static_token,
+            token_header_name=token_header_name,
+            token_query_param=token_query_param,
+            verify_hmac=verify_hmac,
+            hmac_header_name=hmac_header_name,
+            timestamp_header_name=timestamp_header_name,
+            timestamp_ttl_seconds=timestamp_ttl_seconds,
+            verify_ip_allowlist=verify_ip_allowlist,
+            allowed_cidrs=allowed_cidrs,
+            ingest_response_code=ingest_response_code,
+            idempotency_header_names=idempotency_header_names,
+            hmac_signature_encoding=hmac_signature_encoding,
+        )
+        object.__setattr__(self, "secret_token", secret_token)
+
 
 @dataclass(frozen=True)
 class PullEndpointSummary:
@@ -650,14 +708,14 @@ class ExportRecord:
     created_at: datetime
     filter_status: Optional[str] = None
     filter_endpoint_id: Optional[str] = None
-    filter_inbound_endpoint_id: Optional[str] = None
-    direction: Optional[ExportDirection] = None
     row_count: Optional[int] = None
     file_size_bytes: Optional[int] = None
     error_message: Optional[str] = None
     started_at: Optional[datetime] = None
     completed_at: Optional[datetime] = None
     expires_at: Optional[datetime] = None
+    filter_inbound_endpoint_id: Optional[str] = None
+    direction: Optional[ExportDirection] = None
 
 
 @dataclass(frozen=True)

{hookbridge-2.1.0 → hookbridge-2.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "hookbridge"
-version = "2.1.0"
+version = "2.1.1"
 description = "Official HookBridge SDK for Python"
 readme = "README.md"
 license = "MIT"

hookbridge-2.1.1/tests/test_positional_compat.py

@@ -0,0 +1,614 @@
+import dataclasses
+import inspect
+from datetime import datetime, timedelta, timezone
+
+import hookbridge.types as types_module
+from hookbridge.types import CreatePullEndpointResponse, ExportRecord, PullEndpoint
+
+NOW = datetime(2026, 1, 1, tzinfo=timezone.utc)
+
+
+def at(day: int) -> datetime:
+    return NOW + timedelta(days=day)
+
+
+def test_export_record_positional_2_0_0_order() -> None:
+    record = ExportRecord(
+        "id1",
+        "proj1",
+        "completed",
+        at(1),
+        at(2),
+        at(3),
+        "failed",
+        "ep1",
+        42,
+        1024,
+        "boom",
+        at(4),
+        at(5),
+        at(6),
+    )
+    assert record.id == "id1"
+    assert record.project_id == "proj1"
+    assert record.status == "completed"
+    assert record.filter_status == "failed"
+    assert record.filter_endpoint_id == "ep1"
+    assert record.row_count == 42
+    assert record.file_size_bytes == 1024
+    assert record.error_message == "boom"
+    assert record.filter_start_time == at(1)
+    assert record.filter_end_time == at(2)
+    assert record.created_at == at(3)
+    assert record.started_at == at(4)
+    assert record.completed_at == at(5)
+    assert record.expires_at == at(6)
+    assert record.filter_inbound_endpoint_id is None
+    assert record.direction is None
+
+
+def test_pull_endpoint_positional_2_0_0_order() -> None:
+    counts = None
+    endpoint = PullEndpoint(
+        "id1",
+        "pull",
+        "https://ingest.example.com/x",
+        True,
+        False,
+        at(1),
+        at(2),
+        "name",
+        "desc",
+        7,
+        "header",
+        "$.type",
+        counts,
+        True,
+        "X-Token",
+        "token",
+        True,
+        "X-Sig",
+        "X-Ts",
+        300,
+        True,
+        ["10.0.0.0/8"],
+        202,
+        ["X-Idem"],
+    )
+    assert endpoint.created_at == at(1)
+    assert endpoint.updated_at == at(2)
+    assert endpoint.hmac_header_name == "X-Sig"
+    assert endpoint.timestamp_header_name == "X-Ts"
+    assert endpoint.timestamp_ttl_seconds == 300
+    assert endpoint.verify_ip_allowlist is True
+    assert endpoint.allowed_cidrs == ["10.0.0.0/8"]
+    assert endpoint.ingest_response_code == 202
+    assert endpoint.idempotency_header_names == ["X-Idem"]
+    assert endpoint.hmac_signature_encoding is None
+
+
+def test_create_pull_endpoint_response_positional_2_0_0_order() -> None:
+    resp = CreatePullEndpointResponse(
+        "id1",
+        "pull",
+        "https://ingest.example.com/x",
+        True,
+        False,
+        at(1),
+        at(2),
+        "name",
+        "desc",
+        7,
+        "header",
+        "$.type",
+        None,
+        True,
+        "X-Token",
+        "token",
+        True,
+        "X-Sig",
+        "X-Ts",
+        300,
+        True,
+        ["10.0.0.0/8"],
+        202,
+        ["X-Idem"],
+        "sekret",
+    )
+    assert isinstance(resp, PullEndpoint)
+    assert resp.created_at == at(1)
+    assert resp.updated_at == at(2)
+    assert resp.idempotency_header_names == ["X-Idem"]
+    assert resp.secret_token == "sekret"
+    assert resp.hmac_signature_encoding is None
+
+
+def test_create_pull_endpoint_response_keywords() -> None:
+    resp = CreatePullEndpointResponse(
+        id="id1",
+        mode="pull",
+        ingest_url="u",
+        active=True,
+        paused=False,
+        created_at=NOW,
+        updated_at=NOW,
+        hmac_signature_encoding="base64",
+        secret_token="s",
+    )
+    assert resp.hmac_signature_encoding == "base64"
+    assert resp.secret_token == "s"
+    assert resp.name is None
+    assert resp == CreatePullEndpointResponse(
+        id="id1",
+        mode="pull",
+        ingest_url="u",
+        active=True,
+        paused=False,
+        created_at=NOW,
+        updated_at=NOW,
+        hmac_signature_encoding="base64",
+        secret_token="s",
+    )
+
+
+def test_create_pull_endpoint_response_init_covers_every_field() -> None:
+    params = set(inspect.signature(CreatePullEndpointResponse.__init__).parameters) - {"self"}
+    assert params == {f.name for f in dataclasses.fields(CreatePullEndpointResponse)}
+
+
+def test_init_parameter_order_is_pinned() -> None:
+    actual = {
+        name: [p for p in inspect.signature(cls.__init__).parameters if p != "self"]
+        for name, cls in inspect.getmembers(types_module, inspect.isclass)
+        if dataclasses.is_dataclass(cls) and cls.__module__ == types_module.__name__
+    }
+    assert set(INIT_ORDER) <= set(actual)
+    for name, expected in INIT_ORDER.items():
+        assert actual[name][: len(expected)] == expected, name
+
+
+INIT_ORDER: dict[str, list[str]] = {
+    "APIKeyInfo": ["key_id", "label", "prefix", "created_at", "last_used_at"],
+    "AckPullEventsResponse": ["acknowledged"],
+    "ActorLookupResult": ["users", "api_keys"],
+    "AttemptRecord": [
+        "id",
+        "attempt_no",
+        "created_at",
+        "response_status",
+        "response_latency_ms",
+        "processing_ms",
+        "error_text",
+        "response_headers",
+        "retry_type",
+        "retry_after_seconds",
+        "resolved_ip",
+        "request_headers",
+        "dns_ms",
+        "tcp_connect_ms",
+        "tls_handshake_ms",
+        "ttfb_ms",
+        "transfer_ms",
+        "conn_reused",
+        "response_body_url",
+        "response_body_truncated",
+    ],
+    "AttemptsResponse": ["attempts", "has_more"],
+    "CreateAPIKeyResponse": ["key_id", "key", "prefix", "label", "created_at"],
+    "CreateEndpointResponse": [
+        "id",
+        "url",
+        "signing_secret",
+        "created_at",
+        "description",
+        "signing_key_id",
+        "key_hint",
+        "ephemeral",
+        "expires_at",
+    ],
+    "CreateInboundEndpointResponse": [
+        "id",
+        "name",
+        "url",
+        "mode",
+        "ingest_url",
+        "secret_token",
+        "created_at",
+        "signing_key_id",
+        "signing_secret",
+        "key_hint",
+        "hmac_signature_encoding",
+        "ephemeral",
+        "expires_at",
+    ],
+    "CreatePullEndpointResponse": [
+        "id",
+        "mode",
+        "ingest_url",
+        "active",
+        "paused",
+        "created_at",
+        "updated_at",
+        "name",
+        "description",
+        "retention_days",
+        "event_type_source",
+        "event_type_path",
+        "counts",
+        "verify_static_token",
+        "token_header_name",
+        "token_query_param",
+        "verify_hmac",
+        "hmac_header_name",
+        "timestamp_header_name",
+        "timestamp_ttl_seconds",
+        "verify_ip_allowlist",
+        "allowed_cidrs",
+        "ingest_response_code",
+        "idempotency_header_names",
+        "secret_token",
+        "hmac_signature_encoding",
+    ],
+    "DLQMessagesResponse": ["messages", "has_more", "next_cursor"],
+    "DeleteAllResult": ["deleted", "deleted_message_ids", "error"],
+    "DeleteBatchItemResult": ["message_id", "outcome", "deleted_at"],
+    "DeleteBatchResult": ["results", "deleted_count", "already_deleted_count", "not_found_count"],
+    "DeleteEventBatchItemResult": ["event_id", "outcome", "deleted_at"],
+    "DeleteEventBatchResult": [
+        "results",
+        "deleted_count",
+        "already_deleted_count",
+        "not_found_count",
+    ],
+    "DeleteEventResult": ["event_id", "deleted_at", "already_deleted"],
+    "DeleteMessageResult": ["message_id", "deleted_at", "already_deleted"],
+    "DeletePartialError": ["code", "message"],
+    "DeletePullEventsAllResult": ["deleted", "deleted_event_ids", "error"],
+    "DeleteResult": ["deleted", "id"],
+    "Endpoint": [
+        "id",
+        "url",
+        "created_at",
+        "updated_at",
+        "paused",
+        "description",
+        "rate_limit_rps",
+        "burst",
+        "headers",
+        "ephemeral",
+        "expires_at",
+    ],
+    "EndpointSummary": [
+        "id",
+        "url",
+        "created_at",
+        "paused",
+        "description",
+        "ephemeral",
+        "expires_at",
+    ],
+    "ExportRecord": [
+        "id",
+        "project_id",
+        "status",
+        "filter_start_time",
+        "filter_end_time",
+        "created_at",
+        "filter_status",
+        "filter_endpoint_id",
+        "row_count",
+        "file_size_bytes",
+        "error_message",
+        "started_at",
+        "completed_at",
+        "expires_at",
+        "filter_inbound_endpoint_id",
+        "direction",
+    ],
+    "InboundEndpoint": [
+        "id",
+        "name",
+        "url",
+        "mode",
+        "active",
+        "paused",
+        "verify_static_token",
+        "verify_hmac",
+        "verify_ip_allowlist",
+        "ingest_response_code",
+        "idempotency_header_names",
+        "signing_enabled",
+        "created_at",
+        "updated_at",
+        "description",
+        "hmac_signature_encoding",
+        "ingest_url",
+        "ephemeral",
+        "expires_at",
+    ],
+    "InboundEndpointSummary": [
+        "id",
+        "name",
+        "url",
+        "mode",
+        "active",
+        "paused",
+        "created_at",
+        "ephemeral",
+        "expires_at",
+    ],
+    "InboundLogEntry": [
+        "message_id",
+        "inbound_endpoint_id",
+        "endpoint",
+        "status",
+        "attempt_count",
+        "received_at",
+        "delivered_at",
+        "response_status",
+        "response_latency_ms",
+        "last_error",
+        "total_delivery_ms",
+        "deleted_at",
+    ],
+    "InboundLogsResponse": ["entries", "has_more", "next_cursor"],
+    "InboundMessage": [
+        "id",
+        "project_id",
+        "inbound_endpoint_id",
+        "status",
+        "attempt_count",
+        "replay_count",
+        "received_at",
+        "updated_at",
+        "content_type",
+        "size_bytes",
+        "payload_sha256",
+        "idempotency_key",
+        "next_attempt_at",
+        "last_error",
+        "response_status",
+        "response_latency_ms",
+        "queue_wait_ms",
+        "total_delivery_ms",
+        "delivered_at",
+        "failed_at",
+        "deleted_at",
+        "deleted_by_user_id",
+        "deleted_by_api_key_id",
+        "retention_hours",
+    ],
+    "InboundMetrics": [
+        "window",
+        "total_messages",
+        "succeeded",
+        "failed",
+        "retries",
+        "success_rate",
+        "avg_latency_ms",
+        "avg_delivery_time_ms",
+    ],
+    "InboundRejection": [
+        "id",
+        "reason_code",
+        "received_at",
+        "inbound_endpoint_id",
+        "reason_detail",
+        "source_ip",
+        "headers_redacted",
+    ],
+    "InboundRejectionsResponse": ["entries", "has_more", "next_cursor"],
+    "Invoice": [
+        "id",
+        "status",
+        "amount_due",
+        "amount_paid",
+        "currency",
+        "period_start",
+        "period_end",
+        "created",
+        "lines",
+        "invoice_pdf",
+        "hosted_invoice_url",
+    ],
+    "InvoiceLine": ["description", "amount", "quantity"],
+    "InvoicesResponse": ["invoices", "has_more"],
+    "ListEndpointsResponse": ["endpoints", "has_more", "next_cursor"],
+    "ListInboundEndpointsResponse": ["endpoints", "has_more", "next_cursor"],
+    "ListPullEndpointsResponse": ["endpoints", "has_more", "next_cursor"],
+    "ListPullEventsResponse": ["events", "has_more", "next_cursor"],
+    "ListenInboundEndpointResponse": ["messages", "next_cursor"],
+    "ListenMessage": [
+        "message_id",
+        "content_type",
+        "headers",
+        "size_bytes",
+        "received_at",
+        "body",
+        "body_encoding",
+        "body_error",
+    ],
+    "LogsResponse": ["messages", "has_more", "next_cursor"],
+    "Message": [
+        "id",
+        "project_id",
+        "endpoint_id",
+        "status",
+        "attempt_count",
+        "replay_count",
+        "content_type",
+        "size_bytes",
+        "payload_sha256",
+        "created_at",
+        "updated_at",
+        "idempotency_key",
+        "next_attempt_at",
+        "last_error",
+        "response_status",
+        "response_latency_ms",
+        "deleted_at",
+        "deleted_by_user_id",
+        "deleted_by_api_key_id",
+        "first_attempt_at",
+        "delivered_at",
+        "processing_ms",
+        "total_delivery_ms",
+        "queue_wait_ms",
+        "retention_hours",
+    ],
+    "MessageSummary": [
+        "message_id",
+        "endpoint",
+        "status",
+        "attempt_count",
+        "created_at",
+        "delivered_at",
+        "next_attempt_at",
+        "response_status",
+        "response_latency_ms",
+        "last_error",
+        "deleted_at",
+        "first_attempt_at",
+        "processing_ms",
+        "total_delivery_ms",
+        "queue_wait_ms",
+    ],
+    "Metrics": [
+        "window",
+        "total_messages",
+        "succeeded",
+        "failed",
+        "retries",
+        "success_rate",
+        "avg_latency_ms",
+        "avg_delivery_time_ms",
+        "avg_queue_wait_ms",
+    ],
+    "PauseState": ["id", "paused", "messages_requeued"],
+    "PullEndpoint": [
+        "id",
+        "mode",
+        "ingest_url",
+        "active",
+        "paused",
+        "created_at",
+        "updated_at",
+        "name",
+        "description",
+        "retention_days",
+        "event_type_source",
+        "event_type_path",
+        "counts",
+        "verify_static_token",
+        "token_header_name",
+        "token_query_param",
+        "verify_hmac",
+        "hmac_header_name",
+        "timestamp_header_name",
+        "timestamp_ttl_seconds",
+        "verify_ip_allowlist",
+        "allowed_cidrs",
+        "ingest_response_code",
+        "idempotency_header_names",
+        "hmac_signature_encoding",
+    ],
+    "PullEndpointCounts": ["stored", "fetched", "delivered", "total"],
+    "PullEndpointSummary": ["id", "active", "paused", "ingest_url", "created_at", "name"],
+    "PullEvent": [
+        "id",
+        "status",
+        "content_type",
+        "payload",
+        "size_bytes",
+        "received_at",
+        "event_type",
+        "headers",
+        "fetched_at",
+        "delivered_at",
+        "timing",
+        "deleted_at",
+        "deleted_by_user_id",
+        "deleted_by_api_key_id",
+    ],
+    "PullEventSummary": [
+        "id",
+        "status",
+        "size_bytes",
+        "received_at",
+        "event_type",
+        "fetched_at",
+        "delivered_at",
+        "timing",
+        "deleted_at",
+    ],
+    "PullLogEntry": [
+        "event_id",
+        "pull_endpoint_id",
+        "status",
+        "size_bytes",
+        "received_at",
+        "endpoint_name",
+        "event_type",
+        "fetched_at",
+        "delivered_at",
+        "timing",
+    ],
+    "PullLogsResponse": ["entries", "has_more", "next_cursor"],
+    "PullTimeSeriesBucket": ["timestamp", "succeeded", "stored", "fetched", "total"],
+    "PullTimeSeriesMetrics": ["window", "buckets"],
+    "PullTimingBreakdown": [
+        "ingest_processing_ms",
+        "time_to_fetch_ms",
+        "time_to_ack_ms",
+        "total_lifecycle_ms",
+    ],
+    "ReplayAllMessagesResponse": [
+        "replayed",
+        "failed",
+        "stuck",
+        "replayed_message_ids",
+        "stuck_message_ids",
+    ],
+    "ReplayBatchMessagesResponse": ["replayed", "failed", "stuck", "results"],
+    "ReplayBatchResult": ["message_id", "status", "error", "error_code"],
+    "ReplayMessageResponse": ["message_id", "status"],
+    "RotateSecretResponse": ["id", "signing_secret", "key_hint", "created_at"],
+    "SendWebhookResponse": ["message_id", "status"],
+    "SigningKey": ["id", "key_hint", "created_at"],
+    "Subscription": [
+        "plan",
+        "status",
+        "limits",
+        "usage",
+        "cancel_at_period_end",
+        "current_period_end",
+    ],
+    "SubscriptionLimits": [
+        "plan",
+        "messages_per_month",
+        "max_projects",
+        "max_endpoints",
+        "retention_days",
+        "max_retries",
+        "overage_rate_per_message",
+    ],
+    "SubscriptionUsage": [
+        "messages_used",
+        "period_start",
+        "period_end",
+        "overage_count",
+        "overage_rate",
+        "estimated_overage_charge",
+    ],
+    "TimeSeriesBucket": ["timestamp", "total", "succeeded", "failed", "retrying", "avg_latency_ms"],
+    "TimeSeriesMetrics": ["window", "buckets"],
+    "UpdateResult": ["id", "updated"],
+    "UsageHistoryResponse": ["rows", "total", "limit", "offset", "has_more"],
+    "UsageHistoryRow": [
+        "period_start",
+        "period_end",
+        "message_count",
+        "overage_count",
+        "plan_limit",
+    ],
+}