projectal.entities.company

 1from projectal.entity import Entity
 2from projectal.enums import CompanyType
 3from projectal.linkers import *
 4from projectal import api
 5
 6
 7class Company(Entity, LocationLinker, StaffLinker, CompanyLinker, DepartmentLinker,
 8              ProjectLinker, FileLinker, ContactLinker, NoteLinker, TagLinker):
 9    """
10    Implementation of the [Company](https://projectal.com/docs/latest/#tag/Company) API.
11    """
12    _path = 'company'
13    _name = 'company'
14
15    _links = [LocationLinker, StaffLinker, CompanyLinker, DepartmentLinker,
16              ProjectLinker, FileLinker, ContactLinker, NoteLinker, TagLinker]
17
18    @classmethod
19    def tree(cls, uuId=None, level=False, include_department=False):
20        """
21        Return company list in organisation chart format.
22
23        `uuId`: Of a company. If no company is requested, the full
24        organizational chart is returned (default: `None`)
25
26        `level`: If `True`, only returns the top level of the
27        hierarchy (default: `False`).
28
29        `include_department`: If `True`, lists all departments within
30        each company and their sub-companies (default: `False`).
31
32        """
33        url = '/api/company/tree?'
34        params = []
35        params.append('uuId={}'.format(uuId)) if uuId else None
36        params.append('level=true') if level else None
37        params.append('includeDepartment=true') if include_department else None
38        url += '&'.join(params)
39
40        return api.get(url)
41
42
43    @classmethod
44    def get_primary_company(cls, links=None):
45        """Return the Primary company"""
46        payload = {
47            "name": "Find primary company uuId",
48            "type": "msql", "start": 0, "limit": 1,
49            "select": [
50                ["COMPANY.uuId"]
51            ],
52            "filter": [["COMPANY.type", 'eq', CompanyType.Primary]]
53        }
54        response = api.query(payload)
55        uuId = response[0][0]
56        return cls.get(uuId, links)