klaviyo-api-sdk 17.0.0 → 19.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13d8ac69c9b6abf4e7c6faa6daa65bada73f70b263ab8447e9652382535d0b28
-  data.tar.gz: 1d192afcce1a13abc2b9bdd1c40de36db8cf9705b64afa89e19f8e1d52325397
+  metadata.gz: '09d04608e3c0ef9731a1ad22106a8f61845e6ab90fdd7452286c38de994ab5c8'
+  data.tar.gz: d5e36232b202996f3fdb2bdaf385988cf6cc48b4278086a40b2e030f4384bab1
 SHA512:
-  metadata.gz: 85afcc0796fc7899b2b97d9e02d4803ac366c4b22e3a58454ba6d8054d6e399d4b282122dc200dd7bb49b1fc2c9546fd9a65bb3ae42ce13f49f9f1c20fd3d5bb
-  data.tar.gz: 99be1312f1056c0b551f9ecdb936fd0b844ead0a915fc93dcbd318c375d84de4a02fc5243f4896000dcf3e15e58af920a7010c947a1414ed53000e3560470e9d
+  metadata.gz: ca13c4bf97b9fa88e098d37128022196f4af97355bc48f1bfed4a16c66c4c6c940406b3b509dd5817628152ada5ba0ae1157f33cd78e6b0574470aa0b78edb13
+  data.tar.gz: 76444d9bf6da288c774927958eef8dc564e303f3ea7b12ab1c16663478e1627bf236d58489441e49345e6a1015587d8edf642e9fefcfc8161fe86f3bc8b3e368

data/CHANGELOG.md

@@ -4,6 +4,72 @@ 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).
 
