API Reference Magpie v#0.1.0

Copy Markdown View Source

Modules

Core HTTP layer for the Dropbox API v2.

Struct for a Dropbox user account (/users/get_account).

Endpoints of the Dropbox account namespace (profile photo management).

Struct for the space allocation section of /users/get_space_usage.

Waits for Dropbox asynchronous jobs to complete.

Endpoints of the Dropbox auth namespace.

Endpoints of the Dropbox check namespace, useful to validate credentials.

Holds the Dropbox access token used to authenticate every request.

Endpoints of the Dropbox contacts namespace.

Normalized Dropbox API error.

Endpoints of the Dropbox file_properties namespace: custom property groups attached to files, based on user- or team-owned templates.

Endpoints for Dropbox file requests (/file_requests/*).

This module contains endpoints and data types for basic file operations.

Batch copy operations (/files/copy_batch_v2).

Copy references let you copy files across Dropbox accounts (/files/copy_reference/*).

Batch folder creation (/files/create_folder_batch).

Batch delete operations (/files/delete_batch).

Folder listing and change-cursor endpoints (/files/list_folder*).

File locking endpoints (/files/*_file_lock_batch), useful to coordinate editing on shared files.

Batch move operations (/files/move_batch_v2).

Paper docs stored as files (/files/paper/*) — the replacement for the deprecated /paper/docs/* API. Content is uploaded from a local file.

Save a URL's contents into Dropbox (/files/save_url).

User-defined tags on files (/files/tags/*).

This namespace contains endpoints and data types for basic file operations.

Struct for folder metadata returned by the files endpoints.

Struct for the name field of a Dropbox account.

Endpoints of the Dropbox openid namespace.

Turns Dropbox cursor-based pagination into a lazy Stream.

Dropbox Paper docs endpoints.

Dropbox Paper folder users endpoints. Deprecated by Dropbox (see Magpie.Paper.Docs).

Dropbox Paper sharing policy endpoints. Deprecated by Dropbox (see Magpie.Paper.Docs).

Dropbox Paper doc users endpoints. Deprecated by Dropbox (see Magpie.Paper.Docs).

Struct for a shared link returned by the sharing endpoints.

Endpoints for creating and managing shared links and shared folders.

Struct for /users/get_space_usage responses.

This namespace contains endpoints and data types for user management.

Small helpers shared across the API modules.