|
1 | 1 | # Changelog |
2 | 2 |
|
3 | | -NOTE: For more granular API-specific changes, please see our [API Changelog](https://developers.klaviyo.com/en/docs/changelog_) |
4 | | - |
5 | | -## 2.0.0 |
6 | | -Breaking Changes: |
7 | | - - Relationship endpoints that were previously grouped together are now split into related-resource-specific endpoints |
8 | | - - To migrate to this latest version, all calls to relationship endpoints need to be updated, as in the following example: |
9 | | - - `get_campaign_relationships(campaign_id, "tags")` will become `get_campaign_relationships_tags(campaign_id)` |
10 | | - |
| 3 | +All notable changes to this project will be documented in this file. |
11 | 4 |
|
12 | | -Additive updates: |
13 | | -- Our Profiles API can now return predictive analytics when calling get_profile and get_profiles, by passing in the following keyword arg to those methods: |
14 | | - - `additional_fields_profile = "predictive_analytics"` |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
15 | 7 |
|
| 8 | +NOTE: For more granular API-specific changes, please see our [API Changelog](https://developers.klaviyo.com/en/docs/changelog_) |
16 | 9 |
|
17 | | -## 1.3.0 |
| 10 | +## [Unreleased] |
18 | 11 |
|
| 12 | +## [2.0.0] - 2023-04-06 |
19 | 13 | ### Added |
20 | | -- `page_size`: you can now set page_size when paging through endpoints that return profiles |
21 | | - |
22 | | -## 1.2.1 |
| 14 | +- Profiles API now returns predictive analytics when calling `get_profile` and `get_profiles` by passing in `additional_fields_profile = "predictive_analytics"`. |
23 | 15 |
|
24 | | -### Bug Fixes |
25 | | -- Fixed bug that caused paging through events to periodically fail |
| 16 | +### Changed |
| 17 | +- Relationship endpoints that were previously grouped together are now split into related-resource-specific endpoints. |
26 | 18 |
|
27 | | -## 1.2.0 |
| 19 | +### Migration Guide |
| 20 | +- To migrate to this latest version, all calls to relationship endpoints need to be updated, as in the following example: |
| 21 | + - `get_campaign_relationships(campaign_id, "tags")` will become `get_campaign_relationships_tags(campaign_id)`. |
28 | 22 |
|
| 23 | +## [1.3.1] - 2023-03-09 |
29 | 24 | ### Added |
30 | | -- Campaigns (which were previously in our Beta API/SDKs) |
31 | | - |
32 | | -### Changes |
33 | | -- Flows |
34 | | - - Pagination changed from page offset to cursor |
| 25 | +- Added `page_size` support for paging through endpoints that return profiles. |
35 | 26 |
|
36 | | -## 1.1.0 |
| 27 | +## [1.2.1] - 2023-02-23 |
| 28 | +### Fixed |
| 29 | +- Fixed a bug that caused paging through events to periodically fail. |
37 | 30 |
|
38 | | - - Added the following endpoints (which were previously in our Beta API/SDKs): |
39 | | - - Data Privacy |
40 | | - - All Tags endpoints, as well as the following related resource-specific endpoints: |
41 | | - - Get Flow Tags |
42 | | - - Get List Tags |
43 | | - - Get Segment Tags |
44 | | - |
45 | | -## 1.0.0 |
46 | | - |
47 | | - * Initial release |
48 | | - |
49 | | - Differences between 1.0.0 and BETA: |
| 31 | +## [1.2.0] - 2023-02-23 |
| 32 | +### Added |
| 33 | +- Added support for Campaigns (which were previously in our Beta API/SDKs). |
50 | 34 |
|
51 | | - - Namespace changes |
52 | | - - Pypi package name: `klaviyo–sdk-beta` → `klaviyo-api` |
53 | | - - Module name: `klaviyo_sdk_beta` → `klaviyo_api` |
54 | | - - client name: `Client` → `KlaviyoAPI` |
55 | | - - Client variable name in readme examples: `client` → `klaviyo` |
56 | | - - Some functions have changed name |
57 | | - - New resources and endpoints: see [API Changelog](https://developers.klaviyo.com/en/docs/changelog_) for full details |
| 35 | +### Changed |
| 36 | +- Pagination for Flows changed from page offset to cursor. |
58 | 37 |
|
| 38 | +## [1.1.0] - 2023-01-25 |
| 39 | +### Added |
| 40 | +- Added the following endpoints (which were previously in our Beta API/SDKs): |
| 41 | + - Data Privacy |
| 42 | + - All Tags endpoints, as well as the following related resource-specific endpoints: |
| 43 | + - Get Flow Tags |
| 44 | + - Get List Tags |
| 45 | + - Get Segment Tags |
| 46 | + |
| 47 | +## [1.0.0] - 2022-10-19 |
| 48 | +### Added |
| 49 | +- Initial release |
| 50 | + |
| 51 | +### Changed |
| 52 | +- Namespace changes: |
| 53 | + - Pypi package name: `klaviyo–sdk-beta` → `klaviyo-api` |
| 54 | + - Module name: `klaviyo_sdk_beta` → `klaviyo_api` |
| 55 | + - client name: `Client` → `KlaviyoAPI` |
| 56 | + - Client variable name in readme examples: `client` → `klaviyo` |
| 57 | + - Some functions have changed name |
| 58 | +- New resources and endpoints: see [API Changelog](https://developers.klaviyo.com/en/docs/changelog_) for full details |
0 commit comments