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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
use crate::Client;
use crate::ClientResult;
pub struct CampaignsApi {
pub client: Client,
}
impl CampaignsApi {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
CampaignsApi { client }
}
/**
* Retrieve all Campaigns.
*
* This function performs a `GET` to the `/campaigns` endpoint.
*
* **This endpoint allows you to retrieve a list of all of your campaigns.**
*
* Returns campaigns in reverse order they were created (newest first).
*
* Returns an empty array if no campaigns exist.
*
* **Parameters:**
*
* * `limit: i64` -- The number of results you would like to receive at a time.
* * `offset: i64` -- The index of the first campaign to return, where 0 is the first campaign.
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_campaigns(
&self,
limit: i64,
offset: i64,
) -> ClientResult<crate::Response<crate::types::GetCampaignsResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
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!("/campaigns?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Create a Campaign.
*
* This function performs a `POST` to the `/campaigns` endpoint.
*
* **This endpoint allows you to create a campaign.**
*
* In order to send or schedule the campaign, you will be required to provide a subject, sender ID, content (we suggest both html and plain text), and at least one list or segment ID. This information is not required when you create a campaign.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_campaign(
&self,
body: &crate::types::CampaignsRequest,
) -> ClientResult<crate::Response<crate::types::CampaignResponseAllOf>> {
let url = self.client.url("/campaigns", None);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Retrieve a single campaign.
*
* This function performs a `GET` to the `/campaigns/{campaign_id}` endpoint.
*
* **This endpoint allows you to retrieve a specific campaign.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_campaigns_campaign(
&self,
campaign_id: i64,
) -> ClientResult<crate::Response<crate::types::GetCampaignsCampaignResponse>> {
let url = self.client.url(
&format!(
"/campaigns/{}",
crate::progenitor_support::encode_path(&campaign_id.to_string()),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete a Campaign.
*
* This function performs a `DELETE` to the `/campaigns/{campaign_id}` endpoint.
*
* **This endpoint allows you to delete a specific campaign.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn delete_campaigns_campaign(
&self,
campaign_id: i64,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/campaigns/{}",
crate::progenitor_support::encode_path(&campaign_id.to_string()),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update a Campaign.
*
* This function performs a `PATCH` to the `/campaigns/{campaign_id}` endpoint.
*
* **This endpoint allows you to update a specific campaign.**
*
* This is especially useful if you only set up the campaign using POST /campaigns, but didn't set many of the parameters.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn patch_campaigns_campaign(
&self,
campaign_id: i64,
body: &crate::types::UpdateACampaignRequest,
) -> ClientResult<crate::Response<crate::types::CampaignResponseAllOf>> {
let url = self.client.url(
&format!(
"/campaigns/{}",
crate::progenitor_support::encode_path(&campaign_id.to_string()),
),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Send a Campaign.
*
* This function performs a `POST` to the `/campaigns/{campaign_id}/schedules/now` endpoint.
*
* **This endpoint allows you to immediately send an existing campaign.**
*
* Normally a POST request would have a body, but since this endpoint is telling us to send a resource that is already created, a request body is not needed.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_campaigns_campaign_schedules_now(
&self,
campaign_id: i64,
) -> ClientResult<crate::Response<crate::types::SendACampaignResponse>> {
let url = self.client.url(
&format!(
"/campaigns/{}/schedules/now",
crate::progenitor_support::encode_path(&campaign_id.to_string()),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* View Scheduled Time of a Campaign.
*
* This function performs a `GET` to the `/campaigns/{campaign_id}/schedules` endpoint.
*
* **This endpoint allows you to retrieve the date and time that a campaign has been scheduled to be sent.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_campaigns_campaign_schedule(
&self,
campaign_id: i64,
) -> ClientResult<crate::Response<crate::types::ScheduleACampaignRequest>> {
let url = self.client.url(
&format!(
"/campaigns/{}/schedules",
crate::progenitor_support::encode_path(&campaign_id.to_string()),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Schedule a Campaign.
*
* This function performs a `POST` to the `/campaigns/{campaign_id}/schedules` endpoint.
*
* **This endpoint allows you to schedule a specific date and time for your campaign to be sent.**
*
* If you have the flexibility, it's better to schedule mail for off-peak times. Most emails are scheduled and sent at the top of the hour or half hour. Scheduling email to avoid those times (for example, scheduling at 10:53) can result in lower deferral rates because it won't be going through our servers at the same times as everyone else's mail.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_campaigns_campaign_schedule(
&self,
campaign_id: i64,
body: &crate::types::ScheduleACampaignRequest,
) -> ClientResult<crate::Response<crate::types::ScheduleACampaignResponse>> {
let url = self.client.url(
&format!(
"/campaigns/{}/schedules",
crate::progenitor_support::encode_path(&campaign_id.to_string()),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Unschedule a Scheduled Campaign.
*
* This function performs a `DELETE` to the `/campaigns/{campaign_id}/schedules` endpoint.
*
* **This endpoint allows you to unschedule a campaign that has already been scheduled to be sent.**
*
* A successful unschedule will return a 204.
* If the specified campaign is in the process of being sent, the only option is to cancel (a different method).
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn delete_campaigns_campaign_schedules(
&self,
campaign_id: i64,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/campaigns/{}/schedules",
crate::progenitor_support::encode_path(&campaign_id.to_string()),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update a Scheduled Campaign.
*
* This function performs a `PATCH` to the `/campaigns/{campaign_id}/schedules` endpoint.
*
* **This endpoint allows to you change the scheduled time and date for a campaign to be sent.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn patch_campaigns_campaign_schedules(
&self,
campaign_id: i64,
body: &crate::types::ScheduleACampaignRequest,
) -> ClientResult<crate::Response<crate::types::UpdateAScheduledCampaignResponse>> {
let url = self.client.url(
&format!(
"/campaigns/{}/schedules",
crate::progenitor_support::encode_path(&campaign_id.to_string()),
),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Send a Test Campaign.
*
* This function performs a `POST` to the `/campaigns/{campaign_id}/schedules/test` endpoint.
*
* **This endpoint allows you to send a test campaign.**
*
* To send to multiple addresses, use an array for the JSON "to" value ["one@address","two@address"]
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_campaigns_campaign_schedules_test(
&self,
campaign_id: i64,
body: &crate::types::SendATestCampaignRequest,
) -> ClientResult<crate::Response<crate::types::SendATestCampaignRequest>> {
let url = self.client.url(
&format!(
"/campaigns/{}/schedules/test",
crate::progenitor_support::encode_path(&campaign_id.to_string()),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
}