added add to environment and updated readme and changes

Author: kleinjoshuaa

CHANGES.txt

@@ -41,5 +41,5 @@
 - Updated to support flag sets, large segments and the impressionsDisabled boolean value
 3.5.0 (May 6, 2025)
 - Updated to support harness mode
-3.5.1 (May 8, 2025)
+3.5.1 (June 20, 2025)
 - Updated to support rule based segments

README.md

@@ -284,6 +284,8 @@ splitDef.submit_change_request(definition, 'UPDATE', 'updating default rule', 'c
 
 ### Rule-Based Segments
 
+Rule-based segments allow you to define audience segments using complex rule structures and exclusion logic. Added in version 3.5.1, they offer enhanced functionality for targeting users.
+
 Fetch all Rule-Based Segments:
 
 ```python
@@ -313,27 +315,83 @@ env = client.environments.find("Production", ws.id)
 segdef = segment.add_to_environment(env.id)
 ```
 
+#### Rule-Based Segment Structure
+
+Rule-based segment definitions support multiple rule types and matching conditions:
+
+```python
+# Examples of different matcher types
+matchers = [
+    # String matching
+    {
+        'type': 'IN_LIST_STRING',
+        'attribute': 'device',
+        'strings': ['mobile', 'tablet']
+    },
+    # Numeric comparisons
+    {
+        'type': 'GREATER_THAN_OR_EQUAL_NUMBER',
+        'attribute': 'age',
+        'number': 21
+    },
+    {
+        'type': 'LESS_THAN_OR_EQUAL_NUMBER',
+        'attribute': 'account_age_days',
+        'number': 30
+    },
+    {
+        'type': 'BETWEEN_NUMBER',
+        'attribute': 'purchases',
+        'between': {'from': 5, 'to': 20}
+    },
+    # Boolean conditions
+    {
+        'type': 'BOOLEAN',
+        'attribute': 'subscribed',
+        'bool': True
+    },
+    # Date/time matching
+    {
+        'type': 'ON_DATE',
+        'attribute': 'sign_up_date',
+        'date': 1623456789000  # timestamp in milliseconds
+    },
+    # Dependency on another split
+    {
+        'type': 'IN_SPLIT',
+        'attribute': '',
+        'depends': {'splitName': 'another_split', 'treatment': 'on'}
+    }
+]
+
+# Multiple conditions using combiners
+condition = {
+    'combiner': 'AND',  # Can only be 'AND'
+    'matchers': matchers
+}
+```
+
 Update Rule-Based Segment definition with rules:
 
 ```python
 ws = client.workspaces.find("Defaults")
 env = client.environments.find("Production", ws.id)
 segdef = client.rule_based_segment_definitions.find("advanced_users", env.id, ws.id)
 
-# Define rules that match users with age > 30 and have completed tutorials
+# Define rules that match users in a certain list
 rules_data = {
     'rules': [
         {
             'condition': {
                 'combiner': 'AND',
                 'matchers': [
                     {
-                        'type': 'GREATER_THAN_OR_EQUAL_TO',
+                        'type': 'GREATER_THAN_OR_EQUAL_NUMBER',
                         'attribute': 'age',
                         'number': 30
                     },
                     {
-                        'type': 'EQUAL_TO',
+                        'type': 'BOOLEAN',
                         'attribute': 'completed_tutorials',
                         'bool': True
                     }
@@ -347,6 +405,42 @@ rules_data = {
 updated_segdef = segdef.update(rules_data)
 ```
 
+Update Rule-Based Segment definition with excluded keys and excluded segments:
+
+```python
+ws = client.workspaces.find("Defaults")
+env = client.environments.find("Production", ws.id)
+segdef = client.rule_based_segment_definitions.find("advanced_users", env.id, ws.id)
+
+# Define rules and exclusion data
+update_data = {
+    'rules': [
+        {
+            'condition': {
+                'combiner': 'AND',
+                'matchers': [
+                    {
+                        'type': 'GREATER_THAN_OR_EQUAL_NUMBER',
+                        'attribute': 'age',
+                        'number': 30
+                    }
+                ]
+            }
+        }
+    ],
+    'excludedKeys': ['user1', 'user2', 'user3'],
+    'excludedSegments': [
+        {
+            'name': 'beta_testers',
+            'type': 'standard_segment'
+        }
+    ]
+}
+
+# Update the segment definition with rules and exclusions
+updated_segdef = segdef.update(update_data)
+```
+
 Submit a Change request to update a Rule-Based Segment definition:
 
 ```python
@@ -375,14 +469,24 @@ rules = [
     }
 ]
 
-# Submit change request
+# Define excluded keys and segments for the change request
+excluded_keys = ['user1', 'user2']
+excluded_segments = [
+    {
+        'name': 'test_users',
+        'type': 'rule_based_segment'
+    }
+]
+
+# Submit change request with all parameters
 segdef.submit_change_request(
     rules=rules,
+    excluded_keys=excluded_keys,
+    excluded_segments=excluded_segments,
     operation_type='UPDATE',
     title='Lower age threshold to 25',
     comment='Including more users in advanced segment',
     approvers=['[email protected]'],
-    rollout_status_id=None,
     workspace_id=ws.id
 )
 ```

splitapiclient/microclients/rule_based_segment_definition_microclient.py

@@ -30,6 +30,17 @@ class RuleBasedSegmentDefinitionMicroClient:
             }],
             'query_string': [],
             'response': True,
