klaviyo-api-sdk 8.0.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d912ad2ed63157f996b3b1c86210a305ee7092d6077d08b6c50b483cb31cbdc7
-  data.tar.gz: bedf4d29446dba67879342fc3e2cce6f21d11562c8e09436d32eea324b5c09df
+  metadata.gz: cd86c7db8242a1cdf18cc7edb186fcec7d291228640c74dcd3e674b28b047f2e
+  data.tar.gz: 83e1c70d807961915812f20fce5e8b6753f2e48fa6b0da6f132ed33792d74041
 SHA512:
-  metadata.gz: 2fde6d2d6eac6b0e4d5e830d309647e07f9a63d01d0ec2692cdcc3e28db9b51051a13e51a760a7e263db65335affa5d12b53334841db685f16b02e28cf9f57e5
-  data.tar.gz: 7f49417324ac9b44e00ef1a0fdc129ffda3453704cb10eee975b0f1a2dbb5e8a8412503aeac69e6378f14f8a522784482bec7698a0c9ff2bfc14fbf5bee47f44
+  metadata.gz: 9a26b5b4602dfb7afbe49a203e9cbd03f1b330bcbcc51278f1b1b4593f30b5df1bf30840673667f648acc436669cc6b11ee78eee1d2c1d272f83fc33551cafbd
+  data.tar.gz: d50c64595fa55e97b02d9fdba9fbad0d95159b3a65894ed79f9b09f36657d54192e745c2dab769d3d0446064f504b2ae4424e9420c1bc243d32a9019b53c01e2

data/CHANGELOG.md

