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

Alias for copy_v2/3.

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

POST files/copy_batch/check_v2.

@spec copy_batch_v2([map()], opts()) :: result()

POST files/copy_batch_v2.

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

POST files/copy_reference/get.

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

POST files/copy_reference/save.

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

POST files/copy_v2.

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

Alias for create_folder_v2/2.

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

POST files/create_folder_batch.

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

POST files/create_folder_batch/check.

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

POST files/create_folder_v2.

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

Alias for delete_v2/2.

@spec delete_batch([map()], opts()) :: result()

POST files/delete_batch.

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

POST files/delete_batch/check.

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

POST files/delete_v2.

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

POST files/download — returns %{metadata: map, body: binary, headers: list}.

@spec download_to_file(Path.t(), String.t(), opts()) :: result()

Download and write body to a local file path.

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

POST files/download_zip.

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

POST files/export (Paper / Google docs etc.).

@spec get_file_lock_batch([map()], opts()) :: result()

POST files/get_file_lock_batch.

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

POST files/get_metadata.

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

POST files/get_preview.

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

POST files/get_temporary_link.

@spec get_temporary_upload_link(map(), opts()) :: result()

POST files/get_temporary_upload_link.

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

POST files/get_thumbnail.

@spec get_thumbnail_batch([map()], opts()) :: result()

POST files/get_thumbnail_batch.

@spec get_thumbnail_v2(map(), opts()) :: result()

POST files/get_thumbnail_v2.

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

POST files/list_folder. Use path: "" for the root folder.

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

Paginate list_folder until has_more is false. Returns atom-key maps.

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

POST files/list_folder/continue.

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

POST files/list_folder/get_latest_cursor.

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

POST files/list_folder/longpoll (notify host; no user auth).

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

POST files/list_revisions.

@spec lock_file_batch([map()], opts()) :: result()

POST files/lock_file_batch.

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

Alias for move_v2/3.

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

POST files/move_batch/check_v2.

@spec move_batch_v2([map()], opts()) :: result()

POST files/move_batch_v2.

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

POST files/move_v2.

@spec paper_create(String.t(), binary(), String.t() | atom(), opts()) :: result()

POST files/paper/create (content upload).

@spec paper_update(
  String.t(),
  binary(),
  String.t() | atom(),
  String.t() | atom(),
  opts()
) :: result()

POST files/paper/update (content upload).

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

POST files/permanently_delete.

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

POST files/restore.

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

POST files/save_url.

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

POST files/save_url/check_job_status.

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

Alias for search_v2/2.

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

POST files/search/continue_v2.

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

POST files/search_v2.

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

POST files/tags/add.

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

POST files/tags/get.

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

POST files/tags/remove.

@spec unlock_file_batch([map()], opts()) :: result()

POST files/unlock_file_batch.

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

POST files/upload (max ~150 MB). For larger files use upload sessions.

Options

• :mode — "add" | "overwrite" | %{".tag" => "update", "update" => rev}

• :autorename, :mute, :strict_conflict, :client_modified, :property_groups

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

Convenience: upload arbitrary-size binary using sessions (4 MB chunks by default).

Options

• :chunk_size — bytes per chunk (default 4_194_304)
• :mode — commit mode (default "overwrite")
• :autorename — passed to commit (default false)

@spec upload_session_append_v2(map(), binary(), opts()) :: result()

POST files/upload_session/append_v2.

@spec upload_session_finish(map(), map(), binary(), opts()) :: result()

POST files/upload_session/finish.

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

POST files/upload_session/finish_batch/check.

@spec upload_session_finish_batch_v2([map()], opts()) :: result()

POST files/upload_session/finish_batch_v2.

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

POST files/upload_session/start.

@spec upload_session_start_batch(pos_integer(), opts()) :: result()

POST files/upload_session/start_batch.