remove deprecated fields (#110)

* remove deprecated fields

* update version

* add docs and update readme

---------

Co-authored-by: Keegan Cordeiro <[email protected]>

Author: corke2013

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.

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)

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):

predicthq/version.py

@@ -1 +1 @@
-__version__ = "4.3.0"
+__version__ = "5.0.0"