pyxecm 3.0.0__py3-none-any.whl → 3.1.0__py3-none-any.whl

pyxecm_customizer/guidewire.py

@@ -48,6 +48,7 @@ class Guidewire:
     def __init__(
         self,
         base_url: str,
+        as_url: str,
         auth_type: str = "",
         client_id: str = "",
         client_secret: str = "",
@@ -62,6 +63,8 @@ class Guidewire:
         Args:
             base_url (str):
                 The base URL of the Guidewire Cloud API.
+            as_url (str):
+                The application server endpount the Guidewire system.
             auth_type (str):
                 The authorization type, either "oauth" or "basic".
             client_id (str, optional):
@@ -104,21 +107,33 @@ class Guidewire:
         guidewire_config = {}
         # Store the credentials and parameters in a config dictionary:
         guidewire_config["baseUrl"] = base_url.rstrip("/")
+        guidewire_config["asUrl"] = as_url.rstrip("/")
         guidewire_config["authType"] = auth_type
         guidewire_config["clientId"] = client_id
         guidewire_config["clientSecret"] = client_secret
         guidewire_config["username"] = username
         guidewire_config["password"] = password
-        guidewire_config["restUrl"] = guidewire_config["baseUrl"] + "/rest"  # "/api/v1"
-        #        guidewire_config["tokenUrl"] = guidewire_config["restUrl"] + "/oauth2/token"
+        guidewire_config["restUrl"] = (
+            guidewire_config["baseUrl"] + "/rest"
+            if guidewire_config["baseUrl"]
+            else guidewire_config["asUrl"] + "/rest"
+        )
         if token_url:
             guidewire_config["tokenUrl"] = token_url
         else:
-            guidewire_config["tokenUrl"] = guidewire_config["baseUrl"] + "/oauth2/token"
+            guidewire_config["tokenUrl"] = (
+                guidewire_config["baseUrl"] + "/oauth2/token"
+                if guidewire_config["baseUrl"]
+                else guidewire_config["asUrl"] + "/oauth2/token"
+            )
 
         guidewire_config["adminUrl"] = guidewire_config["restUrl"] + "/admin/v1"
-        guidewire_config["claimUrl"] = guidewire_config["restUrl"] + "/claim/v1"
         guidewire_config["accountUrl"] = guidewire_config["restUrl"] + "/account/v1"
+        guidewire_config["accountSearchUrl"] = guidewire_config["accountUrl"] + "/search/accounts"
+        guidewire_config["policyUrl"] = guidewire_config["restUrl"] + "/policy/v1"
+        guidewire_config["policySearchUrl"] = guidewire_config["policyUrl"] + "/search/policies"
+        guidewire_config["claimUrl"] = guidewire_config["restUrl"] + "/claim/v1"
+        guidewire_config["claimSearchUrl"] = guidewire_config["claimUrl"] + "/search/claims-v2"
 
         self._config = guidewire_config
 
@@ -208,7 +223,9 @@ class Guidewire:
             # Log an error if required credentials are missing
             # Either username/password AND client credentials (for ROPC)
             # OR just client credentials (for Client Credentials Grant)
-            self.logger.error("Authentication requires either client credentials or username/password.")
+            self.logger.error(
+                "Authentication of type -> '%s' requires either client credentials or username/password.", auth_type
+            )
             return False
 
         if self._scope:
@@ -254,7 +271,9 @@ class Guidewire:
 
     # end method definition
 
-    def do_request(self, method: str, url: str, data: dict | None = None, params: dict | None = None) -> dict:
+    def do_request(
+        self, method: str, url: str, data: dict | None = None, json_data: dict | None = None, params: dict | None = None
+    ) -> dict:
         """Send a request to the Guidewire REST API.
 
         Args:
@@ -264,6 +283,8 @@ class Guidewire:
                 The API endpoint to call.
             data (dict):
                 The request payload (if applicable).
+            json_data (dict | None, optional):
+                Request payload for the JSON parameter. Defaults to None.
             params (dict):
                 The URL parameters (if applicable).
 
@@ -274,7 +295,7 @@ class Guidewire:
         """
 
         response = self._session.request(
-            method=method, url=url, headers=self.request_header(), data=data, params=params
+            method=method, url=url, headers=self.request_header(), data=data, json=json_data, params=params
         )
 
         return response.json() if response.content else {}
@@ -330,6 +351,92 @@ class Guidewire:
 
     # end method definition
 
+    def get_result_value(
+        self,
+        response: dict,
+        key: str,
+        index: int = 0,
+        show_error: bool = True,
+    ) -> str | None:
+        """Read an item value from the REST API response.
+
+        Args:
+            response (dict):
+                REST API response object.
+            key (str):
+                Key to find (e.g., "id", "name").
+            index (int, optional):
+                Index to use if a list of results is delivered (1st element has index 0).
+                Defaults to 0.
+            show_error (bool, optional):
+                Whether an error or just a warning should be logged.
+
+        Returns:
+            str:
+                Value of the item with the given key, or None if no value is found.
+
+        """
+
+        # First do some sanity checks:
+        if not response:
+            self.logger.debug("Empty response - no results found!")
+            return None
+
+        # To support also iterators that yield from results,
+        # we wrap an attributea element into a data element
+        # to make the following code work like for direct REST responses:
+        if "attributes" in response:
+            response = {"data": response}
+
+        if "data" not in response:
+            if show_error:
+                self.logger.error("No 'data' key in REST response - returning None")
+            return None
+
+        results = response["data"]
+        if not results:
+            self.logger.debug("No results found! Empty data element.")
+            return None
+
+        # check if results is a list or a dict (both is possible - iterator responses will be dict):
+        if isinstance(results, dict):
+            # result is a dict - we don't need index value
+
+            attributes = results.get("attributes", {})
+            if key in attributes:
+                return attributes[key]
+            else:
+                self.logger.error(
+                    "Key -> '%s' is not in result attributes!",
+                    key,
+                )
+                return None
+
+        elif isinstance(results, list):
+            # result is a list - we need a valid index:
+            if index > len(results) - 1:
+                self.logger.error(
+                    "Illegal Index -> %s given. List has only -> %s elements!",
+                    str(index),
+                    str(len(results)),
+                )
+                return None
+            data = results[index]
+            attributes = data.get("attributes", {})
+            if key not in attributes:
+                if show_error:
+                    self.logger.error("Key -> '%s' is not in result attributes -> %s!", key, attributes)
+                return None
+            return attributes[key]
+        else:
+            self.logger.error(
+                "Result needs to be a list or dict but it is -> %s",
+                str(type(results)),
+            )
+            return None
+
+    # end method definition
+
     def get_groups(
         self,
         fields: list | None = None,
@@ -1020,7 +1127,7 @@ class Guidewire:
                     * cn - contains
                 - "value": the filue to filter for. Either literal or list of values
             page_size (int, optional):
-                The maximum number of groups to return.
+                The maximum number of accounts to return.
 
         Returns:
             iter:
@@ -1075,6 +1182,79 @@ class Guidewire:
 
     # end method definition
 
+    def search_account(self, attributes: dict) -> dict:
+        """Search accounts based on its attributes.
+
+        Args:
+            attributes (dict):
+                The attribute to search the value in. Possible key values:
+                * "accountNumber"
+                * "addressLine1"
+                * "addressLine2"
+                * "city"
+                * "country"
+                * "companyName"
+
+        Returns:
+            dict:
+                JSON response containing account details.
+
+        Example:
+        {
+            'count': 2,
+            'data': [
+                {
+                    'attributes': {
+                        'accountHolder': {
+                            'displayName': 'Armstrong and Company',
+                            'id': 'test_pc:1',
+                            'type': 'AccountContact',
+                            'uri': '/account/v1/accounts/pc:ds:1/contacts/test_pc:1'
+                        },
+                        'accountNumber': 'C000212105',
+                        'accountStatus': {...},
+                        'businessOperationsDescription': 'business description',
+                        'createdDate': '2025-07-14T03:59:30.055Z',
+                        'frozen': False,
+                        'id': 'pc:ds:1',
+                        'industryCode': {...},
+                        'numberOfContacts': '8',
+                        'organizationType': {...},
+                        'preferredCoverageCurrency': {...},
+                        'preferredSettlementCurrency': {...},
+                        'primaryLanguage': {...},
+                        'primaryLocale': {...},
+                        'primaryLocation': {...},
+                        'producerCodes': [...]
+                    },
+                    'checksum': '2',
+                    'links': {
+                        'do-not-destroy': {...},
+                        'freeze': {...},
+                        'merge': {...},
+                        'move-policies': {...},
+                        'move-submissions': {...},
+                        'self': {...}
+                    }
+                },
+                {...}
+            ],
+            'links': {
+                'first': {...},
+                'self': {...}
+            }
+        }
+
+        """
+
+        body = {"data": {"attributes": attributes}}
+
+        request_url = self.config()["accountSearchUrl"]
+
+        return self.do_request(method="POST", json_data=body, url=request_url)
+
+    # end method definition
+
     def add_account(self, account_data: dict) -> dict:
         """Create a new account.
 
@@ -1134,6 +1314,218 @@ class Guidewire:
 
     # end method definition
 
+    def get_policies(
+        self,
+        fields: list | None = None,
+        filters: list | None = None,
+        page_size: int = 25,
+        next_page_url: str | None = None,
+    ) -> dict | None:
+        """Retrieve a list of policies.
+
+        Args:
+            fields (list | None, optional):
+                The list of fields in the results. If None, all default
+                fields are returned.
+                Fields for Guidewire accounts:
+                - *all = return all fields
+                - *default = return just the default list of fields
+                - *summary = return the fields defined for giving a summary
+                - *detail = details
+                - displayName
+                - groupType
+                - id
+                - loadFactor
+                - name
+                - organization
+                - parent
+                - securityZone
+                - supervisor
+            filters (list | None, optional):
+                List of dictionaries with three keys each:
+                - "attribute" - name of the attribute to use for the filter (available attributes see above)
+                - "op" - operator:
+                    * eq - equal
+                    * ne - not equal
+                    * lt - less than - also usable for dates (before)
+                    * gt - greater than - also usable for dates (after)
+                    * le - less or equal
+                    * ge - greater or equal
+                    * in - is in list
+                    * ni - is NOT in list
+                    * sw - starts with
+                    * cn - contains
+                - "value": the value to filter for. Either literal or list of values
+            page_size (int, optional):
+                The maximum number of groups to return.
+            next_page_url (str, optional):
+                The Guidewire URL to retrieve the next page of Guidewire groups (pagination).
+                This is used for the iterator get_groups_iterator() below.
+
+        Returns:
+            dict | None:
+                JSON response containing claim data.
+
+        """
+
+        if not next_page_url:
+            request_url = self.config()["policyUrl"] + "/policies"
+
+            encoded_query = self.process_parameters(fields=fields, filters=filters, page_size=page_size)
+            if encoded_query:
+                request_url += "?" + encoded_query
+        else:
+            request_url = self.config()["restUrl"] + next_page_url
+
+        return self.do_request(method="GET", url=request_url)
+
+    # end method definition
+
+    def get_policies_iterator(
+        self, fields: list | None = None, filters: list | None = None, page_size: int = 25
+    ) -> iter:
+        """Get an iterator object that can be used to traverse all Guidewire policies.
+
+        Returning a generator avoids loading a large number of nodes into memory at once. Instead you
+        can iterate over the potential large list of groups.
+
+        Example usage:
+            policies = guidewire_object.get_policies_iterator()
+            for policy in policies:
+                logger.info("Traversing Guidewire policy -> '%s'...", policy.get("attributes", {}).get("displayName"))
+
+        Args:
+            fields (list | None, optional):
+                The list of fields in the results. If None, all default
+                fields are returned.
+                Fields for Guidewire accounts:
+                - *all = return all fields
+                - *default = return just the default list of fields
+                - *summary = return the fields defined for giving a summary
+                - *detail = details
+                - displayName
+                - groupType
+                - id
+                - loadFactor
+                - name
+                - organization
+                - parent
+                - securityZone
+                - supervisor
+            filters (list | None, optional):
+                List of dictionaries with three keys each:
+                - "attribute" - name of the attribute to use for the filter (available attributes see above)
+                - "op" - operator:
+                    * eq - equal
+                    * ne - not equal
+                    * lt - less than - also usable for dates (before)
+                    * gt - greater than - also usable for dates (after)
+                    * le - less or equal
+                    * ge - greater or equal
+                    * in - is in list
+                    * ni - is NOT in list
+                    * sw - starts with
+                    * cn - contains
+                - "value": the value to filter for. Either literal or list of values
+            page_size (int, optional):
+                The maximum number of policies to return.
+
+        Returns:
+            iter:
+                A generator yielding one Guidewire account per iteration.
+                If the REST API fails, returns no value.
+
+        """
+
+        next_page_url = None
+
+        while True:
+            response = self.get_policies(
+                fields=fields, filters=filters, page_size=page_size, next_page_url=next_page_url
+            )
+            if not response or "data" not in response:
+                # Don't return None! Plain return is what we need for iterators.
+                # Natural Termination: If the generator does not yield, it behaves
+                # like an empty iterable when used in a loop or converted to a list:
+                return
+
+            # Yield users one at a time:
+            yield from response["data"]
+
+            # See if we have an additional result page.
+            # If not terminate the iterator and return
+            # no value.
+            next_page_url = response.get("links", {}).get("next", {}).get("href")
+            if not next_page_url:
+                # Don't return None! Plain return is what we need for iterators.
+                # Natural Termination: If the generator does not yield, it behaves
+                # like an empty iterable when used in a loop or converted to a list:
+                return
+
+    # end method definition
+
+    def search_policy(self, attributes: dict) -> dict:
+        """Search a specific policy based on its attributes.
+
+        See: https://docs.guidewire.com/cloud/pc/202407/apiref/generated/Policy%20API/search-policies--post
+
+        Args:
+            attributes (dict):
+                The attribute to search the value in. Possible key values:
+                * "policyNumber" (str)
+                * "city" (str)
+                * "state" (dict with keys "code", "name"), e.g. {"code": "GA", "name": "Georgia"}
+                * "country" (str)
+                * "postalCode" (str)
+                * "street" (str)
+                * "companyName" (str)
+                * "firstName" (str)
+                * "lastName" (str)
+                * "officialId" (str)
+
+        Returns:
+            dict:
+                JSON response containing account details.
+
+        Example:
+        {
+            'count': 1,
+            'data': [
+                {
+                    'attributes': {
+                        'accountNumber': 'C000212105',
+                        'effectiveDate': '2025-07-14T04:01:00.000Z',
+                        'expirationDate': '2026-07-14T04:01:00.000Z',
+                        'insuredName': 'Armstrong and Company',
+                        'policyAddress': '142 Central Ave, Metter, GA 30439',
+                        'policyId': 'pc:Sn09Itxh7Btpc8izhUrtc',
+                        'policyNumber': '5050680845',
+                        'producerOfRecordName': 'Armstrong and Company',
+                        'producerOfServiceName': 'Armstrong and Company',
+                        'product': {
+                            'displayName': 'Manual Products',
+                            'id': 'Manual'
+                        }
+                    },
+                    'links': {...}
+                }
+            ],
+            'links': {
+                'first': {'href': '/policy/v1/search/policies', 'methods': ['post']},
+                'self': {'href': '/policy/v1/search/policies', 'methods': ['post']}
+            }
+        }
+
+        """
+
+        body = {"data": {"attributes": attributes}}
+
+        request_url = self.config()["policySearchUrl"]
+
+        return self.do_request(method="POST", json_data=body, url=request_url)
+
+    # end method definition
+
     def get_claims(
         self,
         fields: list | None = None,
@@ -1299,6 +1691,28 @@ class Guidewire:
 
     # end method definition
 
+    def search_claim(self, attributes: dict) -> dict:
+        """Search a specific claim based on its attributes.
+
+        Args:
+            attributes (dict):
+                The attribute to search the value in. Possible key values:
+                * TBD
+
+        Returns:
+            dict:
+                JSON response containing account details.
+
+        """
+
+        body = {"data": {"attributes": attributes}}
+
+        request_url = self.config()["claimSearchUrl"]
+
+        return self.do_request(method="POST", json_data=body, url=request_url)
+
+    # end method definition
+
     def add_claim(self, claim_data: dict) -> dict:
         """Create a new claim.
 

pyxecm_customizer/k8s.py

@@ -205,7 +205,7 @@ class K8s:
                 self.logger.debug("Pod -> '%s' not found (may be deleted).", pod_name)
                 return None
             else:
-                self.logger.error("Failed to get Pod -> '%s'!", pod_name)
+                self.logger.error("Failed to get pod -> '%s'!", pod_name)
                 return None  # Unexpected error, return None
         return response
 
@@ -306,8 +306,9 @@ class K8s:
 
             except ApiException:
                 self.logger.error(
-                    "Failed to wait for pod -> '%s'",
+                    "Failed to wait for pod -> '%s' to reach state -> '%s'.",
                     pod_name,
+                    condition_name,
                 )
 
     # end method definition
@@ -320,7 +321,7 @@ class K8s:
         time_retry: int = 10,
         container: str | None = None,
         timeout: int = 60,
-    ) -> str:
+    ) -> str | None:
         """Execute a command inside a Kubernetes Pod (similar to kubectl exec on command line).
 
         See: https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/CoreV1Api.md#connect_get_namespaced_pod_exec
@@ -342,14 +343,15 @@ class K8s:
                 Each time a response is found in stdout or stderr we wait another timeout duration [60]
 
         Returns:
-            str:
+            str | None:
                 Response of the command or None if the call fails.
 
         """
 
         pod = self.get_pod(pod_name=pod_name)
         if not pod:
-            self.logger.error("Pod -> '%s' does not exist", pod_name)
+            self.logger.error("Pod -> '%s' does not exist. Cannot execute command -> %s", pod_name, command)
+            return None
 
         self.logger.debug("Execute command -> %s in pod -> '%s'", command, pod_name)
 
@@ -391,10 +393,10 @@ class K8s:
                 return response
 
         self.logger.error(
-            "Failed to execute command with %s retries -> %s in pod -> '%s'; error -> %s",
-            max_retry,
+            "Failed to execute command -> %s in pod -> '%s' after %d retries; error -> %s",
             command,
             pod_name,
+            max_retry,
             str(exception),
         )
 
@@ -409,7 +411,7 @@ class K8s:
         commands: list,
         timeout: int = 30,
         write_stderr_to_error_log: bool = True,
-    ) -> str:
+    ) -> str | None:
         """Execute a command inside a Kubernetes pod (similar to kubectl exec on command line).
 
         Other than exec_pod_command() method above this is an interactive execution using
@@ -432,19 +434,20 @@ class K8s:
                 Default is write to error log (True).
 
         Returns:
-            str:
+            str | None:
                 Response of the command or None if the call fails.
 
         """
 
-        pod = self.get_pod(pod_name=pod_name)
-        if not pod:
-            self.logger.error("Pod -> '%s' does not exist", pod_name)
-
         if not commands:
             self.logger.error("No commands to execute on pod ->'%s'!", pod_name)
             return None
 
