Skip to main content

openlark_workflow/v2/custom_field/
update.rs

1//! 更新自定义字段
2//!
3//! docPath: https://open.feishu.cn/document/server-docs/docs/task-v2/custom_field/update
4
5use crate::common::{api_endpoints::TaskApiV2, api_utils::*};
6use crate::v2::custom_field::models::{UpdateCustomFieldBody, UpdateCustomFieldResponse};
7use openlark_core::{
8    SDKResult,
9    api::{ApiRequest, ApiResponseTrait, ResponseFormat},
10    config::Config,
11    validate_required,
12};
13use std::sync::Arc;
14
15/// 更新自定义字段请求
16#[derive(Debug, Clone)]
17pub struct UpdateCustomFieldRequest {
18    /// 配置信息
19    config: Arc<Config>,
20    /// 任务清单 GUID
21    tasklist_guid: String,
22    /// 字段 GUID
23    field_guid: String,
24    /// 请求体
25    body: UpdateCustomFieldBody,
26}
27
28impl UpdateCustomFieldRequest {
29    /// 创建新的请求构建器。
30    pub fn new(config: Arc<Config>, tasklist_guid: String, field_guid: String) -> Self {
31        Self {
32            config,
33            tasklist_guid,
34            field_guid,
35            body: UpdateCustomFieldBody::default(),
36        }
37    }
38
39    /// 设置字段名称
40    pub fn name(mut self, name: impl Into<String>) -> Self {
41        self.body.name = Some(name.into());
42        self
43    }
44
45    /// 设置字段配置
46    pub fn config(mut self, config: crate::v2::custom_field::models::CustomFieldConfig) -> Self {
47        self.body.config = Some(config);
48        self
49    }
50
51    /// 执行请求
52    pub async fn execute(self) -> SDKResult<UpdateCustomFieldResponse> {
53        self.execute_with_options(openlark_core::req_option::RequestOption::default())
54            .await
55    }
56
57    /// 执行请求(带选项)
58    pub async fn execute_with_options(
59        self,
60        option: openlark_core::req_option::RequestOption,
61    ) -> SDKResult<UpdateCustomFieldResponse> {
62        // 验证必填字段
63        validate_required!(self.tasklist_guid.trim(), "任务清单GUID不能为空");
64        validate_required!(self.field_guid.trim(), "字段GUID不能为空");
65
66        let api_endpoint =
67            TaskApiV2::CustomFieldUpdate(self.tasklist_guid.clone(), self.field_guid.clone());
68        let mut request = ApiRequest::<UpdateCustomFieldResponse>::put(api_endpoint.to_url());
69
70        let request_body = &self.body;
71        request = request.body(serialize_params(request_body, "更新自定义字段")?);
72
73        let response =
74            openlark_core::http::Transport::request(request, &self.config, Some(option)).await?;
75        extract_response_data(response, "更新自定义字段")
76    }
77}
78
79impl ApiResponseTrait for UpdateCustomFieldResponse {
80    fn data_format() -> ResponseFormat {
81        ResponseFormat::Data
82    }
83}
84
85#[cfg(test)]
86#[allow(unused_imports)]
87mod tests {
88    use std::sync::Arc;
89
90    use super::*;
91
92    #[test]
93    fn test_update_custom_field_builder() {
94        let config = Arc::new(
95            openlark_core::config::Config::builder()
96                .app_id("test")
97                .app_secret("test")
98                .build(),
99        );
100
101        let request = UpdateCustomFieldRequest::new(
102            config,
103            "tasklist_123".to_string(),
104            "field_456".to_string(),
105        )
106        .name("更新的字段名");
107
108        assert_eq!(request.tasklist_guid, "tasklist_123");
109        assert_eq!(request.field_guid, "field_456");
110        assert_eq!(request.body.name, Some("更新的字段名".to_string()));
111    }
112}