Skip to main content

openlark_workflow/v2/custom_field/
create.rs

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