spatialflow 1.1.0__tar.gz → 2.0.0__tar.gz

spatialflow-2.0.0/CHANGELOG.md

@@ -0,0 +1,112 @@
+# Changelog
+
+All notable changes to the SpatialFlow Python SDK will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2026-10-08
+
+**Breaking changes.** `paginate_users`, `paginate_files`, `GeofencesResource.list_by_group` and the account onboarding wrappers are removed, and several list and request-body wrappers take different arguments. See Removed and Fixed below.
+
+### Added
+
+- `client.devices`: `start_shift`, `pause_shift`, `resume_shift`, `end_shift`,
+  `list_sessions`, `get_session`, `get_session_locations`, `list_session_notes`,
+  `add_session_note`.
+- `client.geofences`: `list_groups`, `list_group_geofences`, `test_group_point`,
+  `assign_to_group`.
+- `client.workspaces`: `list_members`, `update_member_role`, `remove_member`,
+  `list_invitations`, `create_invitation`, `resend_invitation`,
+  `resend_missing_invitations`, `extend_invitation`, `cancel_invitation`.
+- `verify_workflow_signature` verifies a workflow Webhook action delivery: `X-SpatialFlow-Signature` (`sha256=<hex>` HMAC-SHA256 over `<timestamp>.<raw body>`) and `X-SpatialFlow-Timestamp`, with a default 300 second tolerance in both directions. A body that isn't JSON is returned as text. `verify_webhook_signature` is unchanged.
+
+### Fixed
+
+- Exceptions raised from generated API calls now carry the server's `detail` and
+  `error_code` for every status class, not just the generic case. A plan limit
+  returns a `PermissionError` with `error_code == "WORKFLOW_LIMIT_REACHED"`
+  instead of `detail=None`.
+- `SpatialFlow.close()` and `async with SpatialFlow(...)` now close the aiohttp
+  session, so Python no longer prints `Unclosed client session` on exit.
+- `client.storage.delete_file(file_id=...)` now deletes an uploaded file. The
+  endpoint takes the `file_id` an upload returned; before, it could not find
+  uploaded files and the call failed. It returns `None` on success.
+- **List and metrics wrappers**: these forwarded parameters the endpoints reject, so they failed validation before any request was sent.
+  - `client.devices.list()` takes `is_active`, `include_geofences` and `group` instead of `limit` and `offset`.
+  - `client.integrations.list()` takes `type`, `is_active`, `is_verified` and `search` instead of `limit`, `offset` and `integration_type`.
+  - `client.storage.list_files(file_type)` takes the file type the endpoint requires, and no `limit` or `offset`.
+  - `client.geofences.list()` no longer takes `group_id`; use `list_group_geofences(group_id)` for the geofences in one group.
+  - `client.webhooks.get_metrics()` and `get_success_timeline()` no longer take `webhook_id`: the metrics endpoint is platform-wide and admin-only, and the timeline covers the whole workspace.
+  - Request-body wrappers sent argument names the generated client doesn't have. `workflows.update` takes a `WorkflowUpdate`, `workflows.test` a `TestWorkflowIn`, `workflows.duplicate` the copy's `name` instead of a `request`, `workflows.execute` an optional dict sent as `test_data` (the endpoint does not accept a payload yet), and `devices.update` an `UpdateDeviceIn`. `workflows.import_workflow`, `workflows.update_retry_policy`, `devices.create` and `devices.update_location` keep their signatures.
+  - `client.webhooks.retry_dlq()` sends the entry ID as the endpoint's `dlq_id`.
+- **Paginators**: `paginate_workflows` reads `total` and `paginate_webhooks` reads `pagination.total`, instead of a `count` field those responses don't have. `paginate_geofences` reports `total_count` as its total.
+- **Webhook signature verification**: `verify_webhook_signature` now matches the platform, which signs the raw request body with HMAC-SHA256 and sends it as `X-SF-Signature: sha256=<hex>`. The previous implementation expected a Stripe-style `t=<timestamp>,v1=<sig>` header and rejected every real webhook.
+  - Malformed (non-hex or non-ASCII) signatures now raise `WebhookSignatureError` instead of a `TypeError`.
+  - The `tolerance` parameter is retained but deprecated and ignored (the signature carries no timestamp; to guard against replays, verify the signature and then deduplicate on the signed payload `id`, because the `X-Idempotency-Key` and `X-SF-Event-ID` headers are not signed).
+  - Docs corrected to read the backend `event` key (`event["event"]`).
+
+### Removed
+
+- Removed the account wrapper methods `get_onboarding_progress`,
+  `update_onboarding_progress`, and `dismiss_onboarding`. Their endpoints were
+  removed from the platform; the generated Python and Node clients already no
+  longer expose them. No generated files were changed.
+- `GeofencesResource.list_by_group`, which always failed; `list_group_geofences` covers it.
+- `paginate_users` and `paginate_files`. The SDK has no user list call, and the storage list isn't paginated, so `paginate_files` never stopped.
+
+## [1.1.0] - 2026-04-05
+
+### Changed
+
+- The generated API client is rebuilt from OpenAPI spec v1.1.0. Schemas that were untyped objects are now typed, including geofence geometry, the login response's user, the created API key, workflow import, retry policy, integration configs and simulation details.
+- Every operation's generated types include the standard 4xx error responses.
+- `VERSION` and the `User-Agent` header report `1.1.0` (they reported `0.2.0` before).
+
+## [0.2.0] - 2025-12-26
+
+### Added
+
+- **Workflow activation**: `client.workflows.activate(workflow_id)` - Activate draft workflows for production use
+  - Idempotent: returns success if workflow is already active
+  - Validates workflow has trigger and steps before activation
+  - Rate limited: 1000 requests/hour
+
+### Fixed
+
+- **Integrations API key auth**: Integrations API now accepts API key authentication (was JWT-only)
+  - Requires `integrations:read` permission for list/get endpoints
+  - Requires `integrations:write` permission for create/update/delete/test endpoints
+  - Fixes: GitHub issue #114
+
+- **Location ingest JWT auth**: Location ingest API now accepts JWT authentication (was API-key-only)
+  - Both JWT and API key auth now work for location ingestion
+  - Fixes: GitHub issue #115
+
+### Technical Details
+
+- Regenerated from OpenAPI spec using openapi-generator-cli 7.19.0
+- Generated package now installed as `spatialflow_generated` in virtualenv
+- OpenAPI spec hash: ce5ef5f82f7f17ebc5d628a612b84d1d39159c330c8362c4680be7bbdda50327
+
+## [0.1.0] - 2025-12-04
+
+### Added
+
+- Initial alpha release
+- **Authentication**: API key and JWT token support
+- **Client**: `SpatialFlow` async client with resource accessors
+- **Resources**: Full CRUD for geofences, workflows, webhooks, devices
+- **Pagination**: `paginate()` async iterator for paginated endpoints
+- **Webhook verification**: `verify_webhook_signature()` with HMAC-SHA256
+- **Job polling**: `poll_job()` for async job status tracking
+- **File uploads**: `upload_geofences()` for GeoJSON/KML/GPX imports
+- **Typed exceptions**: `AuthenticationError`, `NotFoundError`, `ValidationError`, etc.
+- **Models**: Re-exported Pydantic models from generated code
+
+### Technical Details
+
+- Generated from OpenAPI spec using openapi-generator-cli 7.10.0
+- Python generator with `library=asyncio` for native async/await
+- Requires Python 3.9+
+- Dependencies: aiohttp, pydantic v2, python-dateutil

