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
use crate::Client;
use crate::ClientResult;
pub struct CancelScheduledSends {
pub client: Client,
}
impl CancelScheduledSends {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
CancelScheduledSends { client }
}
/**
* Create a batch ID.
*
* This function performs a `POST` to the `/mail/batch` endpoint.
*
* **This endpoint allows you to generate a new batch ID.**
*
* Once a `batch_id` is created, you can associate it with a scheduled send using the `/mail/send` endpoint. Passing the `batch_id` as a field in the `/mail/send` request body will assign the ID to the send you are creating.
*
* Once an ID is associated with a scheduled send, the send can be accessed and its send status can be modified using the `batch_id`.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_mail_batch(
&self,
) -> ClientResult<crate::Response<crate::types::MailBatchId>> {
let url = self.client.url("/mail/batch", None);
self.client
.post(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve all scheduled sends.
*
* This function performs a `GET` to the `/user/scheduled_sends` endpoint.
*
* **This endpoint allows you to retrieve all cancelled and paused scheduled send information.**
*
* This endpoint will return only the scheduled sends that are associated with a `batch_id`. If you have scheduled a send using the `/mail/send` endpoint and the `send_at` field but no `batch_id`, the send will be scheduled for delivery; however, it will not be returned by this endpoint. For this reason, you should assign a `batch_id` to any scheduled send you may need to pause or cancel in the future.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_user_scheduled_sends(
&self,
) -> ClientResult<crate::Response<Vec<crate::types::UserScheduledSendStatusAllOf>>> {
let url = self.client.url("/user/scheduled_sends", None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve all scheduled sends.
*
* This function performs a `GET` to the `/user/scheduled_sends` endpoint.
*
* As opposed to `get_user_scheduled_sends`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve all cancelled and paused scheduled send information.**
*
* This endpoint will return only the scheduled sends that are associated with a `batch_id`. If you have scheduled a send using the `/mail/send` endpoint and the `send_at` field but no `batch_id`, the send will be scheduled for delivery; however, it will not be returned by this endpoint. For this reason, you should assign a `batch_id` to any scheduled send you may need to pause or cancel in the future.
*/
pub async fn get_all_user_scheduled_sends(
&self,
) -> ClientResult<crate::Response<Vec<crate::types::UserScheduledSendStatusAllOf>>> {
let url = self.client.url("/user/scheduled_sends", None);
self.client
.get_all_pages(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Cancel or pause a scheduled send.
*
* This function performs a `POST` to the `/user/scheduled_sends` endpoint.
*
* **This endpoint allows you to cancel or pause a scheduled send associated with a `batch_id`.**
*
* Passing this endpoint a `batch_id` and status will cancel or pause the scheduled send.
*
* Once a scheduled send is set to `pause` or `cancel` you must use the "Update a scheduled send" endpoint to change its status or the "Delete a cancellation or pause from a scheduled send" endpoint to remove the status. Passing a status change to a scheduled send that has already been paused or cancelled will result in a `400` level status code.
*
* If the maximum number of cancellations/pauses are added to a send, a `400` level status code will be returned.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn post_user_scheduled_send(
&self,
body: &crate::types::CancelPauseAScheduledSendRequest,
) -> ClientResult<crate::Response<crate::types::UserScheduledSendStatusAllOf>> {
let url = self.client.url("/user/scheduled_sends", 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
}
/**
* Validate batch ID.
*
* This function performs a `GET` to the `/mail/batch/{batch_id}` endpoint.
*
* **This endpoint allows you to validate a batch ID.**
*
* When you pass a valid `batch_id` to this endpoint, it will return a `200` status code and the batch ID itself.
*
* If you pass an invalid `batch_id` to the endpoint, you will receive a `400` level status code and an error message.
*
* A `batch_id` does not need to be assigned to a scheduled send to be considered valid. A successful response means only that the `batch_id` has been created, but it does not indicate that it has been associated with a send.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_mail_batch(
&self,
batch_id: &str,
) -> ClientResult<crate::Response<crate::types::MailBatchId>> {
let url = self.client.url(
&format!(
"/mail/batch/{}",
crate::progenitor_support::encode_path(batch_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve scheduled send.
*
* This function performs a `GET` to the `/user/scheduled_sends/{batch_id}` endpoint.
*
* **This endpoint allows you to retrieve the cancel/paused scheduled send information for a specific `batch_id`.**
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn get_user_scheduled_sends_batch(
&self,
batch_id: &str,
) -> ClientResult<crate::Response<Vec<crate::types::UserScheduledSendStatusAllOf>>> {
let url = self.client.url(
&format!(
"/user/scheduled_sends/{}",
crate::progenitor_support::encode_path(batch_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Retrieve scheduled send.
*
* This function performs a `GET` to the `/user/scheduled_sends/{batch_id}` endpoint.
*
* As opposed to `get_user_scheduled_sends_batch`, this function returns all the pages of the request at once.
*
* **This endpoint allows you to retrieve the cancel/paused scheduled send information for a specific `batch_id`.**
*/
pub async fn get_all_user_scheduled_sends_batch(
&self,
batch_id: &str,
) -> ClientResult<crate::Response<Vec<crate::types::UserScheduledSendStatusAllOf>>> {
let url = self.client.url(
&format!(
"/user/scheduled_sends/{}",
crate::progenitor_support::encode_path(batch_id),
),
None,
);
self.client
.get_all_pages(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete a cancellation or pause from a scheduled send.
*
* This function performs a `DELETE` to the `/user/scheduled_sends/{batch_id}` endpoint.
*
* **This endpoint allows you to delete the cancellation/pause of a scheduled send.**
*
* Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn delete_user_scheduled_sends_batch(
&self,
batch_id: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/user/scheduled_sends/{}",
crate::progenitor_support::encode_path(batch_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update a scheduled send.
*
* This function performs a `PATCH` to the `/user/scheduled_sends/{batch_id}` endpoint.
*
* **This endpoint allows you to update the status of a scheduled send for the given `batch_id`.**
*
* If you have already set a `cancel` or `pause` status on a scheduled send using the "Cancel or pause a scheduled send" endpoint, you can update it's status using this endpoint. Attempting to update a status once it has been set with the "Cancel or pause a scheduled send" endpoint will result in a `400` error.
*
* **Parameters:**
*
* * `on_behalf_of: &str` -- The license key provided with your New Relic account.
*/
pub async fn patch_user_scheduled_sends_batch(
&self,
batch_id: &str,
body: &crate::types::UserScheduledSendStatus,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/user/scheduled_sends/{}",
crate::progenitor_support::encode_path(batch_id),
),
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
}
}