+## [19.0.0] - revision 2026-10-15
+### Added
+- Brands API
+  - Create, read, update and delete brand logos, colors, buttons and social groups, e.g. `KlaviyoAPI::Brands.create_brand_logo`, `KlaviyoAPI::Brands.get_brand_color`, `KlaviyoAPI::Brands.update_brand_button`, `KlaviyoAPI::Brands.delete_brand_social_group`.
+  - Read and update brand voice with `KlaviyoAPI::Brands.get_brand_voice` and `KlaviyoAPI::Brands.update_brand_voice`.
+  - Read and update brand email defaults with `KlaviyoAPI::Brands.get_brand_email_defaults`, `KlaviyoAPI::Brands.get_brand_email_default` and `KlaviyoAPI::Brands.update_brand_email_default`.
+  - Requires the `brands:read` and `brands:write` scopes.
+- Text Messaging API
+  - Create and retrieve senders with `KlaviyoAPI::TextMessaging.create_text_messaging_sender`, `KlaviyoAPI::TextMessaging.get_text_messaging_senders` and `KlaviyoAPI::TextMessaging.get_text_messaging_sender`.
+  - Track and resubmit sender registrations with `KlaviyoAPI::TextMessaging.get_text_messaging_sender_registration` and `KlaviyoAPI::TextMessaging.create_text_messaging_sender_registration`.
+  - Create and retrieve your account's text messaging configuration with `KlaviyoAPI::TextMessaging.create_text_messaging_configuration` and `KlaviyoAPI::TextMessaging.get_text_messaging_configuration`.
+  - Requires the `sender-config:read` and `sender-config:write` scopes.
+  - For more information, see our [Text Messaging API overview](https://developers.klaviyo.com/en/reference/text_messaging_api_overview).
+- Templates API
+  - New send test email endpoint `KlaviyoAPI::Templates.create_template_preview_send_job` sends a test email of a template to one or more recipients. Requires the `templates:write` scope.
+- Billing Usage API
+  - Read your account's current-period metered usage against plan caps with `KlaviyoAPI::BillingUsage.list_billing_usage` and `KlaviyoAPI::BillingUsage.get_billing_usage`. Requires the `usage:read` scope.
+- Translations API
+  - List, retrieve, create, update and delete translations with `KlaviyoAPI::Translations.get_translations`, `KlaviyoAPI::Translations.get_translation`, `KlaviyoAPI::Translations.create_translation`, `KlaviyoAPI::Translations.update_translation` and `KlaviyoAPI::Translations.delete_translation`.
+  - New relationship endpoints retrieve the campaign variation, flow message, email template or template universal content associated with a translation.
+- Forms API
+  - New update form endpoint `KlaviyoAPI::Forms.update_form`.
+  - New publish and unpublish endpoints `KlaviyoAPI::Forms.publish_form` and `KlaviyoAPI::Forms.unpublish_form`.
+- Flows API
+  - New create flow action endpoint `KlaviyoAPI::Flows.create_flow_action`. Place the new action after an existing action, before an existing action, or as the first action in a flow that has none. Requires the `flows:write` scope.
+- Universal Content API
+  - New clone endpoint `KlaviyoAPI::Templates.clone_universal_content`. Requires the `templates:write` scope.
+- Campaigns API
+  - The campaign audience, campaign variation and campaign scheduling endpoints are now generally available, including scheduling one message or all messages in a campaign.
+  - `KlaviyoAPI::Campaigns.create_campaign` now accepts a partial structure. Send a campaign with only some of its audiences, messages and variations and add the rest with the individual endpoints, or still send the full structure in one request.
+### Changed
+- **Breaking:** Campaigns API now uses the omnichannel model
+  - Affects `get_campaigns`, `get_campaign`, `create_campaign`, `update_campaign`, `create_campaign_clone`, and the campaign message endpoints including `get_campaign_message` and `update_campaign_message`. Request and response shapes have been replaced.
+  - A campaign is now a container with defaults for send timezone, send strategy and exit conditions. It has one or more audiences, and each audience has one or more messages.
+  - A campaign no longer has a channel, and `get_campaigns` no longer requires a channel filter.
+  - Each message belongs to one audience and sends on one channel. Each message has one variation, which holds the channel-specific content. A/B tests are not supported.
+  - The relationship from a campaign message to its campaign now returns the omnichannel campaign.
+  - If you used the omnichannel beta, request and response shapes are unchanged. The `include=campaign` parameter on the campaign message endpoints is fixed.
+  - For more information, see our [Campaigns API overview](https://developers.klaviyo.com/en/reference/campaigns_api_overview).
+- **Breaking:** Universal Content blocks and sections have a new `display_options` shape
+  - Universal content now supports all block types and sections, where only seven block types were supported before.
+  - If you read or write `display_options` through `get_all_universal_content`, `get_universal_content`, `create_universal_content`, `update_universal_content` or `delete_universal_content`, update your code.
+  - For more information, see our [Universal Content API overview](https://developers.klaviyo.com/en/reference/universal_content_api_overview).
+
+## [18.0.0] - revision 2026-07-15
+### Added
+- Custom Objects API
+  - Full CRUD support across four groups of endpoints:
+    - Object Types: `CustomObjects.create_object_type`, `CustomObjects.get_object_type`, `CustomObjects.get_object_types`, and `CustomObjects.delete_object_type`.
+    - Object Schemas: `CustomObjects.create_object_schema`, `CustomObjects.get_object_schema`, and `CustomObjects.update_object_schema`, plus schema versions via `CustomObjects.get_current_schema_for_object_type`, `CustomObjects.get_draft_schema_for_object_type`, and `CustomObjects.get_schema_versions_for_object_type`.
+    - Source Mappings: `CustomObjects.get_source_mapping`, `CustomObjects.update_source_mapping`, `CustomObjects.get_source_mapping_for_object_schema`, and `CustomObjects.get_source_mapping_id_for_object_schema`.
+    - Object Records: `CustomObjects.get_object_record`, `CustomObjects.get_records_for_object_type`, `CustomObjects.get_record_ids_for_object_type`, and `CustomObjects.bulk_delete_object_records`.
+- Conversations API
+  - Added support for creating conversation messages with `Conversations.create_conversation_message`.
+- Client API
+  - Added `Client.get_client_ip_allowlist` to retrieve your account's client-side IP allowlist.
+- Flows API
+  - Added `Flows.delete_flow_action` to remove an action from a flow.
+### Changed
+- **Breaking:** Conversations API
+  - Conversation endpoints are now plural — e.g. `Profiles.get_conversation_for_profile` is now `Profiles.get_conversations_for_profile` (and `Profiles.get_conversation_id_for_profile` is now `Profiles.get_conversation_ids_for_profile`), as well as the relevant relationship methods and parameters.
+  - Response shapes are now lists, instead of single objects.
+- Events API
+  - Added a new `backfill` flag on `Events.create_event` & `Events.bulk_create_events`, which records historical events without triggering flows.
+  - `Events.get_events` now returns events with unresolvable metrics by default, matching `Events.get_event`. Use the new `has(metric)` filter to exclude them.
+
 ## [17.0.0] - revision 2026-04-15
 ### Added
 - Conversations API