traduora 0.4.0

REST API bindings for Traduora, an open-source translation management platform
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

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

impl_wrapper!(AccessToken, "Type-safe access token wrapper");
impl_wrapper!(UserId, "Type-safe user id wrapper");
impl_wrapper!(ProjectId, "Type-safe project id wrapper");
impl_wrapper!(TermId, "Type-safe term id wrapper");

/// Data object that is returned by the Traduora API
/// for multiple endpoints.
///
/// It contains timestamps that inform about the latest
/// interactions with an object. What exactly an object
/// is depends on the endpoint that return the [`AccessDates`].
#[derive(Debug, Copy, Clone, Deserialize, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct AccessDates {
    /// Time when the object was created.
    pub created: DateTime<Utc>,
    /// Time when the object was last changed.
    pub modified: DateTime<Utc>,
}

/// Data object that holds a role. These roles are project-specific for each user.
/// By default, the creator of a new project becomes its admin.
/// All other users get the role that the project admin chose for them while inviting.
///
/// For a detailed overview of what role may access which endpoint, see
/// <https://docs.traduora.co/docs/api/v1/roles-permissions>.
#[derive(Debug, Copy, Clone, Deserialize, Serialize, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[serde(rename_all = "camelCase")]
pub enum Role {
    /// Access to everything
    Admin,
    /// Read and write access but may not change
    /// configuration data like inviting a new user.
    Editor,
    /// Read-only access
    Viewer,
}

// False positive in clippy (containing module is glob-exported
// so pub(crate) is not redundant here):
// https://github.com/rust-lang/rust-clippy/issues/7862
#[allow(clippy::redundant_pub_crate)]
pub(crate) mod mime_types {
    pub const JSON: &str = "application/json";
}