Notebooks

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

Civis API /notebooks endpoint.

Methods

delete_deployments(notebook_id, deployment_id)	Delete a Notebook deployment
delete_projects(id, project_id)	Remove a Notebook 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)	Get a Notebook
get_deployments(notebook_id, deployment_id)	Get details about a Notebook deployment
get_git(id)	Get the git metadata attached to an item
get_git_commits(id, commit_hash)	Get file contents at git ref
get_update_links(id)	Get URLs to update notebook
list(*[, hidden, archived, author, status, ...])	List Notebooks
list_dependencies(id, *[, user_id])	List dependent objects for this object
list_deployments(notebook_id, *[, ...])	List deployments for a Notebook
list_deployments_logs(id, deployment_id, *)	Get the logs for a Notebook deployment
list_git(id)	Get the git metadata attached to an item
list_git_commits(id)	Get the git commits for an item on the current branch
list_projects(id, *[, hidden])	List the projects a Notebook belongs to
list_shares(id)	List users and groups permissioned on this object
list_update_links(id)	Get URLs to update notebook
patch(id, *[, name, language, description, ...])	Update some attributes of this Notebook
patch_git(id, *[, git_ref, git_branch, ...])	Update an attached git file
post(*[, name, language, description, ...])	Create a Notebook
post_clone(id)	Clone this Notebook
post_deployments(notebook_id, *[, deployment_id])	Deploy a Notebook
post_git_commits(id, content, message, file_hash)	Commit and push a new version of the file
put(id, *[, name, language, description, ...])	Replace all attributes of this Notebook
put_archive(id, status)	Update the archive status of this object
put_git(id, *[, git_ref, git_branch, ...])	Attach an item to a file in a git repo
put_projects(id, project_id)	Add a Notebook 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