RemarkableClient(token::String)

Client used for identification. Simply contains the authentification token

download_document(client, id::String, [path_target::String]) -> ZipFile Body
download_document(client, doc::Document, [path_target::String]) -> Zipfile Body

Download a document object with given id/doc. The document is always given as a ZipFile and can be saved via write(filepath, body) if path_target is given, the zip file is automatically written and named.

request(client, verb, url, headers, body; kwargs...) -> body

Workhorse to communicate with the Remarkable servers. It is behaving like HTTP.request, except that it automatically uses the identification token in every request.

create_folder!(client, name::String, parent::String="") ->

Create a folder (Collection) in parent (root by default)

create_upload_request(client, doc::Document=Document()) -> Document

Create a request to upload a document with a given id.

delete_item!(client, id::String)
delete_item!(client, obj::remarkable)

Delete the object from your collection (online)

dict_to_query(d::Dict) -> String

From a dictionary creates a string as : "key1=value1&key2=value2..."

discover_storage(client) -> String

Check that the storage URL is still the right one and update it if needed

get_item(client, id::String, download = false)
get_item(client, id::RemarkableObject, download = false)

Return a RemarkableObject given an ID or an existing RemarkableObject, using download=true will give the BlobURLGet to download the files

list_items(client::RemarkableClient) -> Collection

Return a Collection of all Documents and Collection present on the server You can visualize them nicely via print_tree

refresh_token(client::RemarkableClient) -> token

Before running operations the token needs to be refreshed, refresh_token! does just that!

register(code::String) -> String
register() -> String

Create a new authentification token from a code obtained on https://my.remarkable.com/connect/desktop If a code is not provided a tutorial is given.

storage_request(client, verb, url, obj, kwargs...)

Specific request related to storage. Converts obj to a JSON string, and automatically transform the body in another JSON.

update_metadata!(client, obj::RemarkableObject) ->

Update the metadata of an object, can be used to modify a file or create a Collection

upload_document!(client, obj::RemarkableObject, zip) -> RemarkableObject

Upload zip file (actual zip file) with metadata from obj

upload_pdf!(client, pdf_path::String, pdf_name::String = basename(pdf_path), parent)

Create a document for the given pdf and upload it.