klaviyo-api-sdk 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07e9fa20d14acf94cfb9d6d8b18185225fe2dcc8a030a624ce506c25164dae3a
-  data.tar.gz: 963c7743c608b629204421195ee04a5d7f0a255d312c6235a15859ed5a6d6903
+  metadata.gz: e468a8c419adf257cfad5d970c4782c7b734487dc4dfdf61964c44e6362a7d36
+  data.tar.gz: 15f37103fceb8a0ceea3cc2909591fe8182cc06e98e480f3e61a09cebf377853
 SHA512:
-  metadata.gz: fc3c75c12e23b8bd5c5312c5bbbd8b2e4ce9e95a0b3a5ec5f5e02a3085f517a1694eaab4e6476088c9eacca7f845162f82f1a73a6a9a12d61d6f855616b7356f
-  data.tar.gz: 8531e5a7221da3923dd2a6e7820f1eeb41eac2d9f1eb44b577cd216da8d26480d4ab7350bfdfc895285f473c74ba6108595e2645e1df02fbc6b466e7961a7829
+  metadata.gz: d783dcfeb784be68cd5e4a907b10797c31802e9c012651ff2d7a9d27467b4ce8760be6ba4353192e86dce0a8e3f66b79ed7edf9a550ba3e12b4371da61043a7b
+  data.tar.gz: b3dbee0c43b78aa56b0b076e2ce51c376938ef173565270a34f7d2095d3415922fe1b2dc16f49374daaf887ba6e2c848dcfc0332c57958b7c2320a29916f467c

data/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [3.0.0] - revision 2023-06-15
+### Added
+- Accounts API is now available, this will allow you to access information about the Klaviyo account associated with your API key.
+  - `getAccounts`
+  - `getAccount`
+  
+**Note:** You will need to generate a new API key with either the `Accounts` scope enabled or `Full Access` to use these endpoints.
+
+### Removed
+- All `client` endpoints - While you could potentially get this repo to work for frontend and use only these the client endpoints, this is bad practice.
+ Klaviyo has the much lighter weight `klaviyo.js` wrapper [which you can read about here.](https://developers.klaviyo.com/en/docs/introduction_to_the_klaviyo_object)
+  - `createClientEvent`
+  - `createClientProfile`
+  - `createClientSubscription`
+## [2.0.0] - 2023-04-06
+### Added
+- Profiles API now returns predictive analytics when calling `get_profile` and `get_profiles` by passing in `additional_fields_profile: ["predictive_analytics"]`.
+
+### Changed
+- Relationship endpoints that were previously grouped together are now split into related-resource-specific endpoints.
+
+### Migration Guide
+- To migrate to this latest version, all calls to relationship endpoints need to be updated, as in the following example:
+  - `get_campaign_relationships(id, "tags")` will become `get_campaign_relationships_tags(id)`.
+## [1.2.0] - 2023-02-22
+### Added
+- Campagins (which were previously in our Beta API/SDKs)
+
+### Changes
+- Profiles
+    - Fix longitude value in ProfileLocation type mapping
+- Flows
+    - Pagination changed from page offset to cursor
+
+## [1.1.0] - 2022-01-24
+### 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.1] - 2022-12-06
+### Changes
+- Support for cursor pagination
+    - Passing the `next` value from a paginated result to the following call via the `page_cursor` query string argument will now result in the cursor being parsed and set appropriately by the `ApiClient`.
+
+## [1.0.0] - 2022-10-19
+### Added
+- Initial release
+
+### Changes
+- Naming changes:
+    - Package name: klaviyo_sdk -> klaviyo-api-sdk
+    - Module name: KlaviyoBeta -> KlaviyoAPI
+    - Some functions have changed name
+- New resources and endpoints: 
+    - See API Changelog for full details