sfq 0.0.30__py3-none-any.whl → 0.0.32__py3-none-any.whl

sfq/__init__.py

@@ -10,6 +10,7 @@ import os
 import re
 import time
 import warnings
+import webbrowser
 import xml.etree.ElementTree as ET
 from collections import OrderedDict
 from concurrent.futures import ThreadPoolExecutor, as_completed
@@ -99,7 +100,7 @@ class SFAuth:
         access_token: Optional[str] = None,
         token_expiration_time: Optional[float] = None,
         token_lifetime: int = 15 * 60,
-        user_agent: str = "sfq/0.0.30",
+        user_agent: str = "sfq/0.0.32",
         sforce_client: str = "_auto",
         proxy: str = "_auto",
     ) -> None:
@@ -169,6 +170,16 @@ class SFAuth:
             * 📖 [Salesforce OAuth Flows Documentation](https://help.salesforce.com/s/articleView?id=xcloud.remoteaccess_oauth_flows.htm&type=5)
         """
 
+        self.__version__ = "0.0.32"
+        """
+        ### `__version__`
+        
+        **The version of the sfq library.**
+        - Schema: `MAJOR.MINOR.PATCH`
+        - Used for debugging and compatibility checks
+        - Updated to reflect the current library version via CI/CD automation
+        """
+
         self.api_version = api_version
         """
 
@@ -997,9 +1008,10 @@ class SFAuth:
 
         return combined_response or None
 
-    def _gen_soap_envelope(self, header: str, body: str) -> str:
-        """Generates a full SOAP envelope with all required namespaces for Salesforce Enterprise API."""
-        return (
+    def _gen_soap_envelope(self, header: str, body: str, type: str) -> str:
+        """Generates a full SOAP envelope with all required namespaces for Salesforce API."""
+        if type == "enterprise":
+            return (
             '<?xml version="1.0" encoding="UTF-8"?>'
             "<soapenv:Envelope "
             'xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" '
@@ -1010,8 +1022,24 @@ class SFAuth:
             f"{header}{body}"
             "</soapenv:Envelope>"
         )
+        elif type == "tooling":
+            return (
+            '<?xml version="1.0" encoding="UTF-8"?>'
+            "<soapenv:Envelope "
+            'xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" '
+            'xmlns:xsd="http://www.w3.org/2001/XMLSchema" '
+            'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" '
+            'xmlns="urn:tooling.soap.sforce.com" '
+            'xmlns:mns="urn:metadata.tooling.soap.sforce.com" '
+            'xmlns:sf="urn:sobject.tooling.soap.sforce.com">'
+            f"{header}{body}"
+            "</soapenv:Envelope>"
+        )
+        raise ValueError(
+            f"Unsupported API type: {type}. Must be 'enterprise' or 'tooling'."
+        )
 
-    def _gen_soap_header(self):
+    def _gen_soap_header(self) -> str:
         """This function generates the header for the SOAP request."""
         headers = self._get_common_headers()
         session_id = headers["Authorization"].split(" ")[1]
@@ -1099,7 +1127,7 @@ class SFAuth:
         insert_list: List[Dict[str, Any]],
         batch_size: int = 200,
         max_workers: int = None,
-        api_type: Literal["enterprise", "tooling", "metadata"] = "enterprise",
+        api_type: Literal["enterprise", "tooling"] = "enterprise",
     ) -> Optional[Dict[str, Any]]:
         """
         Execute the Insert API to insert multiple records via SOAP calls.
@@ -1116,14 +1144,13 @@ class SFAuth:
             endpoint += f"c/{self.api_version}"
         elif api_type == "tooling":
             endpoint += f"T/{self.api_version}"
-        elif api_type == "metadata":
-            endpoint += f"m/{self.api_version}"
         else:
             logger.error(
-                "Invalid API type: %s. Must be one of: 'enterprise', 'tooling', 'metadata'.",
+                "Invalid API type: %s. Must be one of: 'enterprise', 'tooling'.",
                 api_type,
             )
             return None
+        endpoint = endpoint.replace('/v', '/')  # handle API versioning in the endpoint
 
         if isinstance(insert_list, dict):
             insert_list = [insert_list]
@@ -1136,7 +1163,7 @@ class SFAuth:
         def insert_chunk(chunk: List[Dict[str, Any]]) -> Optional[Dict[str, Any]]:
             header = self._gen_soap_header()
             body = self._gen_soap_body(sobject=sobject, method="create", data=chunk)
-            envelope = self._gen_soap_envelope(header, body)
+            envelope = self._gen_soap_envelope(header=header, body=body, type=api_type)
             soap_headers = self._get_common_headers().copy()
             soap_headers["Content-Type"] = "text/xml; charset=UTF-8"
             soap_headers["SOAPAction"] = '""'
@@ -1197,4 +1224,14 @@ class SFAuth:
         Perform cleanup operations for Apex debug logs.
         """
         if apex_logs:
-            self._debug_cleanup_apex_logs()
+            self._debug_cleanup_apex_logs()
+
+    def open_frontdoor(self) -> None:
+        """
+        This function opens the Salesforce Frontdoor URL in the default web browser.
+        """
+        if not self.access_token:
+            self._get_common_headers()
+        sid = quote(self.access_token, safe="")
+        frontdoor_url = f"{self.instance_url}/secur/frontdoor.jsp?sid={sid}"
+        webbrowser.open(frontdoor_url)

{sfq-0.0.30.dist-info → sfq-0.0.32.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sfq
-Version: 0.0.30
+Version: 0.0.32
 Summary: Python wrapper for the Salesforce's Query API.
 Author-email: David Moruzzi <sfq.pypi@dmoruzi.com>
 Keywords: salesforce,salesforce query

sfq-0.0.32.dist-info/RECORD

@@ -0,0 +1,6 @@
+sfq/__init__.py,sha256=sGL_DT0w4-9GqmTD_rffZ_J3eqOtjFUuH1S4nlVzow8,47102
+sfq/_cometd.py,sha256=XimQEubmJwUmbWe85TxH_cuhGvWVuiHHrVr41tguuiI,10508
+sfq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sfq-0.0.32.dist-info/METADATA,sha256=Y3avdu7TKc8BCEz2kHZaqjPAIqcjD4CHzSF_WdMO4pI,6899
+sfq-0.0.32.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+sfq-0.0.32.dist-info/RECORD,,

sfq-0.0.30.dist-info/RECORD

@@ -1,6 +0,0 @@
-sfq/__init__.py,sha256=MpqXIfKQW1XRGBAh_uYBpdF5tj2Mxdzf3cCNO77yyd0,45630
-sfq/_cometd.py,sha256=XimQEubmJwUmbWe85TxH_cuhGvWVuiHHrVr41tguuiI,10508
-sfq/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sfq-0.0.30.dist-info/METADATA,sha256=ieHDwbhGy16xT_kAIEWVnQIWxVHnMN1vxenlIrHypas,6899
-sfq-0.0.30.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sfq-0.0.30.dist-info/RECORD,,