Magpie.Paper.Docs (Magpie v0.1.0)

Copy Markdown View Source

Dropbox Paper docs endpoints.

Deprecated

The whole /paper/docs/* API is deprecated by Dropbox in favor of Paper docs stored as regular files (/files/paper/*).

Summary

Functions

Marks the given Paper doc as archived.

Creates a new Paper doc with the provided content.

Exports and downloads Paper doc either as HTML or markdown.

Return the list of all Paper docs according to the argument specifications.

Updates an existing Paper doc with the provided content.

Retrieves folder information for the given Paper doc.

Returns metadata for a Paper doc or Cloud Doc. This route is NOT deprecated. opts accepts "doc_id" or "file_id".

Permanently deletes the given Paper doc.

Functions

docs_archive(client, doc_id)

Marks the given Paper doc as archived.

Example

Magpie.Paper.Docs.docs_archive client, ""

More info at: https://www.dropbox.com/developers/documentation/http/documentation#paper-docs-create

docs_create(client, import_format, parent_folder_id, file)

Creates a new Paper doc with the provided content.

Example

Magpie.Paper.Docs.docs_create client, "", "", ""

More info at: https://www.dropbox.com/developers/documentation/http/documentation#paper-docs-create

docs_download(client, doc_id, export_format)

Exports and downloads Paper doc either as HTML or markdown.

Example

Magpie.Paper.Docs.docs_download client, "", ""

More info at: https://www.dropbox.com/developers/documentation/http/documentation#paper-docs-download

docs_list(client, filter_by \\ "docs_created", sort_by \\ "modified", sort_order \\ "descending", limit \\ 100)

Return the list of all Paper docs according to the argument specifications.

Example

Magpie.Paper.Docs.docs_list client

More info at: https://www.dropbox.com/developers/documentation/http/documentation#paper-docs-list

docs_update(client, doc_id, doc_update_policy, revision, import_format, file)

Updates an existing Paper doc with the provided content.

Example

Magpie.Paper.Docs.docs_update client, "", "", "", "", ""

More info at: https://www.dropbox.com/developers/documentation/http/documentation#paper-docs-download

get_folder_info(client, doc_id)

Retrieves folder information for the given Paper doc.

Example

Magpie.Paper.Docs.get_folder_info client, "", ""

More info at: https://www.dropbox.com/developers/documentation/http/documentation#paper-docs-get_folder_info

get_metadata(client, opts \\ %{})

Returns metadata for a Paper doc or Cloud Doc. This route is NOT deprecated. opts accepts "doc_id" or "file_id".

More info at: https://www.dropbox.com/developers/documentation/http/documentation#paper-docs-get_metadata

permanently_delete(client, doc_id)

Permanently deletes the given Paper doc.

Example

Magpie.Paper.Docs.permanently_delete client

More info at: https://www.dropbox.com/developers/documentation/http/documentation#paper-docs-list