{spatialflow-1.1.0 → spatialflow-2.0.0}/PKG-INFO

@@ -1,9 +1,9 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: spatialflow
-Version: 1.1.0
+Version: 2.0.0
 Summary: Python SDK for SpatialFlow - Real-time geospatial automation platform
 Project-URL: Homepage, https://spatialflow.io
-Project-URL: Documentation, https://docs.spatialflow.io/sdk/python
+Project-URL: Documentation, https://docs.spatialflow.io/sdks/python/
 Project-URL: Repository, https://github.com/spatialflow-io/spatialflow-python
 Project-URL: Issues, https://github.com/spatialflow-io/spatialflow-python/issues
 Project-URL: Changelog, https://github.com/spatialflow-io/spatialflow-python/blob/main/CHANGELOG.md
@@ -11,7 +11,7 @@ Author-email: SpatialFlow <support@spatialflow.io>
 License-Expression: MIT
 License-File: LICENSE
 Keywords: automation,geofencing,geospatial,location,sdk,spatialflow
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -85,12 +85,12 @@ asyncio.run(main())
 
 | Resource | Methods | Description |
 |----------|---------|-------------|
-| **Geofences** | CRUD, upload, bulk | Manage geofence boundaries |
+| **Geofences** | CRUD, upload, bulk, groups | Manage geofence boundaries |
 | **Workflows** | CRUD, execute, monitor, versioning | Automation workflows |
 | **Webhooks** | CRUD, deliveries, DLQ, metrics | Webhook endpoints and delivery tracking |
-| **Devices** | CRUD, location updates | Device management |
-| **Account** | profile, API keys, metrics, onboarding | User account management |
-| **Workspaces** | get, update, usage | Workspace settings and usage metrics |
+| **Devices** | CRUD, location updates, shifts, sessions | Device management |
+| **Account** | profile, API keys, metrics | User account management |
+| **Workspaces** | get, update, usage, members, invitations | Workspace settings and usage metrics |
 | **Locations** | ingest, batch, stats | Public location ingestion API |
 | **Integrations** | CRUD, test | Third-party service connections |
 | **Storage** | presigned URLs, files | File upload and management |
@@ -132,8 +132,8 @@ Available via `client.raw`:
 - `geofences`, `workflows`, `webhooks`, `devices`, `storage`, `locations`, `integrations`, `workspaces`, `account` (also wrapped)
 - `authentication`, `admin`, `billing`, `subscriptions`, `tiles` (raw only)
 
