hermes-sdk 0.1.0

The most comprehensive Rust SDK for eBay marketplace APIs - 17 specialized clients with 86+ methods
Documentation
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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
use crate::config::EbayConfig;
use crate::error::{HermesError, HermesResult};
use crate::ebay::auth::EbayAuth;
use std::sync::Arc;

// Import eBay Buy Order SDK models and APIs
use hermes_ebay_buy_order::models::{
    GuestCheckoutSessionResponseV2, CreateGuestCheckoutSessionRequestV2, CouponRequest,
    UpdateQuantity, ShippingAddressImpl, UpdateShippingOption, GuestPurchaseOrderV2,
};
use hermes_ebay_buy_order::apis::configuration::Configuration as OrderConfiguration;

/// eBay Buy Order API client for guest checkout and order management
/// 
/// This client provides access to:
/// - Guest checkout session management
/// - Purchase order operations
/// - Coupon management
/// - Shipping and quantity updates
pub struct OrderClient {
    config: EbayConfig,
    auth: Arc<EbayAuth>,
}

impl OrderClient {
    /// Create a new Order API client
    pub fn new(config: EbayConfig) -> HermesResult<Self> {
        let auth = Arc::new(EbayAuth::new(config.clone())?);
        Ok(Self { config, auth })
    }

    /// Initiate a guest checkout session
    /// 
    /// Creates a new checkout session for guest users to purchase items
    /// without requiring an eBay account.
    /// 
    /// # Arguments
    /// * `marketplace_id` - The marketplace ID (e.g., "EBAY_US")
    /// * `checkout_request` - The checkout session creation request
    /// * `end_user_ctx` - Optional end user context for tracking
    pub async fn initiate_guest_checkout_session(
        &self,
        marketplace_id: &str,
        checkout_request: &CreateGuestCheckoutSessionRequestV2,
        end_user_ctx: Option<&str>,
    ) -> HermesResult<GuestCheckoutSessionResponseV2> {
        let start_time = std::time::Instant::now();
        
        // Get access token
        let token_start = std::time::Instant::now();
        let token = self.auth.get_access_token().await?;
        let token_duration = token_start.elapsed();
        tracing::info!("OAuth token request for initiate_guest_checkout_session: {:?}", token_duration);
        
        // Set up configuration
        let mut config = OrderConfiguration::new();
        config.base_path = if self.config.sandbox {
            "https://api.sandbox.ebay.com/buy/order/v1".to_string()
        } else {
            "https://api.ebay.com/buy/order/v1".to_string()
        };
        config.oauth_access_token = Some(token);
        
        // Call the eBay SDK
        let ebay_start = std::time::Instant::now();
        let result = hermes_ebay_buy_order::apis::guest_checkout_session_api::initiate_guest_checkout_session(
            &config,
            marketplace_id,
            "application/json",
            end_user_ctx,
            Some(checkout_request.clone()),
        ).await;
        let ebay_duration = ebay_start.elapsed();
        tracing::info!("eBay initiate_guest_checkout_session API call: {:?}", ebay_duration);
        
        match result {
            Ok(response) => {
                let total_duration = start_time.elapsed();
                let our_processing = total_duration - token_duration - ebay_duration;
                tracing::info!("initiate_guest_checkout_session total: {:?} | Our processing: {:?}", total_duration, our_processing);
                Ok(response)
            },
            Err(e) => {
                let total_duration = start_time.elapsed();
                tracing::error!("eBay initiate_guest_checkout_session error after {:?}: {:?}", total_duration, e);
                Err(HermesError::ApiRequest(format!("eBay initiate_guest_checkout_session failed: {:?}", e)))
            }
        }
    }

