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

//! This module contains the endpoint trait used to implemented api endpoints.

use crate::{LIVE_ENDPOINT, SANDBOX_ENDPOINT};
use serde::{de::DeserializeOwned, Serialize};
use std::borrow::Cow;

/// A trait implemented by api endpoints.
pub trait Endpoint {
    /// The serializable query type.
    type Query: Serialize;
    /// The serializable body type.
    type Body: Serialize;
    /// The deserializable response type.
    type Response: DeserializeOwned;

    /// The endpoint relative path. Must start with a `/`
    fn relative_path(&self) -> Cow<str>;

    /// The request method of this endpoint.
    fn method(&self) -> reqwest::Method;

    /// The query to be used when calling this endpoint.
    fn query(&self) -> Option<Self::Query> {
        None
    }

    /// The body to be used when calling this endpoint.
    fn body(&self) -> Option<Self::Body> {
        None
    }

    /// The full path of this endpoint.
    ///
    /// Automatically implemented.
    fn full_path(&self, is_sandbox: bool) -> String {
        let relative_path = self.relative_path();

        assert!(relative_path.starts_with('/'), "relative path must start with '/'");

        if is_sandbox {
            format!("{}{}", SANDBOX_ENDPOINT, relative_path)
        } else {
            format!("{}{}", LIVE_ENDPOINT, relative_path)
        }
    }
}