-> **Alpha Notice:** This SDK is in alpha (v0.2.0). Some generated APIs (email, system, gpx_simulator,
-> public, default, e2e_test) are not yet exposed. Use the generated client directly for those.
+Some generated APIs (email, system, gpx_simulator, public, default, e2e_test) are not
+exposed on the client. Use the generated client directly for those.
 
 ## Documentation
 

{spatialflow-1.1.0 → spatialflow-2.0.0}/README.md

@@ -39,12 +39,12 @@ asyncio.run(main())
 
 | Resource | Methods | Description |
 |----------|---------|-------------|
-| **Geofences** | CRUD, upload, bulk | Manage geofence boundaries |
+| **Geofences** | CRUD, upload, bulk, groups | Manage geofence boundaries |
 | **Workflows** | CRUD, execute, monitor, versioning | Automation workflows |
 | **Webhooks** | CRUD, deliveries, DLQ, metrics | Webhook endpoints and delivery tracking |
-| **Devices** | CRUD, location updates | Device management |
-| **Account** | profile, API keys, metrics, onboarding | User account management |
-| **Workspaces** | get, update, usage | Workspace settings and usage metrics |
+| **Devices** | CRUD, location updates, shifts, sessions | Device management |
+| **Account** | profile, API keys, metrics | User account management |
+| **Workspaces** | get, update, usage, members, invitations | Workspace settings and usage metrics |
 | **Locations** | ingest, batch, stats | Public location ingestion API |
 | **Integrations** | CRUD, test | Third-party service connections |
 | **Storage** | presigned URLs, files | File upload and management |
@@ -86,8 +86,8 @@ Available via `client.raw`:
 - `geofences`, `workflows`, `webhooks`, `devices`, `storage`, `locations`, `integrations`, `workspaces`, `account` (also wrapped)
 - `authentication`, `admin`, `billing`, `subscriptions`, `tiles` (raw only)
 
-> **Alpha Notice:** This SDK is in alpha (v0.2.0). Some generated APIs (email, system, gpx_simulator,
-> public, default, e2e_test) are not yet exposed. Use the generated client directly for those.
+Some generated APIs (email, system, gpx_simulator, public, default, e2e_test) are not
+exposed on the client. Use the generated client directly for those.
 
 ## Documentation
 

{spatialflow-1.1.0 → spatialflow-2.0.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "spatialflow"
-version = "1.1.0"
+version = "2.0.0"
 description = "Python SDK for SpatialFlow - Real-time geospatial automation platform"
 readme = "README.md"
 license = "MIT"
@@ -14,7 +14,7 @@ authors = [
 ]
 keywords = ["spatialflow", "geospatial", "geofencing", "location", "automation", "sdk"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
@@ -54,7 +54,7 @@ docs = [
 
 [project.urls]
 Homepage = "https://spatialflow.io"
-Documentation = "https://docs.spatialflow.io/sdk/python"
+Documentation = "https://docs.spatialflow.io/sdks/python/"
 Repository = "https://github.com/spatialflow-io/spatialflow-python"
 Issues = "https://github.com/spatialflow-io/spatialflow-python/issues"
 Changelog = "https://github.com/spatialflow-io/spatialflow-python/blob/main/CHANGELOG.md"

{spatialflow-1.1.0 → spatialflow-2.0.0}/src/spatialflow/__init__.py

@@ -19,12 +19,11 @@ Example:
 
 """
 
-__version__ = "1.1.0"
+__version__ = "2.0.0"
 
 # Main client (imported early to get DEFAULT_BASE_URL)
 from .client import SpatialFlow, DEFAULT_BASE_URL
 
-# Custom exceptions
 from .exceptions import (
     SpatialFlowError,
     AuthenticationError,
@@ -39,28 +38,26 @@ from .exceptions import (
     translate_exception,
 )
 
-# Webhook verification
-from .webhooks import verify_webhook_signature, WebhookSignatureError, verify_signature
+from .webhooks import (
+    verify_webhook_signature,
+    verify_workflow_signature,
+    WebhookSignatureError,
+    verify_signature,
+)
 
-# Pagination helpers
 from .pagination import (
     paginate,
     paginate_geofences,
     paginate_workflows,
     paginate_webhooks,
-    paginate_users,
-    paginate_files,
     AsyncPaginator,
     PaginatedResponse,
 )
 
-# Job polling helpers
 from .jobs import poll_job, JobResult, JobTimeoutError, JobFailedError
 
-# File upload helpers
 from .uploads import upload_geofences
 
-# Workflow builders
 from .builders import (
     build_geofence_webhook_workflow,
     build_geofence_integration_workflow,
@@ -105,6 +102,7 @@ __all__ = [
     "translate_exception",
     # Webhooks
     "verify_webhook_signature",
+    "verify_workflow_signature",
     "verify_signature",
     "WebhookSignatureError",
     # Pagination
@@ -112,8 +110,6 @@ __all__ = [
     "paginate_geofences",
     "paginate_workflows",
     "paginate_webhooks",
-    "paginate_users",
-    "paginate_files",
     "AsyncPaginator",
     "PaginatedResponse",
     # Job polling