Skip to content

Latest commit

 

History

History
1085 lines (604 loc) · 33.1 KB

File metadata and controls

1085 lines (604 loc) · 33.1 KB

CHANGELOG

v3.13.3 (2026-04-20)

Bug Fixes

  • Add missing description field to Rule resource (a359b6e)

v3.13.2 (2026-04-16)

Bug Fixes

  • Pass include_total on all paginated requests (40bae3b)

v3.13.1 (2026-03-30)

Bug Fixes

  • Add missing rule -> queue many-to-many relation (bb00d14)

  • Remove deprecated rule -> schema relation (8734f2c)

v3.13.0 (2026-03-25)

Features

  • client: Add cursor pagination and fix existing pagination (970644b)

v3.12.1 (2026-03-23)

Bug Fixes

  • Add missing format field for Datapoint (ff6e21d)

v3.12.0 (2026-03-17)

Bug Fixes

  • Add schema_id field to SchemaIdsPayload (07dd787)

  • Expand AddValidationSourcePayload with schema_ids and multivalue_child_id (413bddc)

  • Handle unknown action types gracefully by falling back to dict (d5e8980)

  • Separate AddRemoveLabelPayload into distinct class with condition (4c563d6)

  • Separate ShowHideFieldPayload into distinct class with condition (c2401f9)

  • Update ChangeQueuePayload to use queue URL instead of queue_id (6f520c4)

Features

  • Add CustomActionPayload for custom rule action (4a47e53)

v3.11.2 (2026-03-16)

Bug Fixes

  • Add matching and enum_value_type fields to Datapoint schema model (b2e614f)

v3.11.1 (2026-03-10)

Bug Fixes

  • Use deserializer for AnnotationProcessingDuration (6c612b4)

Chores

  • Add missing AnnotationProcessingDuration fields (e981c15)

v3.11.0 (2026-03-04)

Chores

  • Add CLAUDE.md symlink to make claude power-user (65e830f)

  • Add OpenApi spec reference to AGENTS.md (91d7d9e)

  • Fix hyperlinks after Elis API doc template change (f33e8bd)

  • Migrate from mypy to ty (a8db181)

  • Run pre-commit as a single separte CI job (7d9ad59)

Features

  • Add annotation processing duration endpoint (9dda9fb)

v3.10.0 (2026-02-12)

Features

  • Add 'lookup' to supported value sources (aa02f57)

v3.9.1 (2026-02-11)

Bug Fixes

  • Add missing fields to HookTemplate model (f0055b6)

  • Derive hook template ID from URL since Rossum API does not send it (f0a6941)

v3.9.0 (2026-02-09)

Chores

  • Add AGENTS.md for better coding agent experience (80994db)

Documentation

  • Update doc references to the new documentation (cf1c8e3)

  • Update docs design to match Rossum API docs style (8ea104f)

Features

  • Add Hook templates and relevant client methods (7308be2)

  • Add Organization Group and relevant client methods (44298f5)

  • Add Organization limits (f52b00e)

  • Add typed dataclasses for RuleAction payloads and literal types (6fddb3f)

v3.8.0 (2026-01-27)

Chores

  • Add missing job hook type to type hints and docs (fef5b5b)

  • Fix correctly Attributes in dataclass docs (f30785f)

Features

  • Add Hook Run Data for listing hook execution logs (3a9efb9)

v3.7.2 (2026-01-26)

Bug Fixes

  • Make sideload compatible with latest api (5c7ee62)

Chores

v3.7.1 (2026-01-07)

Bug Fixes

  • Fix connector optional params (e2c6bfd)

  • Make schema on Rule optional (2bbf7b5)

Chores

  • Add a badge for supported python versions (fcf1eac)

  • Fix badges in README (d865498)

  • Pin sphinx<9.0 (bcf337f)

v3.7.0 (2025-12-08)

Bug Fixes

  • Fix filters on Engine & add missing tests and docstrings (e98ce30)

  • Fix filters on sync listing of Document Relations (30e0419)

Chores

  • Add organization field on Engine (8c8848f)

  • Add package description (2156bed)

  • Run check commit convention step in CI (df96a93)

