projectal.entities.file

  1from projectal.entity import Entity
  2from projectal.linkers import *
  3from projectal import api
  4
  5
  6class File(
  7    Entity,
  8    CompanyLinker,
  9    CustomerLinker,
 10    FolderLinker,
 11    ProjectLinker,
 12    StaffLinker,
 13    TaskLinker,
 14    TaskTemplateLinker,
 15    NoteLinker,
 16    TagLinker,
 17):
 18    """
 19    Implementation of the [File](https://projectal.com/docs/latest/#tag/File) API.
 20    """
 21
 22    _path = "file"
 23    _name = "file"
 24    _links = [NoteLinker, TagLinker]
 25    _links_reverse = [
 26        CompanyLinker,
 27        CustomerLinker,
 28        FolderLinker,
 29        ProjectLinker,
 30        StaffLinker,
 31        TaskLinker,
 32        TaskTemplateLinker,
 33    ]
 34
 35    @classmethod
 36    def create(cls, file_data, entity):
 37        """
 38        Create a File entity with file data.
 39
 40        `file_data` is the raw file data in bytes
 41
 42        `entity` is the File entity and its fields.
 43        """
 44        payload = entity
 45        url = "/api/file/upload"
 46        file = {"file": file_data}
 47        response = api.post(url, payload, file=file)
 48        entity["uuId"] = response["jobClue"]["uuId"]
 49        return cls(entity)
 50
 51    @classmethod
 52    def get(cls, uuId, links=None):
 53        """Get the File entity. No file data is included."""
 54        link_set = cls._get_linkset(links)
 55        url = "/api/file/get?uuId={}".format(uuId)
 56        if link_set:
 57            url += "&links=" + ",".join(link_set)
 58        return cls(api.get(url))
 59
 60    @classmethod
 61    def update(cls, entity, file_data=None):
 62        """
 63        Update the File entity. Optionally, also update the
 64        file data that this File holds.
 65        """
 66        payload = entity
 67        url = "/api/file/update"
 68        if file_data:
 69            file = {"file": file_data}
 70            api.put(url, payload, file=file)
 71        else:
 72            api.put(url, payload, form=True)
 73
 74    @classmethod
 75    def get_file_data(cls, uuId):
 76        """
 77        Get the file data that is held by the file with `uuId`.
 78        Returns the raw content of the response.
 79        """
 80        url = "/api/file/{}".format(uuId)
 81        response = api.get(url, is_json=False)
 82        return response.content
 83
 84    @classmethod
 85    def download_to_browser(cls, uuId):
 86        """
 87        Get the file data that is held by the file with `uuId`.
 88        Returns the response object which will have headers suitable
 89        to initiate a download by the user agent.
 90        """
 91        url = "/api/file/download"
 92        payload = {"uuId": uuId}
 93        response = api.post(url, payload, is_json=False)
 94        return response
 95
 96    @classmethod
 97    def delete(cls, uuId):
 98        """
 99        Delete the File entity and its file data.
100        """
101        url = "/api/file/delete/{}".format(uuId)
102        api.delete(url)
103        return True
104
105    @classmethod
106    def download_multiple(cls, list):
107        """
108        Given a list of File entities, return the file data held by
109        each as a `.zip` file.
110        """
111        url = "/api/file/multidownload"
112        response = api.post(url, list, is_json=False)
113        return response.content
114
115    @classmethod
116    def list(cls, expand=True):
117        """Return all files as a list"""
118        files = api.get("/api/file/list")
119        return [cls(f) for f in files]