Skip to content
This repository has been archived by the owner on Mar 30, 2023. It is now read-only.

Latest commit

 

History

History
191 lines (114 loc) · 5.48 KB

CHANGELOG.md

File metadata and controls

191 lines (114 loc) · 5.48 KB

Change Log

All notable changes to this project will be documented in this file. Quaderno adheres to Semantic Versioning.

0.x Releases


Unreleased.

Changed

  • Resource structs (e.g. Contact) have been replaced by protocols (e.g. ContactResource).
  • ConnectionEntitlements has been replaced by Client.Entitlements.
  • Request works now with Foundation's URL instead of String.
  • Response now handles generic responses, instead of only records and collection of records.
  • Dependencies are now managed with Carthage instead of CocoaPods.

Added

  • Response supports now pagination, which is automatically parsed by Client whenever a request finishes.
  • Response supports now concrete error types through ErrorResponse.
  • Partial support for Evidences (see limitations in Quaderno's API documentation).
  • Support for macOS platform.

Removed

  • AccountCredentials has been removed. Use the JSON response of the request instead.

Fixed

  • Support for Swift 3.
  • PayableResource now support all available operations.

Released on 2016-01-04.

Changed

  • Authorization and Ping have been made internal, as they do not need to be public.
  • Explicit parameters for making payments and calculating taxes have been replaced with types:
    • PaymentData.
    • TransactionDetails.
  • Transaction has been renamed to TransactionType.

Removed

  • Encoding of requests are no longer customisable. We use JSON everywhere.

Unreleased.

Added

  • A Payable protocol for those resource that can be paid:
    • Expense
    • Invoice

Changed

  • fetchAccountCredentials has been renamed to account.

Removed

  • fetchConnectionEntitlements has been removed. The entitlements property in Ciient is now updated after completing every request.

Unreleased.

Added

  • A Tax resource for calculating taxes.

Unreleased.

Added

  • An Authorization resource for fetching account credentials.
  • A fetchAccountCredentials() function in Client.

Unreleased.

Added

  • A Deliverable protocol for those resources that support delivery operations:
    • Estimate.
    • Credit.
    • Invoice.

Changed

  • Resources are now implemented as struct instead of classes.

Fixed

  • Access control for resources. Some previously declared as internal are now public.

Unreleased.

Added

  • The remaining resources in Quaderno that supports CRUD operations:
    • Webhook.
    • Recurring.
    • Expense.
    • Estimate.
    • Credit.
    • Invoice.
    • Item.

Removed

  • Included HTML documentation. We rely now in the documentation generated automatically by CocoaDocs.

Unreleased.

Added

  • A function in Client to request resources.
  • The following protocols:
    • `Resource``: representing a resource in the API.
    • Request: defining how to request a particular resource.
    • Response: representing the responses returned by the service when a request finishes.
  • Two behaviours, based on the above protocols:
    • CRUD: providing a default implementation for creating CRUD requests.
    • SingleRequest: for resources implementing a single request.
  • A Contact resource adhering to the CRUD protocol.

Changed

  • Ping has been rewritten using the new interfaces.

Released on 2015-11-02. All issues associated with this release can be found in the library-modernisation milestone.

Removed

  • The RECQuadernoClient class.
  • All previous Objective-C code.

Fixed

  • Support for installing the framework using Cocoapods.

Added

  • A YAML file to add support for continuous integration using Travis CI.
  • A Client class, replacing the previous RECQuadernoClient class with the same functionality.

Changed

  • The project name, from QuadernoKit to Quaderno.
  • The networking library. Alamofire replaces AFNetworking.
  • Rules for ignoring files in Git.
  • The COPYRIGHT in all files with the latest date.
  • The README to include the new project structure.
  • The documentation is now generated with jazzy instead of appledoc.

Released on 2013-11-10.

Added