Features

  • Add parent-child Relation object and supported API calls (8d9688d)

  • Deserialize schema content into proper dataclasses (76b9d86)

v3.6.1 (2025-11-13)

Bug Fixes

  • Handle APIClientError in should_retry (e397248)

Refactoring

  • Unify retrying between sync and async internal clients (230332d)

v3.6.0 (2025-11-10)

Features

  • Add Rule & Rule Actions (76280c6)

v3.5.2 (2025-11-06)

Bug Fixes

  • Fix README path in pyproject (bdd1f47)

v3.5.1 (2025-11-06)

Bug Fixes

  • Fix readme symlink direction and badges (58e89ee)

Documentation

  • Add documentation deployment CI step (2f7d144)

  • Add link and badge with link to docs (9712884)

  • Build docs to docs/build instead of docs/build (18f8eea)

  • Fix forgotten uv --sytem option (b22593f)

  • Simplify and merge docs build and deploy workflows (00ddf90)

v3.5.0 (2025-11-06)

Chores

  • Fix missing semantic release coment in chlog (2629e3b)

  • Introduce all pyupgrade rules (c02a21b)

  • Introduce all RET ruff rules (897ea4c)

  • Introduce all RUF ruff rules (ea9641e)

  • Introduce all S (flake8-bandit) ruff rules (7197383)

  • Introduce all SIM ruff rules (3959ec3)

  • Set semantic release to re-generate full chlog (edabd78)

  • Update and pin ci action versions (28822db)

Documentation

  • Introduce sphinx docs (4505029)

  • Update docs to Rossum API only (ecda8c8)

Features

  • Achieve feature parity across sync and async clients (9cc7846)

v3.4.0 (2025-10-30)

Chores

  • Add basic pre-commit hooks (87aff93)

  • Define Sideload as a type (c639b7a)

  • Enforce PEP 585 (eed9f47)

  • Enforce PEP 604 (118bb97)

  • Enforce PEP 604 for optional types (118d968)

  • Enforce TCH rule (ffd68de)

  • Enforce type checking and fix typing (cae0ecd)

  • Fix typo in LICENSE file name (f10b56d)

  • Publish package automatically to pypi upon release (c335845)

  • Remove unused .flake8 file (ade9ea7)

  • Remove unused black and isort configs from pyproject.toml (80bf6f9)

  • Remove unused Makefile (24b4e8e)

  • Remove unused tox.ini file (11da97f)

  • Save a few lines by cleaning trailing commas (cda1933)

  • Start using ruff in its full strength (3d5becd)

  • Unify absolute imports of models (59b4c03)

  • Update package version in pre-commit (0781db4)

  • Use JsonDict type globally (44b9b8a)

Documentation

  • Add badge to pypi (ef6e6d4)

  • Add local development section to README (bc6062c)

  • Clean CONTRIBUTING.md (033e7a3)

  • Fix badges (191250d)

  • Fix unintentional copy to README (2f6e13b)

  • Regenerate CHANGELOG.md following semantic releases conventions (f008e54)

  • Remove TODO list (3f1c9b4)

  • Update installation guide (924d108)

Features

  • Replace heavy inflect import by a simple heuristic (683e722)

v3.3.0 (2025-10-27)

Chores

  • Replace python <=3.9 support with python 3.13 (d3dc4bf)

  • Upgrade pytest-httpx (59326f1)

Features

  • Add training_queues field for Engine (6099877)

v3.2.0 (2025-09-16)

Features

  • Add authenticate method to Rossum API client (9bc0d86)

v3.1.3 (2025-09-10)

Bug Fixes

  • Fix sideload in sync client (e140569)

v3.1.2 (2025-09-08)

Bug Fixes

  • Switch from token header to Bearer auth and update tests (45ed114)

  • Switch from token header to Bearer auth and update tests (+ Sync client) (20d715b)

v3.1.1 (2025-06-27)

Bug Fixes

  • Use venv pytest for the test command (fb24918)

v3.1.0 (2025-06-06)

Features

  • Add einvoice document relation type (2396694)

v3.0.0 (2025-05-28)

Bug Fixes

  • Make Task.content optional (48d1e4d)

Features

Breaking Changes

  • Adding to Generic class can break existing setups.

