Skip to content

Latest commit

 

History

History
556 lines (304 loc) · 16.4 KB

CHANGELOG.md

File metadata and controls

556 lines (304 loc) · 16.4 KB

CHANGELOG

v0.23.1 (2025-01-23)

Bug Fixes

  • Rename retrieve_engine_queue_stats to retrieve_engine_queues (7583358)

The new name better conveys the essence that we're retrieving only a list of queues associated with the given engine. The docstring pointing to official documentation was also corrected.

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)

Fixing several implementation as well as typing errors introduced in one of the recent pull requests.

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)

...and use inflect to convert resource names to singular.

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)

The asyncio code is now executed in a ThreadPoolExecutor to avoid problems with multiple event loops.

Chores

  • Fix tests by pinning pytest-httpx (a0c0eeb)

0.22 is the last version that works with Python 3.8.

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

Features

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

When Elis API fails intermittently, we were not retrying which leads to unnecessary failures in production when the client is used.

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)

Iterator is a better type for the method return value, since it correctly type checks the use of next(). Iterable interface doesn't.

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

  • feat: Add delete_annotation method

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)

dummy_annotation was modified by a side-effect and the expected values didn't need to add content which was confusing.

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)

Users can provide a custom deserializer that allows customising which models should be returned by the client.

Refactoring

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

This is not only cleaner but will be useful when implementing custom de-serializers.

v0.9.1 (2023-10-11)

Bug Fixes

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

Limit the maximum number of fetch_all page requests running at in parallel.

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)

Co-authored-by: Ondrej Slama [email protected]

  • 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)

The old version installed a version of types-ats that caused a crash during pre-commit installation.

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

The library no longer ignores missing empty URL parameters when matching URLs.

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)

APIClient now accepts retry configuration where number of retries and backoff can be configured.

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)

Chores

  • Introduce semantic releasing (a485874)

Documentation

  • readme: Add helper page, add makefile (1c95bea)

Features

  • First github release by semantic releasing (7dd7780)

Testing

  • api_client: Reauth correct exception handling (5c0d728)