webhook-platform 2.0.0__tar.gz → 2.2.1__tar.gz

{webhook_platform-2.0.0 → webhook_platform-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webhook-platform
-Version: 2.0.0
+Version: 2.2.1
 Summary: Official Python SDK for Hookflow — reliable webhook infrastructure
 Author-email: Vadym Kykalo <vadymkykalo@gmail.com>
 License: MIT
@@ -338,6 +338,64 @@ except HookflowError as e:
     print(f"Error {e.status}: {e.message}")
 ```
 
+### Error Response Format
+
+All API errors return a consistent JSON body:
+
+```json
+{
+  "error": "error_code",
+  "message": "Human-readable description",
+  "status": 400,
+  "fieldErrors": { "field": "reason" }
+}
+```
+
+- **`error`** — machine-readable error code (`snake_case`), always present
+- **`message`** — human-readable description, always present
+- **`status`** — HTTP status code (integer), always present
+- **`fieldErrors`** — field-level validation details (only present for `validation_error`)
+
+### Error Codes Reference
+
+| HTTP Status | `error` Code | SDK Exception | Description |
+|---|---|---|---|
+| 400 | `validation_error` | `ValidationError` | Invalid request parameters; see `fieldErrors` |
+| 400 | `invalid_request` | `HookflowError` | Malformed or semantically invalid request |
+| 401 | `unauthorized` | `AuthenticationError` | Missing or invalid API key / expired token |
+| 403 | `forbidden` | `HookflowError` | Insufficient permissions for the action |
+| 404 | `not_found` | `NotFoundError` | Requested resource does not exist |
+| 413 | `payload_too_large` | `HookflowError` | Request body exceeds maximum allowed size |
+| 422 | `unprocessable_entity` | `HookflowError` | Valid syntax but violates business rules |
+| 429 | `rate_limit_exceeded` | `RateLimitError` | Too many requests; check `X-RateLimit-*` headers |
+| 500 | `internal_error` | `HookflowError` | Unexpected server error |
+
+## Generic Requests
+
+As the API expands, you can call any endpoint directly without waiting for SDK updates:
+
+```python
+# GET
+schemas = client.get("/api/v1/projects/proj_123/schemas")
+
+# GET with query params
+items = client.get("/api/v1/projects/proj_123/items", params={"status": "active"})
+
+# POST with body and idempotency key
+result = client.post("/api/v1/some/new/endpoint", body={"key": "value"}, idempotency_key="unique-key")
+
+# PUT
+client.put("/api/v1/projects/proj_123/settings", body={"timezone": "UTC"})
+
+# PATCH
+client.patch("/api/v1/projects/proj_123/settings", body={"timezone": "UTC"})
+
+# DELETE
+client.delete("/api/v1/projects/proj_123/tags/old-tag")
+```
+
+All generic methods use the same authentication, error handling, and rate-limit logic as the built-in methods.
+
 ## Configuration
 
 ```python

{webhook_platform-2.0.0 → webhook_platform-2.2.1}/README.md

@@ -309,6 +309,64 @@ except HookflowError as e:
     print(f"Error {e.status}: {e.message}")
 ```
 
+### Error Response Format
+
+All API errors return a consistent JSON body:
+
+```json
+{
+  "error": "error_code",
+  "message": "Human-readable description",
+  "status": 400,
+  "fieldErrors": { "field": "reason" }
+}
+```
+
+- **`error`** — machine-readable error code (`snake_case`), always present
+- **`message`** — human-readable description, always present
+- **`status`** — HTTP status code (integer), always present
+- **`fieldErrors`** — field-level validation details (only present for `validation_error`)
+
+### Error Codes Reference
+
+| HTTP Status | `error` Code | SDK Exception | Description |
+|---|---|---|---|
+| 400 | `validation_error` | `ValidationError` | Invalid request parameters; see `fieldErrors` |
+| 400 | `invalid_request` | `HookflowError` | Malformed or semantically invalid request |
+| 401 | `unauthorized` | `AuthenticationError` | Missing or invalid API key / expired token |
+| 403 | `forbidden` | `HookflowError` | Insufficient permissions for the action |
+| 404 | `not_found` | `NotFoundError` | Requested resource does not exist |
+| 413 | `payload_too_large` | `HookflowError` | Request body exceeds maximum allowed size |
+| 422 | `unprocessable_entity` | `HookflowError` | Valid syntax but violates business rules |
+| 429 | `rate_limit_exceeded` | `RateLimitError` | Too many requests; check `X-RateLimit-*` headers |
+| 500 | `internal_error` | `HookflowError` | Unexpected server error |
+
+## Generic Requests
+
+As the API expands, you can call any endpoint directly without waiting for SDK updates:
+
+```python
+# GET
+schemas = client.get("/api/v1/projects/proj_123/schemas")
+
+# GET with query params
+items = client.get("/api/v1/projects/proj_123/items", params={"status": "active"})
+
+# POST with body and idempotency key
+result = client.post("/api/v1/some/new/endpoint", body={"key": "value"}, idempotency_key="unique-key")
+
+# PUT
+client.put("/api/v1/projects/proj_123/settings", body={"timezone": "UTC"})
+
+# PATCH
+client.patch("/api/v1/projects/proj_123/settings", body={"timezone": "UTC"})
+
+# DELETE
+client.delete("/api/v1/projects/proj_123/tags/old-tag")
+```
+
+All generic methods use the same authentication, error handling, and rate-limit logic as the built-in methods.
+
 ## Configuration
 
 ```python

{webhook_platform-2.0.0 → webhook_platform-2.2.1}/hookflow/__init__.py

@@ -36,7 +36,7 @@ from .types import (
     ReplayEventResponse,
 )
 
-__version__ = "2.0.0"
+__version__ = "2.2.1"
 
 # Backward-compatible aliases
 WebhookPlatform = Hookflow

{webhook_platform-2.0.0 → webhook_platform-2.2.1}/hookflow/client.py

@@ -37,7 +37,7 @@ from .errors import (
 
 DEFAULT_BASE_URL = "http://localhost:8080"
 DEFAULT_TIMEOUT = 30
-SDK_VERSION = "2.0.0"
+SDK_VERSION = "2.2.1"
 
 
 class Hookflow:
@@ -63,6 +63,31 @@ class Hookflow:
         self.incoming_sources = IncomingSources(self)
         self.incoming_events = IncomingEventsApi(self)
 
+    def get(self, path: str, params: Optional[Dict[str, Any]] = None) -> Any:
+        """Generic GET request. Use for endpoints not yet covered by the SDK."""
+        return self._request("GET", path, params=params)
+
+    def post(
+        self,
+        path: str,
+        body: Optional[Dict[str, Any]] = None,
+        idempotency_key: Optional[str] = None,
+    ) -> Any:
+        """Generic POST request. Use for endpoints not yet covered by the SDK."""
+        return self._request("POST", path, body=body, idempotency_key=idempotency_key)
+
+    def put(self, path: str, body: Optional[Dict[str, Any]] = None) -> Any:
+        """Generic PUT request. Use for endpoints not yet covered by the SDK."""
+        return self._request("PUT", path, body=body)
+
+    def patch(self, path: str, body: Optional[Dict[str, Any]] = None) -> Any:
+        """Generic PATCH request. Use for endpoints not yet covered by the SDK."""
+        return self._request("PATCH", path, body=body)
+
+    def delete(self, path: str) -> Any:
+        """Generic DELETE request. Use for endpoints not yet covered by the SDK."""
+        return self._request("DELETE", path)
+
     def _request(
         self,
         method: str,

{webhook_platform-2.0.0 → webhook_platform-2.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "webhook-platform"
-version = "2.0.0"
+version = "2.2.1"
 description = "Official Python SDK for Hookflow — reliable webhook infrastructure"
 readme = "README.md"
 license = {text = "MIT"}

{webhook_platform-2.0.0 → webhook_platform-2.2.1}/tests/test_client.py

@@ -74,6 +74,35 @@ class TestHookflowClient:
         assert client.deliveries is not None
 
 
+class TestGenericRequestMethods:
+    """Tests for generic request methods."""
+
+    def test_exposes_get_method(self):
+        """Should expose public get method."""
+        client = Hookflow(api_key="test_api_key")
+        assert callable(client.get)
+
+    def test_exposes_post_method(self):
+        """Should expose public post method."""
+        client = Hookflow(api_key="test_api_key")
+        assert callable(client.post)
+
+    def test_exposes_put_method(self):
+        """Should expose public put method."""
+        client = Hookflow(api_key="test_api_key")
+        assert callable(client.put)
+
+    def test_exposes_patch_method(self):
+        """Should expose public patch method."""
+        client = Hookflow(api_key="test_api_key")
+        assert callable(client.patch)
+
+    def test_exposes_delete_method(self):
+        """Should expose public delete method."""
+        client = Hookflow(api_key="test_api_key")
+        assert callable(client.delete)
+
+
 class TestErrorClasses:
     """Tests for error classes."""
 

{webhook_platform-2.0.0 → webhook_platform-2.2.1}/webhook_platform.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webhook-platform
-Version: 2.0.0
+Version: 2.2.1
 Summary: Official Python SDK for Hookflow — reliable webhook infrastructure
 Author-email: Vadym Kykalo <vadymkykalo@gmail.com>
 License: MIT
@@ -338,6 +338,64 @@ except HookflowError as e:
     print(f"Error {e.status}: {e.message}")
 ```
 
+### Error Response Format
+
+All API errors return a consistent JSON body:
+
+```json
+{
+  "error": "error_code",
+  "message": "Human-readable description",
+  "status": 400,
+  "fieldErrors": { "field": "reason" }
+}
+```
+
+- **`error`** — machine-readable error code (`snake_case`), always present
+- **`message`** — human-readable description, always present
+- **`status`** — HTTP status code (integer), always present
+- **`fieldErrors`** — field-level validation details (only present for `validation_error`)
+
+### Error Codes Reference
+
+| HTTP Status | `error` Code | SDK Exception | Description |
+|---|---|---|---|
+| 400 | `validation_error` | `ValidationError` | Invalid request parameters; see `fieldErrors` |
+| 400 | `invalid_request` | `HookflowError` | Malformed or semantically invalid request |
+| 401 | `unauthorized` | `AuthenticationError` | Missing or invalid API key / expired token |
+| 403 | `forbidden` | `HookflowError` | Insufficient permissions for the action |
+| 404 | `not_found` | `NotFoundError` | Requested resource does not exist |
+| 413 | `payload_too_large` | `HookflowError` | Request body exceeds maximum allowed size |
+| 422 | `unprocessable_entity` | `HookflowError` | Valid syntax but violates business rules |
+| 429 | `rate_limit_exceeded` | `RateLimitError` | Too many requests; check `X-RateLimit-*` headers |
+| 500 | `internal_error` | `HookflowError` | Unexpected server error |
+
+## Generic Requests
+
+As the API expands, you can call any endpoint directly without waiting for SDK updates:
+
+```python
+# GET
+schemas = client.get("/api/v1/projects/proj_123/schemas")
+
+# GET with query params
+items = client.get("/api/v1/projects/proj_123/items", params={"status": "active"})
+
+# POST with body and idempotency key
+result = client.post("/api/v1/some/new/endpoint", body={"key": "value"}, idempotency_key="unique-key")
+
+# PUT
+client.put("/api/v1/projects/proj_123/settings", body={"timezone": "UTC"})
+
+# PATCH
+client.patch("/api/v1/projects/proj_123/settings", body={"timezone": "UTC"})
+
+# DELETE
+client.delete("/api/v1/projects/proj_123/tags/old-tag")
+```
+
+All generic methods use the same authentication, error handling, and rate-limit logic as the built-in methods.
+
 ## Configuration
 
 ```python