v1.6.0

[1.6.0] - 2024-12-19

🚀 Features

• (endpoints) Build request private helper method
• (cache) Model helper property

🚜 Refactor

• (endpoints) Remove unnecessary ruff ignore flag
• (endpoints) Convert process_models into clasmethod
• (endpoints) Make client attribute public
• (endpoints) Request handle error helper private method
• (endpoints) Process_response private helper method
• (endpoints) Improve request method readability
• (json-cache) Uses new model property
• (sqlite-cache) Uses new model property
• (reports) Adjust report endpoint to base
• (endpoints) Use MODEL classvar instead of property
• (cached_endpoint) Adjust subclass to new structure
• (cached_endpoint) Log info about cache expiration
• Remove all optional types

🕸 Deprecations

• (endpoints) Deprecate 'method' helper method in favour of build_request
• (endpoints) Deprecate model property in favour of class variable
• (endpoints) Deprecate 'endpoint' property in favour of 'BASE_ENDPOINT' ClassVar

📚 Documentation

• (json_cache) Encoder & decoder docstrings

⚙️ Miscellaneous Tasks

• (ruff) Ignore tc006 code
• (cliff) Ignore merge commits
• (cliff) Merge cliff.toml with pyproject

v1.5.1

[1.5.1] - 2024-11-26

🐛 Bug Fixes

• (models) From_kwargs not incorporating organization id

📚 Documentation

• (endpoints) Correct and improve docstrings
• (cache, config) Remove unnecessary type on return value in docstrings

v1.5.0

[1.5.0] - 2024-11-25

🚀 Features

• (workspace) Organization id accepts a model
• (utility) Deprecation helper method
• (tags) Single get endpoint convenience method
• (models) Add start and end date to project model
• (utility) Get_timestamp helper function
• (models) Project status enum
• (models) Project get_status method
• (projects) Status to query helper method
• (endpoints) Implement re_raise parameter
• (endpoints) Implement retries parameter
• (trackers) Bulk edit item typed dict
• (trackers) Edit named tuple data structure
• (trackers) Bulk edit patch endpoint method

🐛 Bug Fixes

• (projects) Default color for using old gray hex code
• (models) Missing pound sign on project default color
• (projects) Edit & add method return type had none

🚜 Refactor

• (workspace) Deprecate workspace_id argument correctly
• (user) Add workspace_id param to endpoint + model type
• (tracker) Add workspace_id param to endpoint + model type
• (projects) Add workspace_id param to endpoint + model type
• (clients) Add workspace_id param to endpoint + model type
• (tags) Add workspace_id param to endpoint + model type
• (user) Current endpoint will try refresh if no tracker is running
• (clients) Properly implement collect endpoint cache queries
• (cache) Json serializer formating date objects
• (user) Collect method uses get_timestamp helper
• (workspace) Collect method uses get_timestamp helper
• (projects) Add collect endpoint method body attributes
• (projects) Collect method endpoint format method helper
• (projects) Implement new body attributes into format method
• (projects) Update project collect method to include querying cache
• (models) Prevent unnecessary datetime call
• (endpoints) Change default timeout parameter
• (utility) [breaking] Turn requires into a private function
• (tracker) Improve edit endpoint method
• (endpoints) Request method accepts lists as a body
• (trackers) Update body parameters

🕸 Deprecations

• (meta) Base endpoint workspace_id argument removal
• (projects) Get color argument name
• (trackers) Body start_date parameter

📚 Documentation

• (user) Update current endpoint docstring
• (tags) Update get method docstring
• (models) Helper method docstrngs
• (projects) Update basic color docstrings
• (projects) Add and update all endpoint + body docstrings
• (cache) Remove docstring newlines
• (endpoints) Improve all endpoint parameter documentation
• (trackers) Add new functionality
• (mermaid) Update package diagrams
• (models) Improve docstring parameters
• (models) Document from_kwargs classmethod

⚙️ Miscellaneous Tasks

• (actions) Change release & documentation workflow dependency
• (ruff) Ignore PLR0913 code
• (ruff) Ignore C901 code
• (merge) V1.5.0-release

🧪 Testing

• (projects) Validate new body params
• (projects) Validate status_to_query method
• (projects) Sample data fixture
• (projects) Check collect method endpoint parameters
• (user) Validate re_raise works with current tracker
• (trackers) Validate bulk edit endpoint
• (utils) Improve version testing

v1.4.0

[1.4.0] - 2024-11-11

🚀 Features

• (exceptions) Custom exceptions for commonly raised value errors
• (cache) Custom missing parent error

🐛 Bug Fixes

• (project) Wrong hex code for gray color
• (utils) Remove unnecessary import

🚜 Refactor

