open_lark/service/cloud_docs/sheets/v3/protect_range/
delete.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    service::sheets::v3::SpreadsheetService,
14};
15
16impl SpreadsheetService {
17    /// 删除保护范围
18    pub async fn delete_protect_range(
19        &self,
20        request: DeleteProtectRangeRequest,
21        option: Option<RequestOption>,
22    ) -> SDKResult<BaseResponse<DeleteProtectRangeResponseData>> {
23        let mut api_req = request.api_request;
24        api_req.http_method = Method::DELETE;
25        api_req.api_path = format!(
26            "/open-apis/sheets/v3/spreadsheets/{}/protect_range/{}",
27            request.spreadsheet_token, request.protect_id
28        );
29        api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];
30
31        let api_resp = Transport::request(api_req, &self.config, option).await?;
32
33        Ok(api_resp)
34    }
35}
36
37/// 删除保护范围请求
38#[derive(Default, Debug, Serialize, Deserialize)]
39pub struct DeleteProtectRangeRequest {
40    #[serde(skip)]
41    api_request: ApiRequest,
42    /// spreadsheet 的 token
43    spreadsheet_token: String,
44    /// 保护范围 ID
45    protect_id: String,
46}
47
48impl DeleteProtectRangeRequest {
49    pub fn builder() -> DeleteProtectRangeRequestBuilder {
50        DeleteProtectRangeRequestBuilder::default()
51    }
52}
53
54#[derive(Default)]
55pub struct DeleteProtectRangeRequestBuilder {
56    request: DeleteProtectRangeRequest,
57}
58
59impl DeleteProtectRangeRequestBuilder {
60    pub fn spreadsheet_token(mut self, spreadsheet_token: impl ToString) -> Self {
61        self.request.spreadsheet_token = spreadsheet_token.to_string();
62        self
63    }
64
65    pub fn protect_id(mut self, protect_id: impl ToString) -> Self {
66        self.request.protect_id = protect_id.to_string();
67        self
68    }
69
70    pub fn build(mut self) -> DeleteProtectRangeRequest {
71        self.request.api_request.body = serde_json::to_vec(&self.request).unwrap();
72        self.request
73    }
74}
75
76/// 删除保护范围响应体最外层
77#[derive(Deserialize, Debug)]
78pub struct DeleteProtectRangeResponseData {
79    /// 删除操作是否成功
80    #[serde(default)]
81    pub success: bool,
82    /// 删除的保护范围 ID
83    #[serde(skip_serializing_if = "Option::is_none")]
84    pub protect_id: Option<String>,
85}
86
87impl ApiResponseTrait for DeleteProtectRangeResponseData {
88    fn data_format() -> ResponseFormat {
89        ResponseFormat::Data
90    }
91}
92
93#[cfg(test)]
94mod test {
95    use super::*;
96    use serde_json::json;
97
98    #[test]
99    fn test_delete_protect_range_response() {
100        let json = json!({
101            "success": true,
102            "protect_id": "protect_001"
103        });
104
105        let response: DeleteProtectRangeResponseData = serde_json::from_value(json).unwrap();
106        assert!(response.success);
107        assert_eq!(response.protect_id, Some("protect_001".to_string()));
108    }
109}