endpoints.Documents.Documents

Documents methods

add_document

 | add_document(employee_id, doc_name, doc_url, tags=None, shared=True)

Add a document to an employee to the shared or confidential folder

Arguments:

• employee_id str - employee id
• doc_name str - document name
• doc_url str - URL of the document to upload
• tags List[str] - document's tags
• shared bool - whether document should be uploaded to shared folder or confidential

References:

• https://apidocs.hibob.com/reference#post_docs-people-id-shared
• https://apidocs.hibob.com/reference#post_docs-people-id-confidential

---

delete_document

 | delete_document(employee_id, doc_id, shared=True)

Delete specific document from employee's shared or confidential folder

Arguments:

• employee_id str - employee id
• doc_id str - document id
• shared bool - whether document should be deleted from shared folder or confidential

References:

• https://apidocs.hibob.com/reference#delete_docs-people-id-shared-docid
• https://apidocs.hibob.com/reference#delete_docs-people-id-confidential-docid

---

list

 | list(employee_id)

Download employee's documents

Returns list of documents and download links.

Arguments:

• employee_id str - employee id

References:

• https://apidocs.hibob.com/reference#get_docs-people-id