brynq-sdk-brynq 4.0.2__tar.gz → 4.0.3__tar.gz

{brynq_sdk_brynq-4.0.2 → brynq_sdk_brynq-4.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq_sdk_brynq
-Version: 4.0.2
+Version: 4.0.3
 Summary: BrynQ SDK for the BrynQ.com platform
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_brynq-4.0.2 → brynq_sdk_brynq-4.0.3}/brynq_sdk_brynq/interfaces.py

@@ -1,7 +1,7 @@
 from typing import Dict, List, Any, Optional
 from .credentials import Credentials
 from .mappings import Mappings
-from .schemas.interfaces import Interface, InterfaceDetail, InterfaceConfig, Schedule, Scope, DevSettings
+from .schemas.interfaces import Interface, InterfaceDetail, InterfaceConfig, Schedule, Scope, DevSettings, Scenario
 from brynq_sdk_functions import Functions
 
 class Interfaces:
@@ -11,7 +11,7 @@ class Interfaces:
     def __init__(self, brynq_instance):
         """
         Initialize Interfaces manager.
-        
+
         Args:
             brynq_instance: The parent BrynQ instance
         """
@@ -21,7 +21,7 @@ class Interfaces:
 
     def get_all(self) -> List[Dict[str, Any]]:
         """Get all interfaces this token has access to.
-        
+
         Returns:
             List[Dict[str, Any]]: List of interfaces with their details including:
                 - id (int): Interface ID
@@ -30,7 +30,7 @@ class Interfaces:
                 - sourceSystems (List[int]): List of source system IDs
                 - targetSystems (List[int]): List of target system IDs
                 - taskSchedule (Dict): Task schedule details including status, timing, etc.
-            
+
         Raises:
             ValueError: If the response data is invalid
             requests.exceptions.RequestException: If the API request fails
@@ -40,7 +40,7 @@ class Interfaces:
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         try:
             interfaces_data = response.json()
             valid_data, _ = Functions.validate_pydantic_data(interfaces_data, schema=Interface)
@@ -57,7 +57,7 @@ class Interfaces:
                 - apps (Dict): Application configuration with:
                     - source (str): Source application name
                     - target (str): Target application name
-            
+
         Raises:
             ValueError: If interface_id is not a positive integer or if the response data is invalid
             requests.exceptions.RequestException: If the API request fails
@@ -69,7 +69,7 @@ class Interfaces:
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         try:
             interface_data = response.json()
             valid_data, _ = Functions.validate_pydantic_data(interface_data, schema=InterfaceDetail)
@@ -79,15 +79,15 @@ class Interfaces:
 
     def get_config(self) -> Dict[str, Any]:
         """Get the base configuration of an interface.
-        
+
         Args:
             interface_id (int): The ID of the interface
-            
+
         Returns:
             Dict[str, Any]: Interface configuration including:
                 - mapping (List): List of mapping configurations
                 - variables (Dict): Configuration variables
-            
+
         Raises:
             ValueError: If interface_id is not a positive integer or if the response data is invalid
             requests.exceptions.RequestException: If the API request fails
@@ -99,7 +99,7 @@ class Interfaces:
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         try:
             config_data = response.json()
             valid_data, _ = Functions.validate_pydantic_data(config_data, schema=InterfaceConfig)
@@ -113,7 +113,7 @@ class Interfaces:
 
         Returns:
             Dict[str, Any]: Response from the flush operation
-            
+
         Raises:
             requests.exceptions.RequestException: If the API request fails
         """
@@ -138,7 +138,7 @@ class Interfaces:
                 - startAfterPrecedingTask (bool, optional): Whether to start after preceding task
                 - lastReload (str): Last reload time
                 - lastErrorMessage (str): Last error message
-            
+
         Raises:
             ValueError: If interface_id is not a positive integer or if the response data is invalid
             requests.exceptions.RequestException: If the API request fails
@@ -148,7 +148,7 @@ class Interfaces:
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         try:
             schedule_data = response.json()
             valid_data, _ = Functions.validate_pydantic_data(schedule_data, schema=Schedule)
@@ -162,7 +162,7 @@ class Interfaces:
 
         Returns:
             Dict[str, Any]: Template configuration
-            
+
         Raises:
             requests.exceptions.RequestException: If the API request fails
         """
@@ -180,7 +180,7 @@ class Interfaces:
             Dict[str, Any]: Scope configuration including:
                 - live (Dict, optional): Live scope configuration
                 - draft (Dict, optional): Draft scope configuration