v2.1.0 (2025-05-28)

Features

  • Add missing annotation fields (71c2e2d)

v2.0.1 (2025-04-28)

Bug Fixes

  • Move exceptions module to rossum_api package (548215a)

v2.0.0 (2025-04-24)

Features

  • Add document relation resource (230bb1c)

Breaking Changes

  • Adding to Generic class can break existing setups.

v1.0.1 (2025-04-04)

Bug Fixes

  • Fix bugs in internal sync client (5e57018)

Refactoring

  • Rename module with tests of internal async client (1334338)

  • Use helpers from domain logic in clients (24e0657)

v1.0.0 (2025-03-26)

Features

  • Implement sync client without event loop (3964632)

Breaking Changes

  • Public interface changed.

v0.24.0 (2025-03-21)

Features

  • Add response post-processor (a1ab75f)

v0.23.2 (2025-03-20)

Bug Fixes

  • Resolve problem with typing and custom deserializer (a9b95bd)

v0.23.1 (2025-01-23)

Bug Fixes

  • Rename retrieve_engine_queue_stats to retrieve_engine_queues (7583358)

v0.23.0 (2025-01-20)

Features

  • Add more information to APIClientError (53d0781)

  • Add support for filters in export helper methods (8a94d6f)

v0.22.0 (2025-01-16)

Bug Fixes

  • Remove 'button' possibility for EngineField.type as it should not happen (da698b0)

  • Use _iter_over_async instead of _run_coroutine and Iterator instead of list (9540929)

Code Style

  • Reformat method parameters - do not break lines if not necessary (31537af)

Features

  • Support retrieval of Queues associated with the given Engine (8aee3d4)

v0.21.0 (2025-01-14)

Chores

  • Correct resource name in sideloading test integration test (a419002)

Features

  • Add support for retrieving EngineFields (c976954)

Refactoring

  • Extract sideloading logic into domain logic (080b7af)

v0.20.1 (2024-12-11)

Bug Fixes

  • Prevent race condition over the asyncio event loop in ThreadPoolExecutor (6a4d922)

Chores

  • Extract Resource into domain logic (99ec60c)

  • Extract URL domain logic into a reusable module (826fcd5)

v0.20.0 (2024-12-10)

Bug Fixes

  • Do not crash when running sync client in async context (0038e4a)

Chores

  • Fix tests by pinning pytest-httpx (a0c0eeb)

  • Improve readability of assert in XML export test (4c88b7e)

Features

  • Retry also on request/HTTP errors during authentication (3bae7da)

v0.19.0 (2024-09-25)

Chores

  • Fix naming in queues tests (2c51b64)

Features

  • Add cancel annotation method (a217b64)

  • Add new methods for hook object (232269f)

  • Add retrieve document method (4edac76)

v0.18.1 (2024-08-20)

Bug Fixes

  • Handle http:// urls for local development (715513d)

v0.18.0 (2024-08-15)

Features

  • Add basic support for EmailTemplate object (0dc2882)

v0.17.2 (2024-08-12)

Bug Fixes

  • Fix typing of filters kwargs in sync client (7ae75e1)

v0.17.1 (2024-08-09)

Bug Fixes

  • Use Iterator instead of Iterable types (77edb52)

v0.17.0 (2024-08-07)

Chores

  • Drop support for Python 3.7 (3a4e359)

  • Fix typos and missing docs (a499da2)

Features

  • Add support for Task and Upload objects (6e582a9)

  • Upload documents using new upload endpoint (9ff22d9)

v0.16.0 (2024-06-04)

Chores

  • Add missing type hint for list_all_organizations (86fb228)

Features

v0.15.2 (2024-06-03)

Bug Fixes

v0.15.1 (2024-06-03)

Bug Fixes

  • Remove semantic-release version_variable (9d5d101)

v0.15.0 (2024-06-03)

Features

  • Add support for engine object (c6ad1d5)

v0.14.0 (2024-05-22)

Features

  • Add py.typed and let the world know we use types (9415403)

v0.13.3 (2024-05-22)

Bug Fixes

  • Make User.last_login optional (406b16b)

v0.13.2 (2024-04-09)

