From 896a1d0734bae3e61e2ec04063894554f0680e90 Mon Sep 17 00:00:00 2001 From: Keegan Cordeiro Date: Wed, 7 May 2025 14:50:11 +1200 Subject: [PATCH 1/3] remove deprecated fields --- predicthq/endpoints/v1/beam/schemas.py | 5 ----- predicthq/version.py | 2 +- 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/predicthq/endpoints/v1/beam/schemas.py b/predicthq/endpoints/v1/beam/schemas.py index 8c2d156..232662a 100644 --- a/predicthq/endpoints/v1/beam/schemas.py +++ b/predicthq/endpoints/v1/beam/schemas.py @@ -162,11 +162,6 @@ class CorrelationResult(BaseModel): remainder: Optional[float] = None impact_significance: str impact_significance_score: Optional[int] = None - features: dict - phq_impact_sum: int - phq_spend_sum: int - phq_attendance_sum: int - phq_rank_count: int class CorrelationResultSet(BeamPaginationResultSet): diff --git a/predicthq/version.py b/predicthq/version.py index 111dc91..ecdb1ce 100644 --- a/predicthq/version.py +++ b/predicthq/version.py @@ -1 +1 @@ -__version__ = "4.3.0" +__version__ = "4.4.0" From b1af8464c1970817744e97b4943bca56b0350d42 Mon Sep 17 00:00:00 2001 From: Keegan Cordeiro Date: Wed, 7 May 2025 14:54:10 +1200 Subject: [PATCH 2/3] update version --- predicthq/version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/predicthq/version.py b/predicthq/version.py index ecdb1ce..ba7be38 100644 --- a/predicthq/version.py +++ b/predicthq/version.py @@ -1 +1 @@ -__version__ = "4.4.0" +__version__ = "5.0.0" From a1565c0df932df2898a1ec4f0c792d5ff8606ef6 Mon Sep 17 00:00:00 2001 From: Keegan Cordeiro Date: Wed, 14 May 2025 10:41:18 +1200 Subject: [PATCH 3/3] add docs and update readme --- README.md | 2 ++ docs/V5_Breaking_Changes.md | 10 ++++++++++ 2 files changed, 12 insertions(+) create mode 100644 docs/V5_Breaking_Changes.md diff --git a/README.md b/README.md index eef2f3f..5352979 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,8 @@ If you are migrating to version 3.0.0 or above from an earlier version, please c If you are migrating to version 4.0.0 or above from an earlier version, please check the [V4 breaking changes details](./docs/V4_Breaking_Changes.md). +If you are migrating to version 5.0.0 or above from an earlier version, please check the [V5 breaking changes details](./docs/V5_Breaking_Changes.md). + ## Usage We support all the endpoints available in our API. diff --git a/docs/V5_Breaking_Changes.md b/docs/V5_Breaking_Changes.md new file mode 100644 index 0000000..89933dd --- /dev/null +++ b/docs/V5_Breaking_Changes.md @@ -0,0 +1,10 @@ +# V5 breaking changes details + +V5 removes the following fields from the Beam correlation results response; +* features +* phq_impact_sum +* phq_spend_sum +* phq_attendance_sum +* phq_rank_count + +It is recommended to query features directly from [Features API](https://docs.predicthq.com/api/features/get-features)