mbu-dev-shared-components 0.4.4__tar.gz → 1.0.0__tar.gz

{mbu_dev_shared_components-0.4.4 → mbu_dev_shared_components-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mbu_dev_shared_components
-Version: 0.4.4
+Version: 1.0.0
 Summary: Shared components to use in RPA projects
 Author-email: MBU <rpa@mbu.aarhus.dk>
 Classifier: Programming Language :: Python :: 3

{mbu_dev_shared_components-0.4.4 → mbu_dev_shared_components-1.0.0}/mbu_dev_shared_components/getorganized/cases.py

@@ -4,6 +4,26 @@ import requests
 from mbu_dev_shared_components.getorganized.auth import get_ntlm_go_api_credentials
 
 
+def get_case_metadata(api_endpoint: str, api_username: str, api_password: str) -> requests.Response:
+    """
+    Sends a GET request to fetch metadata for a given case in GO
+
+    Parameters:
+    api_endpoint (str): GetOrganized API endpoint.
+    api_username (str): The API username for GetOrganized API.
+    api_password (str): The API password for GetOrganized API.
+
+    Returns:
+    requests.Response: The response object from the API.
+    """
+
+    headers = {"Content-Type": "application/json"}
+
+    response = requests.request(method='GET', url=api_endpoint, headers=headers, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
+
+    return response
+
+
 def find_case_by_case_properties(case_data: str, api_endpoint: str, api_username: str, api_password: str) -> requests.Response:
     """
     Sends a POST request to search for cases based on specific case properties provided in `case_data`.

{mbu_dev_shared_components-0.4.4 → mbu_dev_shared_components-1.0.0}/mbu_dev_shared_components/getorganized/documents.py

@@ -3,6 +3,26 @@ import requests
 from mbu_dev_shared_components.getorganized.auth import get_ntlm_go_api_credentials
 
 
+def get_document_metadata(api_endpoint: str, api_username: str, api_password: str) -> requests.Response:
+    """
+    Sends a GET request to fetch metadata for a given document in GO
+
+    Parameters:
+    api_endpoint (str): GetOrganized API endpoint.
+    api_username (str): The API username for GetOrganized API.
+    api_password (str): The API password for GetOrganized API.
+
+    Returns:
+    requests.Response: The response object from the API.
+    """
+
+    headers = {"Content-Type": "application/json"}
+
+    response = requests.request(method='GET', url=api_endpoint, headers=headers, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
+
+    return response
+
+
 def upload_file_to_case(file_data: str, api_endpoint: str, api_username: str, api_password: str) -> requests.Response:
     """
     Uploads a file to a case by sending file data as a JSON payload to a specific API endpoint.
@@ -75,9 +95,40 @@ def finalize_file(documents_id: list, api_endpoint: str, api_username: str, api_
     payload = {
         "DocumentIds": documents_id,
         "ShouldCloseOpenTasks": False
-        }
+    }
 
     response = requests.request(method='POST', url=api_endpoint, headers=headers, json=payload, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
     response.raise_for_status()
 
     return response
+
+
+def search_documents(search_term: str, api_endpoint: str, api_username: str, api_password: str) -> requests.Response:
+    """
+    Looks for documents in GetOrganized related to the specified search term
+
+    Parameters:
+    search_term (str): The phrase/term to be searched for in GetOrganized.
+    api_endpoint (str): GetOrganized API endpoint.
+    api_username (str): The API username for GetOrganized API.
+    api_password (str): The API password for GetOrganized API.
+
+    Returns:
+    requests.Response: The response object from the API.
+
+    Raises:
+    requests.RequestException: If the HTTP request fails for any reason.
+    """
+
+    payload = {
+        "SearchPhrase": search_term,
+        "AdditionalColumns": [],
+        "ResultLimit": 25,
+        "StartRow": 1
+    }
+
+    headers = {'Content-Type': 'application/json'}
+
+    response = requests.request(method='POST', url=api_endpoint, headers=headers, json=payload, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
+
+    return response

{mbu_dev_shared_components-0.4.4 → mbu_dev_shared_components-1.0.0}/mbu_dev_shared_components/getorganized/objects.py

@@ -34,9 +34,74 @@ class CaseDataJson:
         }
         return case_data
 
-    def search_case_folder_data_json(self, case_type_prefix: CaseTypePrefix, person_full_name: str, person_id: str, person_ssn: str, case_title: str = None) -> str:
+    def generic_search_case_data_json(self, case_type_prefix: CaseTypePrefix, person_full_name: str, person_id: str, person_ssn: str, include_name: bool = True, returned_cases_number: str = "1", field_properties: dict = None) -> str:
         """
         Creates a JSON string representing a search string for case folder with the provided attributes.
+        It is possible to provide a field_properties list, which can contain additional properties for the search.
+
+        Parameters:
+        case_type_prefix (CaseTypePrefix): The prefix indicating the type of the case. Must be one of the predefined literal values.
+        person_full_name (str): The full name of the person associated with the case.
+        person_id (str): The ID of the person associated with the case.
+        person_ssn (str): The Social Security Number of the person associated with the case.
+        include_name (str): Whether or not, the person_full_name should be included in the contact_data for the search
+        returned_cases_number (str): The number of returned results
+        field_properties: A list of desired field properties to add, in order to specify the search
+
+        Returns:
+        dict: A dictionary representing the search criteria for the case folder in JSON format.
+        """
+
+        search_case_folder_data = {
+            "FieldProperties": [],
+            "CaseTypePrefixes": [
+                f"{case_type_prefix}"
+            ],
+            "LogicalOperator": "AND",
+            "ExcludeDeletedCases": "True",
+            "ReturnCasesNumber": returned_cases_number
+        }
+
+        if include_name:
+            search_case_folder_data["FieldProperties"].append(
+                {
+                    "InternalName": "ows_CCMContactData",
+                    "Value": f"{person_full_name};#{person_id};#{person_ssn};#;#",
+                    "DataType": "Text",
+                    "ComparisonType": "Equal",
+                    "IsMultiValue": "False"
+                }
+            )
+
+        else:
+            search_case_folder_data["FieldProperties"].append(
+                {
+                    "InternalName": "ows_CCMContactData",
+                    "Value": f";#{person_id};#{person_ssn};#;#",
+                    "DataType": "Text",
+                    "ComparisonType": "Equal",
+                    "IsMultiValue": "False"
+                }
+            )
+
+        # Could be CaseTitle, CaseCategory, CaseProfile etc.
+        if len(field_properties) != 0:
+            for field_property_key, field_property_value in field_properties.items():
+                search_case_folder_data["FieldProperties"].append(
+                    {
+                        "InternalName": str(field_property_key),
+                        "Value": field_property_value,
+                        "DataType": "Text",
+                        "ComparisonType": "Equal",
+                        "IsMultiValue": "False"
+                    }
+                )
+
+        return search_case_folder_data
+
+    def search_citizen_folder_data_json(self, case_type_prefix: CaseTypePrefix, person_full_name: str, person_id: str, person_ssn: str) -> str:
+        """
+        Creates a JSON string, representing a search string, used to retrieve a GetOrganized citizen folder, leveraging provided citizen data
 
         Parameters:
         case_type_prefix (CaseTypePrefix): The prefix indicating the type of the case. Must be one of the predefined literal values.
@@ -72,23 +137,6 @@ class CaseDataJson:
             "ReturnCasesNumber": "1"
         }
 
-        if case_title is not None:
-            # Change the value of the existing case category to "Standard"
-            for field in search_case_folder_data["FieldProperties"]:
-                if field["InternalName"] == "ows_CaseCategory":
-                    field["Value"] = "Standard"
-
-                    break
-
-            # Optionally add the case title property
-            search_case_folder_data["FieldProperties"].append({
-                "InternalName": "ows_CaseTitle",
-                "Value": case_title,
-                "DataType": "Text",
-                "ComparisonType": "Equal",
-                "IsMultiValue": "False"
-            })
-
         return search_case_folder_data
 
 

{mbu_dev_shared_components-0.4.4 → mbu_dev_shared_components-1.0.0}/mbu_dev_shared_components.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mbu_dev_shared_components
-Version: 0.4.4
+Version: 1.0.0
 Summary: Shared components to use in RPA projects
 Author-email: MBU <rpa@mbu.aarhus.dk>
 Classifier: Programming Language :: Python :: 3

{mbu_dev_shared_components-0.4.4 → mbu_dev_shared_components-1.0.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mbu_dev_shared_components"
-version = "0.4.4"  # Specify the version manually here
+version = "1.0.0"  # Specify the version manually here
 authors = [
   { name="MBU", email="rpa@mbu.aarhus.dk" },
 ]