Files

class Files(session_kwargs, client, return_type='raw')

Civis API /files endpoint.

Methods

delete_projects(id, project_id)	Remove a File from a project
delete_shares_groups(id, group_id)	Revoke the permissions a group has on this object
delete_shares_users(id, user_id)	Revoke the permissions a user has on this object
get(id, *[, link_expires_at, inline])	Get details about a file
get_preprocess_csv(id)	Get a Preprocess CSV
get_preview(id, *[, column_delimiter, ...])	Get a column and row preview of a file
list_dependencies(id, *[, user_id])	List dependent objects for this object
list_projects(id, *[, hidden])	List the projects a File belongs to
list_shares(id)	List users and groups permissioned on this object
patch(id, *[, name, expires_at, description])	Update details about a file
patch_preprocess_csv(id, *[, file_id, ...])	Update some attributes of this Preprocess CSV
post(name, *[, expires_at, description])	Initiate an upload of a file into the platform
post_multipart(name, num_parts, *[, ...])	Initiate a multipart upload
post_multipart_complete(id)	Complete a multipart upload
post_preprocess_csv(file_id, *[, in_place, ...])	Create a Preprocess CSV
put(id, name, expires_at, *[, description])	Update details about a file
put_preprocess_csv(id, file_id, *[, ...])	Replace all attributes of this Preprocess CSV
put_preprocess_csv_archive(id, status)	Update the archive status of this object
put_projects(id, project_id)	Add a File to a project
put_shares_groups(id, group_ids, ...[, ...])	Set the permissions groups has on this object
put_shares_users(id, user_ids, ...[, ...])	Set the permissions users have on this object
put_transfer(id, user_id, ...[, email_body, ...])	Transfer ownership of this object to another user