-            
+
         Raises:
             ValueError: If interface_id is not a positive integer or if the response data is invalid
             requests.exceptions.RequestException: If the API request fails
@@ -190,7 +190,7 @@ class Interfaces:
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         try:
             scope_data = response.json()
             valid_data, _ = Functions.validate_pydantic_data(scope_data, schema=Scope)
@@ -219,7 +219,7 @@ class Interfaces:
             timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         valid_data, _ = Functions.validate_pydantic_data(response.json(), schema=DevSettings)
         return valid_data
 
@@ -245,4 +245,34 @@ class Interfaces:
             return variable
         else:
             self.flush_config()
-            return variables
+            return variables
+
+    def get_scenario(self, strict: bool = True) -> List[Dict[str, Any]]:
+        """
+        Get the scenarios of an interface.
+
+        Args:
+            strict (bool): If True, raises an error when all scenario records fail validation.
+
+        Returns:
+            List[Dict[str, Any]]: List of scenario configurations.
+        """
+        response = self._brynq.brynq_session.get(
+            url=f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}/scenarios",
+            timeout=self._brynq.timeout
+        )
+        response.raise_for_status()
+
+        try:
+            scenario_data = response.json()
+            valid_data, invalid_data = Functions.validate_pydantic_data(
+                scenario_data, schema=Scenario, debug=True
+            )
+
+            if strict and not valid_data and invalid_data:
+                raise ValueError(f"Invalid scenario data, see debug for more information")
+
+            return valid_data
+
+        except ValueError as e:
+            raise ValueError(f"Invalid scenario data: {str(e)}")

{brynq_sdk_brynq-4.0.2 → brynq_sdk_brynq-4.0.3}/brynq_sdk_brynq/schemas/interfaces.py

@@ -1,4 +1,4 @@
-from typing import Dict, List, Any, Optional
+from typing import Dict, List, Any, Optional, Union
 from datetime import datetime
 from pydantic import BaseModel, Field, field_validator
 
@@ -179,3 +179,55 @@ class DevSettings(BaseModel):
         frozen = True
         strict = True
         populate_by_name = True
+
+
+class SourceTarget(BaseModel):
+    """Schema for source/target configuration in scenario details"""
+    data: List[str] = Field(..., description="List of data field names")
+    type: str = Field(..., description="Type of the source/target (e.g., 'LIBRARY')")
+
+    class Config:
+        frozen = True
+        strict = True
+        populate_by_name = True
+
+
+class ScenarioMappingConfiguration(BaseModel):
+    """Schema for mapping configuration in scenario details"""
+    values: List[str] = Field(default_factory=list, description="List of mapping values")
+    default_value: str = Field(default="", alias="defaultValue", description="Default value for mapping")
+
+    class Config:
+        frozen = True
+        strict = True
+        populate_by_name = True
+
+
+class ScenarioDetail(BaseModel):
+    """Schema for scenario detail mapping"""
+    id: str = Field(..., description="Detail ID")
+    logic: str = Field(default="", description="Mapping logic")
+    unique: bool = Field(..., description="Whether the mapping is unique")
+    required: bool = Field(..., description="Whether the field is required")
+    mapping_required: bool = Field(..., alias="mappingRequired", description="Whether the mapping is required")
+    source: SourceTarget = Field(..., description="Source configuration")
+    target: SourceTarget = Field(..., description="Target configuration")
+    mapping: ScenarioMappingConfiguration = Field(..., description="Mapping configuration")
+
+    class Config:
+        frozen = True
+        strict = True
+        populate_by_name = True
+
+
+class Scenario(BaseModel):
+    """Schema for interface scenario configuration"""
+    id: str = Field(..., description="Scenario ID")
+    name: str = Field(..., description="Scenario name")
+    description: str = Field(default="", description="Scenario description")
+    details: List[ScenarioDetail] = Field(..., description="Scenario mapping details")
+
+    class Config:
+        frozen = True
+        strict = True
+        populate_by_name = True

{brynq_sdk_brynq-4.0.2 → brynq_sdk_brynq-4.0.3}/brynq_sdk_brynq.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq-sdk-brynq
-Version: 4.0.2
+Version: 4.0.3
 Summary: BrynQ SDK for the BrynQ.com platform
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_brynq-4.0.2 → brynq_sdk_brynq-4.0.3}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_namespace_packages
 
 setup(
     name='brynq_sdk_brynq',
-    version='4.0.2',
+    version='4.0.3',
     description='BrynQ SDK for the BrynQ.com platform',
     long_description='BrynQ SDK for the BrynQ.com platform',
     author='BrynQ',