Noizu.Dropbox.Api.Sharing (Noizu Dropbox v0.1.0)

Copy Markdown View Source

Dropbox sharing/* endpoints — folders, files, members, and shared links.

Summary

Functions

POST sharing/add_file_member.

POST sharing/check_job_status.

POST sharing/check_remove_member_job_status.

POST sharing/check_share_job_status.

POST sharing/create_shared_link (legacy).

POST sharing/create_shared_link_with_settings.

POST sharing/get_file_metadata.

POST sharing/get_file_metadata/batch.

POST sharing/get_folder_metadata.

POST sharing/get_shared_link_file (content download).

POST sharing/get_shared_link_metadata.

POST sharing/get_shared_links (legacy).

POST sharing/list_file_members.

POST sharing/list_file_members/batch.

POST sharing/list_file_members/continue.

POST sharing/list_folder_members.

POST sharing/list_folder_members/continue.

POST sharing/list_folders.

POST sharing/list_folders/continue.

POST sharing/list_mountable_folders.

POST sharing/list_mountable_folders/continue.

POST sharing/list_received_files.

POST sharing/list_received_files/continue.

POST sharing/list_shared_links.

POST sharing/modify_shared_link_settings.

POST sharing/mount_folder.

POST sharing/relinquish_access (legacy alias path if needed by clients).

POST sharing/relinquish_file_membership.

POST sharing/relinquish_folder_membership.

POST sharing/remove_file_member_2.

POST sharing/revoke_shared_link.

POST sharing/share_folder.

POST sharing/unmount_folder.

POST sharing/unshare_file.

POST sharing/unshare_folder.

POST sharing file policy helper.

POST sharing/update_folder_policy.

Types

opts()

@type opts() :: keyword() | map()

result()

@type result() :: {:ok, term()} | {:error, Noizu.Dropbox.Error.t()}

Functions

add_file_member(file, members, opts \\ [])

@spec add_file_member(String.t(), [map()], opts()) :: result()

POST sharing/add_file_member.

add_folder_member(shared_folder_id, members, opts \\ [])

@spec add_folder_member(String.t(), [map()], opts()) :: result()

POST sharing/add_folder_member.

check_job_status(async_job_id, opts \\ [])

@spec check_job_status(String.t(), opts()) :: result()

POST sharing/check_job_status.

check_remove_member_job_status(async_job_id, opts \\ [])

@spec check_remove_member_job_status(String.t(), opts()) :: result()

POST sharing/check_remove_member_job_status.

check_share_job_status(async_job_id, opts \\ [])

@spec check_share_job_status(String.t(), opts()) :: result()

POST sharing/check_share_job_status.

create_shared_link(path, opts \\ [])

@spec create_shared_link(String.t(), opts()) :: result()

POST sharing/create_shared_link (legacy).

get_file_metadata(file, opts \\ [])

@spec get_file_metadata(String.t(), opts()) :: result()

POST sharing/get_file_metadata.

get_file_metadata_batch(files, opts \\ [])

@spec get_file_metadata_batch([String.t()], opts()) :: result()

POST sharing/get_file_metadata/batch.

get_folder_metadata(shared_folder_id, opts \\ [])

@spec get_folder_metadata(String.t(), opts()) :: result()

POST sharing/get_folder_metadata.

get_shared_links(opts \\ [])

@spec get_shared_links(opts()) :: result()

POST sharing/get_shared_links (legacy).

list_file_members(file, opts \\ [])

@spec list_file_members(String.t(), opts()) :: result()

POST sharing/list_file_members.

list_file_members_batch(files, opts \\ [])

@spec list_file_members_batch([String.t()], opts()) :: result()

POST sharing/list_file_members/batch.

list_file_members_continue(cursor, opts \\ [])

@spec list_file_members_continue(String.t(), opts()) :: result()

POST sharing/list_file_members/continue.

list_folder_members(shared_folder_id, opts \\ [])

@spec list_folder_members(String.t(), opts()) :: result()

POST sharing/list_folder_members.

list_folder_members_continue(cursor, opts \\ [])

@spec list_folder_members_continue(String.t(), opts()) :: result()

POST sharing/list_folder_members/continue.

list_folders(opts \\ [])

@spec list_folders(opts()) :: result()

POST sharing/list_folders.

list_folders_continue(cursor, opts \\ [])

@spec list_folders_continue(String.t(), opts()) :: result()

POST sharing/list_folders/continue.

list_mountable_folders(opts \\ [])

@spec list_mountable_folders(opts()) :: result()

POST sharing/list_mountable_folders.

list_mountable_folders_continue(cursor, opts \\ [])

@spec list_mountable_folders_continue(String.t(), opts()) :: result()

POST sharing/list_mountable_folders/continue.

list_received_files(opts \\ [])

@spec list_received_files(opts()) :: result()

POST sharing/list_received_files.

list_received_files_continue(cursor, opts \\ [])

@spec list_received_files_continue(String.t(), opts()) :: result()

POST sharing/list_received_files/continue.

list_shared_links(opts \\ [])

@spec list_shared_links(opts()) :: result()

POST sharing/list_shared_links.

mount_folder(shared_folder_id, opts \\ [])

@spec mount_folder(String.t(), opts()) :: result()

POST sharing/mount_folder.

relinquish_access(shared_folder_id, opts \\ [])

@spec relinquish_access(String.t(), opts()) :: result()

POST sharing/relinquish_access (legacy alias path if needed by clients).

relinquish_file_membership(file, opts \\ [])

@spec relinquish_file_membership(String.t(), opts()) :: result()

POST sharing/relinquish_file_membership.

relinquish_folder_membership(shared_folder_id, opts \\ [])

@spec relinquish_folder_membership(String.t(), opts()) :: result()

POST sharing/relinquish_folder_membership.

remove_file_member_2(file, member, opts \\ [])

@spec remove_file_member_2(String.t(), map(), opts()) :: result()

POST sharing/remove_file_member_2.

remove_folder_member(shared_folder_id, member, opts \\ [])

@spec remove_folder_member(String.t(), map(), opts()) :: result()

POST sharing/remove_folder_member.

revoke_shared_link(url, opts \\ [])

@spec revoke_shared_link(String.t(), opts()) :: result()

POST sharing/revoke_shared_link.

set_access_inheritance(shared_folder_id, access_inheritance, opts \\ [])

@spec set_access_inheritance(String.t(), map() | String.t(), opts()) :: result()

POST sharing/set_access_inheritance.

share_folder(path, opts \\ [])

@spec share_folder(String.t(), opts()) :: result()

POST sharing/share_folder.

transfer_folder(shared_folder_id, to_dropbox_id, opts \\ [])

@spec transfer_folder(String.t(), String.t(), opts()) :: result()

POST sharing/transfer_folder.

unmount_folder(shared_folder_id, opts \\ [])

@spec unmount_folder(String.t(), opts()) :: result()

POST sharing/unmount_folder.

unshare_file(file, opts \\ [])

@spec unshare_file(String.t(), opts()) :: result()

POST sharing/unshare_file.

unshare_folder(shared_folder_id, opts \\ [])

@spec unshare_folder(String.t(), opts()) :: result()

POST sharing/unshare_folder.

update_file_member(file, member, access_level, opts \\ [])

@spec update_file_member(String.t(), map(), map() | String.t(), opts()) :: result()

POST sharing/update_file_member.

update_file_policy(file, opts \\ [])

@spec update_file_policy(String.t(), opts()) :: result()

POST sharing file policy helper.

Accepts policy-related opts (:member_policy, :acl_update_policy, :viewer_info_policy, :shared_link_policy, :actions) and posts them with the file path/id. Prefer modify_shared_link_settings/3 for link settings and update_file_member/4 for per-member access levels.

update_folder_member(shared_folder_id, member, access_level, opts \\ [])

@spec update_folder_member(String.t(), map(), map() | String.t(), opts()) :: result()

POST sharing/update_folder_member.

update_folder_policy(shared_folder_id, opts \\ [])

@spec update_folder_policy(String.t(), opts()) :: result()

POST sharing/update_folder_policy.