Secure Share | Python SDK
init
Share()Delete (Beta)
Share.delete(id, path, force)Delete object by ID or path. If both are supplied, the path must match that of the object represented by the ID. How to install a Beta release.
response = share.delete(id="pos_3djfmzg2db4c6donarecbyv5begtj2bm")download-file
Share.download_file()Create a folder (Beta)
Share.folder_create(name, metadata, parent_id, path, tags)Create a folder, either by name or path and parent_id. How to install a Beta release.
response = share.folder_create(
metadata={
"created_by": "jim",
"priority": "medium",
},
parent_id="pos_3djfmzg2db4c6donarecbyv5begtj2bm",
path="/",
tags=["irs_2023", "personal"],
)Get an object (Beta)
Share.get(id, path, transfer_method)Get object. If both ID and Path are supplied, the call will fail if the target object doesn't match both properties. How to install a Beta release.
response = share.get(
id="pos_3djfmzg2db4c6donarecbyv5begtj2bm",
path="/",
)Get archive (Beta)
Share.get_archive(ids, format, transfer_method)Get an archive file of multiple objects. How to install a Beta release.
response = share.get_archive(
ids=["pos_3djfmzg2db4c6donarecbyv5begtj2bm"],
)List (Beta)
Share.list(filter, last, order, order_by, size)List or filter/search records. How to install a Beta release.
response = share.list()Poll result
Share.poll_result(exception)Returns request's result that has been accepted by the server
response = service.poll_result(exception)Upload a file (Beta)
Share.put(file, name, path, format, metadata, mimetype, parent_id, tags, transfer_method, crc32c, md5, sha1, sha256, sha512, size)Upload a file. How to install a Beta release.
try:
with open("./path/to/file.pdf", "rb") as f:
response = share.put(file=f)
print(f"Response: {response.result}")
except pe.PangeaAPIException as e:
print(f"Request Error: {e.response.summary}")
for err in e.errors:
print(f"\t{err.detail} \n")Request upload URL (Beta)
Share.request_upload_url(name, path, format, metadata, mimetype, parent_id, tags, transfer_method, md5, sha1, sha512, crc32c, sha256, size)Request an upload URL. How to install a Beta release.
response = share.request_upload_url(
transfer_method=TransferMethod.POST_URL,
crc32c="515f7c32",
sha256="c0b56b1a154697f79d27d57a3a2aad4c93849aa2239cd23048fc6f45726271cc",
size=222089,
metadata={
"created_by": "jim",
"priority": "medium",
},
parent_id="pos_3djfmzg2db4c6donarecbyv5begtj2bm",
path="/",
tags=["irs_2023", "personal"],
)Create share links (Beta)
Share.share_link_create(links)Create a share link. How to install a Beta release.
response = share.share_link_create(
links=[
{
targets: ["pos_3djfmzg2db4c6donarecbyv5begtj2bm"],
link_type: LinkType.DOWNLOAD,
authenticators: [
{
"auth_type": AuthenticatorType.PASSWORD,
"auth_context": "my_fav_Pa55word",
}
],
}
],
)Delete share links (Beta)
Share.share_link_delete(ids)Delete share links. How to install a Beta release.
response = share.share_link_delete(
ids=["psl_3djfmzg2db4c6donarecbyv5begtj2bm"]
)response = share.share_link_get(
id="psl_3djfmzg2db4c6donarecbyv5begtj2bm"
)List share links (Beta)
Share.share_link_list(filter, last, order, order_by, size)Look up share links by filter options. How to install a Beta release.
response = share.share_link_list()Send share links (Beta)
Share.share_link_send(sender_email)Send a secure share-link notification to a set of email addresses. The notification email will contain an Open button that the recipient can use to follow the secured share-link to authenticate and then access the shared content. How to install a Beta release.
response = share.share_link_send(
links=[ShareLinkSendItem(id=link.id, email="foo@example.org")],
sender_email="sender@example.org",
)Update a file (Beta)
Share.update(id, path, add_metadata, remove_metadata, metadata, add_tags, remove_tags, tags, parent_id, updated_at)Update a file. How to install a Beta release.
response = share.update(
id="pos_3djfmzg2db4c6donarecbyv5begtj2bm",
remove_metadata={
"created_by": "jim",
"priority": "medium",
},
remove_tags=["irs_2023", "personal"],
)