# YourImageShare v1.0.0 - Table of Contents

> Official Elixir client for the YourImageShare upload API (https://yourimageshare.com/about/api) - upload, list, and delete files.

## Pages

- [yourimageshare-api/elixir](readme.md)

## Modules

- [YourImageShare](YourImageShare.md): Official Elixir client for the [YourImageShare](https://yourimageshare.com)
upload API. See `YourImageShare.Client` for the full API - this module is
just an entry point.
- [YourImageShare.Client](YourImageShare.Client.md): Client for the YourImageShare upload API
(https://yourimageshare.com/about/api). Mirrors the existing JS, Python,
PHP, Go, Rust, and Ruby SDKs - same method names, same result shapes,
same error type - just idiomatic Elixir on top (`{:ok, result} |
{:error, %YourImageShare.APIError{}}` tagged tuples, the direct
equivalent of Go's `(result, error)` return; bang variants that raise
are also provided).
- [YourImageShare.ListMeta](YourImageShare.ListMeta.md): Pagination info for a `list/2` result.
- [YourImageShare.ListResult](YourImageShare.ListResult.md): Response shape for `list/2`.
- [YourImageShare.ListedUpload](YourImageShare.ListedUpload.md): One row of a `list/2` result.
- [YourImageShare.UploadResult](YourImageShare.UploadResult.md): Response shape for a successful upload - same fields as every other official SDK.

- Exceptions
  - [YourImageShare.APIError](YourImageShare.APIError.md): Raised/returned for any non-2xx response or a `{"type": "error"}` payload -
mirrors the JS/Python/PHP/Go/Rust/Ruby SDKs' error type exactly (same
status/message shape) so error-handling logic reads the same across every
official SDK.