    /// Get guest checkout session details
    /// 
    /// Retrieves the current state of a guest checkout session,
    /// including items, pricing, shipping, and payment information.
    /// 
    /// # Arguments
    /// * `checkout_session_id` - The checkout session ID
    /// * `marketplace_id` - The marketplace ID (e.g., "EBAY_US")
    /// * `end_user_ctx` - Optional end user context for tracking
    pub async fn get_guest_checkout_session(
        &self,
        checkout_session_id: &str,
        marketplace_id: &str,
        end_user_ctx: Option<&str>,
    ) -> HermesResult<GuestCheckoutSessionResponseV2> {
        let start_time = std::time::Instant::now();
        
        // Get access token
        let token_start = std::time::Instant::now();
        let token = self.auth.get_access_token().await?;
        let token_duration = token_start.elapsed();
        tracing::info!("OAuth token request for get_guest_checkout_session: {:?}", token_duration);
        
        // Set up configuration
        let mut config = OrderConfiguration::new();
        config.base_path = if self.config.sandbox {
            "https://api.sandbox.ebay.com/buy/order/v1".to_string()
        } else {
            "https://api.ebay.com/buy/order/v1".to_string()
        };
        config.oauth_access_token = Some(token);
        
        // Call the eBay SDK
        let ebay_start = std::time::Instant::now();
        let result = hermes_ebay_buy_order::apis::guest_checkout_session_api::get_guest_checkout_session(
            &config,
            &checkout_session_id,
            marketplace_id,
            end_user_ctx,
        ).await;
        let ebay_duration = ebay_start.elapsed();
        tracing::info!("eBay get_guest_checkout_session API call: {:?}", ebay_duration);
        
        match result {
            Ok(response) => {
                let total_duration = start_time.elapsed();
                let our_processing = total_duration - token_duration - ebay_duration;
                tracing::info!("get_guest_checkout_session total: {:?} | Our processing: {:?}", total_duration, our_processing);
                Ok(response)
            },
            Err(e) => {
                let total_duration = start_time.elapsed();
                tracing::error!("eBay get_guest_checkout_session error after {:?}: {:?}", total_duration, e);
                Err(HermesError::ApiRequest(format!("eBay get_guest_checkout_session failed: {:?}", e)))
            }
        }
    }

    /// Apply a coupon to the guest checkout session
    /// 
    /// Applies a promotional coupon or discount code to reduce the order total.
    /// 
    /// # Arguments
    /// * `checkout_session_id` - The checkout session ID
    /// * `marketplace_id` - The marketplace ID (e.g., "EBAY_US")
    /// * `coupon_request` - The coupon application request
    /// * `end_user_ctx` - Optional end user context for tracking
    pub async fn apply_guest_coupon(
        &self,
        checkout_session_id: &str,
        marketplace_id: &str,
        coupon_request: &CouponRequest,
        end_user_ctx: Option<&str>,
    ) -> HermesResult<GuestCheckoutSessionResponseV2> {
        let start_time = std::time::Instant::now();
        
        // Get access token
        let token_start = std::time::Instant::now();
        let token = self.auth.get_access_token().await?;
        let token_duration = token_start.elapsed();
        tracing::info!("OAuth token request for apply_guest_coupon: {:?}", token_duration);
        
        // Set up configuration
        let mut config = OrderConfiguration::new();
        config.base_path = if self.config.sandbox {
            "https://api.sandbox.ebay.com/buy/order/v1".to_string()
        } else {
            "https://api.ebay.com/buy/order/v1".to_string()
        };
        config.oauth_access_token = Some(token);
        
        // Call the eBay SDK
        let ebay_start = std::time::Instant::now();
        let result = hermes_ebay_buy_order::apis::guest_checkout_session_api::apply_guest_coupon(
            &config,
            &checkout_session_id,
            marketplace_id,
            "application/json",
            end_user_ctx,
            Some(coupon_request.clone()),
        ).await;
        let ebay_duration = ebay_start.elapsed();
        tracing::info!("eBay apply_guest_coupon API call: {:?}", ebay_duration);
        
        match result {
            Ok(response) => {
                let total_duration = start_time.elapsed();
                let our_processing = total_duration - token_duration - ebay_duration;
                tracing::info!("apply_guest_coupon total: {:?} | Our processing: {:?}", total_duration, our_processing);
                Ok(response)
            },
            Err(e) => {
                let total_duration = start_time.elapsed();
                tracing::error!("eBay apply_guest_coupon error after {:?}: {:?}", total_duration, e);
                Err(HermesError::ApiRequest(format!("eBay apply_guest_coupon failed: {:?}", e)))
            }
        }
    }