+        },
+        'delete': {
+            'method': 'DELETE',
+            'url_template': 'rule-based-segments/{environmentId}/{segmentName}',
+            'headers': [{
+                'name': 'Authorization',
+                'template': 'Bearer {value}',
+                'required': True,
+            }],
+            'query_string': [],
+            'response': True,
         }
     }
 
@@ -121,4 +132,19 @@ def update(self, segment_name, environment_id, workspace_id, data):
         )
         return RuleBasedSegmentDefinition(as_dict(response), self._http_client)
 
+    def delete(self, segment_name, environment_id):
+        '''
+        Delete RuleBasedSegmentDefinition object.
+
+        :param segment_name: name of the rule-based segment
+        :param environment_id: id of the environment
 
+        :returns: True if successful
+        :rtype: boolean
+        '''
+        self._http_client.make_request(
+            self._endpoint['delete'],
+            environmentId = environment_id,
+            segmentName = segment_name
+        )
+        return True

splitapiclient/microclients/rule_based_segment_microclient.py

@@ -161,11 +161,13 @@ def delete(self, segment_name, workspace_id):
         )
         return response
 
-    def add_to_environment(self, segment_name, environment_id):
+    def add_to_environment(self, segment_name, environment_id, workspace_id=None):
         '''
         add a rule-based segment to environment
 
-        :param segment: rule-based segment name, environment id
+        :param segment_name: name of the rule-based segment
+        :param environment_id: id of the environment
+        :param workspace_id: id of the workspace (optional)
         
         :returns: newly created rule-based segment definition object
         :rtype: RuleBasedSegmentDefinition
@@ -174,9 +176,10 @@ def add_to_environment(self, segment_name, environment_id):
             self._endpoint['add_to_environment'],
             body="",
             segmentName = segment_name,
-            environmentId = environment_id
+            environmentId = environment_id,
+
         )
-        return RuleBasedSegmentDefinition(response, self._http_client)
+        return RuleBasedSegmentDefinition(response, self._http_client, workspace_id)
 
     def remove_from_environment(self, segment_name, environment_id):
         '''

splitapiclient/resources/rule_based_segment.py

@@ -72,7 +72,7 @@ def add_to_environment(self, environment_id, apiclient=None):
         :rtype: RuleBasedSegmentDefinition
         '''
         imc = require_client('RuleBasedSegment', self._client, apiclient)
-        return imc.add_to_environment(self._name, environment_id)
+        return imc.add_to_environment(self._name, environment_id=environment_id, workspace_id=self._workspace_id)
 
     def remove_from_environment(self, environment_id, apiclient=None):
         '''

splitapiclient/resources/rule_based_segment_definition.py

@@ -44,7 +44,7 @@ class RuleBasedSegmentDefinition(BaseResource):
         }]
     }
 
-    def __init__(self, data=None, client=None):
+    def __init__(self, data=None, client=None, workspace_id=None):
         '''
         Constructor for RuleBasedSegmentDefinition
         '''
@@ -58,6 +58,8 @@ def __init__(self, data=None, client=None):
         self._excludedKeys = data.get('excludedKeys', [])
         self._excludedSegments = data.get('excludedSegments', [])
         self._rules = data.get('rules', [])
+        self._workspace_id = workspace_id
+ 
 
     @property
     def name(self):
@@ -91,20 +93,41 @@ def excluded_segments(self):
     def rules(self):
         return self._rules
 
-    def update(self, data, apiclient=None):
+    def delete(self, apiclient=None):
+        '''
+        Delete RuleBasedSegmentDefinition object.
+
+        :param apiclient: If this instance wasn't returned by the client,
+            the ApiClient instance should be passed in order to perform the
+            http call
+
+        :returns: True if successful
+        :rtype: boolean
+        '''
+        imc = require_client('RuleBasedSegmentDefinition', self._client, apiclient)
+        return imc.delete(self._name, self._environment['id'])
+
+
+    def update(self, data, workspace_id=None, apiclient=None):
         '''
         Update RuleBasedSegmentDefinition object.
 
         :param data: dictionary of data to update
+        :param workspace_id: id of the workspace
         :param apiclient: If this instance wasn't returned by the client,
             the ApiClient instance should be passed in order to perform the
             http call
 
         :returns: RuleBasedSegmentDefinition object
         :rtype: RuleBasedSegmentDefinition
         '''
+        if not workspace_id:
+            workspace_id = self._workspace_id
+            
+        if workspace_id is None:
+            raise ValueError("workspace_id is required argument")
         imc = require_client('RuleBasedSegmentDefinition', self._client, apiclient)
-        return imc.update(self._name, self._environment['id'], self._client._workspace_id, data)
+        return imc.update(self._name, self._environment['id'], workspace_id, data)
 
     def submit_change_request(self, rules, excluded_keys, excluded_segments, operation_type, title, comment, approvers, workspace_id, apiclient=None):
         '''