Fix category sectors param typo (#33)

* fix missing await in code snippet

* bump version to 1.0.1

* fix typo in categories parameters

* fix wrong spelling of sectors parameters in categories endpoint docs

* fix tests for new spelling of sectors

Author: Nacho Maiz

bavapi/client.py

@@ -830,7 +830,7 @@ async def brandscape_data(
     async def categories(
         self,
         name: Optional[str] = None,
-        sector: OptionalListOr[int] = None,
+        sectors: OptionalListOr[int] = None,
         *,
         category_id: Optional[int] = None,
         filters: OptionalFiltersOrMapping[_filters.CategoriesFilters] = None,
@@ -855,7 +855,7 @@ async def categories(
         ----------
         name : str, optional
             Search categories by name, default None
-        sector : int or list[int], optional
+        sectors : int or list[int], optional
             Filter categories by sector ID, default None
         category_id : int, optional
             Fount category ID, default None
@@ -905,7 +905,7 @@ async def categories(
         filters = _filters.CategoriesFilters.ensure(
             filters,
             name=name,
-            sector=sector,
+            sectors=sectors,
         )
 
         query = Query.ensure(

bavapi/filters.py

@@ -372,7 +372,7 @@ class CategoriesFilters(FountFilters):
 
     Attributes
     ----------
-    sector : int or list[int], optional
+    sectors : int or list[int], optional
         Fount sector ID or list of sector IDs, default None
 
     Other Parameters
@@ -381,7 +381,7 @@ class CategoriesFilters(FountFilters):
         Request items that have been updated since the specified date, default None
     """
 
-    sector: OptionalListOr[int] = None
+    sectors: OptionalListOr[int] = None
 
 
 class CitiesFilters(FountFilters):

bavapi/sync.py

@@ -785,7 +785,7 @@ async def brandscape_data(
 async def categories(
     token: str,
     name: Optional[str] = None,
-    sector: OptionalListOr[int] = None,
+    sectors: OptionalListOr[int] = None,
     *,
     category_id: Optional[int] = None,
     filters: OptionalFiltersOrMapping[_filters.CategoriesFilters] = None,
@@ -814,7 +814,7 @@ async def categories(
         WPPBAV Fount API token
     name : str, optional
         Search categories by name, default None
-    sector : int or list[int], optional
+    sectors : int or list[int], optional
         Filter categories by sector ID, default 0
     category_id : int, optional
         Fount category ID, default None
@@ -885,7 +885,7 @@ async def categories(
     ) as client:
         return await client.categories(
             name,
-            sector,
+            sectors,
             category_id=category_id,
             filters=filters,
             fields=fields,

docs/endpoints/categories.md

@@ -33,7 +33,7 @@ For more information on available filters and functionality, see the Fount docum
 
 These filters are available directly within the function/method:
 
-- Positional filters: `name`, `sector`
+- Positional filters: `name`, `sectors`
 - Keyword filters: `category_id`
 
 For other filters, passing a `CategoriesFilters` instance to the `filters` parameter is required.

docs/release-notes.md

@@ -2,6 +2,12 @@
 
 ## `1.0`
 
+### `1.0.1` (2024-01-19)
+
+#### Fix
+
+- :bug: Fixed typo in `sectors` (previously spelled `sector`) parameter for `categories` endpoint queries.
+
 ### `1.0.0` (2024-01-04)
 
 #### Feature

docs/usage/advanced.md

@@ -66,7 +66,7 @@ from bavapi import Query
 from bavapi.filters import FountFilters
 
 async with bavapi.Client("TOKEN") as bav:
-    res = bav.raw_query("companies", Query(filters=FountFilters(name="Apple")))
+    res = await bav.raw_query("companies", Query(filters=FountFilters(name="Apple")))
 ```
 
 These functions will return a list of JSON dictionaries, one for each entry retrieved from the Fount:

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "wpp-bavapi"
-version = "1.0.0"
+version = "1.0.1"
 authors = [
     { name = "Ignacio Maiz Vilches", email = "ignacio.maiz@bavgroup.com" },
 ]

tests/test_client.py

@@ -253,7 +253,7 @@ async def test_brandscape_data(
     (
         None,
         Query(
-            filters=filters.CategoriesFilters(sector=1),
+            filters=filters.CategoriesFilters(sectors=1),
             fields="test",
             include=["sector"],
         ),
@@ -263,12 +263,12 @@ async def test_brandscape_data(
 async def test_categories(
     mock_query: mock.AsyncMock, fount: Client, query: Optional[Query]
 ):
-    await fount.categories(sector=1, fields="test", query=query)
+    await fount.categories(sectors=1, fields="test", query=query)
 
     mock_query.assert_awaited_once_with(
         "categories",
         Query(
-            filters=filters.CategoriesFilters(sector=1),
+            filters=filters.CategoriesFilters(sectors=1),
             fields="test",
             include=["sector"],
         ),