brynq-sdk-brynq 3.0.0__tar.gz → 4.2.2.dev0__tar.gz

brynq_sdk_brynq-4.2.2.dev0/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: brynq_sdk_brynq
+Version: 4.2.2.dev0
+Summary: BrynQ SDK for the BrynQ.com platform
+Author: BrynQ
+Author-email: support@brynq.com
+License: BrynQ License
+Requires-Dist: requests<=3,>=2
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+BrynQ SDK for the BrynQ.com platform

{brynq_sdk_brynq-3.0.0 → brynq_sdk_brynq-4.2.2.dev0}/brynq_sdk_brynq/brynq.py

@@ -18,6 +18,11 @@ class BrynQ:
         self.subdomain = os.getenv("BRYNQ_SUBDOMAIN", subdomain)
         self.api_token = os.getenv("BRYNQ_API_TOKEN", api_token)
         self.environment = os.getenv("BRYNQ_ENVIRONMENT", staging)
+        self.timeout = 3600
+        self.data_interface_id = os.getenv("DATA_INTERFACE_ID")
+        if self.data_interface_id is None:
+            raise ValueError("BRYNQ_DATA_INTERFACE_ID environment variable is not set, you should use this class via the TaskScheduler or set the variable in your code with:"
+                             "os.environ['DATA_INTERFACE_ID'] = str(self.data_interface_id). This is better than setting it in your .env where you will have to change it when switching between interfaces.")
 
         if any([self.subdomain is None, self.api_token is None]):
             raise ValueError("Set the subdomain, api_token either in your .env file or provide the subdomain and api_token parameters")
@@ -27,19 +32,19 @@ class BrynQ:
             raise ValueError(f"Environment should be in {','.join(possible_environments)}")
 
         self.url = 'https://app.brynq-staging.com/api/v2/' if self.environment == 'dev' else 'https://app.brynq.com/api/v2/'
-        
-        # Initialize session with retry strategy
-        self.session = requests.Session()
+
+        # Initialize session with retry strategy. This is called brynq_session and not session as to not conflict with other SDKs that use self.session
+        self.brynq_session = requests.Session()
         retry_strategy = Retry(
             total=3,  # number of retries
             backoff_factor=0.5,  # wait 0.5s * (2 ** (retry - 1)) between retries
             status_forcelist=[500, 502, 503, 504]  # HTTP status codes to retry on
         )
         adapter = HTTPAdapter(max_retries=retry_strategy)
-        self.session.mount("http://", adapter)
-        self.session.mount("https://", adapter)
-        self.session.headers.update(self._get_headers())
-        
+        self.brynq_session.mount("http://", adapter)
+        self.brynq_session.mount("https://", adapter)
+        self.brynq_session.headers.update(self._get_headers())
+
         # Initialize components
         self.users = Users(self)
         self.organization_chart = OrganizationChart(self)
@@ -54,7 +59,7 @@ class BrynQ:
             'Domain': self.subdomain
         }
 
-    def get_mapping(self, data_interface_id: int, mapping: str, return_format: Literal['input_as_key', 'columns_names_as_keys', 'nested_input_output'] = 'input_as_key') -> dict:
+    def get_mapping(self, mapping: str, return_format: Literal['input_as_key', 'columns_names_as_keys', 'nested_input_output'] = 'input_as_key') -> dict:
         """
         DEPRECATED: Use brynq.mappings.get_mapping() instead
         """
@@ -71,7 +76,7 @@ class BrynQ:
         :return: The json of the mapping
         """
         # Find the mapping for the given sheet name
-        mappings = self.interfaces.mappings._get_mappings(interface_id=data_interface_id)
+        mappings = self.interfaces.mappings._get_mappings()
         mapping_data = next((item for item in mappings if item['name'] == mapping), None)
         if not mapping_data:
             raise ValueError(f"Mapping named '{mapping}' not found")
@@ -103,9 +108,10 @@ class BrynQ:
                 else:  # Default to assuming there's only one key-value pair if not concatenating
                     if output_values:
                         final_mapping[input_values[0]] = output_values[0]
+
         return final_mapping
 
-    def get_mapping_as_dataframe(self, data_interface_id: int, mapping: str, prefix: bool = False) -> pd.DataFrame:
+    def get_mapping_as_dataframe(self, mapping: str, prefix: bool = False) -> pd.DataFrame:
         """
         DEPRECATED: Use brynq.mappings.get_mapping_as_dataframe() instead
         """
@@ -121,7 +127,7 @@ class BrynQ:
         :return: The dataframe of the mapping
         """
         # Find the mapping for the given sheet name
