binance_sdk/simple_earn/rest_api/apis/
yield_arena_api.rs

1/*
2 * Binance Simple Earn REST API
3 *
4 * OpenAPI Specification for the Binance Simple Earn REST API
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::simple_earn::rest_api::models;
29
30const HAS_TIME_UNIT: bool = false;
31
32#[async_trait]
33pub trait YieldArenaApi: Send + Sync {
34    async fn get_yield_arena_activities(
35        &self,
36        params: GetYieldArenaActivitiesParams,
37    ) -> anyhow::Result<RestApiResponse<models::GetYieldArenaActivitiesResponse>>;
38}
39
40#[derive(Debug, Clone)]
41pub struct YieldArenaApiClient {
42    configuration: ConfigurationRestApi,
43}
44
45impl YieldArenaApiClient {
46    pub fn new(configuration: ConfigurationRestApi) -> Self {
47        Self { configuration }
48    }
49}
50
51/// Request parameters for the [`get_yield_arena_activities`] operation.
52///
53/// This struct holds all of the inputs you can pass when calling
54/// [`get_yield_arena_activities`](#method.get_yield_arena_activities).
55#[derive(Clone, Debug, Builder, Default)]
56#[builder(pattern = "owned", build_fn(error = "ParamBuildError"))]
57pub struct GetYieldArenaActivitiesParams {
58    /// The value cannot be greater than 60000 (ms)
59    ///
60    /// This field is **optional.
61    #[builder(setter(into), default)]
62    pub recv_window: Option<i64>,
63}
64
65impl GetYieldArenaActivitiesParams {
66    /// Create a builder for [`get_yield_arena_activities`].
67    ///
68    #[must_use]
69    pub fn builder() -> GetYieldArenaActivitiesParamsBuilder {
70        GetYieldArenaActivitiesParamsBuilder::default()
71    }
72}
73
74#[async_trait]
75impl YieldArenaApi for YieldArenaApiClient {
76    async fn get_yield_arena_activities(
77        &self,
78        params: GetYieldArenaActivitiesParams,
79    ) -> anyhow::Result<RestApiResponse<models::GetYieldArenaActivitiesResponse>> {
80        let GetYieldArenaActivitiesParams { recv_window } = params;
81
82        let mut query_params = BTreeMap::new();
83        let body_params = BTreeMap::new();
84
85        if let Some(rw) = recv_window {
86            query_params.insert("recvWindow".to_string(), json!(rw));
87        }
88
89        send_request::<models::GetYieldArenaActivitiesResponse>(
90            &self.configuration,
91            "/sapi/v1/earn/arena/activities",
92            reqwest::Method::GET,
93            query_params,
94            body_params,
95            if HAS_TIME_UNIT {
96                self.configuration.time_unit
97            } else {
98                None
99            },
100            true,
101        )
102        .await
103    }
104}
105
106#[cfg(all(test, feature = "simple_earn"))]
107mod tests {
108    use super::*;
109    use crate::TOKIO_SHARED_RT;
110    use crate::{errors::ConnectorError, models::DataFuture, models::RestApiRateLimit};
111    use async_trait::async_trait;
112    use std::collections::HashMap;
113
114    struct DummyRestApiResponse<T> {
115        inner: Box<dyn FnOnce() -> DataFuture<Result<T, ConnectorError>> + Send + Sync>,
116        status: u16,
117        headers: HashMap<String, String>,
118        rate_limits: Option<Vec<RestApiRateLimit>>,
119    }
120
121    impl<T> From<DummyRestApiResponse<T>> for RestApiResponse<T> {
122        fn from(dummy: DummyRestApiResponse<T>) -> Self {
123            Self {
124                data_fn: dummy.inner,
125                status: dummy.status,
126                headers: dummy.headers,
127                rate_limits: dummy.rate_limits,
128            }
129        }
130    }
131
132    struct MockYieldArenaApiClient {
133        force_error: bool,
134    }
135
136    #[async_trait]
137    impl YieldArenaApi for MockYieldArenaApiClient {
138        async fn get_yield_arena_activities(
139            &self,
140            _params: GetYieldArenaActivitiesParams,
141        ) -> anyhow::Result<RestApiResponse<models::GetYieldArenaActivitiesResponse>> {
142            if self.force_error {
143                return Err(ConnectorError::ConnectorClientError {
144                    msg: "ResponseError".to_string(),
145                    code: None,
146                }
147                .into());
148            }
149
150            let resp_json: Value = serde_json::from_str(r#"{"activities":[{"activityId":10001,"activityType":"AIRDROP","title":"Hold FDUSD & Earn BNB Airdrop","description":"Subscribe to FDUSD Flexible and earn bonus BNB airdrop.","rewardPoolInUsd":"50000","rewardToken":["BNB"],"redirectUrl":"https://www.binance.com/en/earn/arena/airdrop-123","startTime":1713052800000,"endTime":1713657600000}]}"#).unwrap();
151            let dummy_response: models::GetYieldArenaActivitiesResponse =
152                serde_json::from_value(resp_json.clone())
153                    .expect("should parse into models::GetYieldArenaActivitiesResponse");
154
155            let dummy = DummyRestApiResponse {
156                inner: Box::new(move || Box::pin(async move { Ok(dummy_response) })),
157                status: 200,
158                headers: HashMap::new(),
159                rate_limits: None,
160            };
161
162            Ok(dummy.into())
163        }
164    }
165
166    #[test]
167    fn get_yield_arena_activities_required_params_success() {
168        TOKIO_SHARED_RT.block_on(async {
169            let client = MockYieldArenaApiClient { force_error: false };
170
171            let params = GetYieldArenaActivitiesParams::builder().build().unwrap();
172
173            let resp_json: Value = serde_json::from_str(r#"{"activities":[{"activityId":10001,"activityType":"AIRDROP","title":"Hold FDUSD & Earn BNB Airdrop","description":"Subscribe to FDUSD Flexible and earn bonus BNB airdrop.","rewardPoolInUsd":"50000","rewardToken":["BNB"],"redirectUrl":"https://www.binance.com/en/earn/arena/airdrop-123","startTime":1713052800000,"endTime":1713657600000}]}"#).unwrap();
174            let expected_response : models::GetYieldArenaActivitiesResponse = serde_json::from_value(resp_json.clone()).expect("should parse into models::GetYieldArenaActivitiesResponse");
175
176            let resp = client.get_yield_arena_activities(params).await.expect("Expected a response");
177            let data_future = resp.data();
178            let actual_response = data_future.await.unwrap();
179            assert_eq!(actual_response, expected_response);
180        });
181    }
182
183    #[test]
184    fn get_yield_arena_activities_optional_params_success() {
185        TOKIO_SHARED_RT.block_on(async {
186            let client = MockYieldArenaApiClient { force_error: false };
187
188            let params = GetYieldArenaActivitiesParams::builder().recv_window(5000).build().unwrap();
189
190            let resp_json: Value = serde_json::from_str(r#"{"activities":[{"activityId":10001,"activityType":"AIRDROP","title":"Hold FDUSD & Earn BNB Airdrop","description":"Subscribe to FDUSD Flexible and earn bonus BNB airdrop.","rewardPoolInUsd":"50000","rewardToken":["BNB"],"redirectUrl":"https://www.binance.com/en/earn/arena/airdrop-123","startTime":1713052800000,"endTime":1713657600000}]}"#).unwrap();
191            let expected_response : models::GetYieldArenaActivitiesResponse = serde_json::from_value(resp_json.clone()).expect("should parse into models::GetYieldArenaActivitiesResponse");
192
193            let resp = client.get_yield_arena_activities(params).await.expect("Expected a response");
194            let data_future = resp.data();
195            let actual_response = data_future.await.unwrap();
196            assert_eq!(actual_response, expected_response);
197        });
198    }
199
200    #[test]
201    fn get_yield_arena_activities_response_error() {
202        TOKIO_SHARED_RT.block_on(async {
203            let client = MockYieldArenaApiClient { force_error: true };
204
205            let params = GetYieldArenaActivitiesParams::builder().build().unwrap();
206
207            match client.get_yield_arena_activities(params).await {
208                Ok(_) => panic!("Expected an error"),
209                Err(err) => {
210                    assert_eq!(err.to_string(), "Connector client error: ResponseError");
211                }
212            }
213        });
214    }
215}
binance_sdk/simple_earn/rest_api/apis/yield_arena_api.rs

binance_sdk/simple_earn/rest_api/apis/
yield_arena_api.rs
