Merge pull request #15 from klaviyo/20230406

20230406 release: relationship endpoints split and new profile field

Author: jon-batscha

CHANGELOG.md

@@ -1,46 +1,56 @@
 # Changelog
 
-NOTE: For more granular API-specific changes, please see our [API Changelog](https://developers.klaviyo.com/en/docs/changelog_)
-
-## 1.3.0
-
-### Added
-- `page_size`:  you can now set page_size when paging through endpoints that return profiles
+All notable changes to this project will be documented in this file.
 
-## 1.2.1
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-### Bug Fixes
-- Fixed bug that caused paging through events to periodically fail
+NOTE: For more granular API-specific changes, please see our [API Changelog](https://developers.klaviyo.com/en/docs/changelog_)
 
+## [2.0.0] - 2023-04-06
+### Changed
+- Relationship endpoints that were previously grouped together are now split into related-resource-specific endpoints. This means that all relationship endpoints have new function names.
+- Profiles API can now return predictive analytics when calling `getProfile` and `getProfiles`, by passing in `$additional_fields_profile=["predictive_analytics"]`.
 
-## 1.2.0
+### Migration Guide
+- To migrate to this latest version, all calls to relationship endpoints need to be updated, as in the following example:
+  - `getCampaignRelationships($id, "tags")` will become `getCampaignRelationshipsTags($id)`.
+- Because PHP is sensitive to the ordering of optional args, this is a breaking change to all `getProfile` and `getProfiles` calls that use optional args. Please refer to `getProfile` and `getProfiles` in the README for more details on ordering.
+  - Specifically, because params are passed in alphabetical order, even if you do not intend to use this new param, you will need to shift over the params by one by passing in `$additional_fields_profile=NULL`.
 
+## [1.3.0] - 2023-03-01
 ### Added
-- Campaigns (which were previously in our Beta API/SDKs)
-
-### Changes
-- Flows
-    - Pagination changed from page offset to cursor
+- Added `page_size` support for paging through endpoints that return profiles.
 
-## 1.1.0
+## [1.2.1] - 2023-02-23
+### Fixed
+- Fixed a bug that caused paging through events to periodically fail.
 
-  - Added the following endpoints (which were previously in our Beta API/SDKs):
-    - Data Privacy
-    - All Tags endpoints, as well as the following related resource-specific endpoints:
-      - Get Flow Tags
-      - Get List Tags
-      - Get Segment Tags
-
-## 1.0.0
-
-  * Initial release
+## [1.2.0] - 2023-02-23
+### Added
+- Added support for Campaigns (which were previously in our Beta API/SDKs).
 
-  Differences between 1.0.0 and BETA:
+### Changed
+- Pagination for Flows changed from page offset to cursor.
 
-  - Naming changes
-    - Packagist package name: `klaviyo/sdk-beta` → `klaviyo/api`
-    - Namespace: `KlaviyoBeta` → `KlaviyoAPI`
-    - client name: `Client` → `KlaviyoAPI`
-    - Client variable name in readme examples: `$client` → `$klaviyo`
-    - Some functions have changed name
-  - Parameter ordering: The order of params has changed; you will need to update these for your existing implementation to work
+## [1.1.0] - 2023-01-25
+### Added
+- Added the following endpoints (which were previously in our Beta API/SDKs):
+  - Data Privacy
+  - All Tags endpoints, as well as the following related resource-specific endpoints:
+    - Get Flow Tags
+    - Get List Tags
+    - Get Segment Tags
+
+## [1.0.0] - 2023-10-19
+### Added
+- Initial release
+
+### Changed
+- Naming changes:
+  - Packagist package name: `klaviyo/sdk-beta` → `klaviyo/api`
+  - Namespace: `KlaviyoBeta` → `KlaviyoAPI`
+  - client name: `Client` → `KlaviyoAPI`
+  - Client variable name in readme examples: `$client` → `$klaviyo`
+  - Some functions have changed name
+- Parameter ordering: The order of params has changed; you will need to update these for your existing implementation to work