dimescheduler 0.1.0

Official Rust client library for the Dime.Scheduler 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
88
89

# Dime.Scheduler for Rust

Official Rust client for the [Dime.Scheduler](https://dimescheduler.com) API. One async client,
a typed accessor per entity, and the same accessor names as the .NET, JavaScript, Python and
Go SDKs.

## Installation

```toml
[dependencies]
dimescheduler = "0.1"
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
```

## Quick start

```rust
use dimescheduler::{entities::Category, DimeSchedulerClient, Environment};

#[tokio::main]
async fn main() -> dimescheduler::Result<()> {
    // Reads DIMESCHEDULER_API_KEY and targets production.
    let client = DimeSchedulerClient::from_env()?;
    // Or pick the environment explicitly:
    // let client = DimeSchedulerClient::with_environment("api-key", Environment::Test);

    client
        .categories
        .create(&Category {
            name: "INSTALL".into(),
            display_name: "Install".into(),
            color: "#22d3ee".into(),
        })
        .await?;

    for dto in client.categories.get_all().await? {
        println!("{:?}", dto.name);
    }
    Ok(())
}
```

## Accessors

Every import-shaped entity (`client.categories`, `client.resources`, `client.tags`, …) exposes
`create`, `create_many`, `update`, `update_many`, `delete`, `delete_many` and `get_all`. Write
methods take an `entities::*` value and return the API's response envelope; `get_all` returns
the matching `types::*Dto` list.

| Accessor | Extra methods |
|----------|---------------|
| `appointments` | `get(start, end, &resources)`, `get_by_id(id)` |
| `jobs` | `get(job_no)` |
| `tasks` | `list(&TaskListOptions)` |
| `notifications` | `get(page, limit, &NotificationListOptions)` |
| `resource_capacities`, `time_entries`, `time_sessions` | `get(start, end)` |
| `calendars`, `resource_types`, `appointment_dependencies`, `appointment_fields` | `get_all()` only |
| `task_budget_entries` | `create`, `create_many`, `delete`, `delete_many` only |
| `task_assignments` | `create(&req)`, `delete(&req)` |
| `connectors`, `geocoding`, `imports`, `messages`, `optimization`, `recommendation`, `recurring_appointments`, `users` | see the rustdoc |

Dates are plain strings in the API's own format: RFC 3339 for appointments and resource
capacities, `YYYY-MM-DD` for time entries and sessions.

## Generated types

`dimescheduler::entities` holds the import bodies you send, `dimescheduler::types` the DTOs,
request types and enums, and `dimescheduler::models` the server's domain read-models that
appear nested inside DTOs. All structs derive `Default`, so build them with
`..Default::default()`. They are generated from the OpenAPI spec; see
[`scripts/codegen.py`](scripts/codegen.py).

## Errors

Every method returns `dimescheduler::Result<T>`. A non-2xx response is
`Error::Api { status, body }` where `body` is already the human-readable message when the
API sent one of its known error shapes. Transport failures are `Error::Http`.

This crate does **not** retry. A `429` or `5xx` is returned to you; retry at the call site
if your workload needs it.

## Environments

`Environment::Production` (`https://api.dimescheduler.com`), `Environment::Test`,
`Environment::Sandbox`.

## License

MIT