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

//Anything related to GET requests for config vars and it's variations goes here.
use std::collections::HashMap;

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

/// Config Vars Info for App
///
/// Get config-vars for app.
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#config-vars-info-for-app)
pub struct AppConfigVarDetails<'a> {
    /// unique app identifier.
    pub app_id: &'a str,
}

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

impl<'a> HerokuEndpoint<HashMap<String, Option<String>>> for AppConfigVarDetails<'a> {
    fn method(&self) -> Method {
        Method::Get
    }
    fn path(&self) -> String {
        format!("apps/{}/config-vars", self.app_id)
    }
}

/// Config Vars Info for App Release
///
/// Get config-vars for an app release.
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#config-vars-info-for-app-release)
/// 
/// # Example:
///
/// ReleaseConfigVarDetails takes two required parameters, app_id and release_id, and returns a `HashMap<String, Option<String>>`.
/// ```rust
/// use heroku_rs::prelude::*;
///#    let api_client = HttpApiClient::create("API_KEY").unwrap();
///
/// let response = api_client.request(&ReleaseConfigVarDetails::new("APP_ID_HERE", "RELEASE_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
pub struct ReleaseConfigVarDetails<'a> {
    /// unique app identifier.
    pub app_id: &'a str,
    // unique release identifier, release id or release version
    pub release_id: &'a str,
}

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

impl<'a> HerokuEndpoint<HashMap<String, Option<String>>> for ReleaseConfigVarDetails<'a> {
    fn method(&self) -> Method {
        Method::Get
    }
    fn path(&self) -> String {
        format!(
            "apps/{}/releases/{}/config-vars",
            self.app_id, self.release_id
        )
    }
}

/// Config Vars Info for Pipeline
///
/// Pipeline Config Vars allow you to manage the configuration information provided to a pipeline.
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#pipeline-config-vars)
/// 
/// # Example:
///
/// PipelineConfigVarDetails takes two required parameters, app_id and stage_id, and returns a `HashMap<String, Option<String>>`.
/// ```rust
/// use heroku_rs::prelude::*;
///#    let api_client = HttpApiClient::create("API_KEY").unwrap();
///
/// let response = api_client.request(&PipelineConfigVarDetails::new("APP_ID_HERE", "STAGE_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
pub struct PipelineConfigVarDetails<'a> {
    /// unique pipeline identifier.
    pub pipeline_id: &'a str,
    /// pipeline stage
    pub stage_id: &'a str,
}

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

impl<'a> HerokuEndpoint<HashMap<String, Option<String>>> for PipelineConfigVarDetails<'a> {
    fn method(&self) -> Method {
        Method::Get
    }
    fn path(&self) -> String {
        format!(
            "pipelines/{}/stage/{}/config-vars",
            self.pipeline_id, self.stage_id
        )
    }
}