    /// Remove a coupon from the guest checkout session
    /// 
    /// Removes a previously applied coupon or discount code.
    /// 
    /// # Arguments
    /// * `checkout_session_id` - The checkout session ID
    /// * `marketplace_id` - The marketplace ID (e.g., "EBAY_US")
    /// * `coupon_request` - The coupon removal request
    /// * `end_user_ctx` - Optional end user context for tracking
    pub async fn remove_guest_coupon(
        &self,
        checkout_session_id: &str,
        marketplace_id: &str,
        coupon_request: &CouponRequest,
        end_user_ctx: Option<&str>,
    ) -> HermesResult<GuestCheckoutSessionResponseV2> {
        let start_time = std::time::Instant::now();
        
        // Get access token
        let token_start = std::time::Instant::now();
        let token = self.auth.get_access_token().await?;
        let token_duration = token_start.elapsed();
        tracing::info!("OAuth token request for remove_guest_coupon: {:?}", token_duration);
        
        // Set up configuration
        let mut config = OrderConfiguration::new();
        config.base_path = if self.config.sandbox {
            "https://api.sandbox.ebay.com/buy/order/v1".to_string()
        } else {
            "https://api.ebay.com/buy/order/v1".to_string()
        };
        config.oauth_access_token = Some(token);
        
        // Call the eBay SDK
        let ebay_start = std::time::Instant::now();
        let result = hermes_ebay_buy_order::apis::guest_checkout_session_api::remove_guest_coupon(
            &config,
            &checkout_session_id,
            marketplace_id,
            "application/json",
            end_user_ctx,
            Some(coupon_request.clone()),
        ).await;
        let ebay_duration = ebay_start.elapsed();
        tracing::info!("eBay remove_guest_coupon API call: {:?}", ebay_duration);
        
        match result {
            Ok(response) => {
                let total_duration = start_time.elapsed();
                let our_processing = total_duration - token_duration - ebay_duration;
                tracing::info!("remove_guest_coupon total: {:?} | Our processing: {:?}", total_duration, our_processing);
                Ok(response)
            },
            Err(e) => {
                let total_duration = start_time.elapsed();
                tracing::error!("eBay remove_guest_coupon error after {:?}: {:?}", total_duration, e);
                Err(HermesError::ApiRequest(format!("eBay remove_guest_coupon failed: {:?}", e)))
            }
        }
    }

    /// Update item quantity in the guest checkout session
    /// 
    /// Changes the quantity of items in the shopping cart.
    /// 
    /// # Arguments
    /// * `checkout_session_id` - The checkout session ID
    /// * `marketplace_id` - The marketplace ID (e.g., "EBAY_US")
    /// * `update_quantity` - The quantity update request
    /// * `end_user_ctx` - Optional end user context for tracking
    pub async fn update_guest_quantity(
        &self,
        checkout_session_id: &str,
        marketplace_id: &str,
        update_quantity: &UpdateQuantity,
        end_user_ctx: Option<&str>,
    ) -> HermesResult<GuestCheckoutSessionResponseV2> {
        let start_time = std::time::Instant::now();
        
        // Get access token
        let token_start = std::time::Instant::now();
        let token = self.auth.get_access_token().await?;
        let token_duration = token_start.elapsed();
        tracing::info!("OAuth token request for update_guest_quantity: {:?}", token_duration);
        
        // Set up configuration
        let mut config = OrderConfiguration::new();
        config.base_path = if self.config.sandbox {
            "https://api.sandbox.ebay.com/buy/order/v1".to_string()
        } else {
            "https://api.ebay.com/buy/order/v1".to_string()
        };
        config.oauth_access_token = Some(token);
        
        // Call the eBay SDK
        let ebay_start = std::time::Instant::now();
        let result = hermes_ebay_buy_order::apis::guest_checkout_session_api::update_guest_quantity(
            &config,
            &checkout_session_id,
            marketplace_id,
            "application/json",
            end_user_ctx,
            Some(update_quantity.clone()),
        ).await;
        let ebay_duration = ebay_start.elapsed();
        tracing::info!("eBay update_guest_quantity API call: {:?}", ebay_duration);
        
        match result {
            Ok(response) => {
                let total_duration = start_time.elapsed();
                let our_processing = total_duration - token_duration - ebay_duration;
                tracing::info!("update_guest_quantity total: {:?} | Our processing: {:?}", total_duration, our_processing);
                Ok(response)
            },
            Err(e) => {
                let total_duration = start_time.elapsed();
                tracing::error!("eBay update_guest_quantity error after {:?}: {:?}", total_duration, e);
                Err(HermesError::ApiRequest(format!("eBay update_guest_quantity failed: {:?}", e)))
            }
        }
    }

