reliefweb 0.1.2

A Rust client for the ReliefWeb API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

# ReliefWeb Rust Client

[![crates.io](https://img.shields.io/crates/v/reliefweb)](https://crates.io/crates/reliefweb) 
[![docs.rs](https://docs.rs/reliefweb/badge.svg)](https://docs.rs/reliefweb)

A fully asynchronous Rust client for the [ReliefWeb API](https://api.reliefweb.int/), providing typed endpoints for reports, disasters, countries, jobs, blogs, books, sources, and trainings.

---

## Features

- Fully typed resources with serde support.
- Async support with `reqwest` + `tokio`.
- Support for filtering, sorting, limiting, and profiles.
- Prebuilt endpoints for:
  - `reports`
  - `disasters`
  - `countries`
  - `jobs`
  - `training`
  - `sources`
  - `blogs`
  - `books`
- Automatic URL and query parameter handling.

---

## Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
reliefweb-rust = "0.1.0"
tokio = { version = "1.47.1", features = ["full"] }
```

## Usage

```rust
use reliefweb_rust::{Client, QueryParams, APIVersion};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = Client::new("api.reliefweb.int", "my_app_name", APIVersion::V2)?;

    // List reports
    let reports = client.reports()
        .list(Some(&QueryParams::new().limit(5)))
        .await?;

    for report in reports.data {
        println!("Report: {:?}", report.fields.title);
    }

    // Get a single report
    if let Some(first_report) = reports.data.first() {
        let report_detail = client.reports()
            .get(&first_report.id, None, None, None)
            .await?;
        println!("Full report details: {:?}", report_detail.data[0].fields);
    }

    Ok(())
}
```

## QueryParams
You can filter, sort, and limit results using `QueryParams`:
```rust
use reliefweb_rust::{QueryParams, QueryProfile};

let params = QueryParams::new()
    .limit(10)
    .profile(QueryProfile::Minimal);

```

## Documentation
Full API documentation is available at [docs.rs](https://docs.rs/reliefweb)

## License
Licensed under MIT.

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.