Add information about the breaking changes to the changelog (or somewhere)

Question

Add information about the breaking changes to the changelog (or somewhere)

danieljuhl opened this issue 8 years ago · 5 comments

I fully understand that there is breaking changes in the latest version (v2.0.0) - but I can't find any place, where the breaking changes is outlined.

I have found some of them in the changelog (stuff that has been removed), but I don't know if that everything.

Please, add some information about ALL breaking changes, so we (clients/developers using the API) doesn't have to go through all the code.

Answer 1 · 2016-11-09T13:41:24.000Z

Apologies. This is coming.

Answer 2 · 2016-11-16T08:38:18.000Z

@aydrian any news? This is blocking safe upgrades.

Answer 3 · 2016-11-16T15:03:58.000Z

@danieljuhl I'm targeting end of my day tomorrow.

Out of curiosity, would you mind telling me which parts of the client library beyond transmissions you are using?

Answer 4 · 2016-11-17T14:02:58.000Z

Message events and suppression list

Answer 5 · 2016-11-17T16:30:30.000Z

Please have a look at PR #192. I have refactored the changelog. Between that and the examples/resource docs, you should be good.
At a high level, the Message Events wrapper did not change. You shouldn't see a problem.
For the Suppression List wrapper the method names were standardized:
search -> list
checkStatus -> get
removeStatus -> delete