open_lark/service/cloud_docs/sheets/v3/protect_range/
update.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        endpoints::cloud_docs::*,
10        http::Transport,
11        req_option::RequestOption,
12        SDKResult,
13    },
14    service::sheets::v3::SpreadsheetService,
15};
16
17use super::create::ProtectRangeData;
18
19impl SpreadsheetService {
20    /// 修改保护范围
21    pub async fn update_protect_range(
22        &self,
23        request: UpdateProtectRangeRequest,
24        option: Option<RequestOption>,
25    ) -> SDKResult<BaseResponse<UpdateProtectRangeResponseData>> {
26        let mut api_req = request.api_request;
27        api_req.http_method = Method::PUT;
28        api_req.api_path = SHEETS_V3_SPREADSHEET_PROTECT_RANGE_GET
29            .replace("{}", &request.spreadsheet_token)
30            .replace("{}", &request.protect_id);
31        api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];
32
33        let api_resp = Transport::request(api_req, &self.config, option).await?;
34
35        Ok(api_resp)
36    }
37}
38
39/// 修改保护范围请求
40#[derive(Default, Debug, Serialize, Deserialize)]
41pub struct UpdateProtectRangeRequest {
42    #[serde(skip)]
43    api_request: ApiRequest,
44    /// spreadsheet 的 token
45    spreadsheet_token: String,
46    /// 保护范围 ID
47    protect_id: String,
48    /// 新的保护范围设置
49    protect_range: ProtectRangeData,
50}
51
52impl UpdateProtectRangeRequest {
53    pub fn builder() -> UpdateProtectRangeRequestBuilder {
54        UpdateProtectRangeRequestBuilder::default()
55    }
56}
57
58#[derive(Default)]
59pub struct UpdateProtectRangeRequestBuilder {
60    request: UpdateProtectRangeRequest,
61}
62
63impl UpdateProtectRangeRequestBuilder {
64    pub fn spreadsheet_token(mut self, spreadsheet_token: impl ToString) -> Self {
65        self.request.spreadsheet_token = spreadsheet_token.to_string();
66        self
67    }
68
69    pub fn protect_id(mut self, protect_id: impl ToString) -> Self {
70        self.request.protect_id = protect_id.to_string();
71        self
72    }
73
74    pub fn protect_range(mut self, protect_range: ProtectRangeData) -> Self {
75        self.request.protect_range = protect_range;
76        self
77    }
78
79    pub fn build(mut self) -> UpdateProtectRangeRequest {
80        self.request.api_request.body = serde_json::to_vec(&self.request).unwrap();
81        self.request
82    }
83}
84
85/// 修改保护范围响应体最外层
86#[derive(Deserialize, Debug)]
87pub struct UpdateProtectRangeResponseData {
88    /// 保护范围 ID
89    pub protect_id: String,
90    /// 更新后的保护范围信息
91    #[serde(flatten)]
92    pub protect_range: ProtectRangeData,
93}
94
95impl ApiResponseTrait for UpdateProtectRangeResponseData {
96    fn data_format() -> ResponseFormat {
97        ResponseFormat::Data
98    }
99}
100
101#[cfg(test)]
102#[allow(unused_variables, unused_unsafe)]
103mod test {
104    use super::*;
105    use serde_json::json;
106
107    #[test]
108    fn test_update_protect_range_response() {
109        let json = json!({
110            "protect_id": "protect_001",
111            "dimension": "ROWS",
112            "sheet_id": "Sheet1",
113            "start_index": 5,
114            "end_index": 15,
115            "lock_info": "user@example.com"
116        });
117
118        let response: UpdateProtectRangeResponseData = serde_json::from_value(json).unwrap();
119        assert_eq!(response.protect_id, "protect_001");
120        assert_eq!(response.protect_range.start_index, 5);
121        assert_eq!(response.protect_range.end_index, 15);
122    }
123}