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