binance_sdk/rebate/rest_api/apis/
api.rs

1/*
2 * Rebate REST API
3 *
4 * Query spot trading rebate history records.
5 *
6 * The version of the OpenAPI document: 1.0.0
7 *
8 *
9 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
10 * https://openapi-generator.tech
11 * Do not edit the class manually.
12 */
13
14#![allow(unused_imports)]
15use async_trait::async_trait;
16use derive_builder::Builder;
17use reqwest;
18use rust_decimal::prelude::*;
19use serde::{Deserialize, Serialize};
20use serde_json::{Value, json};
21use std::collections::BTreeMap;
22
23use crate::common::{
24    config::ConfigurationRestApi,
25    models::{ParamBuildError, RestApiResponse},
26    utils::send_request,
27};
28use crate::rebate::rest_api::models;
29
30const HAS_TIME_UNIT: bool = false;
31
32#[async_trait]
33pub trait Api: Send + Sync {
34    async fn get_spot_rebate_history_records(
35        &self,
36        params: GetSpotRebateHistoryRecordsParams,
37    ) -> anyhow::Result<RestApiResponse<models::GetSpotRebateHistoryRecordsResponse>>;
38}
39
40#[derive(Debug, Clone)]
41pub struct ApiClient {
42    configuration: ConfigurationRestApi,
43}
44
45impl ApiClient {
46    pub fn new(configuration: ConfigurationRestApi) -> Self {
47        Self { configuration }
48    }
49}
50
51/// Request parameters for the [`get_spot_rebate_history_records`] operation.
52///
53/// This struct holds all of the inputs you can pass when calling
54/// [`get_spot_rebate_history_records`](#method.get_spot_rebate_history_records).
55#[derive(Clone, Debug, Builder, Deserialize, Default)]
56#[builder(pattern = "owned", build_fn(error = "ParamBuildError"))]
57pub struct GetSpotRebateHistoryRecordsParams {
58    /// Start time in milliseconds.
59    ///
60    /// This field is **optional.
61    #[builder(setter(into), default)]
62    #[serde(rename = "startTime", default)]
63    pub start_time: Option<i64>,
64    /// End time in milliseconds.
65    ///
66    /// This field is **optional.
67    #[builder(setter(into), default)]
68    #[serde(rename = "endTime", default)]
69    pub end_time: Option<i64>,
70    /// Page number.
71    ///
72    /// This field is **optional.
73    #[builder(setter(into), default)]
74    #[serde(rename = "page", default)]
75    pub page: Option<i64>,
76    /// Request validity window in milliseconds.
77    ///
78    /// This field is **optional.
79    #[builder(setter(into), default)]
80    #[serde(rename = "recvWindow", default)]
81    pub recv_window: Option<i64>,
82}
83
84impl GetSpotRebateHistoryRecordsParams {
85    /// Create a builder for [`get_spot_rebate_history_records`].
86    ///
87    #[must_use]
88    pub fn builder() -> GetSpotRebateHistoryRecordsParamsBuilder {
89        GetSpotRebateHistoryRecordsParamsBuilder::default()
90    }
91}
92
93#[async_trait]
94impl Api for ApiClient {
95    async fn get_spot_rebate_history_records(
96        &self,
97        params: GetSpotRebateHistoryRecordsParams,
98    ) -> anyhow::Result<RestApiResponse<models::GetSpotRebateHistoryRecordsResponse>> {
99        let GetSpotRebateHistoryRecordsParams {
100            start_time,
101            end_time,
102            page,
103            recv_window,
104        } = params;
105
106        let mut query_params = BTreeMap::new();
107        let body_params = BTreeMap::new();
108
109        if let Some(rw) = start_time {
110            query_params.insert("startTime".to_string(), json!(rw));
111        }
112
113        if let Some(rw) = end_time {
114            query_params.insert("endTime".to_string(), json!(rw));
115        }
116
117        if let Some(rw) = page {
118            query_params.insert("page".to_string(), json!(rw));
119        }
120
121        if let Some(rw) = recv_window {
122            query_params.insert("recvWindow".to_string(), json!(rw));
123        }
124
125        send_request::<models::GetSpotRebateHistoryRecordsResponse>(
126            &self.configuration,
127            "/sapi/v1/rebate/taxQuery",
128            reqwest::Method::GET,
129            query_params,
130            body_params,
131            if HAS_TIME_UNIT {
132                self.configuration.time_unit
133            } else {
134                None
135            },
136            true,
137        )
138        .await
139    }
140}
141
142#[cfg(all(test, feature = "rebate"))]
143mod tests {
144    use super::*;
145    use crate::TOKIO_SHARED_RT;
146    use crate::{errors::ConnectorError, models::DataFuture, models::RestApiRateLimit};
147    use async_trait::async_trait;
148    use std::collections::HashMap;
149
150    struct DummyRestApiResponse<T> {
151        inner: Box<dyn FnOnce() -> DataFuture<Result<T, ConnectorError>> + Send + Sync>,
152        status: u16,
153        headers: HashMap<String, String>,
154        rate_limits: Option<Vec<RestApiRateLimit>>,
155    }
156
157    impl<T> From<DummyRestApiResponse<T>> for RestApiResponse<T> {
158        fn from(dummy: DummyRestApiResponse<T>) -> Self {
159            Self {
160                data_fn: dummy.inner,
161                status: dummy.status,
162                headers: dummy.headers,
163                rate_limits: dummy.rate_limits,
164            }
165        }
166    }
167
168    struct MockApiClient {
169        force_error: bool,
170    }
171
172    #[async_trait]
173    impl Api for MockApiClient {
174        async fn get_spot_rebate_history_records(
175            &self,
176            _params: GetSpotRebateHistoryRecordsParams,
177        ) -> anyhow::Result<RestApiResponse<models::GetSpotRebateHistoryRecordsResponse>> {
178            if self.force_error {
179                return Err(ConnectorError::ConnectorClientError {
180                    msg: "ResponseError".to_string(),
181                    code: None,
182                }
183                .into());
184            }
185
186            let resp_json: Value = serde_json::from_str(r#"{"status":"OK","type":"GENERAL","code":"000000000","data":{"page":1,"totalRecords":2,"totalPageNum":1,"data":[{"asset":"USDT","type":1,"amount":"0.0001126","updateTime":1637651320000}]}}"#).unwrap_or_else(|_| serde_json::json!({}));
187            let dummy_response: models::GetSpotRebateHistoryRecordsResponse =
188                serde_json::from_value(resp_json.clone())
189                    .expect("should parse into models::GetSpotRebateHistoryRecordsResponse");
190
191            let dummy = DummyRestApiResponse {
192                inner: Box::new(move || Box::pin(async move { Ok(dummy_response) })),
193                status: 200,
194                headers: HashMap::new(),
195                rate_limits: None,
196            };
197
198            Ok(dummy.into())
199        }
200    }
201
202    #[test]
203    fn get_spot_rebate_history_records_required_params_success() {
204        TOKIO_SHARED_RT.block_on(async {
205            let client = MockApiClient { force_error: false };
206
207            let params = GetSpotRebateHistoryRecordsParams::builder().build().unwrap();
208
209            let resp_json: Value = serde_json::from_str(r#"{"status":"OK","type":"GENERAL","code":"000000000","data":{"page":1,"totalRecords":2,"totalPageNum":1,"data":[{"asset":"USDT","type":1,"amount":"0.0001126","updateTime":1637651320000}]}}"#).unwrap_or_else(|_| serde_json::json!({}));
210            let expected_response : models::GetSpotRebateHistoryRecordsResponse = serde_json::from_value(resp_json.clone()).expect("should parse into models::GetSpotRebateHistoryRecordsResponse");
211
212            let resp = client.get_spot_rebate_history_records(params).await.expect("Expected a response");
213            let data_future = resp.data();
214            let actual_response = data_future.await.unwrap();
215            assert_eq!(actual_response, expected_response);
216        });
217    }
218
219    #[test]
220    fn get_spot_rebate_history_records_optional_params_success() {
221        TOKIO_SHARED_RT.block_on(async {
222            let client = MockApiClient { force_error: false };
223
224            let params = GetSpotRebateHistoryRecordsParams::builder().start_time(1623319461670).end_time(1641782889000).page(1).recv_window(5000).build().unwrap();
225
226            let resp_json: Value = serde_json::from_str(r#"{"status":"OK","type":"GENERAL","code":"000000000","data":{"page":1,"totalRecords":2,"totalPageNum":1,"data":[{"asset":"USDT","type":1,"amount":"0.0001126","updateTime":1637651320000}]}}"#).unwrap_or_else(|_| serde_json::json!({}));
227            let expected_response : models::GetSpotRebateHistoryRecordsResponse = serde_json::from_value(resp_json.clone()).expect("should parse into models::GetSpotRebateHistoryRecordsResponse");
228
229            let resp = client.get_spot_rebate_history_records(params).await.expect("Expected a response");
230            let data_future = resp.data();
231            let actual_response = data_future.await.unwrap();
232            assert_eq!(actual_response, expected_response);
233        });
234    }
235
236    #[test]
237    fn get_spot_rebate_history_records_response_error() {
238        TOKIO_SHARED_RT.block_on(async {
239            let client = MockApiClient { force_error: true };
240
241            let params = GetSpotRebateHistoryRecordsParams::builder()
242                .build()
243                .unwrap();
244
245            match client.get_spot_rebate_history_records(params).await {
246                Ok(_) => panic!("Expected an error"),
247                Err(err) => {
248                    assert_eq!(err.to_string(), "Connector client error: ResponseError");
249                }
250            }
251        });
252    }
253}
binance_sdk/rebate/rest_api/apis/api.rs

binance_sdk/rebate/rest_api/apis/
api.rs
