Skip to main content

openlark_workflow/v2/task/
list.rs

1//! 获取任务列表
2//!
3//! docPath: https://open.feishu.cn/document/server-docs/docs/task-v2/task/list
4
5use crate::common::{api_endpoints::TaskApiV2, api_utils::*};
6use crate::v2::task::models::ListTasksResponse;
7use openlark_core::{
8    SDKResult,
9    api::{ApiRequest, ApiResponseTrait, ResponseFormat},
10    config::Config,
11};
12use std::sync::Arc;
13
14/// 获取任务列表请求
15#[derive(Debug, Clone)]
16pub struct ListTasksRequest {
17    /// 配置信息
18    config: Arc<Config>,
19    /// 任务清单 GUID
20    tasklist_guid: Option<String>,
21    /// 分组 GUID
22    section_guid: Option<String>,
23    /// 分页大小
24    page_size: Option<i32>,
25    /// 分页标记
26    page_token: Option<String>,
27    /// 筛选条件(公式字符串)
28    filter: Option<String>,
29    /// 排序条件(JSON 数组)
30    sort: Option<serde_json::Value>,
31    /// 用户类型
32    user_type: Option<String>,
33}
34
35impl ListTasksRequest {
36    /// 创建新的请求构建器。
37    pub fn new(config: Arc<Config>) -> Self {
38        Self {
39            config,
40            tasklist_guid: None,
41            section_guid: None,
42            page_size: None,
43            page_token: None,
44            filter: None,
45            sort: None,
46            user_type: None,
47        }
48    }
49
50    /// 设置任务清单 GUID
51    pub fn tasklist_guid(mut self, tasklist_guid: impl Into<String>) -> Self {
52        self.tasklist_guid = Some(tasklist_guid.into());
53        self
54    }
55
56    /// 设置分组 GUID
57    pub fn section_guid(mut self, section_guid: impl Into<String>) -> Self {
58        self.section_guid = Some(section_guid.into());
59        self
60    }
61
62    /// 设置分页大小
63    pub fn page_size(mut self, page_size: i32) -> Self {
64        self.page_size = Some(page_size);
65        self
66    }
67
68    /// 设置分页标记
69    pub fn page_token(mut self, page_token: impl Into<String>) -> Self {
70        self.page_token = Some(page_token.into());
71        self
72    }
73
74    /// 设置筛选条件(公式字符串)
75    pub fn filter(mut self, filter: impl Into<String>) -> Self {
76        self.filter = Some(filter.into());
77        self
78    }
79
80    /// 设置排序条件(JSON 数组)
81    pub fn sort(mut self, sort: serde_json::Value) -> Self {
82        self.sort = Some(sort);
83        self
84    }
85
86    /// 设置用户类型
87    pub fn user_type(mut self, user_type: impl Into<String>) -> Self {
88        self.user_type = Some(user_type.into());
89        self
90    }
91
92    /// 执行请求
93    pub async fn execute(self) -> SDKResult<ListTasksResponse> {
94        self.execute_with_options(openlark_core::req_option::RequestOption::default())
95            .await
96    }
97
98    /// 执行请求(带选项)
99    pub async fn execute_with_options(
100        self,
101        option: openlark_core::req_option::RequestOption,
102    ) -> SDKResult<ListTasksResponse> {
103        let api_endpoint = TaskApiV2::TaskList;
104        let mut request = ApiRequest::<ListTasksResponse>::get(api_endpoint.to_url());
105
106        // 构建查询参数
107        if let Some(tasklist_guid) = &self.tasklist_guid {
108            request = request.query("tasklist_guid", tasklist_guid);
109        }
110        if let Some(section_guid) = &self.section_guid {
111            request = request.query("section_guid", section_guid);
112        }
113        if let Some(page_size) = self.page_size {
114            request = request.query("page_size", page_size.to_string());
115        }
116        if let Some(page_token) = &self.page_token {
117            request = request.query("page_token", page_token);
118        }
119        if let Some(filter) = &self.filter {
120            request = request.query("filter", filter);
121        }
122        if let Some(user_type) = &self.user_type {
123            request = request.query("user_type", user_type);
124        }
125        if let Some(sort) = &self.sort {
126            request = request.query("sort", sort.to_string());
127        }
128
129        let response =
130            openlark_core::http::Transport::request(request, &self.config, Some(option)).await?;
131        extract_response_data(response, "获取任务列表")
132    }
133}
134
135impl ApiResponseTrait for ListTasksResponse {
136    fn data_format() -> ResponseFormat {
137        ResponseFormat::Data
138    }
139}
140
141#[cfg(test)]
142#[allow(unused_imports)]
143mod tests {
144    use std::sync::Arc;
145
146    use super::*;
147
148    #[test]
149    fn test_list_tasks_request() {
150        let config = openlark_core::config::Config::builder()
151            .app_id("test")
152            .app_secret("test")
153            .build();
154
155        let request = ListTasksRequest::new(Arc::new(config))
156            .tasklist_guid("tasklist_123")
157            .page_size(20);
158
159        assert_eq!(request.tasklist_guid, Some("tasklist_123".to_string()));
160        assert_eq!(request.page_size, Some(20));
161    }
162}