• (tag) Edit endpoint method accepts seperate name argument
• (tag) Validate minimum name length
• (endpoint) Use generics with base endpoint
• (cache) User generic type with cache
• (endpoint) Assign generics to all endpoints
• (endpoint) Cache query method always returns list
• (typing) Generics implementation
• (workspace) Use custom exceptions for raised errors
• (user) Use custom exceptions for raised errors
• (user) Use custom exceptions for raised errors
• (tag) Use custom exceptions for raised errors
• (project) Use custom exceptions for raised errors
• (client) Use custom exceptions for raised errors
• (models) Use naming error instead of value error
• (cache) Implement new error subclass

🕸 Deprecations

• (tag) Remove the internal usage of a modified name in a tag
• (trackers) Change exception type in add endpoint method

📚 Documentation

• (tag) Update edit endpoint docstring
• (tag) Improve delete endpoint docstring
• (tag) Improve add endpoint method docstring
• (tag) Improve endpoint class docstring
• (organization) Use custom exceptions for raised errors docstring
• (exceptions) Document new exception classes
• (mkdocs) Enable symbols in table of contents
• (config) Reconfigure headings

🧪 Testing

• (tag) Validate tag name length
• (conftest) Rate limit trackers teardown
• (utility) Make sure version is updated

v1.3.2

[1.3.2] - 2024-11-05

🐛 Bug Fixes

• (cache) Json query hashable type error
• (cache) Check for all sequences

📚 Documentation

• (endpoint) Improve cached endpoint docstrings
• (cache) Improve base cache docstring
• (cache) Improve json cache docstrings
• (cache) Improve sqlite cache docstrings

🧪 Testing

• (cache) Test for distinct flag and unhashable types

v1.3.1

[1.3.1] - 2024-11-02

🐛 Bug Fixes

• (user) Refresh not getting passed to request
• (cache) Json query distinct & list comparisons

🚜 Refactor

• (endpoints) Add future type import

📚 Documentation

• (tracker) Add examples to docstrings

v1.3.0

[1.3.0] - 2024-10-31

🚀 Features

• (workspace) Workspace body dataclass
• (workspace) Add workspace endpoint
• (workspace) Collect workspaces endpoint
• (workspace) Edit workspace endpoint
• (workspace) Get time constraints
• (workspace) Statistics endpoint
• (models) Organization model
• (schema) Added organization model
• (endpoint) Added organization endpoint
• (organization) Add endpoint method
• (organization) Get endpoint method
• (models) Validate organization name
• (models) Validate workspace name
• (organization) Edit endpoint method
• (organization) Collect endpoint method
• (organization) Delete endpoint method
• (workspace) Organization id property
• (utility) Add org endpoint to cleanup
• Add organization objects to init

🐛 Bug Fixes

• (endpoint) Api status not catching json decode error
• (body) Verifying wrong variable
• (organization) Make sure edit method stores and returns model

🚜 Refactor

• (workspace) Use a blank endpoint property
• (endpoint) [breaking] Remove unnecessary class variables
• (workspace) Improve get method error handling

🕸 Deprecations

• (workspace) Accept organization instead of workspace
• (workspace) Turn get method workspace argument optional

📚 Documentation

• (examples) Improve authentication information
• (workspace) Document new workspace features
• (workspace) Improve docstrings
• (api) Update project structure and mermaid
• (organization) Add organization to api reference
• (workspace) Add typed dicts to api documentation
• (config) Reword deprecation
• (models) Improve model documentation

⚙️ Miscellaneous Tasks

• (dev-deps) Pytest dependency added
• (actions) Add new secrets to environment

🧪 Testing

• (conftest) Organization id fixture
• (workspace) Cover new endpoint methods
• (tags) Extra delete method validation
• (user) Fix test date creation
• (workspace) Use org id instead
• (organization) Test all functionality
• (conftest) User id fixture

v1.2.0

[1.2.0] - 2024-10-27

🚀 Features

• (user) User details endpoint
• (user) Verify authentication static method

🐛 Bug Fixes

• (user) Authentication verifier using wrong endpoint

🚜 Refactor

• (endpoint) User httpx error codes
• (user) Remove endpoint property forward slash

🕸 Deprecations

• (user) Check authentication method convert to staticmethod

📚 Documentation

• (user) Update documentation

v1.1.1

[1.1.1] - 2024-10-25

🐛 Bug Fixes

• (config) Revert exception type change
• (cache) Check if the model has been deleted already

⚙️ Miscellaneous Tasks

• (actions) Documentation requires test to pass

v1.1.0

[1.1.0] - 2024-10-25

🚀 Features

• (cache) Json session refresh method
• (config) Get workspace helper function
• (config) Togglrc workspace retrieve helper function

🐛 Bug Fixes

• (cache) Json session diff method not including completely new models

🚜 Refactor

• (config) Extract togglrc retriever

📚 Documentation

• (config) Add example to config helper functions
• (config) Add new helper functions

🧪 Testing

• (cache) Test session refresh method and diffing
• Validate more errors