+        pod = self.get_pod(pod_name=pod_name)
+        if not pod:
+            self.logger.error("Pod -> '%s' does not exist. Cannot execute commands -> %s", pod_name, commands)
+            return None
+
         # Get first command - this should be the shell:
         command = commands.pop(0)
 
@@ -499,7 +502,7 @@ class K8s:
 
     # end method definition
 
-    def delete_pod(self, pod_name: str) -> None:
+    def delete_pod(self, pod_name: str) -> V1Pod | None:
         """Delete a pod in the configured namespace (the namespace is defined in the class constructor).
 
         See: https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/CoreV1Api.md#delete_namespaced_pod
@@ -509,21 +512,14 @@ class K8s:
                 The name of the Kubernetes pod in the current namespace.
 
         Returns:
-            V1Status (object) or None if the call fails.
-            - api_version: The Kubernetes API version.
-            - kind: The Kubernetes object kind, which is always "Status".
-            - metadata: Additional metadata about the status object, such as the resource version.
-            - status: The status of the operation, which is either "Success" or an error status.
-            - message: A human-readable message explaining the status.
-            - reason: A short string that describes the reason for the status.
-            - code: An HTTP status code that corresponds to the status.
-            See: https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1Status.md
+            V1Pod (object) or None if the call fails.
 
         """
 
         pod = self.get_pod(pod_name=pod_name)
         if not pod:
