pyxecm 3.8.0__tar.gz → 3.8.2__tar.gz

{pyxecm-3.8.0 → pyxecm-3.8.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pyxecm
-Version: 3.8.0
+Version: 3.8.2
 Summary: A Python library to interact with Opentext Content Management Rest API
 Project-URL: Homepage, https://github.com/opentext/pyxecm
 Author-email: Kai Gatzweiler <kgatzweiler@opentext.com>, "Dr. Marc Diefenbruch" <mdiefenb@opentext.com>

{pyxecm-3.8.0 → pyxecm-3.8.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyxecm"
-version = "3.8.0"
+version = "3.8.2"
 description = 'A Python library to interact with Opentext Content Management Rest API'
 keywords = [
   'opentext',

{pyxecm-3.8.0 → pyxecm-3.8.2}/src/pyxecm_customizer/customizer.py

@@ -1792,6 +1792,7 @@ class Customizer:
                     otca_object=self.otca_object,
                     otkd_object=self.otkd_object,
                     avts_object=self.avts_object,
+                    settings=self.settings,
                     logger=self.logger,
                 )
                 # Load the payload file and initialize the payload sections:

{pyxecm-3.8.0 → pyxecm-3.8.2}/src/pyxecm_customizer/guidewire.py

@@ -1470,7 +1470,12 @@ class Guidewire:
 
     # end method definition
 
-    def search_policy(self, attributes: dict) -> dict:
+    def search_policy(
+        self,
+        attributes: dict,
+        filter_field: str | None = None,
+        filter_value: str | None = None,
+    ) -> dict:
         """Search a specific policy based on its attributes.
 
         See: https://docs.guidewire.com/cloud/pc/202407/apiref/generated/Policy%20API/search-policies--post
@@ -1488,6 +1493,10 @@ class Guidewire:
                 * "firstName" (str)
                 * "lastName" (str)
                 * "officialId" (str)
+            filter_field (str | None, optional):
+                Additional policy attribute used to filter the results.
+            filter_value (str | None, optional):
+                Value that filter_field must equal.
 
         Returns:
             dict:
@@ -1528,7 +1537,17 @@ class Guidewire:
 
         request_url = self.config()["policySearchUrl"]
 
-        return self.do_request(method="POST", json_data=body, url=request_url)
+        response = self.do_request(method="POST", json_data=body, url=request_url)
+        policies = response.get("data", [])
+        if filter_field and filter_value is not None and isinstance(policies, list):
+            response["data"] = [
+                policy
+                for policy in policies
+                if policy.get("attributes", {}).get(filter_field) == filter_value
+            ]
+            response["count"] = len(response["data"])
+
+        return response
 
     # end method definition
 

{pyxecm-3.8.0 → pyxecm-3.8.2}/src/pyxecm_customizer/payload.py

@@ -248,6 +248,7 @@ class Payload:
         otca_object: OTCA | None = None,
         otkd_object: OTKD | None = None,
         avts_object: AVTS | None = None,
+        settings: Settings | None = None,
         logger: logging.Logger = default_logger,
     ) -> None:
         """Initialize the Payload object.
@@ -306,6 +307,9 @@ class Payload:
                 An optional Knowledge Discovery object.
             avts_object (AVTS | None, optional):
                 An optional Aviator Search object.
+            settings (Settings | None, optional):
+                The customizer settings. They are the fallback for values that are
+                not defined in the payload. Defaults to the settings of the environment.
             logger (logging.Logger, optional):
                 The logging object to use for all log messages. Defaults to default_logger.
 
@@ -315,6 +319,7 @@ class Payload:
         for logfilter in logger.filters:
             self.logger.addFilter(logfilter)
 
+        self._settings = settings if settings is not None else Settings()
         self._stop_on_error = stop_on_error
         self._payload_source = payload_source
         self._k8s = k8s_object
@@ -12152,6 +12157,8 @@ class Payload:
         object_type: str,
         search_field: str,
         search_value: str,
+        filter_field: str | None = None,
+        filter_value: str | None = None,
     ) -> str | None:
         """Get the Guidewire ID (str) of a Guidewire object by querying the Guidewire API.
 
@@ -12165,6 +12172,10 @@ class Payload:
                 Search field to find business object in external system.
             search_value (str):
                 Search value to find business object in external system.
+            filter_field (str | None, optional):
+                Policy attribute used to filter the search results.
+            filter_value (str | None, optional):
+                Value that filter_field must equal.
 
         Returns:
             str | None:
@@ -12207,6 +12218,8 @@ class Payload:
             case "Policy" | "policy" | "gw.policy":
                 response = guidewire_object.search_policy(
                     attributes={search_field: search_value},
+                    filter_field=filter_field,
+                    filter_value=filter_value,
                 )
                 bo_id = guidewire_object.get_result_value(response=response, key="policyNumber")
             case "Claim" | "claim" | "gw.claim":
@@ -12718,6 +12731,8 @@ class Payload:
                 bo_id = business_object_data["bo_id"]
                 bo_search_field = None
                 bo_search_value = None
+                bo_filter_field = None
+                bo_filter_value = None
             elif "bo_search_field" not in business_object_data or "bo_search_value" not in business_object_data:
                 self.logger.error(
                     "Missing BO search fields (bo_search_field, bo_search_value) in Business Object payload without BO ID for workspace -> '%s'.",
@@ -12727,6 +12742,8 @@ class Payload:
             else:
                 bo_search_field = business_object_data["bo_search_field"]
                 bo_search_value = business_object_data["bo_search_value"]
+                bo_filter_field = business_object_data.get("bo_filter_field")
+                bo_filter_value = business_object_data.get("bo_filter_value")
                 bo_id = None
 
             # Lookup external system in this payload or a former processed payload:
@@ -12811,6 +12828,8 @@ class Payload:
                     object_type=bo_type,
                     search_field=bo_search_field,
                     search_value=bo_search_value,
+                    filter_field=bo_filter_field,
+                    filter_value=bo_filter_value,
                 )
                 if not bo_id:
                     self.logger.warning(
@@ -20816,13 +20835,13 @@ class Payload:
         # Principal propagation (pyxecm as SAML 2.0 identity provider, see SAP.get_saml_assertion())
         # First priority is taking it from the external system payload - otherwise fall back to the global settings
         saml_idp_private_key_file = (
-            sap_external_system.get("saml_idp_private_key_file") or Settings.sap.saml_idp_private_key_file
+            sap_external_system.get("saml_idp_private_key_file") or self._settings.sap.saml_idp_private_key_file
         )
         saml_idp_certificate_file = (
-            sap_external_system.get("saml_idp_certificate_file") or Settings.sap.saml_idp_certificate_file
+            sap_external_system.get("saml_idp_certificate_file") or self._settings.sap.saml_idp_certificate_file
         )
-        saml_issuer = sap_external_system.get("saml_issuer") or Settings.sap.saml_issuer
-        saml_audience = sap_external_system.get("saml_audience") or Settings.sap.saml_audience
+        saml_issuer = sap_external_system.get("saml_issuer") or self._settings.sap.saml_issuer
+        saml_audience = sap_external_system.get("saml_audience") or self._settings.sap.saml_audience
         # Read the PEM files (typically mounted from a Kubernetes secret). The file names are
         # not checked (e.g. a Kubernetes TLS secret mounts "tls.key" / "tls.crt") - SAP()
         # validates the content and logs an error if it is not a matching PEM key pair:

{pyxecm-3.8.0 → pyxecm-3.8.2}/src/pyxecm_customizer/sap.py

@@ -976,6 +976,24 @@ class SAP:
 
     # end method definition
 
+    def oauth_token_url(self) -> str:
+        """Return the URL of SAP's OAuth 2.0 token endpoint, including the SAP client.
+
+        SAP checks that the Recipient of a SAML bearer assertion is exactly the URL the
+        token request is sent to - including the sap-client query parameter. Both
+        get_saml_assertion() and get_oauth_access_token() therefore use this URL.
+
+        Returns:
+            str:
+                The token endpoint URL, e.g.
+                "https://s4.example.com:44300/sap/bc/sec/oauth2/token?sap-client=100".
+
+        """
+
+        return "{}{}?{}".format(self._base_url, OAUTH_TOKEN_PATH, urllib.parse.urlencode({"sap-client": self._client}))
+
+    # end method definition
+
     def get_saml_assertion(
         self,
         user_id: str,
@@ -1023,8 +1041,9 @@ class SAP:
                 Defaults to "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified".
             recipient (str | None, optional):
                 The token endpoint URL the assertion is posted to (SubjectConfirmationData
-                Recipient). Defaults to None = "<base_url>/sap/bc/sec/oauth2/token". Only
-                needed if SAP is reached via a different URL (e.g. a reverse proxy).
+                Recipient). Defaults to None = oauth_token_url(), i.e.
+                "<base_url>/sap/bc/sec/oauth2/token?sap-client=<client>". Only needed if SAP
+                sees the token request under a different URL (e.g. behind a reverse proxy).
             audience (str | None, optional):
                 The AudienceRestriction. Defaults to None = saml_audience of the constructor.
             validity_seconds (int, optional):
@@ -1073,7 +1092,7 @@ class SAP:
             )
             return None
 
-        recipient = recipient or (self._base_url + OAUTH_TOKEN_PATH)
+        recipient = recipient or self.oauth_token_url()
         audience = audience or self._saml_audience
 
         now = datetime.now(tz=UTC)
@@ -1167,7 +1186,7 @@ class SAP:
         ("Authorization: Bearer <access_token>", see the 'auth' parameter of the SAP class)
         run with the SAP user's own authorizations - no SAP password of the user is needed.
 
-        The request is sent as form data to <base_url>/sap/bc/sec/oauth2/token. It does
+        The request is sent as form data to oauth_token_url(). It does
         not use the session of this object (the token endpoint authenticates the OAuth
         client, not the technical user).
 
@@ -1219,7 +1238,8 @@ class SAP:
         if assertion.lstrip().startswith("<"):
             assertion = base64.urlsafe_b64encode(assertion.strip().encode("utf-8")).decode("ascii").rstrip("=")
 
-        token_url = self._base_url + OAUTH_TOKEN_PATH
+        # Same URL (incl. sap-client) as the default Recipient of the assertion - SAP compares both:
+        token_url = self.oauth_token_url()
         data = {"grant_type": OAUTH_SAML2_BEARER_GRANT_TYPE, "assertion": assertion, "client_id": client_id}
         if scope:
             data["scope"] = scope
@@ -1229,7 +1249,6 @@ class SAP:
         try:
             response = requests.post(
                 url=token_url,
-                params={"sap-client": self._client},
                 data=data,
                 auth=(client_id, client_secret),
                 headers={"User-Agent": USER_AGENT, "Accept": "application/json"},
@@ -1278,6 +1297,7 @@ class SAP:
         client_secret: str,
         scope: str | None = None,
         nameid_format: str = SAML_NAMEID_FORMAT_UNSPECIFIED,
+        recipient: str | None = None,
     ) -> dict | None:
         """Get an SAP OAuth 2.0 access token for a user via principal propagation, in one call.
 
@@ -1302,6 +1322,9 @@ class SAP:
             nameid_format (str, optional):
                 The NameID format - must match transaction SAML2 (see get_saml_assertion()).
                 Defaults to "urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified".
+            recipient (str | None, optional):
+                The Recipient of the assertion - only needed behind a reverse proxy (see
+                get_saml_assertion()). Defaults to None = oauth_token_url().
 
         Returns:
             dict | None:
@@ -1310,7 +1333,7 @@ class SAP:
 
         """
 
-        assertion = self.get_saml_assertion(user_id=user_id, nameid_format=nameid_format)
+        assertion = self.get_saml_assertion(user_id=user_id, nameid_format=nameid_format, recipient=recipient)
         if not assertion:
             return None
 

{pyxecm-3.8.0 → pyxecm-3.8.2}/src/pyxecm_customizer/sap_models.py

@@ -1255,7 +1255,7 @@ class SAPMaintenanceOrderModel(SAPODataCreateModel):
     basic_start_datetime: ODataV2DateTime = Field(
         default=None,
         alias="MaintOrdBasicStartDateTime",
-        description="Basic start date and time of the order, ISO 8601, e.g. '2026-11-01T08:00:00Z'; without timezone treated as UTC.",
+        description="Basic start date and time of the order, ISO 8601, e.g. '2026-11-01T08:00:00Z'; without timezone treated as UTC. Defaults to now if neither start nor end is given.",
     )
     basic_end_datetime: ODataV2DateTime = Field(
         default=None,
@@ -1271,7 +1271,13 @@ class SAPMaintenanceOrderModel(SAPODataCreateModel):
 
     @model_validator(mode="after")
     def check_dates(self) -> Self:
-        """Validate that the basic end date is not before the basic start date."""
+        """Default the basic start date and validate that the basic end date is not before it."""
+
+        # The API does not default the basic dates - without them SAP rejects the order with
+        # IW/426 "Forward scheduling: Please enter start date". An end date alone is left
+        # as is (backward scheduling):
+        if self.basic_start_datetime is None and self.basic_end_datetime is None:
+            self.basic_start_datetime = datetime.now(tz=UTC).replace(microsecond=0)
 
         # Compare as UTC timestamps (naive datetimes are treated as UTC, see serialize_odata_datetime()):
         start, end = (