sumup-rs 0.2.0

A comprehensive, type-safe Rust client for the SumUp API with full async/await support
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

use crate::{Receipt, ReceiptListResponse, Result, SumUpClient};
use serde::Serialize;

#[derive(Debug, Clone, Serialize)]
pub struct ReceiptListQuery {
    pub mid: String, // Required: Merchant ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub offset: Option<i32>,
}

#[derive(Debug, Clone, Serialize)]
pub struct ReceiptRetrieveQuery {
    pub mid: String, // Required: Merchant ID
}

impl SumUpClient {
    /// Lists all receipts for the authenticated merchant.
    ///
    /// # Arguments
    /// * `query` - Query parameters including required mid
    ///
    /// Note: The /v1.1/receipts list endpoint does not exist in the SumUp API.
    /// Only individual receipt retrieval is supported.
    #[deprecated(
        since = "0.2.0",
        note = "The /v1.1/receipts list endpoint does not exist. Use retrieve_receipt for individual receipts."
    )]
    pub async fn list_receipts(&self, _query: &ReceiptListQuery) -> Result<ReceiptListResponse> {
        Err(crate::Error::ApiError {
            status: 404,
            body: crate::ApiErrorBody {
                error_type: None,
                title: Some("Endpoint not implemented".to_string()),
                status: Some(404),
                detail: Some("The /v1.1/receipts list endpoint does not exist in the SumUp API. Only individual receipt retrieval is supported.".to_string()),
                error_code: None,
                message: None,
                param: None,
                additional_fields: std::collections::HashMap::new(),
            }
        })
    }

    /// Lists receipts for a specific merchant.
    ///
    /// # Arguments
    /// * `merchant_code` - The unique merchant code identifier
    /// * `query` - Query parameters including required mid
    ///
    /// Note: The /v1.1/merchants/{merchant_code}/receipts list endpoint does not exist in the SumUp API.
    /// Only individual receipt retrieval is supported.
    #[deprecated(
        since = "0.2.0",
        note = "The merchant receipts list endpoint does not exist. Use retrieve_merchant_receipt for individual receipts."
    )]
    pub async fn list_merchant_receipts(
        &self,
        _merchant_code: &str,
        _query: &ReceiptListQuery,
    ) -> Result<ReceiptListResponse> {
        Err(crate::Error::ApiError {
            status: 404,
            body: crate::ApiErrorBody {
                error_type: None,
                title: Some("Endpoint not implemented".to_string()),
                status: Some(404),
                detail: Some("The /v1.1/merchants/{merchant_code}/receipts list endpoint does not exist in the SumUp API. Only individual receipt retrieval is supported.".to_string()),
                error_code: None,
                message: None,
                param: None,
                additional_fields: std::collections::HashMap::new(),
            }
        })
    }

    /// Retrieves an identified receipt resource.
    ///
    /// # Arguments
    /// * `receipt_id` - The unique receipt identifier
    /// * `query` - Query parameters including required mid
    pub async fn retrieve_receipt(
        &self,
        receipt_id: &str,
        query: &ReceiptRetrieveQuery,
    ) -> Result<Receipt> {
        let url = self.build_url(&format!("/v1.1/receipts/{}", receipt_id))?;

        let response = self
            .http_client
            .get(url)
            .bearer_auth(&self.api_key)
            .query(query)
            .send()
            .await?;

        if response.status().is_success() {
            let receipt = response.json::<Receipt>().await?;
            Ok(receipt)
        } else {
            self.handle_error(response).await
        }
    }

    /// Retrieves a receipt for a specific merchant.
    ///
    /// # Arguments
    /// * `merchant_code` - The unique merchant code identifier
    /// * `receipt_id` - The unique receipt identifier
    /// * `query` - Query parameters including required mid
    pub async fn retrieve_merchant_receipt(
        &self,
        merchant_code: &str,
        receipt_id: &str,
        query: &ReceiptRetrieveQuery,
    ) -> Result<Receipt> {
        let url = self.build_url(&format!(
            "/v1.1/merchants/{}/receipts/{}",
            merchant_code, receipt_id
        ))?;

        let response = self
            .http_client
            .get(url)
            .bearer_auth(&self.api_key)
            .query(query)
            .send()
            .await?;

        if response.status().is_success() {
            let receipt = response.json::<Receipt>().await?;
            Ok(receipt)
        } else {
            self.handle_error(response).await
        }
    }
}