brynq-sdk-zoho 1.0.0__tar.gz

brynq_sdk_zoho-1.0.0/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 1.0
+Name: brynq_sdk_zoho
+Version: 1.0.0
+Summary: ZOHO wrapper from BrynQ
+Home-page: UNKNOWN
+Author: BrynQ
+Author-email: support@brynq.com
+License: BrynQ License
+Description: ZOHO wrapper from BrynQ
+Platform: UNKNOWN

brynq_sdk_zoho-1.0.0/brynq_sdk/zoho/__init__.py

@@ -0,0 +1,2 @@
+from brynq_sdk.zoho.extract_zoho_desk import ExtractZohoDesk
+from brynq_sdk.zoho.upload_zoho_desk import UploadZohoDesk

brynq_sdk_zoho-1.0.0/brynq_sdk/zoho/extract_zoho_desk.py

@@ -0,0 +1,174 @@
+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 ExtractZohoDesk(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_headers(label=label)
+        self.base_url = "https://desk.zoho.com/api/v1/"
+        self.payload = {}
+
+    def _get_headers(self, label):
+        """
+        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)
+
+        # With those credentials, get the access_token from Tracket
+        org_id = credentials["config"]["organisation_id"]
+        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}',
+            'orgId': f'{org_id}',
+        }
+        return headers
+
+    def get_zoho_accounts(self, query_params=""):
+        """
+        This function gets all the accounts from zoho and saves them as df_zoho_accounts
+        :return: df_zoho_accounts
+        """
+        base_url = f"{self.base_url}accounts"
+        return self._multiple_calls(base_url, query_params)
+
+    def get_zoho_agents(self, query_params=""):
+        """
+        This function gets the user data from zoho and saves the data to df_zoho_users
+        :return:
+        """
+        base_url = f"{self.base_url}agents"
+        return self._multiple_calls(base_url, query_params)
+
+    def get_zoho_agent(self, agent_id, query_params=""):
+        """
+        This function gets the user data from zoho and saves the data to df_zoho_users
+        :return:
+        """
+        url = f"{self.base_url}agents/{agent_id}?{query_params}"
+        return self._single_call(url)
+
+    def get_zoho_contacts(self, query_params=""):
+        """
+        This function gets the zoho contact information from zoho desk and saves the data to df_zoho_contacts
+        :return:
+        """
+        base_url = f"{self.base_url}contacts"
+        return self._multiple_calls(base_url, query_params)
+
+    def get_recent_zoho_tickets(self, query_params=""):
+        """
+        This function gets the newest 100 tickets form Zoho-Desk
+        :return:
+        """
+        url = f"{self.base_url}tickets?limit=100&from=0&{query_params}"
+        return self._single_call(url)
+
+    def get_all_zoho_tickets(self, query_params: str = "") -> pd.DataFrame:
+        """
+        This function gets the zoho contact information from zoho desk and saves the data to df_zoho_contacts
+        :return:
+        """
+        base_url = f"{self.base_url}tickets"
+        return self._multiple_calls(base_url, query_params)
+
+    def get_archived_zoho_tickets(self, query_params: str = "") -> pd.DataFrame:
+        """
+        This function gets the zoho contact information from zoho desk and saves the data to df_zoho_contacts
+        :return:
+        """
+        base_url = f"{self.base_url}tickets/archivedTickets"
+        return self._multiple_calls(base_url, query_params)
+
+    def get_active_ticket_timers(self, tickets: pd.DataFrame, query_params: str = "") -> pd.DataFrame:
+        """=
+        This function gets all the active ticket timers from the tickets given in the tickets dataframe.
+        :param tickets: dataframe with the ticket_id's
+        :param query_params: query parameters for the API call
+        :return: pd.DataFrame with the ticket timers
+        """
+        df = pd.DataFrame()
+        count = 0
+        for index, ticket in tickets.iterrows():
+            count = count + 1
+            print(f"Checking for ticket number {ticket.ticket_id}. ticket {count} / " + str(
+                len(tickets.index)))
+            url = f"{self.base_url}tickets/{ticket.ticket_id}/activeTimer?{query_params}"
+            df_temp = self._single_call(url)
+            df_temp['ticket_id'] = ticket.ticket_id
+            df_temp['link'] = ticket.link
+            df_temp['ticket_number'] = ticket.ticket_number
+            df = pd.concat([df, df_temp])
+        df = df.reset_index(drop=True)
+        return df
+
+    def get_zoho_ticket_timers(self, tickets, query_params=""):
+        """
+        This function gets all the ticket timers from the recent tickets if there already exists a database. Otherwise,
+        it will get all the ticket timers. the ticket timers are saved to df_zoho_ticket_timers
+        :return:
+        """
+        df = pd.DataFrame()
+        count = 0
+        for ticket_id in tickets["ticket_id"]:
+            count = count + 1
+            print(f"Checking for ticket number {ticket_id}. ticket {count} / " + str(
+                len(tickets.index)))
+            url = f"{self.base_url}tickets/{ticket_id}/timeEntry?{query_params}"
+            df_temp = self._single_call(url)
+            df = pd.concat([df, df_temp])
+        df = df.reset_index(drop=True)
+        return df
+
+    def _multiple_calls(self, base_url, query_params) -> pd.DataFrame:
+        """
+        This function helps the API calls to do multiple calls in one function
+        :return:
+        """
+        df = pd.DataFrame()
+        end_of_loop = False
+        offset = 0
+        while not end_of_loop:
+            url = f"{base_url}?from={offset}&limit=90&{query_params}"
+            df_temp = self._single_call(url)
+            df = pd.concat([df_temp, df])
+            if len(df_temp) != 90:
+                end_of_loop = True
+            else:
+                offset += 90
+        return df
+
+    def _single_call(self, url: str) -> pd.DataFrame:
+        """
+        This function helps the API calls to do a single call in one function
+        :return:
+        """
+        response = requests.request("GET", url, headers=self.headers, data=self.payload)
+        if response.status_code == 401:
+            response = requests.request("GET", url, headers=self.headers, data=self.payload)
+        if response.status_code == 200:
+            df = response.json()
+            if 'data' in df:
+                df = pd.json_normalize(df['data'])
+            else:
+                df = pd.json_normalize(df)
+            return df
+        elif response.status_code == 204:
+            return pd.DataFrame()
+        else:
+            raise Exception(response.text)

brynq_sdk_zoho-1.0.0/brynq_sdk/zoho/upload_zoho_desk.py

@@ -0,0 +1,51 @@
+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_headers(label=label)
+        self.base_url = "https://desk.zoho.com/api/v1/"
+
+    def __get_headers(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
+        org_id = credentials["config"]["organisation_id"]
+        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}',
+            'orgId': f'{org_id}',
+            '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))
+        return response

brynq_sdk_zoho-1.0.0/brynq_sdk_zoho.egg-info/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 1.0
+Name: brynq-sdk-zoho
+Version: 1.0.0
+Summary: ZOHO wrapper from BrynQ
+Home-page: UNKNOWN
+Author: BrynQ
+Author-email: support@brynq.com
+License: BrynQ License
+Description: ZOHO wrapper from BrynQ
+Platform: UNKNOWN

brynq_sdk_zoho-1.0.0/brynq_sdk_zoho.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+setup.py
+brynq_sdk/zoho/__init__.py
+brynq_sdk/zoho/extract_zoho_desk.py
+brynq_sdk/zoho/upload_zoho_desk.py
+brynq_sdk_zoho.egg-info/PKG-INFO
+brynq_sdk_zoho.egg-info/SOURCES.txt
+brynq_sdk_zoho.egg-info/dependency_links.txt
+brynq_sdk_zoho.egg-info/not-zip-safe
+brynq_sdk_zoho.egg-info/requires.txt
+brynq_sdk_zoho.egg-info/top_level.txt

brynq_sdk_zoho-1.0.0/brynq_sdk_zoho.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

brynq_sdk_zoho-1.0.0/brynq_sdk_zoho.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

brynq_sdk_zoho-1.0.0/brynq_sdk_zoho.egg-info/requires.txt

@@ -0,0 +1 @@
+brynq-sdk-brynq>=1

brynq_sdk_zoho-1.0.0/brynq_sdk_zoho.egg-info/top_level.txt

@@ -0,0 +1 @@
+brynq_sdk

brynq_sdk_zoho-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

brynq_sdk_zoho-1.0.0/setup.py

@@ -0,0 +1,16 @@
+from setuptools import setup
+
+setup(
+    name='brynq_sdk_zoho',
+    version='1.0.0',
+    description='ZOHO wrapper from BrynQ',
+    long_description='ZOHO wrapper from BrynQ',
+    author='BrynQ',
+    author_email='support@brynq.com',
+    packages=["brynq_sdk.zoho"],
+    license='BrynQ License',
+    install_requires=[
+        'brynq-sdk-brynq>=1'
+    ],
+    zip_safe=False,
+)