openlark_workflow/v2/custom_field/option/
patch.rs

1//! 更新自定义字段选项
2//!
3//! docPath: https://open.feishu.cn/document/server-docs/docs/task-v2/custom_field-option/patch
4
5use crate::common::{api_endpoints::TaskApiV2, api_utils::*};
6use crate::v2::custom_field::option::create::CustomFieldOption;
7use openlark_core::{
8    SDKResult,
9    api::{ApiRequest, ApiResponseTrait, ResponseFormat},
10    config::Config,
11    validate_required,
12};
13use serde::{Deserialize, Serialize};
14use std::sync::Arc;
15
16/// 更新自定义字段选项请求体
17#[derive(Debug, Clone, Serialize, Default)]
18pub struct UpdateCustomFieldOptionBody {
19    /// 选项名称
20    #[serde(skip_serializing_if = "Option::is_none")]
21    pub name: Option<String>,
22    /// 选项颜色
23    #[serde(skip_serializing_if = "Option::is_none")]
24    pub color: Option<String>,
25}
26
27/// 更新自定义字段选项响应
28#[derive(Debug, Clone, Deserialize)]
29pub struct UpdateCustomFieldOptionResponse {
30    /// 选项信息
31    pub option: CustomFieldOption,
32}
33
34/// 更新自定义字段选项请求
35#[derive(Debug, Clone)]
36pub struct UpdateCustomFieldOptionRequest {
37    /// 配置信息
38    config: Arc<Config>,
39    /// 自定义字段 GUID
40    custom_field_guid: String,
41    /// 选项 GUID
42    option_guid: String,
43    /// 请求体
44    body: UpdateCustomFieldOptionBody,
45}
46
47impl UpdateCustomFieldOptionRequest {
48    /// 创建新的请求构建器。
49    pub fn new(
50        config: Arc<Config>,
51        custom_field_guid: impl Into<String>,
52        option_guid: impl Into<String>,
53    ) -> Self {
54        Self {
55            config,
56            custom_field_guid: custom_field_guid.into(),
57            option_guid: option_guid.into(),
58            body: UpdateCustomFieldOptionBody::default(),
59        }
60    }
61
62    /// 设置选项名称
63    pub fn name(mut self, name: impl Into<String>) -> Self {
64        self.body.name = Some(name.into());
65        self
66    }
67
68    /// 设置选项颜色
69    pub fn color(mut self, color: impl Into<String>) -> Self {
70        self.body.color = Some(color.into());
71        self
72    }
73
74    /// 执行请求
75    pub async fn execute(self) -> SDKResult<UpdateCustomFieldOptionResponse> {
76        self.execute_with_options(openlark_core::req_option::RequestOption::default())
77            .await
78    }
79
80    /// 执行请求（带选项）
81    pub async fn execute_with_options(
82        self,
83        option: openlark_core::req_option::RequestOption,
84    ) -> SDKResult<UpdateCustomFieldOptionResponse> {
85        // 验证必填字段
86        validate_required!(self.custom_field_guid.trim(), "自定义字段GUID不能为空");
87        validate_required!(self.option_guid.trim(), "选项GUID不能为空");
88
89        let api_endpoint = TaskApiV2::CustomFieldOptionUpdate(
90            self.custom_field_guid.clone(),
91            self.option_guid.clone(),
92        );
93        let mut request =
94            ApiRequest::<UpdateCustomFieldOptionResponse>::patch(api_endpoint.to_url());
95
96        let request_body = &self.body;
97        request = request.body(serialize_params(request_body, "更新自定义字段选项")?);
98
99        let response =
100            openlark_core::http::Transport::request(request, &self.config, Some(option)).await?;
101        extract_response_data(response, "更新自定义字段选项")
102    }
103}
104
105impl ApiResponseTrait for UpdateCustomFieldOptionResponse {
106    fn data_format() -> ResponseFormat {
107        ResponseFormat::Data
108    }
109}
110
111#[cfg(test)]
112#[allow(unused_imports)]
113mod tests {
114    use std::sync::Arc;
115
116    use super::*;
117
118    #[test]
119    fn test_update_custom_field_option_builder() {
120        let config = Arc::new(
121            openlark_core::config::Config::builder()
122                .app_id("test")
123                .app_secret("test")
124                .build(),
125        );
126
127        let request = UpdateCustomFieldOptionRequest::new(config, "custom_field_123", "option_456")
128            .name("中优先级")
129            .color("#00FF00");
130
131        assert_eq!(request.custom_field_guid, "custom_field_123");
132        assert_eq!(request.option_guid, "option_456");
133        assert_eq!(request.body.name, Some("中优先级".to_string()));
134        assert_eq!(request.body.color, Some("#00FF00".to_string()));
135    }
136
137    #[test]
138    fn test_custom_field_option_update_api_v2_url() {
139        let endpoint = TaskApiV2::CustomFieldOptionUpdate(
140            "custom_field_123".to_string(),
141            "option_456".to_string(),
142        );
143        assert_eq!(
144            endpoint.to_url(),
145            "/open-apis/task/v2/custom_fields/custom_field_123/options/option_456"
146        );
147    }
148}
openlark_workflow/v2/custom_field/option/patch.rs

openlark_workflow/v2/custom_field/option/
patch.rs
