TRAP-2056 Adding required filter to amenities (#125)

* Adding required filter to amenities

Author: stephaniepinero

CHANGELOG.md

@@ -3,6 +3,12 @@
 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).
 
+## [4.24.0] - 2022-07-07
+
+## Changed
+
+- Added `required` filter to `get_amenities()`.
+
 ## [4.23.0] - 2021-01-03
 
 ## Changed

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='VacasaConnect',
-    version='4.23.0',
+    version='4.24.0',
     description='A Python 3.6+ SDK for the connect.vacasa.com API.',
     packages=['vacasa.connect'],
     url='https://github.com/Vacasa/python-vacasa-connect-sdk',

vacasa/connect/connect.py

@@ -443,7 +443,8 @@ def get_amenities(self,
                       params: dict = None,
                       include_categories: bool = False,
                       include_content: bool = False,
-                      include_options: bool = False
+                      include_options: bool = False,
+                      filter_required = False
                       ):
         """Retrieve a master list of all amenities
 
@@ -465,6 +466,9 @@ def get_amenities(self,
         if include_options:
             params = self._add_include_param(params, 'options')
 
+        if filter_required:
+            params['filter[required]'] = True
+
         return self._iterate_pages(url, headers, params)
 
     def get_amenities_groups(self, params: dict = None):