Skip to content

Latest commit

 

History

History
49 lines (45 loc) · 2.02 KB

v3-upgrade.md

File metadata and controls

49 lines (45 loc) · 2.02 KB
Raw

Changes included in v3

Breaking changes

  • Minimum go version is now v1.17
  • All service actions accept a context.Context as first parameter.
  • Methods service actions now return pointers instead of struct literals.
  • Invoice service actions now return pointers instead of struct literals.
  • Mandates service actions now return pointers instead of struct literals.
  • Payments service actions now return pointers instead of struct literals.
  • Get permissions now accepts a direct reference to a PermissionGrant struct instead of a string.
  • All services now return an instance of mollie.Response as first value changing the signature from (value, error) to (response, value, error).
  • All data structures are changed to the following naming patterns
    • For Lists: {Value}List
    • For Options: {Value}Options | {Value}ListOptions
    • For Links: {Value}Links | {Value}ListLinks
  • Params now contain the full name of the value they contain. Ex. pID now is payment.
  • Methods and its references is now PaymentMethods to make its purpose clear.
  • Services that now return the full response object as part of the returned values (the response is always the first value of n returned):
    • Captures
    • Chargebacks
    • Customers
    • Invoices
    • Mandates
    • Miscellaneous
    • Onboarding
    • Partners
    • Orders
    • Organizations
    • PaymentLinks
    • PaymentMethods
    • Payments
    • Permissions
    • Profiles
    • Refunds
    • Settlements
    • Shipments
    • Subscriptions
  • Errors now use the mollie.BaseError type to provide better error reporting.
  • The type mollie.Error is removed from the codebase.
  • PaginationLinks changed to pointers.

Other changes

  • All the tests are now using testify.Suite
  • Removed the example tests as it was not accurate nor well implemented.
  • Remove CHANGELOG.md as the releases now provide a more accurate report of changes.
  • Some typos were fixed on several query serializable param tags
  • Client now contains helpers for the used http actions (get, post, patch & delete) to simplify the way the requests are dispatched.