Insightly-Python/insightly.py at master · msanjaq/Insightly-Python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
import time

import requests
from requests.auth import HTTPBasicAuth


class Entity:
    def __init__(self, auth, base_url):
        '''
        Initalizes class

        :param auth: Authorization needed to use Insightly's API
        :type auth: requests.auth.HTTPBasicAuth
        :param base_url: the api url base component
        :type url: str
        '''
        self.auth = auth
        self.base_url = base_url

    def get(self, eid):
        '''
        Gets the json of a single entity

        :param eid: Id of the entity
        :type eid: int
        '''
        req = requests.get(self.base_url+"/"+str(eid), auth=self.auth)
        return self._get_json(req)

    def get_all(self, brief=False):
        '''
        Returns a list of each entity's json

        :param brief: Whether the API strips the entitys's child objects
        '''
        result = []

        params = {"brief": brief, "skip": 0, "top": 500, "count_total": True}
        req = requests.get(self.base_url, auth=self.auth, params=params)
        count = int(req.headers["X-Total-Count"])

        while count >= 0:
            req = requests.get(self.base_url, auth=self.auth, params=params)

            if req.status_code == 200:
                pass

            elif req.status_code == 429:
                time.sleep(1)
                req = requests.get(self.base_url, auth=self.auth)

            else:
                req.raise_for_status()

            result += req.json()
            count -= params["top"]
            params["skip"] += params["top"]

        return result

    def update(self, data):
        '''
        Updates a entity and returns it's json post-update

        :param data: json that will be the result of the update
        :type data: dict
        '''
        req = requests.put(self.base_url, json=data, auth=self.auth)
        return self._get_json(req)

    def create(self, data):
        '''
        Creates an entity and returns it's json post-update

        :param data: json that will be the result of the update
        :type data: dict
        '''
        req = requests.post(self.base_url, json=data, auth=self.auth)
        return self._get_json(req)

    def delete(self, eid):
        '''
        Deletes a entity and returns none.

        :param eid: id of an entity that is to be deleted
        :type eid: int
        '''
        req = requests.delete(self.base_url+"/"+str(eid), auth=self.auth)
        req.raise_for_status()

    def _get_json(self, req):
        '''
        Raises an error if the request status code is not 200,
        otherwise returns the json object of the request

        :param req: the request that will have its json checked and retuned
        :type req: requests.Requests
        '''
        req.raise_for_status()
        return req.json()


class Contacts(Entity):
    def __init__(self, auth):
        '''
        Initalizes class

        :param auth: Authorization needed to use Insightly's API
        :type auth: requests.auth.HTTPBasicAuth
        '''
        Entity.__init__(self, auth, "https://api.insight.ly/v2.2/Contacts")


class Organisations(Entity):
    def __init__(self, auth):
        Entity.__init__(self, auth,
                        "https://api.insight.ly/v2.2/Organisations")

    def create(self, data):
        # we are using v2.1 of the API since v2.2 seems to have a bug with
        # creating an organisation
        '''
        Creates a organisations and returns it's json post-update

        :param data: json that will be the result of the update
        :type data: dict
        '''
        url = "https://api.insight.ly/v2.1/Organisations"
        req = requests.post(url, json=data, auth=self.auth)
        return self._get_json(req)


class Tasks(Entity):
    def __init__(self, auth):
        Entity.__init__(self, auth,
                        "https://api.insight.ly/v2.2/Tasks")


class Projects(Entity):
    def __init__(self, auth):
        Entity.__init__(self, auth,
                        "https://api.insight.ly/v2.2/Projects")


class Leads(Entity):
    def __init__(self, auth):
        Entity.__init__(self, auth,
                        "https://api.insight.ly/v2.2/leads")


class Opportunities(Entity):
    def __init__(self, auth):
        Entity.__init__(self, auth,
                        "https://api.insight.ly/v2.2/Opportunities")


class Insightly:
    def __init__(self, api_key):
        auth = HTTPBasicAuth(api_key, '')
        self.contacts = Contacts(auth)
        self.organisations = Organisations(auth)
        self.tasks = Tasks(auth)
        self.projects = Projects(auth)
        self.leads = Leads(auth)
        self.opportunities = Opportunities(auth)