open_lark/service/cloud_docs/sheets/v3/condition_format/
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        endpoints::cloud_docs::*,
10        http::Transport,
11        req_option::RequestOption,
12        SDKResult,
13    },
14    service::sheets::v3::SpreadsheetSheetService,
15};
16
17impl SpreadsheetSheetService {
18    /// 批量删除条件格式
19    pub async fn delete_condition_formats(
20        &self,
21        request: DeleteConditionFormatsRequest,
22        option: Option<RequestOption>,
23    ) -> SDKResult<BaseResponse<DeleteConditionFormatsResponseData>> {
24        let mut api_req = request.api_request;
25        api_req.http_method = Method::DELETE;
26        api_req.api_path = SHEETS_V3_SPREADSHEET_CONDITION_FORMAT
27            .replace("{}", &request.spreadsheet_token)
28            .replace("{}", &request.sheet_id);
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 DeleteConditionFormatsRequest {
40    #[serde(skip)]
41    api_request: ApiRequest,
42    /// spreadsheet 的 token
43    spreadsheet_token: String,
44    /// sheet 的 id
45    sheet_id: String,
46    /// 要删除的条件格式 ID 列表
47    cf_ids: Vec<String>,
48}
49
50impl DeleteConditionFormatsRequest {
51    pub fn builder() -> DeleteConditionFormatsRequestBuilder {
52        DeleteConditionFormatsRequestBuilder::default()
53    }
54}
55
56#[derive(Default)]
57pub struct DeleteConditionFormatsRequestBuilder {
58    request: DeleteConditionFormatsRequest,
59}
60
61impl DeleteConditionFormatsRequestBuilder {
62    pub fn spreadsheet_token(mut self, spreadsheet_token: impl ToString) -> Self {
63        self.request.spreadsheet_token = spreadsheet_token.to_string();
64        self
65    }
66
67    pub fn sheet_id(mut self, sheet_id: impl ToString) -> Self {
68        self.request.sheet_id = sheet_id.to_string();
69        self
70    }
71
72    pub fn cf_ids(mut self, cf_ids: Vec<String>) -> Self {
73        self.request.cf_ids = cf_ids;
74        self
75    }
76
77    pub fn add_cf_id(mut self, cf_id: impl ToString) -> Self {
78        self.request.cf_ids.push(cf_id.to_string());
79        self
80    }
81
82    pub fn build(mut self) -> DeleteConditionFormatsRequest {
83        self.request.api_request.body = serde_json::to_vec(&self.request).unwrap();
84        self.request
85    }
86}
87
88/// 删除结果
89#[derive(Deserialize, Debug)]
90pub struct DeleteResult {
91    /// 条件格式 ID
92    pub cf_id: String,
93    /// 删除是否成功
94    #[serde(default)]
95    pub success: bool,
96    /// 错误信息(如果删除失败)
97    #[serde(skip_serializing_if = "Option::is_none")]
98    pub error_message: Option<String>,
99}
100
101/// 批量删除条件格式响应体最外层
102#[derive(Deserialize, Debug)]
103pub struct DeleteConditionFormatsResponseData {
104    /// 删除结果列表
105    pub items: Vec<DeleteResult>,
106    /// 删除成功的数量
107    #[serde(default)]
108    pub deleted_count: u32,
109    /// 删除失败的数量
110    #[serde(default)]
111    pub failed_count: u32,
112}
113
114impl ApiResponseTrait for DeleteConditionFormatsResponseData {
115    fn data_format() -> ResponseFormat {
116        ResponseFormat::Data
117    }
118}
119
120#[cfg(test)]
121#[allow(unused_variables, unused_unsafe)]
122mod test {
123    use super::*;
124    use serde_json::json;
125
126    #[test]
127    fn test_delete_condition_formats_response() {
128        let json = json!({
129            "items": [
130                {
131                    "cf_id": "cf_001",
132                    "success": true
133                },
134                {
135                    "cf_id": "cf_002",
136                    "success": false,
137                    "error_message": "条件格式不存在"
138                }
139            ],
140            "deleted_count": 1,
141            "failed_count": 1
142        });
143
144        let response: DeleteConditionFormatsResponseData = serde_json::from_value(json).unwrap();
145        assert_eq!(response.items.len(), 2);
146        assert!(response.items[0].success);
147        assert!(!response.items[1].success);
148        assert_eq!(response.deleted_count, 1);
149        assert_eq!(response.failed_count, 1);
150    }
151}