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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
use crate::Client;
use crate::ClientResult;
pub struct Categories {
pub client: Client,
}
impl Categories {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Categories { client }
}
/**
* Retrieve all categories.
*
* This function performs a `GET` to the `/categories` endpoint.
*
* **This endpoint allows you to retrieve a list of all of your categories.**
*
* **Parameters:**
*
* * `limit: i64` -- The number of categories to display per page.
* * `category: &str` -- Allows you to perform a prefix search on this particular category.
* * `offset: i64` -- The point in the list that you would like to begin displaying results.
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_page(
&self,
limit: i64,
category: &str,
offset: i64,
) -> ClientResult<crate::Response<Vec<crate::types::GetCategoriesResponse>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !category.is_empty() {
query_args.push(("category".to_string(), category.to_string()));
}
if limit > 0 {
query_args.push(("limit".to_string(), limit.to_string()));
}
if offset > 0 {
query_args.push(("offset".to_string(), offset.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/categories?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve all categories.
*
* This function performs a `GET` to the `/categories` endpoint.
*
* As opposed to `get`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve a list of all of your categories.**
*/
pub async fn get_all(
&self,
category: &str,
offset: i64,
) -> ClientResult<crate::Response<Vec<crate::types::GetCategoriesResponse>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !category.is_empty() {
query_args.push(("category".to_string(), category.to_string()));
}
if offset > 0 {
query_args.push(("offset".to_string(), offset.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/categories?{}", query_), None);
self.client
.get_all_pages(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve sums of email stats for each category [Needs: Stats object defined, has category ID?].
*
* This function performs a `GET` to the `/categories/stats/sums` endpoint.
*
* **This endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range.**
*
* If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
*
* **Parameters:**
*
* * `sort_by_metric: &str` -- The metric that you want to sort by. Must be a single metric.
* * `sort_by_direction: crate::types::SortByDirection` -- The direction you want to sort.
* * `start_date: &str` -- The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
* * `end_date: &str` -- The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
* * `limit: i64` -- Limits the number of results returned.
* * `offset: i64` -- The point in the list to begin retrieving results.
* * `aggregated_by: crate::types::TraitStatsAdvancedBaseQueryStringsAggregatedBy` -- How to group the statistics. Must be either "day", "week", or "month".
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_stats_sum(
&self,
sort_by_metric: &str,
sort_by_direction: crate::types::SortByDirection,
start_date: &str,
end_date: &str,
limit: i64,
offset: i64,
aggregated_by: crate::types::TraitStatsAdvancedBaseQueryStringsAggregatedBy,
) -> ClientResult<crate::Response<crate::types::CategoryStats>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !aggregated_by.to_string().is_empty() {
query_args.push(("aggregated_by".to_string(), aggregated_by.to_string()));
}
if !end_date.is_empty() {
query_args.push(("end_date".to_string(), end_date.to_string()));
}
if limit > 0 {
query_args.push(("limit".to_string(), limit.to_string()));
}
if offset > 0 {
query_args.push(("offset".to_string(), offset.to_string()));
}
if !sort_by_direction.to_string().is_empty() {
query_args.push((
"sort_by_direction".to_string(),
sort_by_direction.to_string(),
));
}
if !sort_by_metric.is_empty() {
query_args.push(("sort_by_metric".to_string(), sort_by_metric.to_string()));
}
if !start_date.is_empty() {
query_args.push(("start_date".to_string(), start_date.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/categories/stats/sums?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve Email Statistics for Categories.
*
* This function performs a `GET` to the `/categories/stats` endpoint.
*
* **This endpoint allows you to retrieve all of your email statistics for each of your categories.**
*
* If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
*
* **Parameters:**
*
* * `start_date: &str` -- The starting date of the statistics to retrieve. Must follow format YYYY-MM-DD.
* * `end_date: &str` -- The end date of the statistics to retrieve. Defaults to today. Must follow format YYYY-MM-DD.
* * `categories: &str` -- The individual categories that you want to retrieve statistics for. You may include up to 10 different categories.
* * `limit: i64` -- The number of results to include.
* * `offset: i64` -- The number of results to skip.
* * `aggregated_by: crate::types::TraitStatsAdvancedBaseQueryStringsAggregatedBy` -- How to group the statistics. Must be either "day", "week", or "month".
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_stats(
&self,
start_date: &str,
end_date: &str,
categories: &str,
limit: i64,
offset: i64,
aggregated_by: crate::types::TraitStatsAdvancedBaseQueryStringsAggregatedBy,
) -> ClientResult<crate::Response<Vec<crate::types::CategoryStats>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !aggregated_by.to_string().is_empty() {
query_args.push(("aggregated_by".to_string(), aggregated_by.to_string()));
}
if !categories.is_empty() {
query_args.push(("categories".to_string(), categories.to_string()));
}
if !end_date.is_empty() {
query_args.push(("end_date".to_string(), end_date.to_string()));
}
if limit > 0 {
query_args.push(("limit".to_string(), limit.to_string()));
}
if offset > 0 {
query_args.push(("offset".to_string(), offset.to_string()));
}
if !start_date.is_empty() {
query_args.push(("start_date".to_string(), start_date.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/categories/stats?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve Email Statistics for Categories.
*
* This function performs a `GET` to the `/categories/stats` endpoint.
*
* As opposed to `get_stats`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve all of your email statistics for each of your categories.**
*
* If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.
*/
pub async fn get_all_stats(
&self,
start_date: &str,
end_date: &str,
categories: &str,
offset: i64,
aggregated_by: crate::types::TraitStatsAdvancedBaseQueryStringsAggregatedBy,
) -> ClientResult<crate::Response<Vec<crate::types::CategoryStats>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !aggregated_by.to_string().is_empty() {
query_args.push(("aggregated_by".to_string(), aggregated_by.to_string()));
}
if !categories.is_empty() {
query_args.push(("categories".to_string(), categories.to_string()));
}
if !end_date.is_empty() {
query_args.push(("end_date".to_string(), end_date.to_string()));
}
if offset > 0 {
query_args.push(("offset".to_string(), offset.to_string()));
}
if !start_date.is_empty() {
query_args.push(("start_date".to_string(), start_date.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/categories/stats?{}", query_), None);
self.client
.get_all_pages(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
}