Update version to 3.5.8rc2 and enhance HarnessGroupMicroClient to support an optional filterType parameter in API requests, modifying the URL template accordingly.

Author: kleinjoshuaa

CHANGES.txt

@@ -3,7 +3,7 @@ CHANGELOG
 
 This file tracks the version history and changes made to the Split/Harness FME Python API Client library.
 
-3.5.8 (December 4, 2025)
+3.5.8 (December 5, 2025)
 -------------------------
 Features:
 - Added optional org_identifier and project_identifier support for Harness microclients
@@ -12,6 +12,7 @@ Features:
   - When not provided, they are completely omitted from URLs rather than being passed as empty strings
   - Applies to all Harness microclients: harness_project, harness_user, harness_group, 
     harness_apikey, service_account, token, role, resource_group, and role_assignment
+Added filterType support to the group endpoint
 
 3.5.7 (November 26, 2025)
 -------------------------

README.md

@@ -154,6 +154,28 @@ new_sa = client.service_account.create(sa_data, account_id)
 client.harness_user.add_user_to_groups(user.id, [group.id], account_id)
 ```
 
+### Harness Groups
+
+The `harness_group.list()` method supports an optional `filterType` parameter to filter groups:
+
+```python
+# List all groups (default behavior)
+all_groups = client.harness_group.list()
+
+# List groups with filterType to exclude inherited groups
+groups = client.harness_group.list(filterType='EXCLUDE_INHERITED_GROUPS')
+
+# List groups with filterType and other optional parameters
+groups = client.harness_group.list(
+    account_identifier='YOUR_ACCOUNT_ID',
+    org_identifier='YOUR_ORG_ID',
+    project_identifier='YOUR_PROJECT_ID',
+    filterType='INCLUDE_INHERITED_GROUPS'
+)
+```
+
+**Note:** The `filterType` parameter is optional. When not provided (or set to `None`), it will be omitted from the API request. Valid values depend on the Harness API specification.
+
 
 For detailed examples and API specifications for each resource, please refer to the [Harness API documentation](https://apidocs.harness.io/).
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "splitapiclient"
-version = "3.5.8rc1"
+version = "3.5.8rc2"
 license = "Apache-2.0"
 description = "This Python Library provides full support for Split REST Admin API, allow creating, deleting and editing Environments, Splits, Split Definitions, Segments, Segment Keys, Users, Groups, API Keys, Change Requests, Attributes and Identities"
 classifiers = [

splitapiclient/microclients/harness/harness_group_microclient.py

@@ -14,7 +14,7 @@ class HarnessGroupMicroClient:
     _endpoint = {
         'all_items': {
             'method': 'GET',
-            'url_template': '/ng/api/user-groups?accountIdentifier={accountIdentifier}&orgIdentifier={orgIdentifier}&projectIdentifier={projectIdentifier}&pageIndex={pageIndex}&pageSize=100',
+            'url_template': '/ng/api/user-groups?accountIdentifier={accountIdentifier}&orgIdentifier={orgIdentifier}&projectIdentifier={projectIdentifier}&pageIndex={pageIndex}&pageSize=100&filterType={filterType}',
             'headers': [{
                 'name': 'x-api-key',
                 'template': '{value}',
@@ -83,13 +83,14 @@ def __init__(self, http_client, account_identifier=None, org_identifier=None, pr
         self._org_identifier = org_identifier
         self._project_identifier = project_identifier
 
-    def list(self, account_identifier=None, org_identifier=None, project_identifier=None):
+    def list(self, account_identifier=None, org_identifier=None, project_identifier=None, filterType=None):
         '''
         Returns a list of HarnessGroup objects.
 
         :param account_identifier: Account identifier to use for this request, overrides the default
         :param org_identifier: Organization identifier to use for this request, overrides the default
         :param project_identifier: Project identifier to use for this request, overrides the default
+        :param filterType: Filter type to use for filtering groups
         :returns: list of HarnessGroup objects
         :rtype: list(HarnessGroup)
         '''
@@ -109,6 +110,8 @@ def list(self, account_identifier=None, org_identifier=None, project_identifier=
                     endpoint['url_template'] = endpoint['url_template'].replace('&orgIdentifier={orgIdentifier}', '')
                 if project_id is None:
                     endpoint['url_template'] = endpoint['url_template'].replace('&projectIdentifier={projectIdentifier}', '')
+                if filterType is None:
+                    endpoint['url_template'] = endpoint['url_template'].replace('&filterType={filterType}', '')
 
                 request_kwargs = {
                     'pageIndex': page_index,
@@ -118,6 +121,8 @@ def list(self, account_identifier=None, org_identifier=None, project_identifier=
                     request_kwargs['orgIdentifier'] = org_id
                 if project_id is not None:
                     request_kwargs['projectIdentifier'] = project_id
+                if filterType is not None:
+                    request_kwargs['filterType'] = filterType
 
                 response = self._http_client.make_request(
                     endpoint,

splitapiclient/tests/microclients/harness/harness_group_microclient_test.py

@@ -52,7 +52,7 @@ def test_list(self, mocker):
         # Verify the make_request calls
         assert SyncHttpClient.make_request.call_count == 2
 
-        # Create expected endpoint with modified URL template (orgIdentifier and projectIdentifier removed)
+        # Create expected endpoint with modified URL template (orgIdentifier, projectIdentifier, and filterType removed)
         expected_endpoint = HarnessGroupMicroClient._endpoint['all_items'].copy()
         expected_endpoint['url_template'] = '/ng/api/user-groups?accountIdentifier={accountIdentifier}&pageIndex={pageIndex}&pageSize=100'
 
@@ -245,3 +245,169 @@ def test_delete(self, mocker):
 
         # Verify the result
         assert result is True
+
+    def test_list_with_filter_type(self, mocker):
+        '''
+        Test listing groups with filterType parameter
+        '''
+        mocker.patch('splitapiclient.http_clients.sync_client.SyncHttpClient.make_request')
+        sc = SyncHttpClient('abc', 'abc')
+        gmc = HarnessGroupMicroClient(sc, 'test_account')
+        
+        # Mock the API response for the first page
+        first_page_data = {
+            'data': {
+                'content': [
+                    {
+                        'identifier': 'group1',
+                        'name': 'Group 1',
+                        'accountIdentifier': 'test_account',
+                        'users': []
+                    }
+                ]
+            }
+        }
+        
+        # Mock the API response for the second page (empty to end pagination)
+        second_page_data = {
+            'data': {
+                'content': []
+            }
+        }
+        
+        # Set up the mock to return different responses for different calls
+        SyncHttpClient.make_request.side_effect = [first_page_data, second_page_data]
+        
+        # Call the method being tested with filterType
+        result = gmc.list(filterType='EXCLUDE_INHERITED_GROUPS')
+        
+        # Verify the make_request calls
+        assert SyncHttpClient.make_request.call_count == 2
+        
+        # Create expected endpoint with filterType included, but orgIdentifier and projectIdentifier removed
+        expected_endpoint = HarnessGroupMicroClient._endpoint['all_items'].copy()
+        expected_endpoint['url_template'] = '/ng/api/user-groups?accountIdentifier={accountIdentifier}&pageIndex={pageIndex}&pageSize=100&filterType={filterType}'
+        
+        SyncHttpClient.make_request.assert_any_call(
+            expected_endpoint,
+            pageIndex=0,
+            accountIdentifier='test_account',
+            filterType='EXCLUDE_INHERITED_GROUPS'
+        )
+        SyncHttpClient.make_request.assert_any_call(
+            expected_endpoint,
+            pageIndex=1,
+            accountIdentifier='test_account',
+            filterType='EXCLUDE_INHERITED_GROUPS'
+        )
+        
+        # Verify the result
+        assert len(result) == 1
+        assert isinstance(result[0], HarnessGroup)
+        assert result[0]._identifier == 'group1'
+
+    def test_list_with_filter_type_and_org_identifier(self, mocker):
+        '''
+        Test listing groups with filterType and org_identifier parameters
+        '''
+        mocker.patch('splitapiclient.http_clients.sync_client.SyncHttpClient.make_request')
+        sc = SyncHttpClient('abc', 'abc')
+        gmc = HarnessGroupMicroClient(sc, 'test_account', org_identifier='test_org')
+        
+        # Mock the API response for the first page
+        first_page_data = {
+            'data': {
+                'content': [
+                    {
+                        'identifier': 'group1',
+                        'name': 'Group 1',
+                        'accountIdentifier': 'test_account',
+                        'users': []
+                    }
+                ]
+            }
+        }
+        
+        # Mock the API response for the second page (empty to end pagination)
+        second_page_data = {
+            'data': {
+                'content': []
+            }
+        }
+        
+        # Set up the mock to return different responses for different calls
+        SyncHttpClient.make_request.side_effect = [first_page_data, second_page_data]
+        
+        # Call the method being tested with filterType
+        result = gmc.list(filterType='INCLUDE_INHERITED_GROUPS')
+        
+        # Verify the make_request calls
+        assert SyncHttpClient.make_request.call_count == 2
+        
+        # Create expected endpoint with filterType and orgIdentifier included, but projectIdentifier removed
+        expected_endpoint = HarnessGroupMicroClient._endpoint['all_items'].copy()
+        expected_endpoint['url_template'] = '/ng/api/user-groups?accountIdentifier={accountIdentifier}&orgIdentifier={orgIdentifier}&pageIndex={pageIndex}&pageSize=100&filterType={filterType}'
+        
+        SyncHttpClient.make_request.assert_any_call(
+            expected_endpoint,
+            pageIndex=0,
+            accountIdentifier='test_account',
+            orgIdentifier='test_org',
+            filterType='INCLUDE_INHERITED_GROUPS'
+        )
+        
+        # Verify the result
+        assert len(result) == 1
+        assert isinstance(result[0], HarnessGroup)
+
+    def test_list_with_filter_type_none(self, mocker):
+        '''
+        Test listing groups with filterType=None (should be omitted from URL)
+        '''
+        mocker.patch('splitapiclient.http_clients.sync_client.SyncHttpClient.make_request')
+        sc = SyncHttpClient('abc', 'abc')
+        gmc = HarnessGroupMicroClient(sc, 'test_account')
+        
+        # Mock the API response for the first page
+        first_page_data = {
+            'data': {
+                'content': [
+                    {
+                        'identifier': 'group1',
+                        'name': 'Group 1',
+                        'accountIdentifier': 'test_account',
+                        'users': []
+                    }
+                ]
+            }
+        }
+        
+        # Mock the API response for the second page (empty to end pagination)
+        second_page_data = {
+            'data': {
+                'content': []
+            }
+        }
+        
+        # Set up the mock to return different responses for different calls
+        SyncHttpClient.make_request.side_effect = [first_page_data, second_page_data]
+        
+        # Call the method being tested with filterType=None (explicit)
+        result = gmc.list(filterType=None)
+        
+        # Verify the make_request calls
+        assert SyncHttpClient.make_request.call_count == 2
+        
+        # Create expected endpoint with filterType removed (since it's None)
+        expected_endpoint = HarnessGroupMicroClient._endpoint['all_items'].copy()
+        expected_endpoint['url_template'] = '/ng/api/user-groups?accountIdentifier={accountIdentifier}&pageIndex={pageIndex}&pageSize=100'
+        
+        SyncHttpClient.make_request.assert_any_call(
+            expected_endpoint,
+            pageIndex=0,
+            accountIdentifier='test_account'
+        )
+        
+        # Verify the result
+        assert len(result) == 1
+        assert isinstance(result[0], HarnessGroup)

splitapiclient/version.py

@@ -1 +1 @@
-__version__ = '3.5.8rc1'
+__version__ = '3.5.8rc2'