Skip to content

Commit 0746ce4

Browse files
authored
Fad 3147 (SparkPost#124)
* updated CHANGELOG.md * added MIGRATION.md
1 parent 3aed142 commit 0746ce4

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
44

55
## [Unreleased][unreleased]
66

7+
## [2.0.0] - 2016-06-24
8+
### Changed
9+
- [#123](https://github.com/SparkPost/php-sparkpost/pull/123) Rewrote docs and updated composer name
10+
- [#122](https://github.com/SparkPost/php-sparkpost/pull/122) Add transmission class and examples
11+
- [#121](https://github.com/SparkPost/php-sparkpost/pull/121) Update base resource and tests
12+
713
## [1.2.1] - 2016-05-27
814
### Fixed
915
- [#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/).
5763
- README now has proper code blocks denoting PHP language
5864

5965
[unreleased]: https://github.com/sparkpost/php-sparkpost/compare/1.2.1...HEAD
66+
[2.0.0]: https://github.com/sparkpost/php-sparkpost/compare/1.2.1...2.0.0
6067
[1.2.1]: https://github.com/sparkpost/php-sparkpost/compare/1.2.0...1.2.1
6168
[1.2.0]: https://github.com/sparkpost/php-sparkpost/compare/v1.1.0...1.2.0
6269
[1.1.0]: https://github.com/sparkpost/php-sparkpost/compare/v1.0.3...v1.1.0

MIGRATION.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Migration Guide
2+
3+
This is a guide to help you make the switch when the SparkPost PHP library changes major versions.
4+
5+
## Migrating from 1.0 to 2.0
6+
7+
## Package name change
8+
The composer package name has changed from `sparkpost/php-sparkpost` to `sparkpost/sparkpost`
9+
10+
### No more setupUnwrapped
11+
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).
12+
13+
### `transmission` becomes `transmissions`
14+
Transmission endpoints are now under `$sparky->transmissions` instead of `$sparky->transmission` to map more directly to the [API docs](https://developers.sparkpost.com/api/).
15+
16+
* We no longer map parameters to the API - we simplified. Instead custom mapping, now set the payload to match the API docs.
17+
* 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)
18+
19+
### Switched from Ivory Http Adapter to HTTPlug
20+
Ivory Http Adapter was deprecated in favor fo HTTPlug.
21+
22+
### Asynchronous support
23+
We addeded in support for [asynchronous calls](https://github.com/SparkPost/php-sparkpost/tree/2.0.0#asynchronous) (assuming your client supports it).

0 commit comments

Comments
 (0)