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
157
158
159
160
161
162
163
164
165
166
167
use std::{marker::PhantomData, sync::Arc};
use super::PAYSTACK_BASE_URL;
use crate::{
HttpClient, Interval, PaystackAPIError, PaystackResult, PlanRequest, PlanResponseData,
PlanStatus, PlanUpdateRequest, Response,
};
pub struct PlansEndpoints<T: HttpClient + Default> {
/// Paystack API Key
key: String,
/// Base URL for the plans route
base_url: String,
/// Http client for the route
http: Arc<T>,
}
/// Create a new `PlansEndpoints<T>` instance
///
/// # Arguments
/// - `key` - The Paystack API key
/// - `http`: The HTTP client implementation to use for the API requests
///
/// # Returns
/// A new PlansEndpoints instance
impl<T: HttpClient + Default> PlansEndpoints<T> {
pub fn new(key: Arc<String>, http: Arc<T>) -> PlansEndpoints<T> {
let base_url = format!("{PAYSTACK_BASE_URL}/plan");
PlansEndpoints {
key: key.to_string(),
base_url,
http,
}
}
/// Create a plan on your integration
///
/// # Arguments
/// * `plan_request` - The request data to create the plan.
/// Should be created with a `PlanRequestBuilder` struct.
///
/// # Returns
/// A Result containing the plan response data or an error
pub async fn create_plan(&self, plan_request: PlanRequest) -> PaystackResult<PlanResponseData> {
let url = &self.base_url;
let body = serde_json::to_value(plan_request)
.map_err(|e| PaystackAPIError::Plan(e.to_string()))?;
let response = self
.http
.post(url, &self.key, &body)
.await
.map_err(|e| PaystackAPIError::Plan(e.to_string()))?;
let parsed_response: Response<PlanResponseData> =
serde_json::from_str(&response).map_err(|e| PaystackAPIError::Plan(e.to_string()))?;
Ok(parsed_response)
}
/// Lists plans available in your integration
///
/// # Arguments
/// * `per_page` - specify how many records you want to retrieve per page. Defaults to 50 if None
/// * `page` - specify exactly what page you want to retrieve. Defaults to 1 if None
/// * `status` - Optional parameter to filter list by plans with specified status
/// * `interval` - Optional parameter to filter list by plans with specified interval
/// * `amount`- Optional parameter to filter list by plans with specified amount using the supported currency
///
/// # Returns
/// A Result containing a vector of plan response data or an error
pub async fn list_plans(
&self,
per_page: Option<u8>,
page: Option<u8>,
status: Option<PlanStatus>,
interval: Option<Interval>,
amount: Option<u32>,
) -> PaystackResult<Vec<PlanResponseData>> {
let url = &self.base_url;
let per_page = per_page.unwrap_or(50).to_string();
let page = page.unwrap_or(1).to_string();
let mut query = vec![("perPage", per_page), ("page", page)];
// Process optional parameters
if let Some(s) = status {
query.push(("status", s.to_string()));
}
if let Some(i) = interval {
query.push(("interval", i.to_string()));
}
if let Some(a) = amount {
query.push(("amount", a.to_string()));
}
// convert all string to &str
// TODO: there has to be a cleaner way of doing this
let query: Vec<(&str, &str)> = query.iter().map(|(k, v)| (*k, v.as_str())).collect();
let response = self
.http
.get(url, &self.key, Some(&query))
.await
.map_err(|e| PaystackAPIError::Plan(e.to_string()))?;
let parsed_response: Response<Vec<PlanResponseData>> =
serde_json::from_str(&response).map_err(|e| PaystackAPIError::Plan(e.to_string()))?;
Ok(parsed_response)
}
/// Get details of a plan on your integration
///
/// # Arguments
/// * `id_or_code` - the plan `ID` or `code` you want to fetch
///
/// # Returns
/// A Result containing the plan response data or an error
pub async fn fetch_plan(&self, id_or_code: String) -> PaystackResult<PlanResponseData> {
let url = format!("{}/{}", &self.base_url, id_or_code);
let response = self
.http
.get(&url, &self.key, None)
.await
.map_err(|e| PaystackAPIError::Plan(e.to_string()))?;
let parsed_response: Response<PlanResponseData> =
serde_json::from_str(&response).map_err(|e| PaystackAPIError::Plan(e.to_string()))?;
Ok(parsed_response)
}
/// Update a plan details on your integration
///
/// # Arguments
/// * `id_or_code` - the plan `ID` or `code` you want to update
/// * `plan_update_request` - The request data to update the plan with.
/// Should be created with a `PlanUpdateRequestBuilder` struct.
///
/// # Returns
/// A Result containing a success message if the plan has been updated
pub async fn update_plan(
&self,
id_or_code: String,
plan_update_request: PlanUpdateRequest,
) -> PaystackResult<PhantomData<String>> {
let url = format!("{}/{}", self.base_url, id_or_code);
let body = serde_json::to_value(plan_update_request)
.map_err(|e| PaystackAPIError::Plan(e.to_string()))?;
let response = self
.http
.put(&url, &self.key, &body)
.await
.map_err(|e| PaystackAPIError::Plan(e.to_string()))?;
let parsed_response: Response<PhantomData<String>> =
serde_json::from_str(&response).map_err(|e| PaystackAPIError::Plan(e.to_string()))?;
Ok(parsed_response)
}
}