# Magpie v0.3.1 - Table of Contents

> Elixir client for the Dropbox API v2, built on Req

## Pages

- [Magpie 🐦](readme.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)

- Guides
  - [OAuth 2 & token refresh](oauth.md)
  - [Examples](examples.md)

## Modules

- Core
  - [Magpie](Magpie.md): Core HTTP layer for the Dropbox API v2.
  - [Magpie.Client](Magpie.Client.md): Holds the credentials used to authenticate every request.
  - [Magpie.Error](Magpie.Error.md): Normalized Dropbox API error.
  - [Magpie.Utils](Magpie.Utils.md): Small helpers shared across the API modules.

- OAuth & tokens
  - [Magpie.Auth](Magpie.Auth.md): OAuth 2 flow helpers — plus the endpoints of the Dropbox `auth` namespace.
  - [Magpie.Auth.StaticToken](Magpie.Auth.StaticToken.md): `Magpie.Auth.TokenProvider` backed by a plain access token string.
  - [Magpie.Auth.Token](Magpie.Auth.Token.md): An OAuth 2 token set returned by Dropbox's `/oauth2/token` endpoint.
  - [Magpie.Auth.TokenProvider](Magpie.Auth.TokenProvider.md): Behaviour for anything that can hand an access token to `Magpie.Client`.
  - [Magpie.Auth.TokenServer](Magpie.Auth.TokenServer.md): A `Magpie.Auth.TokenProvider` that keeps an access token fresh.

- High-level flows
  - [Magpie.Async](Magpie.Async.md): Waits for Dropbox asynchronous jobs to complete.
  - [Magpie.Pager](Magpie.Pager.md): Turns Dropbox cursor-based pagination into a lazy `Stream`.

- Phoenix
  - [Magpie.LiveView](Magpie.LiveView.md): Direct browser → Dropbox uploads for `Phoenix.LiveView`.
  - [Magpie.LiveView.UploadWriter](Magpie.LiveView.UploadWriter.md): A `Phoenix.LiveView.UploadWriter` that streams an upload straight into a
Dropbox upload session — the bytes never touch your server's disk.

- Files
  - [Magpie.Files](Magpie.Files.md): This module contains endpoints and data types
for basic file operations.

  - [Magpie.Files.CopyBatch](Magpie.Files.CopyBatch.md): Batch copy operations (`/files/copy_batch_v2`).

  - [Magpie.Files.CopyReference](Magpie.Files.CopyReference.md): Copy references let you copy files across Dropbox accounts (`/files/copy_reference/*`).

  - [Magpie.Files.CreateFolderBatch](Magpie.Files.CreateFolderBatch.md): Batch folder creation (`/files/create_folder_batch`).

  - [Magpie.Files.DeleteBatch](Magpie.Files.DeleteBatch.md): Batch delete operations (`/files/delete_batch`).

  - [Magpie.Files.ListFolder](Magpie.Files.ListFolder.md): Folder listing and change-cursor endpoints (`/files/list_folder*`).

  - [Magpie.Files.Locks](Magpie.Files.Locks.md): File locking endpoints (`/files/*_file_lock_batch`), useful to coordinate
editing on shared files.
  - [Magpie.Files.MoveBatch](Magpie.Files.MoveBatch.md): Batch move operations (`/files/move_batch_v2`).

  - [Magpie.Files.Paper](Magpie.Files.Paper.md): Paper docs stored as files (`/files/paper/*`) — the replacement for the
deprecated `/paper/docs/*` API. Content is uploaded from a local file.

  - [Magpie.Files.SaveUrl](Magpie.Files.SaveUrl.md): Save a URL's contents into Dropbox (`/files/save_url`).

  - [Magpie.Files.Tags](Magpie.Files.Tags.md): User-defined tags on files (`/files/tags/*`).

  - [Magpie.Files.UploadSession](Magpie.Files.UploadSession.md): This namespace contains endpoints and data types for basic file operations.

- Sharing
  - [Magpie.Sharing](Magpie.Sharing.md): Endpoints for creating and managing shared links and shared folders.

- Users & Account
  - [Magpie.Accounts](Magpie.Accounts.md): Endpoints of the Dropbox `account` namespace (profile photo management).
  - [Magpie.Check](Magpie.Check.md): Endpoints of the Dropbox `check` namespace, useful to validate credentials.

  - [Magpie.Contacts](Magpie.Contacts.md): Endpoints of the Dropbox `contacts` namespace.

  - [Magpie.OpenId](Magpie.OpenId.md): Endpoints of the Dropbox `openid` namespace.

  - [Magpie.Users](Magpie.Users.md): This namespace contains endpoints and data types for user management.

- File properties & requests
  - [Magpie.FileProperties](Magpie.FileProperties.md): Endpoints of the Dropbox `file_properties` namespace: custom property
groups attached to files, based on user- or team-owned templates.
  - [Magpie.FileRequests](Magpie.FileRequests.md): Endpoints for Dropbox file requests (`/file_requests/*`).

- Paper (deprecated)
  - [Magpie.Paper.Docs](Magpie.Paper.Docs.md): Dropbox Paper docs endpoints.
  - [Magpie.Paper.FolderUsers](Magpie.Paper.FolderUsers.md): Dropbox Paper folder users endpoints. Deprecated by Dropbox (see `Magpie.Paper.Docs`).

  - [Magpie.Paper.SharingPolicy](Magpie.Paper.SharingPolicy.md): Dropbox Paper sharing policy endpoints. Deprecated by Dropbox (see `Magpie.Paper.Docs`).

  - [Magpie.Paper.Users](Magpie.Paper.Users.md): Dropbox Paper doc users endpoints. Deprecated by Dropbox (see `Magpie.Paper.Docs`).

- Structs
  - [Magpie.Account](Magpie.Account.md): Struct for a Dropbox user account (`/users/get_account`).

  - [Magpie.Allocation](Magpie.Allocation.md): Struct for the space allocation section of `/users/get_space_usage`.

  - [Magpie.Folder](Magpie.Folder.md): Struct for folder metadata returned by the files endpoints.

  - [Magpie.Name](Magpie.Name.md): Struct for the `name` field of a Dropbox account.

  - [Magpie.SharedLink](Magpie.SharedLink.md): Struct for a shared link returned by the sharing endpoints.

  - [Magpie.SpaceUsage](Magpie.SpaceUsage.md): Struct for `/users/get_space_usage` responses.