mbu-dev-shared-components 0.0.33__tar.gz → 0.0.35__tar.gz

{mbu_dev_shared_components-0.0.33/mbu_dev_shared_components.egg-info → mbu_dev_shared_components-0.0.35}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mbu_dev_shared_components
-Version: 0.0.33
+Version: 0.0.35
 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.0.33 → mbu_dev_shared_components-0.0.35}/mbu_dev_shared_components/getorganized/cases.py

@@ -1,16 +1,15 @@
 """This module has functions to do with case related calls
 to the GetOrganized api."""
-from typing import Dict, Any
 import requests
 from mbu_dev_shared_components.getorganized.auth import get_ntlm_go_api_credentials
 
 
-def find_case_by_case_properties(case_data: Dict[str, Any], api_endpoint: str, api_username: str, api_password: str) -> requests.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`.
 
     Parameters:
-    case_data (Dict[str, Any]): A dictionary containing case properties to filter cases by in the API search.
+    case_data (str): A JSON string containing case properties to filter cases by in the API search.
     api_endpoint (str): GetOrganized API endpoint.
     api_username (str): The API username for GetOrganized API.
     api_password (str): The API password for GetOrganized API.
@@ -22,17 +21,17 @@ def find_case_by_case_properties(case_data: Dict[str, Any], api_endpoint: str, a
     requests.RequestException: If the HTTP request fails for any reason.
     """
     headers = {"Content-Type": "application/json"}
-    response = requests.request(method='POST', url=api_endpoint, headers=headers, json=case_data, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
+    response = requests.request(method='POST', url=api_endpoint, headers=headers, data=case_data, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
 
     return response
 
 
-def create_case_folder(case_data: Dict[str, Any], api_endpoint: str, api_username: str, api_password: str) -> requests.Response:
+def create_case_folder(case_data: str, api_endpoint: str, api_username: str, api_password: str) -> requests.Response:
     """
     Sends a POST request to create a new case folder with the provided `case_data`.
 
     Parameters:
-    case_data (Dict[str, Any]): A dictionary containing the data required to create a new case folder.
+    case_data (str): A JSON string containing the data required to create a new case folder.
     api_endpoint (str): GetOrganized API endpoint.
     api_username (str): The API username for GetOrganized API.
     api_password (str): The API password for GetOrganized API.
@@ -44,17 +43,17 @@ def create_case_folder(case_data: Dict[str, Any], api_endpoint: str, api_usernam
     requests.RequestException: If the HTTP request fails for any reason.
     """
     headers = {"Content-Type": "application/json"}
-    response = requests.request(method='POST', url=api_endpoint, headers=headers, json=case_data, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
+    response = requests.request(method='POST', url=api_endpoint, headers=headers, data=case_data, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
 
     return response
 
 
-def create_case(case_data: Dict[str, Any], api_endpoint: str, api_username: str, api_password: str) -> requests.Response:
+def create_case(case_data: str, api_endpoint: str, api_username: str, api_password: str) -> requests.Response:
     """
     Sends a POST request to create a new case in the system with the specified `case_data`.
 
     Parameters:
-    case_data (Dict[str, Any]): A dictionary containing the data required to create a new case.
+    case_data (str): A JSON string containing the data required to create a new case.
     api_endpoint (str): GetOrganized API endpoint.
     api_username (str): The API username for GetOrganized API.
     api_password (str): The API password for GetOrganized API.
@@ -66,6 +65,6 @@ def create_case(case_data: Dict[str, Any], api_endpoint: str, api_username: str,
     requests.RequestException: If the HTTP request fails for any reason.
     """
     headers = {"Content-Type": "application/json"}
-    response = requests.request(method='POST', url=api_endpoint, headers=headers, json=case_data, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
+    response = requests.request(method='POST', url=api_endpoint, headers=headers, data=case_data, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
 
     return response

{mbu_dev_shared_components-0.0.33 → mbu_dev_shared_components-0.0.35}/mbu_dev_shared_components/getorganized/documents.py

@@ -1,16 +1,15 @@
 """This module..."""
-from typing import Dict, Any
 import requests
 from mbu_dev_shared_components.getorganized.auth import get_ntlm_go_api_credentials
 
 
-def upload_file_to_case(file_data: Dict[str, Any], api_endpoint: str, api_username: str, api_password: str) -> requests.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.
     The function uses NTLM authentication and expects an environment variable for the API base URL.
 
     Parameters:
-    file_data (Dict[str, Any]): A dictionary containing file data and associated case information to be uploaded.
+    file_data (str): A JSON string containing file data and associated case information to be uploaded.
     api_endpoint (str): GetOrganized API endpoint.
     api_username (str): The API username for GetOrganized API.
     api_password (str): The API password for GetOrganized API.
@@ -22,12 +21,12 @@ def upload_file_to_case(file_data: Dict[str, Any], api_endpoint: str, api_userna
     requests.RequestException: If the HTTP request fails for any reason.
     """
     headers = {'Content-Type': 'application/json'}
-    response = requests.request(method='POST', url=api_endpoint, headers=headers, json=file_data, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
+    response = requests.request(method='POST', url=api_endpoint, headers=headers, data=file_data, auth=get_ntlm_go_api_credentials(api_username, api_password), timeout=60)
 
     return response
 
 
-def mark_file_as_case_record(documents_id: list, api_endpoint: str, api_username: str, api_password: str) -> Dict[str, Any]:
+def mark_file_as_case_record(documents_id: list, api_endpoint: str, api_username: str, api_password: str) -> requests.Response:
     """
     Marks one or more documents by their IDs as case records in the system via a POST request to a specific API endpoint.
     This operation modifies the status of the documents to reflect their new role as official case records.
@@ -50,4 +49,4 @@ def mark_file_as_case_record(documents_id: list, api_endpoint: str, api_username
     print(payload)
     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.json()
+    return response

{mbu_dev_shared_components-0.0.33 → mbu_dev_shared_components-0.0.35}/mbu_dev_shared_components/getorganized/objects.py

@@ -1,6 +1,7 @@
-"""This module contains classes relating data to be used in api request to
-GetOrganized when working with cases and documents."""
-import json
+"""
+This module contains classes relating data to be used in API requests to
+GetOrganized when working with cases and documents.
+"""
 import dataclasses
 from typing import Literal
 
@@ -24,14 +25,14 @@ class CaseDataJson:
         return_when_case_fully_created (bool): A flag indicating whether to wait for the case to be fully created before returning.
 
         Returns:
-        str: A JSON formatted string representing the case with the specified attributes, ensuring non-ASCII characters are retained and output is indented for readability.
+        dict: A dictionary representing the case data in JSON format.
         """
         case_data = {
             "CaseTypePrefix": case_type_prefix,
             "MetadataXml": metadata_xml,
             "ReturnWhenCaseFullyCreated": return_when_case_fully_created
         }
-        return json.dumps(case_data, ensure_ascii=False, indent=4)
+        return case_data
 
     def search_case_folder_data_json(self, case_type_prefix: CaseTypePrefix, person_full_name: str, person_id: str, person_ssn: str) -> str:
         """
@@ -39,10 +40,12 @@ class CaseDataJson:
 
         Parameters:
         case_type_prefix (CaseTypePrefix): The prefix indicating the type of the case. Must be one of the predefined literal values.
-        metadata_xml (str): XML-formatted string containing metadata associated with the case.
+        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.
 
         Returns:
-        str: A JSON formatted string representing the case with the specified attributes, ensuring non-ASCII characters are retained and output is indented for readability.
+        dict: A dictionary representing the search criteria for the case folder in JSON format.
         """
         search_case_folder_data = {
             "FieldProperties": [
@@ -68,7 +71,7 @@ class CaseDataJson:
             "ExcludeDeletedCases": "True",
             "ReturnCasesNumber": "1"
             }
-        return json.dumps(search_case_folder_data, ensure_ascii=False, indent=4)
+        return search_case_folder_data
 
 
 @dataclasses.dataclass
@@ -93,7 +96,7 @@ class DocumentJsonCreator:
         data_in_bytes (bytes): The binary data of the file being represented.
 
         Returns:
-        str: A JSON formatted string representing the document with specified attributes, ensuring non-ASCII characters are retained and output is indented for readability.
+        dict: A dictionary representing the document data in JSON format.
         """
         document_data = {
             "CaseId": case_id,
@@ -104,4 +107,4 @@ class DocumentJsonCreator:
             "Overwrite": overwrite,
             "Bytes": data_in_bytes
         }
-        return json.dumps(document_data, ensure_ascii=False, indent=4)
+        return document_data

{mbu_dev_shared_components-0.0.33 → mbu_dev_shared_components-0.0.35/mbu_dev_shared_components.egg-info}/PKG-INFO

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