-        mappings = self.interfaces.mappings._get_mappings(interface_id=data_interface_id)
+        mappings = self.interfaces.mappings._get_mappings()
         mapping_data = next((item for item in mappings if item['name'] == mapping), None)
         if not mapping_data:
             raise ValueError(f"Mapping named '{mapping}' not found")
@@ -148,6 +154,7 @@ class BrynQ:
         df = pd.DataFrame(rows)
 
         return df
+
     def get_system_credential(self, system: str, label: Union[str, list], test_environment: bool = False) -> dict:
         """
         DEPRECATED: Use brynq.credentials.get() instead
@@ -159,7 +166,7 @@ class BrynQ:
         )
         return self.interfaces.credentials.get_system_credential(system, label, test_environment)
 
-    def get_interface_credential(self, interface_id: str, system: str, system_type: Optional[str] = None,
+    def get_interface_credential(self, system: str, system_type: Optional[str] = None,
                                  test_environment: bool = False) -> Union[dict, List[dict]]:
         """
         DEPRECATED: Use brynq.credentials.get_interface_credential() instead
@@ -169,7 +176,7 @@ class BrynQ:
             DeprecationWarning,
             stacklevel=2
         )
-        return self.interfaces.credentials.get(interface_id, system, system_type, test_environment)
+        return self.interfaces.credentials.get(self.data_interface_id, system, system_type, test_environment)
 
     def get_user_data(self):
         """
@@ -279,4 +286,4 @@ class BrynQ:
     def close(self):
         """Close the session and cleanup resources"""
         if hasattr(self, 'session'):
-            self.session.close()
+            self.brynq_session.close()

{brynq_sdk_brynq-3.0.0 → brynq_sdk_brynq-4.2.2.dev0}/brynq_sdk_brynq/credentials.py

@@ -3,7 +3,7 @@ import requests
 from typing import Optional, Union, List, Dict, Any
 import warnings
 from .schemas.credentials import CredentialsConfig
-from brynq_sdk_functions.functions import Functions
+from brynq_sdk_functions import Functions
 
 
 class Credentials:
@@ -24,8 +24,9 @@ class Credentials:
         DEPRECATED: Use brynq.interfaces.credentials.get() instead
         """
         warnings.warn("This function is deprecated and will be removed in a future version.", DeprecationWarning, stacklevel=2)