Bug Fixes

  • api-client: Do not reauth if no credentials are available (9b5f422)

v0.13.1 (2024-03-25)

Bug Fixes

  • models:automation_blocker: Fix type of samples (b36d6a8)

Continuous Integration

  • pre-commit: Update mypy (06d2272)

v0.13.0 (2024-02-07)

Bug Fixes

  • Do not send None parent when creating new document (95f3fbc)

Documentation

  • Improve client docstrings (94e8522)

Features

  • Consider new created status when checking if annotation is already imported (7c66c63)

v0.12.0 (2024-02-06)

Features

  • Add new create_new_annotation method (7354ec7)

  • Add new create_new_document method (4affb67)

  • Add new retrieve_document_content method (4057e9c)

Refactoring

  • Unify naming of ids and add missing typing (86246cd)

  • tests: Fix typos in tests (19711e2)

v0.11.0 (2023-11-08)

Chores

  • Remove side-effects from tests with sideloads (c3f8130)

Features

  • Add convenience methods for annotation lifecycle (cf56272)

Refactoring

  • Rename UserRole to Group for consistency with the API (ed8065a)

v0.10.0 (2023-11-02)

Chores

  • Streamline Makefile and improve README (0b1064f)

Features

  • Support deserializing of API payloads to user-defined model classes (a1e1385)

Refactoring

  • Use an enum instead of strings to identify API resources (acbf731)

v0.9.1 (2023-10-11)

Bug Fixes

  • api_client: Limit in-flight requests (56244d0)

v0.9.0 (2023-10-11)

Features

  • Export public interface in root package (f85fc58)

v0.8.0 (2023-08-25)

Features

  • api_client: Allow passing json argument in fetch_all as request payload (e433f85)

  • elis_api_clients: Add new search_for_annotations method (34b3f72)

v0.7.4 (2023-08-11)

Features

  • models: Add token_lifetime_s attribute to hook model (f75dcfd)

v0.7.3 (2023-08-07)

Bug Fixes

  • Make time_spent in Annotation optional (a2e5d70)

v0.7.2 (2023-06-02)

Bug Fixes

  • Add await to asyncio.sleep (4a537ab)

v0.7.1 (2023-05-05)

Bug Fixes

  • models: Allow Any in metadata dict values in Queue model (7abaa13)

  • models: Allow null workspace in Queue model (dea0027)

v0.7.0 (2023-05-04)

Features

  • elis_api_client: Add generic method for requests to paginated resources (6b290e8)

v0.6.0 (2023-04-28)

Chores

  • Run test workflow also on pull requests (0ca9b43)

Features

  • api_client: Allow to set max pages limit in filters (090114f)

v0.5.1 (2023-03-31)

Bug Fixes

  • Switch from TravisCI to Github Workflows (de09e69)

Chores

v0.5.0 (2023-03-06)

Features

  • rossum_sdk/api_client: Add request method to ElisApiClient (5d11c3e)

v0.4.0 (2023-03-02)

Bug Fixes

  • Define Document.creator as optional (#35, d797e99)

  • models:hook: Define some attributes (guide, read_more_url, extension_image_url) as optional (b16a456)

Chores

  • Add pre-commit hook for commit messages (e641469)

  • Do not run commitizen when there is no commit (4f534d5)

  • Fix mypy installation in pre-commit by upgrading it (5d4b387)

  • Fix tests that started failing with pytest-httpx==0.21.2 (da18d27)

  • Run semrel only once (3b9392a)

Features

  • Add get_token method to Api client (a1bc957)

v0.3.0 (2022-10-17)

Features

  • Add request_json method to ElisAPIClient (6c2df87)

v0.2.0 (2022-10-13)

Features

  • Implement retrying of failed requests (09ab473)

v0.1.3 (2022-10-12)

Bug Fixes

  • Change Annotation.confirmed_at type to str instead of datetime (40597bb)

v0.1.2 (2022-10-11)

Bug Fixes

  • Allow null Organization.trial_expires_at in the model (dd95716)

v0.1.1 (2022-10-11)

Bug Fixes

  • Making dependency requirements more relaxed (80526da)

v0.1.0 (2022-10-06)

  • Initial Release