@@ -0,0 +1,289 @@
+# 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).
+
+## [10.0.0] - 2024-10-15
+### Added
+- Universal Content API
+  - Read, update, and delete universal content
+  - For more information, see our [Universal Content API overview](https://developers.klaviyo.com/en/reference/universal_content_api_overview)
+- Form Reporting API
+  - Query form performance
+  - For more information, see our [Reporting API overview](https://developers.klaviyo.com/en/reference/reporting_api_overview#forms)
+- Segment Reporting API
+  - Query segment growth data
+  - For more information, see our [Reporting API overview](https://developers.klaviyo.com/en/reference/reporting_api_overview#segments)
+- Reviews API
+  - Get and list reviews
+  - For more information, see our [Reviews API overview](https://developers.klaviyo.com/en/reference/reviews_api_overview)
+- Tracking Settings API
+  - Read and update the Tracking Settings for an account (Account -> Settings -> UTM Tracking in UI)
+  - For more information, see our [Tracking Settings API documentation](https://developers.klaviyo.com/en/reference/get_tracking_settings)
+- Metric Properties API
+  - Access the properties for a given metric (e.g. "Placed Order")
+  - For more information, see our [Metric Properties API documentation](https://developers.klaviyo.com/en/reference/get_metric_property)
+- Suppress/Unsuppress profile job APIs
+  - Monitor the status of jobs created by Suppress Profiles and Unsuppress Profiles requests
+  - For more information, see our [Suppress Profiles Job API documentation](https://developers.klaviyo.com/en/reference/get_bulk_suppress_profiles_job)
+
+### Changed
+- `Profiles.create_or_update_profile` has been updated to an enhanced identity resolution processor to better follow the Klaviyo identity resolution identifier priority order
+- Added support for `$locale` property for `Profiles`
+- Numerous methods have been renamed as part of a large renaming effort - the old methods are now deprecated aliases
+
+## [9.0.0] - revision 2024-07-15
+### Added
+- Added several method aliases based on previous operation IDs
+
+## [8.0.0] - revision 2024-07-15
+
+### Added
+
+ - Forms API
+  - New `KlaviyoAPI::Forms` class with methods to get forms, form versions and relationships.
+ - Webhooks API
+  - new `KlaviyoAPI::Webooks` class containing CRUD operations for webhooks.
+
+### Changed
+ - `ProfilesApi.subscribe()`
+  - Added `historical_import` flag for importing historically consented profiles can now be optionally supplied in the payload for the Subscribe Profiles endpoint.
+  - When using this flag, a consented_at date must be provided and must be in the past.
+
+
+## [7.1.0] - revision 2024-06-15
+
+### Added
+  - Segments Api
+    - New create segment endpoint `KlaviyoAPI::Segments.create_segment()`.
+    - New delete segment endpoint `KlaviyoAPI::Segments.delete_segment()`.
+    - Updated exisiting segments endpoints to include the segment definition
+    - For more information, see our [Segments API overview](https://developers.klaviyo.com/en/reference/segments_api_overview).
+
+  - Flows Api
+    - New delete flows endpoint `KlaviyoAPI::Flows.delete_flow()`
+
+
+## [7.0.0] - revision 2024-05-15
+
+### Added
+
+  - Bulk Create Events API 
+    - We have added support for creating events in bulk via the `KlaviyoAPI::Event.bulk_create_events` method
+  - Create multiple events for new and existing profiles and/or update profile properties in a single API call. For more information, see our [Events API overview](https://developers.klaviyo.com/en/reference/events_api_overview).
+
+### Changed
+
+  - Accounts Api
+    - `KlaviyoAPI::Accounts.get_accounts` and `KlaviyoAPI::Accounts.get_account` have been updated to return the account's locale, e.g. `en-US`.
+
+  - **Breaking** Subscribe API Synchronous Validation Improved
+    - To provide better feedback for handling SMS subscriptions, we’ve added improved validation behavior to `KlaviyoAPI::Profiles.subscribe_profiles` method. In prior revisions, such requests may appear as 202s but will fail to update SMS consent. To handle this issue, 400 validation errors are returned for the following cases
+      1. If a profile is subscribed to SMS marketing and [age-gating is enabled](https://help.klaviyo.com/hc/en-us/articles/4408311712667) but age_gated_date_of_birth is not provided, or the DOB does not meet the region's requirements.
+      2. If the account does not have a sending number in the phone number’s region.
+      3. If the phone number is in a region not supported by Klaviyo.
+      4. If consented_at is set and the list or global setting is double opt-in.
+  - Use `KLAVIYO_API_REVISION` as the env var for controlling which Klaviyo API to call, instead of `API_REVISION`.  However, `API_REVISION` is a fallback, to avoid making this a breaking change
+
+
+## [6.0.0] - revision 2024-02-15
+
+### Added: 
+
+- New `Reporting` allows you to request campaign and flow performance data that you can view in the Klaviyo UI.
+
+- `campaign_values_query`
+  - Request campaign analytics data, for example, a campaign performance report on the open rate over the past 30 days.
+
+- `flow_values_query`
+  - Request flow analytics data, for example, a flow performance report on the revenue per recipient value over the past 3 months.
+
+- `flow_series_query`
+  - Fetch flow series data for a specific interval and timeframe, for example, a flow performance report on weekly click rates  over the past 12 months.
+
+
+- New `Profiles` endpoint allows you to create or update a profile with a set of profile attributes.
+
+  - `create_or_update_profile`
+    - This endpoint operates synchronously and offers an upsert pattern similar to the [v1/v2 Identify API](https://developers.klaviyo.com/en/docs/apis_comparison_chart).
+
+### Changed:
+	
+- Removed the $attribution field from event_properties in get_event and  get_events (breaking change).
+	
+  - To include this data in your request, add include=attributions to your request.
+
+
+## [5.1.0] - revision 2023-12-15
+### Added
+- New Endpoints: Bulk Profile Imports:
+    - `Profiles.spawn_bulk_profile_import_job`
+    - `Profiles.get_bulk_profile_import_job`
+    - `Profiles.get_bulk_profile_import_jobs`
+    - `Profiles.get_bulk_profile_import_job_lists`
+    - `Profiles.get_bulk_profile_import_job_profiles`
+    - `Profiles.get_bulk_profile_import_job_import_errors`
+    - `Profiles.get_bulk_profile_import_job_relationships_profiles`
+    - `Profiles.get_bulk_profile_import_job_relationships_lists`
+### Changed
+- The `relationships` field of Profiles.subscribe_profiles payload is now optional. (see [subscribe_profiles reference](https://developers.klaviyo.com/en/reference/subscribe_profiles) for details).
+
+## [5.0.0] - revision 2023-10-15
+
+### Added
+
+- Support for returning list suppressions via the [/profiles endpoint](https://developers.klaviyo.com/en/reference/get_profiles)
+
+  Rules for suppression [filtering](https://developers.klaviyo.com/en/docs/filtering_):  
+
+    - You may not mix-and-match list and global filters  
+    - You may only specify a single date filter  
+    - You may or may not specify a reason  
+    - You must specify a list_id to filter on any list suppression properties
+
+  Examples:
+
+  - To return profiles who were suppressed after a certain date:  
+    `{filter: "greater-than(subscriptions.email.marketing.suppression.timestamp,2023-03-01T01:00:00Z)`
+  - To return profiles who were suppressed from a specific list after a certain date:  
+    `{filter: "greater-than(subscriptions.email.marketing.list_suppressions.timestamp,2023-03-01T01:00:00Z),equals(subscriptions.email.marketing.list_suppressions.list_id,\"LIST_ID\"")`
+  - To return all profiles who were suppressed for a specific reason after a certain date:  
+    `{"filter: 'greater-than(subscriptions.email.marketing.suppression.timestamp,2023-03-01T01:00:00Z),equals(subscriptions.email.marketing.suppression.reason\"user_suppressed\"")`
+
+- Optionally retrieve subscription status on Get List Profiles, Get Segment Profiles, Get Event Profile
+
+  -  Use `{additional_fields_profile = ["subscriptions"]}` on these endpoints to include subscription information.
+
+## Changes
+
+- Subscription object not returned by default on Get Profile / Get Profiles
+
+  -  The subscription object is no longer returned by default with get profile(s) requests. However, it can be included by adding  `{additional_fields_profile = ["subscriptions"]}s` to the request. This change will allow us to  provide a more performant experience when making requests to Get Profiles without including the subscriptions object.
+
+ -  Profile Subscription Fields Renamed
+
+  - In the interest of providing more clarity and information on the subscription object, we have renamed several fields, and added several as well. This will provide more context on a contact's subscriptions and consent, as well as boolean fields to see who you can or cannot message.
+    
+  For SMSMarketing:
+
+  - `timestamp` is now `consent_timestamp`
+  - `last_updated` is a new field that mirrors `consent_timestamp`
+  - `can_receive_sms_marketing` is a new field which is `True` if the profile is consented for SMS 
+
+  For EmailMarketing:
+
+  - `timestamp` is now `consent_timestamp`
+  - `can_receive_email_marketing` is True if the profile does not have a global suppression
+  - `suppressions` is now `suppression`
+  - `last_updated` is a new field that is the most recent of all the dates on the object
+
+## [4.2.0] - revision 2023-09-15
+### Added
+
+- `Images` API
+  - We now support the following operations to work with images:
+    - `get_image`
+    - `get_images`
+    - `update_image`
+    - `upload_image_from_file`
+    - `upload_image_from_url`
+- `Coupons` API
+  - We now support CRUD operations for both Coupons and Coupon Codes
+  - Check out [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api) for more information.
+- Additional filtering/sorting option for Lists and Segments: `joined_group_at`
+- New profile merge endpoint: `Profiles.merge_profiles`
+- Increased the maximum page size limit for List and Segment Profile Relationship Endpoints to 1000
+
+## [4.1.0] - revision 2023-08-15
+### Added
+- Flow Message Templates
+- You can now retrieve the templates associated with flow messages using `Flows.get_flow_message_template()` or `Flows.get_flow_message_relationships_template()` . You’re also able to include the template HTML for a flow message using `Flows.get_flow_message(id, {"include": ["template"]})`.
+- Create or Update Push Tokens
+- We have added an endpoint to create push tokens, `Profiles.create_push_token()`. This endpoint can be used to migrate profiles and their push tokens from another platform to Klaviyo. If you’re looking to register push tokens from users’ devices, please use our mobile SDKs.
+
+## [4.0.0] - revision 2023-07-15
+### Added
+- Back-In-stock APIs
+  - 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.  
+- New functionality to Campaigns API
+  - CRUD support for SMS campaigns is now available
+  - You can now also retrieve all messages for a campaign to determine performance data on campaigns where you're running A/B tests
+    - To support this functionality, we introduced a relationship between [campaigns and campaign messages](./README.md#get-campaign-relationships-campaign-messages), and between [campaign messages and templates](./README.md#get-campaign-message-relationships-template)
+
+
+### Changed
+- Relationship Standardization
+  - 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.
+  - The changes include:
+    - Updating 1:1 relationships to use singular tense and an object (instead of plural and an array) 
+      - example: for [get_flow_action](./README.md#get-flow-action), if you want to use the `include` param, you would set `include=` to `"flow"` (instead of `"flows"`)
+    - Moving related object IDs from the attributes payload to relationships
+      - example: The format for the [body](https://developers.klaviyo.com/en/reference/create_tag) of [create_tag](./README.md#create-tag) has changed, with `tag_group_id` previously at `data.attributes.tag_group_id` being removed and replaced by a `data` object containing `type`+`id` and located at `data.relationships.tag-group.data`.
+    - Specifying a relationship between two Klaviyo objects to allow for improved consistency and greater interoperability across endpoints 
+      - example: for [create_event](./README.md#create-event), you can now create/update a profile for an event in the same way you would when using the profiles API directly
+  - NOTE: The examples for the above relationship changes are illustrative, not comprehensive. For a complete list of ALL the endpoints that have changed and exactly how, please refer to our latest [API Changelog](https://developers.klaviyo.com/en/docs/changelog_#revision-2023-07-15)
+- For [get_campaigns](./README.md#get-campaigns) endpoint, `filter` param is now required, to, at minimum, filter on `messages.channel`
+
+
+### Removed
+- 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).- 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).
+
+## [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.
+  - `get_accounts`
+  - `get_account`
+  
+**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
+  - `create_client_event`
+  - `create_client_profile`
+  - `create_client_subscription`
+## [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