    /// Update shipping address in the guest checkout session
    /// 
    /// Updates the delivery address for the order.
    /// 
    /// # Arguments
    /// * `checkout_session_id` - The checkout session ID
    /// * `marketplace_id` - The marketplace ID (e.g., "EBAY_US")
    /// * `shipping_address` - The new shipping address
    /// * `end_user_ctx` - Optional end user context for tracking
    pub async fn update_guest_shipping_address(
        &self,
        checkout_session_id: &str,
        marketplace_id: &str,
        shipping_address: &ShippingAddressImpl,
        end_user_ctx: Option<&str>,
    ) -> HermesResult<GuestCheckoutSessionResponseV2> {
        let start_time = std::time::Instant::now();
        
        // Get access token
        let token_start = std::time::Instant::now();
        let token = self.auth.get_access_token().await?;
        let token_duration = token_start.elapsed();
        tracing::info!("OAuth token request for update_guest_shipping_address: {:?}", token_duration);
        
        // Set up configuration
        let mut config = OrderConfiguration::new();
        config.base_path = if self.config.sandbox {
            "https://api.sandbox.ebay.com/buy/order/v1".to_string()
        } else {
            "https://api.ebay.com/buy/order/v1".to_string()
        };
        config.oauth_access_token = Some(token);
        
        // Call the eBay SDK
        let ebay_start = std::time::Instant::now();
        let result = hermes_ebay_buy_order::apis::guest_checkout_session_api::update_guest_shipping_address(
            &config,
            &checkout_session_id,
            marketplace_id,
            "application/json",
            end_user_ctx,
            Some(shipping_address.clone()),
        ).await;
        let ebay_duration = ebay_start.elapsed();
        tracing::info!("eBay update_guest_shipping_address API call: {:?}", ebay_duration);
        
        match result {
            Ok(response) => {
                let total_duration = start_time.elapsed();
                let our_processing = total_duration - token_duration - ebay_duration;
                tracing::info!("update_guest_shipping_address total: {:?} | Our processing: {:?}", total_duration, our_processing);
                Ok(response)
            },
            Err(e) => {
                let total_duration = start_time.elapsed();
                tracing::error!("eBay update_guest_shipping_address error after {:?}: {:?}", total_duration, e);
                Err(HermesError::ApiRequest(format!("eBay update_guest_shipping_address failed: {:?}", e)))
            }
        }
    }

