brynq-sdk-zoho 2.0.4__tar.gz → 3.1.0__tar.gz

{brynq_sdk_zoho-2.0.4 → brynq_sdk_zoho-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq_sdk_zoho
-Version: 2.0.4
+Version: 3.1.0
 Summary: ZOHO wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_zoho-2.0.4 → brynq_sdk_zoho-3.1.0}/brynq_sdk_zoho/extract_zoho_desk.py

@@ -1,7 +1,7 @@
 import os
 import sys
 import pandas as pd
-from typing import Union, List
+from typing import Union, List, Optional, Literal
 import requests
 import json
 from brynq_sdk_brynq import BrynQ
@@ -12,29 +12,28 @@ sys.path.append(basedir)
 
 class ExtractZohoDesk(BrynQ):
 
-    def __init__(self, label: Union[str, List], debug: bool = False):
+    def __init__(self, system_type: Optional[Literal['source', 'target']] = None, debug: bool = False):
         """
         For the full documentation, see: https://avisi-apps.gitbook.io/tracket/api/
         """
         super().__init__()
-        self.headers = self._get_authentication(label=label)
+        self.headers = self._get_authentication(system_type)
         self.base_url = "https://desk.zoho.com/api/v1/"
         self.payload = {}
         self.timeout = 3600
 
-    def _get_authentication(self, label):
+    def _get_authentication(self, system_type):
         """
         Get the credentials for the Tracket API from BrynQ, with those credentials, get the access_token for Tracket.
         Return the headers with the access_token.
         """
         # Get credentials from BrynQ
-        credentials = self.get_system_credential(system='zoho-desk', label=label)
+        credentials = self.interfaces.credentials.get(system="zoho-desk", system_type=system_type)
+        credentials = credentials.get('data')
 
         # With those credentials, get the access_token from Tracket
-        zoho_system_id = credentials["id"]
-        token = BrynQ().refresh_system_credential(system="zoho-desk", system_id=zoho_system_id)["access_token"]
         headers = {
-            'Authorization': f'Zoho-oauthtoken {token}'
+            'Authorization': f'Zoho-oauthtoken {credentials.get("access_token")}'
         }
         return headers
 
