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

Copy Markdown View Source

Legacy Dropbox Paper API (paper/*).

Prefer files/paper/* for new Paper docs stored in Dropbox filesystem.

Summary

Types

opts()
result()

Functions

docs_archive(doc_id, opts \\ [])

POST paper/docs/archive.

docs_create(data, opts \\ [])

POST paper/docs/create (content upload).

docs_download(doc_id, opts \\ [])

POST paper/docs/download (content download).

docs_folder_users_list(doc_id, opts \\ [])

POST paper/docs/folder_users/list.

docs_folder_users_list_continue(cursor, opts \\ [])

POST paper/docs/folder_users/list/continue.

docs_get_folder_info(doc_id, opts \\ [])

POST paper/docs/get_folder_info.

docs_get_metadata(doc_id, opts \\ [])

POST paper/docs/get_metadata.

docs_list(opts \\ [])

POST paper/docs/list.

docs_list_continue(cursor, opts \\ [])

POST paper/docs/list/continue.

docs_permanently_delete(doc_id, opts \\ [])

POST paper/docs/permanently_delete.

docs_sharing_policy_get(doc_id, opts \\ [])

POST paper/docs/sharing_policy/get.

docs_sharing_policy_set(doc_id, sharing_policy, opts \\ [])

POST paper/docs/sharing_policy/set.

docs_update(doc_id, data, opts \\ [])

POST paper/docs/update (content upload).

docs_users_add(doc_id, members, opts \\ [])

POST paper/docs/users/add.

docs_users_list(doc_id, opts \\ [])

POST paper/docs/users/list.

docs_users_list_continue(cursor, opts \\ [])

POST paper/docs/users/list/continue.

docs_users_remove(doc_id, member, opts \\ [])

POST paper/docs/users/remove.

folders_create(name, opts \\ [])

POST paper/folders/create.

Types

opts()

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

result()

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

Functions

docs_archive(doc_id, opts \\ [])

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

POST paper/docs/archive.

docs_create(data, opts \\ [])

@spec docs_create(binary(), opts()) :: result()

POST paper/docs/create (content upload).

Options

  • :import_format (required) — e.g. "markdown", "html", "plain_text"
  • :parent_folder_id

docs_download(doc_id, opts \\ [])

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

POST paper/docs/download (content download).

Options

  • :export_format (required) — e.g. "markdown", "html"

docs_folder_users_list(doc_id, opts \\ [])

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

POST paper/docs/folder_users/list.

docs_folder_users_list_continue(cursor, opts \\ [])

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

POST paper/docs/folder_users/list/continue.

docs_get_folder_info(doc_id, opts \\ [])

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

POST paper/docs/get_folder_info.

docs_get_metadata(doc_id, opts \\ [])

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

POST paper/docs/get_metadata.

docs_list(opts \\ [])

@spec docs_list(opts()) :: result()

POST paper/docs/list.

docs_list_continue(cursor, opts \\ [])

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

POST paper/docs/list/continue.

docs_permanently_delete(doc_id, opts \\ [])

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

POST paper/docs/permanently_delete.

docs_sharing_policy_get(doc_id, opts \\ [])

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

POST paper/docs/sharing_policy/get.

docs_sharing_policy_set(doc_id, sharing_policy, opts \\ [])

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

POST paper/docs/sharing_policy/set.

docs_update(doc_id, data, opts \\ [])

@spec docs_update(String.t(), binary(), opts()) :: result()

POST paper/docs/update (content upload).

Options

  • :import_format (required)
  • :doc_update_policy (required)
  • :revision (required)

docs_users_add(doc_id, members, opts \\ [])

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

POST paper/docs/users/add.

docs_users_list(doc_id, opts \\ [])

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

POST paper/docs/users/list.

docs_users_list_continue(cursor, opts \\ [])

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

POST paper/docs/users/list/continue.

docs_users_remove(doc_id, member, opts \\ [])

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

POST paper/docs/users/remove.

folders_create(name, opts \\ [])

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

POST paper/folders/create.