    /// Update shipping option in the guest checkout session
    /// 
    /// Changes the shipping method (e.g., standard, expedited, overnight).
    /// 
    /// # Arguments
    /// * `checkout_session_id` - The checkout session ID
    /// * `marketplace_id` - The marketplace ID (e.g., "EBAY_US")
    /// * `shipping_option` - The new shipping option
    /// * `end_user_ctx` - Optional end user context for tracking
    pub async fn update_guest_shipping_option(
        &self,
        checkout_session_id: &str,
        marketplace_id: &str,
        shipping_option: &UpdateShippingOption,
        end_user_ctx: Option<&str>,
    ) -> HermesResult<GuestCheckoutSessionResponseV2> {
        let start_time = std::time::Instant::now();
        
        // Get access token
        let token_start = std::time::Instant::now();
        let token = self.auth.get_access_token().await?;
        let token_duration = token_start.elapsed();
        tracing::info!("OAuth token request for update_guest_shipping_option: {:?}", token_duration);
        
        // Set up configuration
        let mut config = OrderConfiguration::new();
        config.base_path = if self.config.sandbox {
            "https://api.sandbox.ebay.com/buy/order/v1".to_string()
        } else {
            "https://api.ebay.com/buy/order/v1".to_string()
        };
        config.oauth_access_token = Some(token);
        
        // Call the eBay SDK
        let ebay_start = std::time::Instant::now();
        let result = hermes_ebay_buy_order::apis::guest_checkout_session_api::update_guest_shipping_option(
            &config,
            &checkout_session_id,
            marketplace_id,
            "application/json",
            end_user_ctx,
            Some(shipping_option.clone()),
        ).await;
        let ebay_duration = ebay_start.elapsed();
        tracing::info!("eBay update_guest_shipping_option API call: {:?}", ebay_duration);
        
        match result {
            Ok(response) => {
                let total_duration = start_time.elapsed();
                let our_processing = total_duration - token_duration - ebay_duration;
                tracing::info!("update_guest_shipping_option total: {:?} | Our processing: {:?}", total_duration, our_processing);
                Ok(response)
            },
            Err(e) => {
                let total_duration = start_time.elapsed();
                tracing::error!("eBay update_guest_shipping_option error after {:?}: {:?}", total_duration, e);
                Err(HermesError::ApiRequest(format!("eBay update_guest_shipping_option failed: {:?}", e)))
            }
        }
    }

    /// Get guest purchase order details
    /// 
    /// Retrieves the details of a completed purchase order,
    /// including order status, items, pricing, and shipping information.
    /// 
    /// # Arguments
    /// * `purchase_order_id` - The purchase order ID
    /// * `marketplace_id` - Optional marketplace ID (e.g., "EBAY_US")
    /// * `end_user_ctx` - Optional end user context for tracking
    pub async fn get_guest_purchase_order(
        &self,
        purchase_order_id: &str,
        marketplace_id: Option<&str>,
        end_user_ctx: Option<&str>,
    ) -> HermesResult<GuestPurchaseOrderV2> {
        let start_time = std::time::Instant::now();
        
        // Get access token
        let token_start = std::time::Instant::now();
        let token = self.auth.get_access_token().await?;
        let token_duration = token_start.elapsed();
        tracing::info!("OAuth token request for get_guest_purchase_order: {:?}", token_duration);
        
        // Set up configuration
        let mut config = OrderConfiguration::new();
        config.base_path = if self.config.sandbox {
            "https://api.sandbox.ebay.com/buy/order/v1".to_string()
        } else {
            "https://api.ebay.com/buy/order/v1".to_string()
        };
        config.oauth_access_token = Some(token);
        
        // Call the eBay SDK
        let ebay_start = std::time::Instant::now();
        let result = hermes_ebay_buy_order::apis::guest_purchase_order_api::get_guest_purchase_order(
            &config,
            purchase_order_id,
            marketplace_id,
            end_user_ctx,
        ).await;
        let ebay_duration = ebay_start.elapsed();
        tracing::info!("eBay get_guest_purchase_order API call: {:?}", ebay_duration);
        
        match result {
            Ok(response) => {
                let total_duration = start_time.elapsed();
                let our_processing = total_duration - token_duration - ebay_duration;
                tracing::info!("get_guest_purchase_order total: {:?} | Our processing: {:?}", total_duration, our_processing);
                Ok(response)
            },
            Err(e) => {
                let total_duration = start_time.elapsed();
                tracing::error!("eBay get_guest_purchase_order error after {:?}: {:?}", total_duration, e);
                Err(HermesError::ApiRequest(format!("eBay get_guest_purchase_order failed: {:?}", e)))
            }
        }
    }
}