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
145
146
147
148
149
150
151
152
153
154
155
156

//Anything related to DELETE requests for Addons and it's variations goes here.
use super::{Addon, AddonAttachment, AddonWebhook};

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

/// Add-on Delete
///
/// Delete an existing add-on.
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#add-on-delete)
///
/// # Example:
///
/// AddonDelete has two required parameters, app_id and addon_id, and returns the deleted [`Addon`][response].
/// ```rust
/// use heroku_rs::prelude::*;
///#    let api_client = HttpApiClient::create(&"API_KEY").unwrap();
///
/// let app_id = "APP_NAME_OR_ID";
/// let addon_id = "ADDON_NAME_OR_ID";
/// let response = api_client.request(&AddonDelete::new(app_id, 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.Addon.html
pub struct AddonDelete<'a> {
    /// unique app identifier, either app name or app id
    pub app_id: &'a str,
    /// unique add-on identifier, either add-on id or add-on name
    pub addon_id: &'a str,
}

#[cfg(feature = "builder")]
impl<'a> AddonDelete<'a> {
    /// Delete addon
    pub fn new(app_id: &'a str, addon_id: &'a str) -> AddonDelete<'a> {
        AddonDelete { app_id, addon_id }
    }
}

impl<'a> HerokuEndpoint<Addon> for AddonDelete<'a> {
    fn method(&self) -> Method {
        Method::Delete
    }
    fn path(&self) -> String {
        format!("apps/{}/addons/{}", self.app_id, self.addon_id)
    }
}

/// Add-on Attachment Delete
///
/// Delete an existing add-on attachment.
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#add-on-attachment-delete)
///
/// # Example:
///
/// AttachmentDelete has one required parameter, attachment_id, and returns the deleted [`AddonAttachment`][response].
/// ```rust
/// use heroku_rs::prelude::*;
///#    let api_client = HttpApiClient::create(&"API_KEY").unwrap();
/// 
/// let response = api_client.request(&AttachmentDelete::new("ADDON_ATTACHMENT_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.AddonAttachment.html
pub struct AttachmentDelete<'a> {
    /// unique addon attachment identifier
    pub attachment_id: &'a str,
}

#[cfg(feature = "builder")]
impl<'a> AttachmentDelete<'a> {
    /// Delete addon
    pub fn new(attachment_id: &'a str) -> AttachmentDelete<'a> {
        AttachmentDelete { attachment_id }
    }
}

impl<'a> HerokuEndpoint<AddonAttachment> for AttachmentDelete<'a> {
    fn method(&self) -> Method {
        Method::Delete
    }
    fn path(&self) -> String {
        format!("addon-attachments/{}", self.attachment_id)
    }
}

/// Add-on Webhook Delete
///
/// Removes an add-on webhook subscription. Can only be accessed by the add-on partner providing this add-on.
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#add-on-webhook-delete)
///
/// # Example:
///
/// WebhookDelete has two required parameters, addon_id and webhook_id, and returns the deleted [`AddonWebhook`][response].
/// ```rust
/// use heroku_rs::prelude::*;
///#    let api_client = HttpApiClient::create(&"API_KEY").unwrap();
///
/// let addon_id = "ADDON_NAME_OR_ID";
/// let webhook_id = "WEBHOOK_ID";
/// let response = api_client.request(&WebhookDelete::new(addon_id, webhook_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.AddonWebhook.html
pub struct WebhookDelete<'a> {
    /// unique addon identifier
    pub addon_id: &'a str,
    /// unique addon webhook identifier
    pub webhook_id: &'a str,
}

#[cfg(feature = "builder")]
impl<'a> WebhookDelete<'a> {
    /// Delete webhook addon
    pub fn new(addon_id: &'a str, webhook_id: &'a str) -> WebhookDelete<'a> {
        WebhookDelete {
            addon_id,
            webhook_id,
        }
    }
}

impl<'a> HerokuEndpoint<AddonWebhook> for WebhookDelete<'a> {
    fn method(&self) -> Method {
        Method::Delete
    }
    fn path(&self) -> String {
        format!("addons/{}/webhooks/{}", self.addon_id, self.webhook_id)
    }
}