You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+33-1Lines changed: 33 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,10 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
8
8
NOTE: For more granular API-specific changes, please see our [API Changelog](https://developers.klaviyo.com/en/docs/changelog_)
9
9
10
+
## [5.0.0] - revision 2023-07-15
10
11
12
+
### Changed
13
+
14
+
- To override the client-level `api_key` for a specific request, you will now need to use the following new keyword arg: `_request_auth`
15
+
- previously, this keyword arg was called `api_client`
16
+
17
+
### Fixed
18
+
19
+
- Fixed errors that were occurring on requests using oneOf schemas
11
20
12
21
## [4.0.0] - revision 2023-07-15
22
+
13
23
### Added
24
+
14
25
- Back-In-stock APIs
15
26
- We have added support for subscribing profiles to back-in-stock notifications, for both email and SMS, using the new [create_back_in_stock_subscription](./README.md#create-back-in-stock-subscription) endpoint.
16
27
- New functionality to Campaigns API
@@ -20,6 +31,7 @@ NOTE: For more granular API-specific changes, please see our [API Changelog](htt
20
31
21
32
22
33
### Changed
34
+
23
35
- Relationship Standardization
24
36
- We are making a number of changes across endpoints to standardize how we handle [relationships](https://developers.klaviyo.com/en/docs/relationships_) in our APIs and leverage consistently typed objects across endpoints. For example, you can create a profile in our APIs in the same shape, regardless of whether you’re calling the profiles endpoint or the events endpoint.
25
37
- The changes include:
@@ -34,53 +46,70 @@ NOTE: For more granular API-specific changes, please see our [API Changelog](htt
34
46
35
47
36
48
### Removed
37
-
- We removed the `company_id` from the response for [get_template](./README.md#get-template) and [get_templates](./README.md#get-templates). If you need to obtain the company ID / public API key for an account, please use the [Accounts API](./README.md#accounts).
38
49
50
+
- We removed the `company_id` from the response for [get_template](./README.md#get-template) and [get_templates](./README.md#get-templates). If you need to obtain the company ID / public API key for an account, please use the [Accounts API](./README.md#accounts).
39
51
40
52
## [3.0.0] - revision 2023-06-15
53
+
41
54
### Added
55
+
42
56
- Accounts API is now available, this will allow you to access information about the Klaviyo account associated with your API key.
43
57
-`get_accounts`
44
58
-`get_account`
45
59
46
60
**Note:** You will need to generate a new API key with either the `Accounts` scope enabled or `Full Access` to use these endpoints.
47
61
48
62
### Changed
63
+
49
64
- The names of positional arguments have changed from `[resource_type]_id` to `id` (i.e. `campaign_id` to `id`) for some relationship endpoints. If keyword arguments were used instead of positional arguments for `[resource_type]_id` you might need to slightly refactor the code.
50
65
51
66
### Removed
67
+
52
68
- All `client` endpoint:
53
69
-`create_client_event`
54
70
-`create_client_profile`
55
71
-`create_client_subscription`
72
+
56
73
## [2.0.0] - 2023-04-06
74
+
57
75
### Added
76
+
58
77
- Profiles API now returns predictive analytics when calling `get_profile` and `get_profiles` by passing in `additional_fields_profile = ["predictive_analytics"]`.
59
78
60
79
### Changed
80
+
61
81
- 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.
62
82
63
83
### Migration Guide
84
+
64
85
- To migrate to this latest version, all calls to relationship endpoints need to be updated, as in the following example:
65
86
-`get_campaign_relationships(campaign_id, "tags")` will become `get_campaign_relationships_tags(campaign_id)`.
66
87
67
88
## [1.3.1] - 2023-03-09
89
+
68
90
### Added
91
+
69
92
- Added `page_size` support for paging through endpoints that return profiles.
70
93
71
94
## [1.2.1] - 2023-02-23
95
+
72
96
### Fixed
73
97
- Fixed a bug that caused paging through events to periodically fail.
74
98
75
99
## [1.2.0] - 2023-02-23
100
+
76
101
### Added
102
+
77
103
- Added support for Campaigns (which were previously in our Beta API/SDKs).
78
104
79
105
### Changed
106
+
80
107
- Pagination for Flows changed from page offset to cursor.
81
108
82
109
## [1.1.0] - 2023-01-25
110
+
83
111
### Added
112
+
84
113
- Added the following endpoints (which were previously in our Beta API/SDKs):
85
114
- Data Privacy
86
115
- All Tags endpoints, as well as the following related resource-specific endpoints:
@@ -89,10 +118,13 @@ NOTE: For more granular API-specific changes, please see our [API Changelog](htt
0 commit comments