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
use anyhow::Result;
use crate::Client;
pub struct Returns {
pub client: Client,
}
impl Returns {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Returns { client }
}
/**
* Get Return Order.
*
* This function performs a `GET` to the `/return/{id}` endpoint.
*
* **Parameters:**
*
* * `id: i64` -- Unique id of the channel.
* * `channel_id: i64` -- Unique id of the channel.
*/
pub async fn get(&self, id: i64) -> Result<crate::types::ReturnOrder> {
let url = format!(
"/return/{}",
crate::progenitor_support::encode_path(&id.to_string()),
);
self.client.get(&url, None).await
}
/**
* Modify Return Order.
*
* This function performs a `PUT` to the `/return/{id}` endpoint.
*
* **Parameters:**
*
* * `channel_id: i64` -- Unique id of the channel.
* * `id: i64` -- Unique id of the channel.
*/
pub async fn put(
&self,
id: i64,
body: &crate::types::ReturnsCreateReturn,
) -> Result<crate::types::ReturnOrder> {
let url = format!(
"/return/{}",
crate::progenitor_support::encode_path(&id.to_string()),
);
self.client
.put(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get Return Orders.
*
* This function performs a `GET` to the `/return` endpoint.
*
* **Parameters:**
*
* * `page: i64` -- Page of return orders to get.
* * `limit: i64` -- Amount of return orders per page to request.
* * `sort_order: crate::types::SortOrder` -- Order to sort results in.
* * `start_date: chrono::DateTime<chrono::Utc>` -- Start date to filter orders inserted later than.
* * `end_date: chrono::DateTime<chrono::Utc>` -- End date to filter orders inserted earlier than.
* * `i_ds: &[String]` -- Comma separated list of return orders ids to filter by.
* * `reference_ids: &[String]` -- Comma separated list of reference ids to filter by.
* * `status: &[String]` -- Comma separated list of statuses to filter by.
* * `fulfillment_center_ids: &[String]` -- Comma separated list of destination fulfillment center IDs to filter by.
* * `tracking_numbers: &[String]` -- Comma separated list of tracking numbers to filter by.
* * `original_shipment_ids: &[String]` -- Comma separated list of original shipment IDs to filter by.
* * `inventory_ids: &[String]` -- Comma separated list of inventory IDs contained in return to filter by.
* * `channel_id: i64` -- Unique id of the channel.
*/
pub async fn get_page(
&self,
page: i64,
limit: i64,
sort_order: crate::types::SortOrder,
start_date: Option<chrono::DateTime<chrono::Utc>>,
end_date: Option<chrono::DateTime<chrono::Utc>>,
ids: &[String],
reference_ids: &[String],
status: &[String],
fulfillment_center_ids: &[String],
tracking_numbers: &[String],
original_shipment_ids: &[String],
inventory_ids: &[String],
) -> Result<Vec<crate::types::ReturnOrder>> {
let mut query_args: Vec<(String, String)> = Default::default();
if let Some(date) = end_date {
query_args.push(("EndDate".to_string(), date.to_rfc3339()));
}
if !fulfillment_center_ids.is_empty() {
query_args.push((
"FulfillmentCenterIds".to_string(),
fulfillment_center_ids.join(" "),
));
}
if !ids.is_empty() {
query_args.push(("IDs".to_string(), ids.join(" ")));
}
if !inventory_ids.is_empty() {
query_args.push(("InventoryIds".to_string(), inventory_ids.join(" ")));
}
if limit > 0 {
query_args.push(("Limit".to_string(), limit.to_string()));
}
if !original_shipment_ids.is_empty() {
query_args.push((
"OriginalShipmentIds".to_string(),
original_shipment_ids.join(" "),
));
}
if page > 0 {
query_args.push(("Page".to_string(), page.to_string()));
}
if !reference_ids.is_empty() {
query_args.push(("ReferenceIds".to_string(), reference_ids.join(" ")));
}
if !sort_order.to_string().is_empty() {
query_args.push(("SortOrder".to_string(), sort_order.to_string()));
}
if let Some(date) = start_date {
query_args.push(("StartDate".to_string(), date.to_rfc3339()));
}
if !status.is_empty() {
query_args.push(("Status".to_string(), status.join(" ")));
}
if !tracking_numbers.is_empty() {
query_args.push(("TrackingNumbers".to_string(), tracking_numbers.join(" ")));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/return?{}", query_);
self.client.get(&url, None).await
}
/**
* Get Return Orders.
*
* This function performs a `GET` to the `/return` endpoint.
*
* As opposed to `get`, this function returns all the pages of the request at once.
*/
pub async fn get_all(
&self,
sort_order: crate::types::SortOrder,
start_date: Option<chrono::DateTime<chrono::Utc>>,
end_date: Option<chrono::DateTime<chrono::Utc>>,
ids: &[String],
reference_ids: &[String],
status: &[String],
fulfillment_center_ids: &[String],
tracking_numbers: &[String],
original_shipment_ids: &[String],
inventory_ids: &[String],
) -> Result<Vec<crate::types::ReturnOrder>> {
let mut query_args: Vec<(String, String)> = Default::default();
if let Some(date) = end_date {
query_args.push(("EndDate".to_string(), date.to_rfc3339()));
}
if !fulfillment_center_ids.is_empty() {
query_args.push((
"FulfillmentCenterIds".to_string(),
fulfillment_center_ids.join(" "),
));
}
if !ids.is_empty() {
query_args.push(("IDs".to_string(), ids.join(" ")));
}
if !inventory_ids.is_empty() {
query_args.push(("InventoryIds".to_string(), inventory_ids.join(" ")));
}
if !original_shipment_ids.is_empty() {
query_args.push((
"OriginalShipmentIds".to_string(),
original_shipment_ids.join(" "),
));
}
if !reference_ids.is_empty() {
query_args.push(("ReferenceIds".to_string(), reference_ids.join(" ")));
}
if !sort_order.to_string().is_empty() {
query_args.push(("SortOrder".to_string(), sort_order.to_string()));
}
if let Some(date) = start_date {
query_args.push(("StartDate".to_string(), date.to_rfc3339()));
}
if !status.is_empty() {
query_args.push(("Status".to_string(), status.join(" ")));
}
if !tracking_numbers.is_empty() {
query_args.push(("TrackingNumbers".to_string(), tracking_numbers.join(" ")));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/return?{}", query_);
self.client.get_all_pages(&url, None).await
}
/**
* Create Return Order.
*
* This function performs a `POST` to the `/return` endpoint.
*
* **Parameters:**
*
* * `channel_id: i64` -- Unique id of the channel.
*/
pub async fn post(
&self,
body: &crate::types::ReturnsCreateReturn,
) -> Result<crate::types::ReturnOrder> {
let url = "/return".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Cancel Return Order.
*
* This function performs a `POST` to the `/return/{id}/cancel` endpoint.
*
* **Parameters:**
*
* * `id: i64` -- Unique id of the channel.
* * `channel_id: i64` -- Unique id of the channel.
*/
pub async fn post_cancel(&self, id: i64) -> Result<crate::types::ReturnOrder> {
let url = format!(
"/return/{}/cancel",
crate::progenitor_support::encode_path(&id.to_string()),
);
self.client.post(&url, None).await
}
/**
* Get One Return's status history.
*
* This function performs a `GET` to the `/return/{id}/statushistory` endpoint.
*
* **Parameters:**
*
* * `id: i64` -- Unique id of the channel.
* * `channel_id: i64` -- Unique id of the channel.
*/
pub async fn get_status_history(
&self,
id: i64,
) -> Result<crate::types::ReturnOrderStatusHistory> {
let url = format!(
"/return/{}/statushistory",
crate::progenitor_support::encode_path(&id.to_string()),
);
self.client.get(&url, None).await
}
}