open_lark/service/cloud_docs/sheets/v3/float_image/
query.rs

1use reqwest::Method;
2use serde::{Deserialize, Serialize};
3
4use crate::{
5    core::{
6        api_req::ApiRequest,
7        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
8        constants::AccessTokenType,
9        http::Transport,
10        req_option::RequestOption,
11        SDKResult,
12    },
13    impl_executable_builder_owned,
14    service::sheets::v3::SpreadsheetSheetService,
15};
16
17use super::get::FloatImageInfo;
18
19impl SpreadsheetSheetService {
20    /// 查询浮动图片
21    pub async fn query_float_images(
22        &self,
23        request: QueryFloatImagesRequest,
24        option: Option<RequestOption>,
25    ) -> SDKResult<BaseResponse<QueryFloatImagesResponseData>> {
26        let mut api_req = request.api_request;
27        api_req.http_method = Method::GET;
28        api_req.api_path = format!(
29            "/open-apis/sheets/v3/spreadsheets/{}/sheets/{}/float_images",
30            request.spreadsheet_token, request.sheet_id
31        );
32        api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];
33
34        let api_resp = Transport::request(api_req, &self.config, option).await?;
35
36        Ok(api_resp)
37    }
38}
39
40/// 查询浮动图片请求
41#[derive(Default, Debug, Serialize, Deserialize)]
42pub struct QueryFloatImagesRequest {
43    #[serde(skip)]
44    api_request: ApiRequest,
45    /// spreadsheet 的 token
46    spreadsheet_token: String,
47    /// sheet 的 id
48    sheet_id: String,
49}
50
51impl QueryFloatImagesRequest {
52    pub fn builder() -> QueryFloatImagesRequestBuilder {
53        QueryFloatImagesRequestBuilder::default()
54    }
55}
56
57#[derive(Default)]
58pub struct QueryFloatImagesRequestBuilder {
59    request: QueryFloatImagesRequest,
60}
61
62impl QueryFloatImagesRequestBuilder {
63    pub fn spreadsheet_token(mut self, spreadsheet_token: impl ToString) -> Self {
64        self.request.spreadsheet_token = spreadsheet_token.to_string();
65        self
66    }
67
68    pub fn sheet_id(mut self, sheet_id: impl ToString) -> Self {
69        self.request.sheet_id = sheet_id.to_string();
70        self
71    }
72
73    pub fn build(mut self) -> QueryFloatImagesRequest {
74        self.request.api_request.body = serde_json::to_vec(&self.request).unwrap();
75        self.request
76    }
77}
78
79impl_executable_builder_owned!(
80    QueryFloatImagesRequestBuilder,
81    SpreadsheetSheetService,
82    QueryFloatImagesRequest,
83    BaseResponse<QueryFloatImagesResponseData>,
84    query_float_images
85);
86
87/// 查询浮动图片响应体最外层
88#[derive(Deserialize, Debug)]
89pub struct QueryFloatImagesResponseData {
90    /// 浮动图片列表
91    pub items: Vec<FloatImageInfo>,
92    /// 是否还有更多数据
93    #[serde(default)]
94    pub has_more: bool,
95    /// 下次请求的页面标记
96    #[serde(skip_serializing_if = "Option::is_none")]
97    pub page_token: Option<String>,
98}
99
100impl ApiResponseTrait for QueryFloatImagesResponseData {
101    fn data_format() -> ResponseFormat {
102        ResponseFormat::Data
103    }
104}
105
106#[cfg(test)]
107mod test {
108    use super::*;
109    use serde_json::json;
110
111    #[test]
112    fn test_query_float_images_response() {
113        let json = json!({
114            "items": [
115                {
116                    "float_image_id": "fimg_001",
117                    "image_token": "img_token_123",
118                    "position": {
119                        "start_col_index": 1,
120                        "start_row_index": 1,
121                        "offset_x": 10.0,
122                        "offset_y": 20.0
123                    },
124                    "size": {
125                        "width": 200.0,
126                        "height": 150.0
127                    },
128                    "name": "图片1"
129                },
130                {
131                    "float_image_id": "fimg_002",
132                    "image_token": "img_token_456",
133                    "position": {
134                        "start_col_index": 3,
135                        "start_row_index": 3,
136                        "offset_x": 0.0,
137                        "offset_y": 0.0
138                    },
139                    "size": {
140                        "width": 150.0,
141                        "height": 100.0
142                    },
143                    "name": "图片2"
144                }
145            ],
146            "has_more": false
147        });
148
149        let response: QueryFloatImagesResponseData = serde_json::from_value(json).unwrap();
150        assert_eq!(response.items.len(), 2);
151        assert_eq!(response.items[0].float_image_id, "fimg_001");
152        assert_eq!(response.items[1].float_image.image_token, "img_token_456");
153        assert!(!response.has_more);
154    }
155}
open_lark/service/cloud_docs/sheets/v3/float_image/query.rs

open_lark/service/cloud_docs/sheets/v3/float_image/
query.rs
