|
1 | 1 | # Changelog |
2 | 2 | All notable changes to this project will be documented in this file. |
3 | 3 |
|
| 4 | +## [16.0.0] - revision 2025-01-15 |
| 5 | +### Added |
| 6 | +- Get and Update Reviews APIs |
| 7 | + - Retrieve all reviews with `ReviewsApi.getReviews` or return a review with a specified ID using the `ReviewsApi.getReview` endpoint. |
| 8 | + - Manage your reviews programmatically with the `ReviewsApi.updateReview` 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. |
| 9 | +- Get and Create Flows APIs |
| 10 | + - Return a flow with the given flow ID using the `FlowsApi.getFlow` endpoint. |
| 11 | + - Create a new flow with the `FlowsApi.createFlow` endpoint. |
| 12 | +- Campaigns API |
| 13 | + - Manage the images for your campaigns with a new set of endpoints for the `Campaigns` API, including: `getImageForCampaignMessage`, `getImageIdForCampaignMessage`, and `updateImageForCampaignMessage`. |
| 14 | +### Changed |
| 15 | +- **Breaking:** Subscription endpoints required field |
| 16 | + - Calls to `ProfilesApi.bulkSubscribeProfiles` and `ProfilesApi.unsubscribeProfiles` now require the `subscriptions` field, which grants or revokes consent for the indicated message types on the specified channels, such as email or sms. |
| 17 | +- **Breaking:** Campaigns API push notification support |
| 18 | + - The Campaigns API now supports the push notification channel. |
| 19 | + - Support for push notifications includes **significant changes** to the following endpoints: `getCampaigns`, `getCampaign`, `createCampaign`, `updateCampaign`, `createCampaignClone`, `getMessagesForCampaign`, `getCampaignMessage`, `updateCampaignMessage`, `getCampaignForCampaignMessage`, `getCampaignIdForCampaignMessage`. |
| 20 | + - 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. |
| 21 | +- **Breaking:** Pagination updates |
| 22 | + - The `FlowsApi.getMessagesForFlowAction` and `FlowsApi.getActionIdForFlowMessage` endpoints have been updated from offset pagination to cursor pagination. |
| 23 | +- Create Template API |
| 24 | + - The `TemplatesApi.createTemplate` endpoint now supports the creation of hybrid templates when `editorType` is `USER_DRAGGABLE` and hybrid template HTML is included. |
| 25 | +- Profiles API |
| 26 | + - The following server-side APIs have been updated to an enhanced identity resolution processor to better follow the Klaviyo identity resolution identifier priority order. |
| 27 | + - `ProfilesApi.createProfile` |
| 28 | + - `ProfilesApi.updateProfile` |
| 29 | +- **Breaking:** Renamed models |
| 30 | + - `AudiencesSubObject` -> `Audiences` |
| 31 | + - `GetCampaignTagRelationshipListResponseCollection` -> `GetCampaignTagsRelationshipsResponseCollection` |
| 32 | + - `GetCatalogCategoryItemListResponseCollection` -> `GetCatalogCategoryItemsRelationshipsResponseCollection` |
| 33 | + - `GetCatalogCategoryItemListResponseCollectionDataInner` -> `GetCatalogCategoryItemsRelationshipsResponseCollectionDataInner` |
| 34 | + - `GetCatalogItemCategoryListResponseCollection` -> `GetCatalogItemCategoriesRelationshipsResponseCollection` |
| 35 | + - `GetCatalogItemCategoryListResponseCollectionDataInner` -> `GetCatalogItemCategoriesRelationshipsResponseCollectionDataInner` |
| 36 | + - `GetCouponRelationshipCouponCodesListResponseCollection` -> `GetCouponCodesRelationshipsResponseCollection` |
| 37 | + - `GetCouponRelationshipCouponCodesListResponseCollectionDataInner` -> `GetCouponCodesRelationshipsResponseCollectionDataInner` |
| 38 | + - `GetEventMetricRelationshipResponseData` -> `GetEventResponseCollectionCompoundDocumentDataInnerAllOfRelationshipsMetricData` |
| 39 | + - `GetFlowResponseCompoundDocument` -> `GetFlowResponseCompoundDocument` |
| 40 | + - `GetFlowTagRelationshipListResponseCollection` -> `GetFlowTagsRelationshipsResponseCollection` |
| 41 | + - `GetFormFormVersionRelationshipsResponseCollection` -> `GetFormVersionsRelationshipsResponseCollection` |
| 42 | + - `GetListRelationshipsResponseCollection` -> `GetListProfilesRelationshipsResponseCollection` |
| 43 | + - `GetListTagRelationshipListResponseCollection` -> `GetListTagsRelationshipsResponseCollection` |
| 44 | + - `GetProfileImportJobProfileRelationshipsResponseCollection` -> `GetProfileBulkImportJobProfilesRelationshipsResponseCollection` |
| 45 | + - `GetProfileListRelationshipsResponseCollection` -> `GetProfileListsRelationshipsResponseCollection` |
| 46 | + - `GetProfileSegmentRelationshipsResponseCollection` -> `GetProfileSegmentsRelationshipsResponseCollection` |
| 47 | + - `GetReviewResponseDTO20240715CollectionCompoundDocument` -> `GetReviewResponseDTOCollectionCompoundDocument` |
| 48 | + - `GetReviewResponseDTO20240715CollectionCompoundDocumentDataInner` -> `GetReviewResponseDTOCollectionCompoundDocumentDataInner` |
| 49 | + - `GetReviewResponseDTO20240715CollectionCompoundDocumentDataInnerAllOfRelationships` -> `GetReviewResponseDTOCollectionCompoundDocumentDataInnerAllOfRelationships` |
| 50 | + - `GetReviewResponseDTO20240715CollectionCompoundDocumentDataInnerAllOfRelationshipsEvents` -> `GetReviewResponseDTOCollectionCompoundDocumentDataInnerAllOfRelationshipsEvents` |
| 51 | + - `GetReviewResponseDTO20240715CollectionCompoundDocumentDataInnerAllOfRelationshipsEventsDataInner` -> `GetReviewResponseDTOCollectionCompoundDocumentDataInnerAllOfRelationshipsEventsDataInner` |
| 52 | + - `GetReviewResponseDTO20240715CompoundDocument` -> `GetReviewResponseDTOCompoundDocument` |
| 53 | + - `GetReviewResponseDTO20240715CompoundDocument` -> `GetReviewResponseDTOCompoundDocument` |
| 54 | + - `GetSegmentTagRelationshipListResponseCollection` -> `GetSegmentTagsRelationshipsResponseCollection` |
| 55 | + - `ReviewResponseDTO20240715ObjectResource` -> `ReviewResponseDTOObjectResource` |
| 56 | + - `ReviewResponseDTO20240715ObjectResourceAttributes` -> `ReviewResponseDTOObjectResourceAttributes` |
| 57 | + |
4 | 58 | ## [15.0.0] - revision 2024-10-15 |
5 | 59 | ### Added |
6 | 60 | - Transactional SMS Content |
|
0 commit comments