@@ -141,7 +140,7 @@ class ExtractZohoDesk(BrynQ):
         """
         df = pd.DataFrame()
         end_of_loop = False
-        offset = 0
+        offset = 1
         while not end_of_loop:
             url = f"{base_url}?from={offset}&limit=90&{query_params}"
             df_temp = self._single_call(url)
@@ -171,3 +170,88 @@ class ExtractZohoDesk(BrynQ):
             return pd.DataFrame()
         else:
             raise Exception(response.text)
+
+    def get_zoho_articles(self, exclude_category_ids: list = []) -> list:
+        """
+        Retrieves all Zoho articles, excluding articles with specified category ID
+        Category ID's can be easily found in your KB-Admin in the link of any article.
+        """
+        limit = 50
+        offset = 1
+        all_articles = []
+
+        while True:
+            url = f'{self.base_url}articles'
+            params = {"status": "Draft,Published", "from": offset, "limit": limit}
+            response = requests.get(url, headers=self.headers, params=params, timeout=120)
+            if response.status_code == 200:
+                articles = response.json().get('data', [])
+                if not articles:
+                    break
+
+                # Filter out articles with the excluded category ID
+                filtered_articles = []
+                for article in articles:
+                    article_category_id = article.get('categoryId')
+                    locale = article.get('locale', "")
+                    if article_category_id not in exclude_category_ids and locale == "nl":
+                        filtered_articles.append(article)
+
+                all_articles.extend(filtered_articles)
+
+                if len(articles) < limit:
+                    break
+            else:
+                error_text = response.text
+                all_articles.insert("Failed to retrieve Zoho articles, status: {response.status_code}, body: {error_text}")
+            offset += limit
+        return all_articles
+
+    def get_base_article_by_id(self, article_id: str) -> dict:
+        """
+        Retrieves the base (non-versioned) Zoho article by ID.
+        """
+        try:
+            detail_url = f"{self.base_url}articles/{article_id}"
+            response = requests.get(detail_url, headers=self.headers, timeout=60)
+            if response.status_code == 200:
+                return response.json()
+            message = f"Failed to retrieve base article for article ID: {article_id}, status: {response.status_code}"
+            return message
+        except Exception as e:
+            message = f"Error getting base article by id: {e}"
+            return message
+
+    def get_zoho_article_latest(self, zoho_article: dict) -> dict:
+        """
+        Retrieves detailed article data from Zoho Desk using the base article object.
+        Uses the article's id and, if available, its latestVersion to fetch the right version.
+        """
+        try:
+            article_id = zoho_article.get("id")
+            if not article_id:
+                message = "Error: No article id provided in base article object."
+                return message
+
+            latest_version = zoho_article.get("latestVersion")
+
+            if latest_version:
+                versioned_article_url = f"{self.base_url}articles/{article_id}?version={latest_version}"
+                version_response = requests.get(versioned_article_url, headers=self.headers, timeout=60)
+                if version_response.status_code == 200:
+                    return version_response.json()
+                message = f"Failed to retrieve versioned article data, status: {version_response.status_code}"
+                return message
+
+            detail_url = f"{self.base_url}articles/{article_id}"
+            response = requests.get(detail_url, headers=self.headers, timeout=60)
+            if response.status_code == 200:
+                article_data = response.json()
+                print(f"Retrieved detailed article data for article ID: {article_id}")
+                return article_data
+            else:
+                message = f"Failed to retrieve versioned article data, status: {version_response.status_code}"
+                return message
+        except Exception as e:
+            message = "Retrieving latest Zoho Article Failed."
+            return message

brynq_sdk_zoho-3.1.0/brynq_sdk_zoho/upload_zoho_desk.py

@@ -0,0 +1,121 @@
+import os
+import sys
+import pandas as pd
+from typing import Union, List, Optional, Literal
+import requests
+import json
+import re
+from brynq_sdk_brynq import BrynQ
+basedir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+sys.path.append(basedir)
+
+
+class UploadZohoDesk(BrynQ):
+
+    def __init__(self, system_type: Optional[Literal['source', 'target']] = None, debug: bool = False):
+        """
+        For the full documentation, see: https://avisi-apps.gitbook.io/tracket/api/
+        """
+        super().__init__()
+        self.headers = self._get_authentication(system_type)
+        self.base_url = "https://desk.zoho.com/api/v1/"
+        self.timeout = 3600
+
+    def _get_authentication(self, system_type):
+        """
+        Get the credentials for the Traket API from BrynQ, with those credentials, get the access_token for Tracket.
+        Return the headers with the access_token.
+        """
+        # Get credentials from BrynQ
+        credentials = self.interfaces.credentials.get(system="zoho-desk", system_type=system_type)
+        credentials = credentials.get('data')
+
+        headers = {
+            'Authorization': f'Zoho-oauthtoken {credentials.get("access_token")}',
+            'Content-Type': 'application/json'
+        }
+        return headers
+
+    def update_ticket_time_entry(self, ticket_id, time_entry_id, payload):
+        """
+        This function updates the time entry of a ticket in zoho desk
+        :param ticket_id: str
+        :param time_entry_id: str
+        :param payload: dict
+        """
+        url = f"{self.base_url}tickets/{ticket_id}/timeEntry/{time_entry_id}"
+        response = requests.request("PATCH", url, headers=self.headers, data=json.dumps(payload), timeout=self.timeout)
+        return response
+
+    def update_article(self, article_id: str, updated_content: str, category_id: int, status="Draft") -> str:
+        """
+        Updates the Zoho article with the updated content as a draft.
+        Returns the web URL where the draft can be reviewed, or an empty string if the update fails.
+
+        Status can be:
+        - Draft
+        - Published
+        - Review
+        - Unpublished
+        """
+        try:
+
+            payload = {
+                "answer": updated_content,
+                "status": status
+            }
+            if category_id is not None:
+                payload["categoryId"] = category_id
+            update_url = f"{self.base_url}articles/{article_id}"
+            update_headers = self.headers
+
+            update_response = requests.patch(update_url, headers=update_headers, data=json.dumps(payload), timeout=60)
+            if update_response.status_code == 200:
+                update_data = update_response.json()
+                web_url = update_data.get("webUrl", "")
+                return web_url
+            else:
+                message = f"Uploading Draft failed. Response: {update_response.status_code}"
+                return message
+        except Exception as e:
+            message = "Uploading Draft failed."
+            return message
+
+    def upload_translation(self, translated, article_data, locale = "en-us"):
+        try:
+            article_id = article_data.get("id")
+            title = article_data.get("title")
+
+            url = f"{self.base_url}articles/{article_id}/translations"
+
+            # Get authorId from the article data or use a default
+            author_id = article_data.get("authorId") or article_data.get("createdBy", {}).get("id")
+            payload = {
+                "title" : title,
+                "answer" : translated,
+                "status" : "Draft",
+                "locale" : locale,
+                "authorId" : author_id
+            }
+            response = requests.post(url, headers=self.headers, data=json.dumps(payload), timeout=60)
+            if response.status_code == 200:
+                update_data = response.json()
+                web_url = update_data.get("webUrl", "")
+                return web_url
+            else:
+                url = f"{self.base_url}articles/{article_id}/translations/{locale}"
+                payload = {
+                "answer" : translated,
+                "status" : "Draft"
+            }
+                response = requests.patch(url, headers=self.headers, data=json.dumps(payload), timeout=60)
+                if response.status_code == 200:
+                    update_data = response.json()
+                    web_url = update_data.get("webUrl", "")
+                    return web_url
+                else:
+                    message = "Uploading Translation failed."
+                    return message
+        except Exception as e:
+                message = "Uploading Translation failed."
+                return message

{brynq_sdk_zoho-2.0.4 → brynq_sdk_zoho-3.1.0}/brynq_sdk_zoho.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq-sdk-zoho
-Version: 2.0.4
+Version: 3.1.0
 Summary: ZOHO wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_zoho-2.0.4 → brynq_sdk_zoho-3.1.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_namespace_packages
 
 setup(
     name='brynq_sdk_zoho',
-    version='2.0.4',
+    version='3.1.0',
     description='ZOHO wrapper from BrynQ',
     long_description='ZOHO wrapper from BrynQ',
     author='BrynQ',

brynq_sdk_zoho-2.0.4/brynq_sdk_zoho/upload_zoho_desk.py

@@ -1,50 +0,0 @@
-import os
-import sys
-import pandas as pd
-from typing import Union, List
-import requests
-import json
-from brynq_sdk_brynq import BrynQ
-
-basedir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-sys.path.append(basedir)
-
-
-class UploadZohoDesk(BrynQ):
-
-    def __init__(self, label: Union[str, List], debug: bool = False):
-        """
-        For the full documentation, see: https://avisi-apps.gitbook.io/tracket/api/
-        """
-        super().__init__()
-        self.headers = self._get_authentication(label=label)
-        self.base_url = "https://desk.zoho.com/api/v1/"
-        self.timeout = 3600
-
-    def _get_authentication(self, label):
-        """
-        Get the credentials for the Traket API from BrynQ, with those credentials, get the access_token for Tracket.
-        Return the headers with the access_token.
-        """
-        # Get credentials from BrynQ
-        credentials = self.get_system_credential(system='zoho-desk', label=label)
-
-        # With those credentials, get the access_token from Tracket
-        zoho_system_id = credentials["id"]
-        token = BrynQ().refresh_system_credential(system="zoho-desk", system_id=zoho_system_id)["access_token"]
-        headers = {
-            'Authorization': f'Zoho-oauthtoken {token}',
-            'Content-Type': 'application/json'
-        }
-        return headers
-
-    def update_ticket_time_entry(self, ticket_id, time_entry_id, payload):
-        """
-        This function updates the time entry of a ticket in zoho desk
-        :param ticket_id: str
-        :param time_entry_id: str
-        :param payload: dict
-        """
-        url = f"{self.base_url}tickets/{ticket_id}/timeEntry/{time_entry_id}"
-        response = requests.request("PATCH", url, headers=self.headers, data=json.dumps(payload), timeout=self.timeout)
-        return response