Klaviyo-api

Changed
- **Breaking:** Minimum Python version is now 3.7
- Lazy importing now happens automatically. No need to use the `KLAVIYO_PYTHON_SDK_LAZY_IMPORTS` environment variable.
- **Breaking:** Renamed classes
- `BaseEventCreateQueryResourceObject` -> `BaseEventCreateQueryBulkEntryResourceObject`
- `BaseEventCreateQueryResourceObjectAttributes` -> `BaseEventCreateQueryBulkEntryResourceObjectAttributes`
- `UnionFilter` -> `FlowDefinitionProfileFilter`
- `UnionConditionGroup` -> `FlowDefinitionProfileFilterConditionGroupsInner`

Added
- Get and Update Reviews APIs
- Retrieve all reviews with `Reviews.get_reviews` or return a review with a specified ID using the `Reviews.get_review` endpoint.
- Manage your reviews programmatically with the `Reviews.update_review` endpoint, which allows you to change the status of a review, such as to reject or approve it. This endpoint modifies the moderation status of a review based on the provided review ID and status.
- Get and Create Flows APIs
- Return a flow with the given flow ID using the `Flows.get_flow` endpoint.
- Create a new flow with the `Flows.create_flow` endpoint.
- Campaigns API
- Manage the images for your campaigns with a new set of endpoints for the `Campaigns` API, including: `get_image_for_campaign_message`, `get_image_id_for_campaign_message`, and `update_image_for_campaign_message`.
Changed
- **Breaking:** Subscription endpoints required field
- Calls to `Profiles.bulk_subscribe_profiles` and `Profiles.unsubscribe_profiles` now require the `subscriptions` field, which grants or revokes consent for the indicated message types on the specified channels, such as email or sms.
- **Breaking:** Campaigns API push notification support
- The Campaigns API now supports the push notification channel.
- Support for push notifications includes **significant changes** to the following endpoints: `get_campaigns`, `get_campaign`, `create_campaign`, `update_campaign`, `create_campaign_clone`, `get_messages_for_campaign`, `get_campaign_message`, `update_campaign_message`, `get_campaign_for_campaign_message`, `get_campaign_id_for_campaign_message`.
- We recommend that you review the [Campaigns API Overview](https://developers.klaviyo.com/en/reference/campaigns_api_overview) for more detailed information about changes to the structure and responses of these endpoints.
- **Breaking:** Pagination updates
- The `Flows.get_messages_for_flow_action` and `Flows.get_action_id_for_flow_message` endpoints have been updated from offset pagination to cursor pagination.
- Create Template API
- The `Templates.create_template` endpoint now supports the creation of hybrid templates when `editor_type` is `USER_DRAGGABLE` and hybrid template HTML is included.
- Profiles API
- The following server-side APIs have been updated to an enhanced identity resolution processor to better follow the Klaviyo identity resolution identifier priority order.
- `Profiles.create_profile`
- `Profiles.update_profile`
- **Breaking:** Renamed models
- `AudiencesSubObject` -> `Audiences`
- `GetCampaignTagRelationshipListResponseCollection` -> `GetCampaignTagsRelationshipsResponseCollection`
- `GetCatalogCategoryItemListResponseCollection` -> `GetCatalogCategoryItemsRelationshipsResponseCollection`
- `GetCatalogCategoryItemListResponseCollectionDataInner` -> `GetCatalogCategoryItemsRelationshipsResponseCollectionDataInner`
- `GetCatalogItemCategoryListResponseCollection` -> `GetCatalogItemCategoriesRelationshipsResponseCollection`
- `GetCatalogItemCategoryListResponseCollectionDataInner` -> `GetCatalogItemCategoriesRelationshipsResponseCollectionDataInner`
- `GetCouponRelationshipCouponCodesListResponseCollection` -> `GetCouponCodesRelationshipsResponseCollection`
- `GetCouponRelationshipCouponCodesListResponseCollectionDataInner` -> `GetCouponCodesRelationshipsResponseCollectionDataInner`
- `GetEventMetricRelationshipResponseData` -> `GetEventResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsMetricData`
- `GetFlowResponseCompoundDocument` -> `GetFlowResponseCompoundDocument`
- `GetFlowTagRelationshipListResponseCollection` -> `GetFlowTagsRelationshipsResponseCollection`
- `GetFormFormVersionRelationshipsResponseCollection` -> `GetFormVersionsRelationshipsResponseCollection`
- `GetListRelationshipsResponseCollection` -> `GetListProfilesRelationshipsResponseCollection`
- `GetListTagRelationshipListResponseCollection` -> `GetListTagsRelationshipsResponseCollection`
- `GetProfileImportJobProfileRelationshipsResponseCollection` -> `GetProfileBulkImportJobProfilesRelationshipsResponseCollection`
- `GetProfileListRelationshipsResponseCollection` -> `GetProfileListsRelationshipsResponseCollection`
- `GetProfileSegmentRelationshipsResponseCollection` -> `GetProfileSegmentsRelationshipsResponseCollection`
- `GetReviewResponseDTO20240715CollectionCompoundDocument` -> `GetReviewResponseDTOCollectionCompoundDocument`
- `GetReviewResponseDTO20240715CollectionCompoundDocumentDataInner` -> `GetReviewResponseDTOCollectionCompoundDocumentDataInner`
- `GetReviewResponseDTO20240715CollectionCompoundDocumentDataInnerAllOfRelationships` -> `GetReviewResponseDTOCollectionCompoundDocumentDataInnerAllOfRelationships`
- `GetReviewResponseDTO20240715CollectionCompoundDocumentDataInnerAllOfRelationshipsEvents` -> `GetReviewResponseDTOCollectionCompoundDocumentDataInnerAllOfRelationshipsEvents`
- `GetReviewResponseDTO20240715CollectionCompoundDocumentDataInnerAllOfRelationshipsEventsDataInner` -> `GetReviewResponseDTOCollectionCompoundDocumentDataInnerAllOfRelationshipsEventsDataInner`
- `GetReviewResponseDTO20240715CompoundDocument` -> `GetReviewResponseDTOCompoundDocument`
- `GetReviewResponseDTO20240715CompoundDocument` -> `GetReviewResponseDTOCompoundDocument`
- `GetSegmentTagRelationshipListResponseCollection` -> `GetSegmentTagsRelationshipsResponseCollection`
- `ReviewResponseDTO20240715ObjectResource` -> `ReviewResponseDTOObjectResource`
- `ReviewResponseDTO20240715ObjectResourceAttributes` -> `ReviewResponseDTOObjectResourceAttributes`

Changed
- **Breaking:** New `RetryWithExponentialBackoff` class for smart retries to replace the `tenacity` retry decorator that wraps each API method.
- **Breaking:** Renamed models:
- `GetCampaignMessagesRelationshipListResponseCollection` -> `GetCampaignMessagesRelationshipsResponseCollection`
- `GetCampaignMessagesRelationshipListResponseCollectionDataInner` -> `GetCampaignMessagesRelationshipsResponseCollectionDataInner`
- `GetTagGroupTagRelationshipsResponseCollection` -> `GetTagGroupTagsRelationshipsResponseCollection`
- `GetTagGroupTagRelationshipsResponseCollectionDataInner` -> `GetListListResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsTagsDataInner`
- `GetTagTagGroupRelationshipsResponse` -> `GetTagGroupRelationshipResponse`
- `GetTagTagGroupRelationshipsResponseData` -> `GetTagResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsTagGroupData`
- `GetCouponCodeRelationshipCouponResponse` -> `GetCouponCodeCouponRelationshipResponse`
- `GetCouponCodeRelationshipCouponResponseData` -> `GetCouponCodeCouponRelationshipResponseData`
- `GetFlowMessageFlowActionRelationshipResponse` -> `GetFlowMessageActionRelationshipResponse`
- `GetMetricPropertyRelationshipMetricResponse` -> `GetMetricPropertyMetricRelationshipResponse`
- `GetMetricPropertyRelationshipMetricResponseData` -> `GetEventMetricRelationshipResponseData`
- `GetMetricRelationshipMetricPropertyResponseCollection` -> `GetMetricPropertiesRelationshipsResponseCollection`
- `GetMetricRelationshipMetricPropertyResponseCollectionDataInner` -> `GetMetricPropertiesRelationshipsResponseCollectionDataInner`
- `GetProfileImportJobListRelationshipsResponseCollection` -> `GetProfileBulkImportJobListsRelationshipsResponseCollection`

Added
- Lazy imports (optional)
- Set `KLAVIYO_PYTHON_SDK_LAZY_IMPORTS` environment variable to `true` to use lazy imports, which will reduce initial load time of library
- Note that using this option may break imports from `openapi_client`
- See [README](https://github.com/klaviyo/klaviyo-api-python-internal/blob/main/README.md#lazy-imports) for more details
Changed
- **Breaking:** renamed several models:
- `GetCampaignMessageTemplateRelationshipListResponse` -> `GetCampaignMessageTemplateRelationshipResponse`
- `GetListFlowTriggersRelationshipResponseCollection` -> `GetListFlowTriggersRelationshipsResponseCollection`
- `GetMetricFlowTriggersRelationshipResponseCollection` -> `GetMetricFlowTriggersRelationshipsResponseCollection`
- `PostListCreateResponseDataRelationshipsFlowTriggers` -> `GetMetricResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsFlowTriggers`
- `GetMetricFlowTriggersRelationshipResponseCollectionDataInner` -> `GetMetricResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsFlowTriggersDataInner`

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

Fixed
- **Breaking**
- Fixed types in several DTO classes