diff options
| author | Avi Goldman <avrahamymgoldman@gmail.com> | 2016-06-27 16:11:10 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-06-27 16:11:10 -0400 |
| commit | 0746ce4e99e8a091dfbc5b7c40530dbaabb50197 (patch) | |
| tree | 93197183518a29193e8ae5d1a1e10b4af49e320e | |
| parent | 3aed142b23e74f05431a2b6eeb0c4a88140e811a (diff) | |
| download | php-sparkpost-0746ce4e99e8a091dfbc5b7c40530dbaabb50197.zip php-sparkpost-0746ce4e99e8a091dfbc5b7c40530dbaabb50197.tar.gz php-sparkpost-0746ce4e99e8a091dfbc5b7c40530dbaabb50197.tar.bz2 | |
Fad 3147 (#124)
* updated CHANGELOG.md
* added MIGRATION.md
| -rw-r--r-- | CHANGELOG.md | 7 | ||||
| -rw-r--r-- | MIGRATION.md | 23 |
2 files changed, 30 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 44fc4c1..61a467d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,12 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased][unreleased] +## [2.0.0] - 2016-06-24 +### Changed +- [#123](https://github.com/SparkPost/php-sparkpost/pull/123) Rewrote docs and updated composer name +- [#122](https://github.com/SparkPost/php-sparkpost/pull/122) Add transmission class and examples +- [#121](https://github.com/SparkPost/php-sparkpost/pull/121) Update base resource and tests + ## [1.2.1] - 2016-05-27 ### Fixed - [#111](https://github.com/SparkPost/php-sparkpost/pull/111) allow pass through of timeout setting in http config @@ -57,6 +63,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). - README now has proper code blocks denoting PHP language [unreleased]: https://github.com/sparkpost/php-sparkpost/compare/1.2.1...HEAD +[2.0.0]: https://github.com/sparkpost/php-sparkpost/compare/1.2.1...2.0.0 [1.2.1]: https://github.com/sparkpost/php-sparkpost/compare/1.2.0...1.2.1 [1.2.0]: https://github.com/sparkpost/php-sparkpost/compare/v1.1.0...1.2.0 [1.1.0]: https://github.com/sparkpost/php-sparkpost/compare/v1.0.3...v1.1.0 diff --git a/MIGRATION.md b/MIGRATION.md new file mode 100644 index 0000000..f57c6fb --- /dev/null +++ b/MIGRATION.md @@ -0,0 +1,23 @@ +# Migration Guide + +This is a guide to help you make the switch when the SparkPost PHP library changes major versions. + +## Migrating from 1.0 to 2.0 + +## Package name change +The composer package name has changed from `sparkpost/php-sparkpost` to `sparkpost/sparkpost` + +### No more setupUnwrapped +We replaced the idea of 'wrapping' API resources with a simple `request` function. To see it in action, check out this [example](https://github.com/SparkPost/php-sparkpost/tree/2.0.0#send-an-api-call-using-the-base-request-function). + +### `transmission` becomes `transmissions` +Transmission endpoints are now under `$sparky->transmissions` instead of `$sparky->transmission` to map more directly to the [API docs](https://developers.sparkpost.com/api/). + +* We no longer map parameters to the API - we simplified. Instead custom mapping, now set the payload to match the API docs. +* The exceptions to the previous statement are `cc` and `bcc`. They are helpers to make it easier to add cc and bcc recipients. [Example](https://github.com/SparkPost/php-sparkpost/tree/2.0.0#send-an-email-using-the-transmissions-endpoint) + +### Switched from Ivory Http Adapter to HTTPlug +Ivory Http Adapter was deprecated in favor fo HTTPlug. + +### Asynchronous support +We addeded in support for [asynchronous calls](https://github.com/SparkPost/php-sparkpost/tree/2.0.0#asynchronous) (assuming your client supports it).
\ No newline at end of file |