heroku_rs 0.6.0

Rust bindings for the Heroku 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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//Anything related to GET requests for heroku logs and it's properties goes here.
use super::LogDrain;

use crate::framework::endpoint::{HerokuEndpoint, Method};

/// Log Drain List
///
/// List existing log drains.
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#log-drain-list)
///
/// # Example:
///
/// LogDrainList takes one required parameter, app_id, and returns a list of [`LogDrains`][response].
/// ```rust
/// use heroku_rs::prelude::*;
///#    let api_client = HttpApiClient::create("API_KEY").unwrap();
///
/// let response = api_client.request(&LogDrainList::new("APP_ID"));
///
///match response {
///     Ok(success) => println!("Success: {:#?}", success),
///     Err(e) => println!("Error: {}", e),
///}
//
/// ```
/// See how to create the Heroku [`api_client`][httpApiClientConfig].
///
/// [httpApiClientConfig]: ../../../framework/struct.HttpApiClient.html
/// [response]: ../struct.LogDrain.html
pub struct LogDrainList<'a> {
    /// unique app identifier, either app name, or app id
    pub app_id: &'a str,
}

#[cfg(feature = "builder")]
impl<'a> LogDrainList<'a> {
    pub fn new(app_id: &'a str) -> LogDrainList {
        LogDrainList { app_id }
    }
}

impl<'a> HerokuEndpoint<Vec<LogDrain>> for LogDrainList<'a> {
    fn method(&self) -> Method {
        Method::Get
    }
    fn path(&self) -> String {
        format!("apps/{}/log-drains", self.app_id)
    }
}

/// Log Drain Info
///
/// Info for existing log drain.
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#log-drain-info)
/// 
/// # Example:
///
/// LogDrainDetails takes two required parameters, app_id and drain_id, and returns the [`LogDrain`][response].
/// ```rust
/// use heroku_rs::prelude::*;
///#    let api_client = HttpApiClient::create("API_KEY").unwrap();
///
/// let response = api_client.request(&LogDrainDetails::new("APP_ID", "DRAIN_ID"));
///
///match response {
///     Ok(success) => println!("Success: {:#?}", success),
///     Err(e) => println!("Error: {}", e),
///}
//
/// ```
/// See how to create the Heroku [`api_client`][httpApiClientConfig].
///
/// [httpApiClientConfig]: ../../../framework/struct.HttpApiClient.html
/// [response]: ../struct.LogDrain.html
pub struct LogDrainDetails<'a> {
    /// unique app identifier, either app name, or app id
    pub app_id: &'a str,
    /// unique log drain identifier, either drain id, url or token
    pub drain_id: &'a str,
}

#[cfg(feature = "builder")]
impl<'a> LogDrainDetails<'a> {
    pub fn new(app_id: &'a str, drain_id: &'a str) -> LogDrainDetails<'a> {
        LogDrainDetails { app_id, drain_id }
    }
}

impl<'a> HerokuEndpoint<LogDrain> for LogDrainDetails<'a> {
    fn method(&self) -> Method {
        Method::Get
    }
    fn path(&self) -> String {
        format!("apps/{}/log-drains/{}", self.app_id, self.drain_id)
    }
}

/// Log Drain List By Add-on
///
/// List existing log drains for an add-on.
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#log-drain-list-by-add-on)
/// 
/// # Example:
///
/// LogDrainListByAddon takes one required parameter, addon_id, and returns a list of [`LogDrains`][response].
/// ```rust
/// use heroku_rs::prelude::*;
///#    let api_client = HttpApiClient::create("API_KEY").unwrap();
///
/// let response = api_client.request(&LogDrainListByAddon::new("ADDON_ID"));
///
///match response {
///     Ok(success) => println!("Success: {:#?}", success),
///     Err(e) => println!("Error: {}", e),
///}
//
/// ```
/// See how to create the Heroku [`api_client`][httpApiClientConfig].
///
/// [httpApiClientConfig]: ../../../framework/struct.HttpApiClient.html
/// [response]: ../struct.LogDrain.html
pub struct LogDrainListByAddon<'a> {
    /// unique addon identifier
    pub addon_id: &'a str,
}

#[cfg(feature = "builder")]
impl<'a> LogDrainListByAddon<'a> {
    pub fn new(addon_id: &'a str) -> LogDrainListByAddon<'a> {
        LogDrainListByAddon { addon_id }
    }
}

impl<'a> HerokuEndpoint<Vec<LogDrain>> for LogDrainListByAddon<'a> {
    fn method(&self) -> Method {
        Method::Get
    }
    fn path(&self) -> String {
        format!("addons/{}/log-drains", self.addon_id)
    }
}