Skip to content

1.0.0

Compare
Choose a tag to compare
@jcwillox jcwillox released this 05 Apr 06:30
· 19 commits to main since this release

This is a major release and the first official production release. I've kept breaking changes to a minimum however most of the core has been rewritten so there will be breaking changes for some users. I've also published a docs site.

🚨 Breaking Changes

  • Replaced transaction.format_desc() with the property transaction.long_description
  • Replaced ModelBase.raw with ModelBase._raw_response
  • Various methods has their properties reordered and some properties are now explility keyword args
  • WebhookLog.response_code and WebhookLog.response_body merged into WebhookLog.response object
  • Renamed WebhookLog.delivery_status to WebhookLog.status
  • Methods that returned an empty dict (or really a 204 response) now return True
  • Parameter for transactions() was renamed from account_id to account and is now the first positional argument
  • Replaced PaginatedList.count with PaginatedList.__len__ so it can now be used as len(paginated_accounts)
  • PaginatedList was refactored into models and the import path has changed
  • Replaced some global constants with enums AccountType and TransactionStatus
  • Replaced webhook_id with webhook for ping, logs and delete methods

⚡ Features

  • Created a docs site, examples and code reference are available over there.
  • Full API support (we now deserialise everything the API provides)
    • Added support for categories
    • Added support for tags
    • Added missing fields e.g. ownership_type, hold_info, round_up, cashback, card_purchase_method.
    • Added enums
  • Asynchronous Client Support
  • Improved internal documentation
  • Fields that previously required an id as a string now also accept their corresponding objects and will extract the id automatically.
  • Maintainability has also been considerably improved by adding workflows, tests, and rewriting/reorganising the codebase.

Full Changelog: 0.3.2...1.0.0