Release 3.7.2

Release Notes - [3.7.2] (24/08/2024)

🚀 Features

• ✨ added "download" method to Backup class

🚨 Breaking Changes

This release has no breaking changes.

Release 3.7.1

Release Notes - [3.7.1] (23/08/2024)

🐛 Bug Fixes

• 📦 added missing package: "typing_extensions"

🚨 Breaking Changes

This release has no breaking changes.

3.7.0

Release Notes - [3.7.0] (16/08/2024)

📜 Summary

This release introduces input validation enhancements across the codebase, improvements in error logging, and updates to versioning.

🚀 Features

• Applied @validate decorator to various methods in Application and Client classes to enforce input validation.

✨ Enhancements

• Replaced find_spec('pydantic') with USING_PYDANTIC for better conditional imports.
• Added additional error logging in HTTPClient to improve error tracking.

🚨 Breaking Changes

• This release has no breaking changes.

✏️ Additional Notes

• Optional Dependency: Pydantic is now an optional dependency. You can enable Pydantic support by installing it separately.
  To use Pydantic, install it with:

  pip install "squarecloud-api[pydantic]"

Release 3.6.2

Release Notes - [3.6.2] (12/08/2024)

📜 Summary

This release Introduced adaptations to allow the installation of Pydantic to be optional. This change allows users to choose whether or not to install Pydantic based on their project requirements.

✏️ Adicional notes

to install squarecloud-api with pydantic, use pip install "squarecloud-api[pydantic]"

3.6.0

Release Notes - [3.6.0] (10/07/2024)

🚀 Features

• Implemented DNS records and file moving features in HTTP client.
• Added methods for DNS records and file moving in application client.
• Introduced new endpoints for DNS records and file moving.

♻️ Refactored

• Refactored code to update endpoint signatures and improve code organization.

✏️ Additional Notes

• Added tests for DNS records and file moving features. (795ddcb)
• Updated examples. (c610857)

🚨 Breaking Changes

• Renamed BackupData to Backup and introduced BackupInfo in data.py. (d8400b8)

Release 3.5.1

Release Notes - [3.5.1] (03/07/2024)

📜 Summary

This release includes updates to dependencies, improvements to the CLI and core classes, and fixes for log messages and test cases.

🚀 Features

• Added new dependencies: DeployData and DomainAnalytics imports in squarecloud/__init__.py.

📦 Dependencies

• Updated aiohttp from 3.9.3 to 3.9.5.

🐛 Bug Fixes

• Core Classes:

  • Fixed return value of __repr__ method in Application class (squarecloud/app.py).

• CLI:

  • Updated table title and rows to use app.name instead of app.tag in squarecloud/cli/app.py.
  • Fixed table headers and rows in app_list and app_group to remove unnecessary fields in squarecloud/cli/app.py.

• Logging:

  • Fixed log message to use app.name instead of app.tag in CaptureListenerManager (squarecloud/listeners/capture_listener.py).

• Tests:

  • Added imports and assertions in test_app.py to check the return types of various methods.

✨ Enhancements

• Type Hints:
  • Added ParamSpec and TypeVar for type hints in Client class (squarecloud/client.py).

🚨 Breaking Changes

• This release has no breaking changes.

Release 3.5.0

Release Notes - [3.5.0] (30/06/2024)

📜 Summary

🚀 Features

• Refactor application tag references to name for better consistency and clarity.

🐛 Bug Fixes

• Fixed import order in squarecloud/__init__.py to maintain PEP8 compliance.
• Corrected the handling of 'lang' and 'name' fields in squarecloud/client.py.

✨ Enhancements

• Updated CLI tables to display app names instead of tags for improved readability.
• Revised data classes in squarecloud/data.py to use 'name' instead of 'tag' and removed 'isWebsite'.
• Improved file info class in squarecloud/data.py to set a default size of 0.0.

🚨 Breaking Changes

• Replaced all instances of 'tag' with 'name' in the Application class, which may affect existing implementations relying on the 'tag' property.

✏️ Additional Notes

• Ensure that all references to the application tag are updated to the new name property to avoid any inconsistencies or runtime errors.

3.4.1

Release Notes - [3.4.1] (09/06/2024)

🐛 Bug Fixes

Fixed cli root command error, the "squarecloud" command wasn't in
pyproject.toml scripts

3.4.0

Release Notes - [3.4.0] (01/06/2024)

🚀 Features

• Now, in certain methods, you have the option to incorporate the extra argument to
  send metadata to listeners. If the annotation of this parameter in the listener is
  a pydantic model, and the metadata provided through extra, the SDK will attempt to
  convert this metadata into that model.

• Added logs to listeners, when a listener is called some useful information are
  provided, like the endpoint of this listener and this return

🐛 Bug Fixes

• Fixed typing dues to api changes

✨ Enhancements

• Previously there was an API to create and manage configuration files, but it was very
  simple and not versatile. For this reason, this API has been modified, now config files
  are class objects and has been added some features, such as serialization and deserialization.

  More about usage can be viewed
  at this link

  ⚠️ The method create_config_file can still be used, but it has been marked as
  deprecated, and will be removed in the future.

• added field app_id to FileInfo object

📝 Docs

• 📚 update config file creation example

• 📚 update request listener example

• 🗑️ removed statistics examples

• 📝 update docstrings

🚨 Breaking Changes

• Endpoint.user_me renamed to Endpoint.user;

• removed Endpoint.user_info;

• removed Client.user_info;

• renamed Client.me to Client.user.

• removed support to statistics endpoint:

  • Client.statistics method;
  • Endpoint.statistics class method;
  • CLI sub-command statistics;

Release 3.3.2

Release Notes - [3.3.2] (18/02/2024)

Summary

This release is focused on fix some bugs

Changelog

Bug Fixes

• fixed incorrect path formatting in Client.app_files_list;
• fixed RequestListenerManager.remove_request_listener and RequestListenerManager.clear_request_listeners
• Fixed bug where logs were not returned correctly in Client.get_logs

Breaking Changes

This release has no breaking changes.