Skip to content

Commit 2ba4b48

Browse files
authored
oneOf fix and api_key override kwarg change (#33)
* resolved oneOf issue and updated api_key override keyword-arg * version bump
1 parent cc9a337 commit 2ba4b48

File tree

541 files changed

+45413
-102087
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

541 files changed

+45413
-102087
lines changed

CHANGELOG.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
NOTE: For more granular API-specific changes, please see our [API Changelog](https://developers.klaviyo.com/en/docs/changelog_)
99

10+
## [5.0.0] - revision 2023-07-15
1011

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
1120

1221
## [4.0.0] - revision 2023-07-15
22+
1323
### Added
24+
1425
- Back-In-stock APIs
1526
- 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.
1627
- New functionality to Campaigns API
@@ -20,6 +31,7 @@ NOTE: For more granular API-specific changes, please see our [API Changelog](htt
2031

2132

2233
### Changed
34+
2335
- Relationship Standardization
2436
- 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.
2537
- The changes include:
@@ -34,53 +46,70 @@ NOTE: For more granular API-specific changes, please see our [API Changelog](htt
3446

3547

3648
### 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).
3849

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).
3951

4052
## [3.0.0] - revision 2023-06-15
53+
4154
### Added
55+
4256
- Accounts API is now available, this will allow you to access information about the Klaviyo account associated with your API key.
4357
- `get_accounts`
4458
- `get_account`
4559

4660
**Note:** You will need to generate a new API key with either the `Accounts` scope enabled or `Full Access` to use these endpoints.
4761

4862
### Changed
63+
4964
- 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.
5065

5166
### Removed
67+
5268
- All `client` endpoint:
5369
- `create_client_event`
5470
- `create_client_profile`
5571
- `create_client_subscription`
72+
5673
## [2.0.0] - 2023-04-06
74+
5775
### Added
76+
5877
- Profiles API now returns predictive analytics when calling `get_profile` and `get_profiles` by passing in `additional_fields_profile = ["predictive_analytics"]`.
5978

6079
### Changed
80+
6181
- 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.
6282

6383
### Migration Guide
84+
6485
- To migrate to this latest version, all calls to relationship endpoints need to be updated, as in the following example:
6586
- `get_campaign_relationships(campaign_id, "tags")` will become `get_campaign_relationships_tags(campaign_id)`.
6687

6788
## [1.3.1] - 2023-03-09
89+
6890
### Added
91+
6992
- Added `page_size` support for paging through endpoints that return profiles.
7093

7194
## [1.2.1] - 2023-02-23
95+
7296
### Fixed
7397
- Fixed a bug that caused paging through events to periodically fail.
7498

7599
## [1.2.0] - 2023-02-23
100+
76101
### Added
102+
77103
- Added support for Campaigns (which were previously in our Beta API/SDKs).
78104

79105
### Changed
106+
80107
- Pagination for Flows changed from page offset to cursor.
81108

82109
## [1.1.0] - 2023-01-25
110+
83111
### Added
112+
84113
- Added the following endpoints (which were previously in our Beta API/SDKs):
85114
- Data Privacy
86115
- 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
89118
- Get Segment Tags
90119

91120
## [1.0.0] - 2022-10-19
121+
92122
### Added
123+
93124
- Initial release
94125

95126
### Changed
127+
96128
- Namespace changes:
97129
- Pypi package name: `klaviyo–sdk-beta``klaviyo-api`
98130
- Module name: `klaviyo_sdk_beta``klaviyo_api`

0 commit comments

Comments
 (0)