-        response = self._brynq.session.get(
+        response = self._brynq.brynq_session.get(
             url=f'{self._brynq.url}apps/{system}',
+            timeout=self._brynq.timeout
         )
         response.raise_for_status()
         credentials = response.json()
@@ -46,7 +47,7 @@ class Credentials:
 
         return credentials[0]
 
-    def get(self,interface_id: str,system: str,system_type: Optional[str] = None,test_environment: bool = False) -> Union[dict, List[dict]]:
+    def get(self, system: str, system_type: Optional[str] = None, test_environment: bool = False) -> Union[dict, List[dict]]:
         """
         This method retrieves authentication credentials from BrynQ for a specific interface and system.
         
@@ -59,7 +60,7 @@ class Credentials:
         """
         
         # Fetch the config using a separate method
-        config = self._fetch_config(interface_id)
+        config = self._fetch_config()
 
         matching_credentials = []
 
@@ -128,7 +129,7 @@ class Credentials:
             warnings.warn(warning_msg)
             return [cred['credential'] for cred in matching_credentials]
 
-    def _fetch_config(self, interface_id: str) -> Dict[str, Any]:
+    def _fetch_config(self) -> Dict[str, Any]:
         """
         Fetch configuration from BrynQ for a given interface ID.
 
@@ -142,8 +143,9 @@ class Credentials:
             ValueError: If the response data is invalid.
             requests.exceptions.RequestException: If the API request fails.
         """
-        response = self._brynq.session.get(
-            url=f'{self._brynq.url}interfaces/{interface_id}/config/auth'
+        response = self._brynq.brynq_session.get(
+            url=f'{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config/auth',
+            timeout=self._brynq.timeout
         )
         response.raise_for_status()
         

{brynq_sdk_brynq-3.0.0 → brynq_sdk_brynq-4.2.2.dev0}/brynq_sdk_brynq/customers.py

@@ -2,7 +2,7 @@ from typing import List, Dict, Any, Optional
 import requests
 from requests import Response
 from .schemas.customers import CustomerSchema, CustomerContractDetailsSchema
-from brynq_sdk_functions.functions import Functions
+from brynq_sdk_functions import Functions
 
 class Customers:
     """Class for interacting with BrynQ customer endpoints"""
@@ -25,8 +25,9 @@ class Customers:
             requests.exceptions.RequestException: If the API request fails
             ValueError: If the response data doesn't match the expected schema
         """
-        response = self.brynq.session.get(
-            f"{self.brynq.url}customers",
+        response = self.brynq.brynq_session.get(
+            url=f"{self.brynq.url}customers",
+            timeout=self.brynq.timeout
         )
         response.raise_for_status()
         
@@ -47,8 +48,9 @@ class Customers:
             requests.exceptions.RequestException: If the API request fails
             ValueError: If the response data doesn't match the expected schema
         """
-        response = self.brynq.session.get(
+        response = self.brynq.brynq_session.get(
             f"{self.brynq.url}customers/contract-details",
+            timeout=self.brynq.timeout
         )
         response.raise_for_status()
         
@@ -72,8 +74,9 @@ class Customers:
             ValueError: If the response data is invalid.
             requests.exceptions.RequestException: If the API request fails.
         """
-        response = self.brynq.session.get(
+        response = self.brynq.brynq_session.get(
             f"{self.brynq.url}customers/{customer_id}/contract-details",
+            timeout=self.brynq.timeout
         )
         response.raise_for_status()
 

{brynq_sdk_brynq-3.0.0 → brynq_sdk_brynq-4.2.2.dev0}/brynq_sdk_brynq/interfaces.py

@@ -1,8 +1,9 @@
 from typing import Dict, List, Any, Optional
 from .credentials import Credentials
 from .mappings import Mappings
+from .scenarios import Scenarios
 from .schemas.interfaces import Interface, InterfaceDetail, InterfaceConfig, Schedule, Scope, DevSettings
-from brynq_sdk_functions.functions import Functions
+from brynq_sdk_functions import Functions
 
 class Interfaces:
     """
@@ -11,17 +12,18 @@ class Interfaces:
     def __init__(self, brynq_instance):
         """
         Initialize Interfaces manager.
-        
+
         Args:
             brynq_instance: The parent BrynQ instance
         """
         self._brynq = brynq_instance
         self.credentials = Credentials(brynq_instance)
         self.mappings = Mappings(brynq_instance)
+        self.scenarios = Scenarios(brynq_instance)
 
-    def get(self) -> List[Dict[str, Any]]:
+    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,16 +32,17 @@ 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
         """
-        response = self._brynq.session.get(
-            f"{self._brynq.url}interfaces"
+        response = self._brynq.brynq_session.get(
+            f"{self._brynq.url}interfaces",
+            timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         try:
             interfaces_data = response.json()
             valid_data, _ = Functions.validate_pydantic_data(interfaces_data, schema=Interface)
@@ -47,12 +50,8 @@ class Interfaces:
         except ValueError as e:
             raise ValueError(f"Invalid interface data received from API: {str(e)}")
 
-    def get_by_id(self, interface_id: int) -> Dict[str, Any]:
+    def get(self) -> Dict[str, Any]:
         """Get a specific interface by its ID.
-        
-        Args:
-            interface_id (int): The ID of the interface to retrieve
-            
         Returns:
             Dict[str, Any]: Interface details including:
                 - name (str): Interface name
@@ -60,20 +59,19 @@ 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
         """
         # Basic validation
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
 
-        response = self._brynq.session.get(
-            f"{self._brynq.url}interfaces/{interface_id}"
+        response = self._brynq.brynq_session.get(
+            f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}",
+            timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         try:
             interface_data = response.json()
             valid_data, _ = Functions.validate_pydantic_data(interface_data, schema=InterfaceDetail)
@@ -81,30 +79,29 @@ class Interfaces:
         except ValueError as e:
             raise ValueError(f"Invalid interface data received from API: {str(e)}")
 
-    def get_config(self, interface_id: int) -> Dict[str, Any]:
+    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
         """
         # Basic validation
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
 
-        response = self._brynq.session.get(
-            f"{self._brynq.url}interfaces/{interface_id}/config"
+        response = self._brynq.brynq_session.get(
+            f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config",
+            timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         try:
             config_data = response.json()
             valid_data, _ = Functions.validate_pydantic_data(config_data, schema=InterfaceConfig)
@@ -112,50 +109,26 @@ class Interfaces:
         except ValueError as e:
             raise ValueError(f"Invalid interface configuration data: {str(e)}")
 
-    def flush_config(self, interface_id: int) -> Dict[str, Any]:
+    def flush_config(self) -> Dict[str, Any]:
         """
         Flushes the interface config to revert to a fresh state.
-        
-        Args:
-            interface_id: The ID of the interface
-            
+
         Returns:
             Dict[str, Any]: Response from the flush operation
-            
-        Raises:
-            requests.exceptions.RequestException: If the API request fails
-        """
-        response = self._brynq.session.get(
-            url=f'{self._brynq.url}interfaces/{interface_id}/config/flush'
-        )
-        response.raise_for_status()
-        return response.json()
 
-    def get_dataflows(self, interface_id: int) -> Dict[str, Any]:
-        """
-        Get the dataflows configuration of an interface.
-        
-        Args:
-            interface_id: The ID of the interface
-            
-        Returns:
-            Dict[str, Any]: Dataflows configuration
-            
         Raises:
             requests.exceptions.RequestException: If the API request fails
         """
-        response = self._brynq.session.get(
-            url=f'{self._brynq.url}interfaces/{interface_id}/config/dataflows'
+        response = self._brynq.brynq_session.get(
+            url=f'{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config/flush',
+            timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        return response.json()
+        return response
 
-    def get_schedule(self, interface_id: int) -> Dict[str, Any]:
+    def get_schedule(self) -> Dict[str, Any]:
         """Get the schedule configuration of an interface.
-        
-        Args:
-            interface_id (int): The ID of the interface
-            
+
         Returns:
             Dict[str, Any]: Schedule configuration including:
                 - id (int): The schedule ID
@@ -167,20 +140,17 @@ 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
         """
-        # Basic validation
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
-
-        response = self._brynq.session.get(
-            f"{self._brynq.url}interfaces/{interface_id}/config/schedule"
+        response = self._brynq.brynq_session.get(
+            f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config/schedule",
+            timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         try:
             schedule_data = response.json()
             valid_data, _ = Functions.validate_pydantic_data(schedule_data, schema=Schedule)
@@ -188,49 +158,25 @@ class Interfaces:
         except ValueError as e:
             raise ValueError(f"Invalid schedule configuration data: {str(e)}")
 
-    def get_template_config(self, interface_id: int) -> Dict[str, Any]:
-        """
-        Get the template configuration of an interface.
-        
-        Args:
-            interface_id: The ID of the interface
-            
-        Returns:
-            Dict[str, Any]: Template configuration
-            
-        Raises:
-            requests.exceptions.RequestException: If the API request fails
-        """
-        response = self._brynq.session.get(
-            url=f'{self._brynq.url}interfaces/{interface_id}/template-config'
-        )
-        response.raise_for_status()
-        return response.json()
 
-    def get_scope(self, interface_id: int) -> Dict[str, Any]:
+    def get_scope(self) -> Dict[str, Any]:
         """Get live and draft scopes from interface by id.
-        
-        Args:
-            interface_id (int): The ID of the interface
-            
+
         Returns:
             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
         """
-        # Basic validation
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
-
-        response = self._brynq.session.get(
-            f"{self._brynq.url}interfaces/{interface_id}/scope"
+        response = self._brynq.brynq_session.get(
+            f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}/scope",
+            timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         try:
             scope_data = response.json()
             valid_data, _ = Functions.validate_pydantic_data(scope_data, schema=Scope)
@@ -238,12 +184,9 @@ class Interfaces:
         except ValueError as e:
             raise ValueError(f"Invalid scope data: {str(e)}")
 
-    def get_dev_settings(self, interface_id: int) -> List[dict[str,Any]]:
+    def get_dev_settings(self) -> List[dict[str,Any]]:
         """Get the dev-settings of an interface
 
-        Args:
-            interface_id: Numeric ID of the interface
-
         Returns:
             Dict[str, Any]: A dictionary containing the dev settings:
                 - dockerImage (str): Docker image name
@@ -256,13 +199,36 @@ class Interfaces:
             requests.exceptions.HTTPError: If dev settings not found (404)
             ValueError: If interface_id is not a positive integer
         """
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
 
-        response = self._brynq.session.get(
-            url=f"{self._brynq.url}interfaces/{interface_id}/config/dev-settings"
+        response = self._brynq.brynq_session.get(
+            url=f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config/dev-settings",
+            timeout=self._brynq.timeout
         )
         response.raise_for_status()
-        
+
         valid_data, _ = Functions.validate_pydantic_data(response.json(), schema=DevSettings)
         return valid_data
+
+    def get_variables(self, variable_name: str = None):
+        """
+        Get a value from the task_variables table corresponding with the given name. If temp value is filled, it will
+        (run_instant = 1), then the temp_value will be returned. This is to give the possibility for users in the frontend to run
+        a task once manual with other values then normal without overwriting the normal values.
+        :param variable_name: the name of the variable
+        :return: the value of the given variable.
+        """
+
+        variables = self.get_config().get("variables")
+
+        if not variables:
+            raise Exception(f"There are no valid variables in interface '{self._brynq.data_interface_id}'")
+
+        if variable_name:
+            variable = variables.get(variable_name)
+            if not variable:
+                raise Exception(f"The variable '{variable_name}' does not exist in interface '{self._brynq.data_interface_id}'")
+            self.flush_config()
+            return variable
+        else:
+            self.flush_config()
+            return variables

{brynq_sdk_brynq-3.0.0 → brynq_sdk_brynq-4.2.2.dev0}/brynq_sdk_brynq/mappings.py

@@ -1,9 +1,9 @@
 import requests
 import pandas as pd
-from typing import Union, Literal, Any, Tuple, List, Dict
+from typing import Optional, Union, Literal, Any, Tuple, List, Dict
 import warnings
-from brynq_sdk_brynq.schemas.interfaces import MappingItem
-from brynq_sdk_functions.functions import Functions
+from .schemas.interfaces import MappingItem
+from brynq_sdk_functions import Functions
 
 class MappingNotFoundError(Exception):
     """Raised when a requested mapping is not found"""
@@ -22,7 +22,7 @@ class Mappings:
         """
         self._brynq = brynq_instance
 
-    def _get_mappings(self, interface_id: int) -> List[Dict[str, Any]]:
+    def _get_mappings(self) -> List[Dict[str, Any]]:
         """Get all mappings for an interface.
 
         Args:
@@ -35,12 +35,9 @@ class Mappings:
             ValueError: If interface_id is not a positive integer or if the response data is invalid
             requests.exceptions.RequestException: If the API request fails
         """
-        # Basic validation
-        if not isinstance(interface_id, int) or interface_id <= 0:
-            raise ValueError("interface_id must be a positive integer")
-
-        response = self._brynq.session.get(
-            f"{self._brynq.url}interfaces/{interface_id}/config/mapping"
+        response = self._brynq.brynq_session.get(
+            f"{self._brynq.url}interfaces/{self._brynq.data_interface_id}/config/mapping",
+            timeout=self._brynq.timeout
         )
         response.raise_for_status()
 
@@ -72,7 +69,7 @@ class Mappings:
             mappings[input_key] = output_value
         return mappings
 
-    def get(self, interface_id: int, mapping: str, as_df: bool = False, prefix: bool = False) -> dict:
+    def get(self, mapping: Optional[str] = None, as_df: bool = False, prefix: bool = False) -> dict:
         """Get the mapping from BrynQ.
 
         Args:
@@ -90,13 +87,21 @@ class Mappings:
             MappingNotFoundError: If mapping is not found
             ValueError: If mapping data is invalid
         """
-        mappings = self._get_mappings(interface_id=interface_id)
-        mapping_data = next((item for item in mappings if item['name'] == mapping), None)
-
-        if not mapping_data:
-            raise MappingNotFoundError(f"Mapping named '{mapping}' not found")
-
-        return {
-            'default_value': mapping_data['default_value'],
-            'mappings': self._to_dataframe(mapping_data, prefix) if as_df else self._to_dict(mapping_data)
-        }
+        mappings = self._get_mappings()
+        if mapping is None:
+            if as_df:
+                mapping_data = [{'default_value': item['default_value'], 'mappings': self._to_dataframe(item, prefix)} for item in mappings]
+            else:
+                mapping_data = [{'default_value': item['default_value'], 'mappings': self._to_dict(item)} for item in mappings]
+
+            return mapping_data
+        else:
+            mapping_data = next((item for item in mappings if item['name'] == mapping), None)
+
+            if not mapping_data:
+                raise MappingNotFoundError(f"Mapping named '{mapping}' not found")
+
+            return {
+                'default_value': mapping_data['default_value'],
+                'mappings': self._to_dataframe(mapping_data, prefix) if as_df else self._to_dict(mapping_data)
+            }