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.

Release 3.3.1

Release Notes - [3.3.1] (25/12/2023)

Summary

This release is focused on refactoring some of the code

Changelog

• Exceptions now inheirits from Exception instead BaseException
• Added header 'User-Agent' on requests headers
• import errors in squarecloud.__init__.py
• Update cli parameters and options descriptions

Breaking Changes

This release has no breaking changes.

Release 3.2.1

Release Notes - [3.2.1] (25/12/2023)

Summary

This release is focused on adding support for new endpoints and refactoring some of the code, as you can see below

Changelog

Features

• new Client.last_deploys method

• new Client.github_integration method

• new Client.set_custom_domain method

• new Client.domain_analytics method

• new Application.last_deploys method

• new Application.github_integration method

• new Application.set_custom_domain method

• new Application.domain_analytics method

• command added to CLI: squarecloud app <APP-ID> last-deploys

• command added to CLI: squarecloud app <APP-ID> github-integration <GITHUB-ACCESS-TOKEN>

• command added to CLI: squarecloud app <APP-ID> custom-domain <DOMAIN>

• command added to CLI: squarecloud app <APP-ID> domain analytics

Bug Fixes

• Resolved bug in the Request and Capture listeners system, when more than one application could access listeners from another application

Enhancements

• Pydantic Dataclasses Integration:

  • The default Python dataclasses have been replaced with pydantic dataclasses.
  • This enhancement brings advanced data type validation to ensure the correctness of data structures.

• Error handling refactored

  • Error handling has been refactored in http module.
  • Error messages have changed
  • New Exceptions have been added to support the new endpoints

Breaking Changes

This release has no breaking changes.

Additional Notes

This release was supposed to come out yesterday (12/25/2023), but unexpected events made that impossible, so, Merry belated Christmas 🎄

Release 3.1.3

Some changes were made due to a change in api responses

Release 3.1.0

This release adds CLI feature.

Release 3.0.3

Fixed an error caused by a change in the UPLOAD route response

v3.0.2

This version fix an error raised when upload an application without description and subdomain.