-            self.logger.error("Pod -> '%s' does not exist!", pod_name)
+            self.logger.error("Pod -> '%s' does not exist! Cannot delete it.", pod_name)
+            return None
 
         try:
             response = self.get_core_v1_api().delete_namespaced_pod(
@@ -1105,7 +1101,7 @@ class K8s:
             rule_index += 1
 
         if not host:
-            self.logger.error("Cannot find host.")
+            self.logger.error("Cannot find host to upgrade the Kubernetes Ingress -> '%s'", ingress_name)
             return None
 
         body = [
@@ -1351,7 +1347,7 @@ class K8s:
                     body,
                     pretty="true",
                 )
-                self.logger.info("Triggered restart of deployment -> '%s'.", deployment_name)
+                self.logger.debug("Triggered restart of deployment -> '%s'.", deployment_name)
 
             except ApiException as api_exception:
                 self.logger.error(
@@ -1484,7 +1480,7 @@ class K8s:
 
         try:
             self.get_apps_v1_api().patch_namespaced_stateful_set(sts_name, self.get_namespace(), body, pretty="true")
-            self.logger.info("Triggered restart of stateful set -> '%s'.", sts_name)
+            self.logger.debug("Triggered restart of stateful set -> '%s'.", sts_name)
 
         except ApiException as api_exception:
             self.logger.error("Failed to restart stateful set -> '%s'; error -> %s!", sts_name, str(api_exception))