openlark_workflow/v1/task/
list.rs

1//! 查询所有任务（v1）
2//!
3//! docPath: <https://open.feishu.cn/document/server-docs/docs/task-v1/task/list>
4
5use openlark_core::{
6    SDKResult,
7    api::{ApiRequest, ApiResponseTrait, ResponseFormat},
8    config::Config,
9};
10use serde::Deserialize;
11use std::sync::Arc;
12
13/// 任务信息（v1）
14#[derive(Debug, Clone, Deserialize)]
15/// 任务摘要信息。
16pub struct TaskListItemV1 {
17    /// 任务 ID
18    pub id: String,
19    /// 任务标题
20    pub summary: String,
21    /// 任务描述
22    #[serde(default)]
23    /// 任务描述。
24    pub description: Option<String>,
25    /// 任务开始时间
26    #[serde(default)]
27    /// 任务开始时间。
28    pub start: Option<String>,
29    /// 任务截止时间
30    #[serde(default)]
31    /// 任务截止时间。
32    pub due: Option<String>,
33    /// 任务优先级（1-5）
34    #[serde(default)]
35    /// 任务优先级。
36    pub priority: Option<i32>,
37    /// 任务是否完成
38    pub is_completed: bool,
39    /// 创建时间
40    pub created_at: String,
41    /// 更新时间
42    pub updated_at: String,
43}
44
45/// 查询任务响应（v1）
46#[derive(Debug, Clone, Deserialize)]
47/// 任务列表响应。
48pub struct ListTaskResponseV1 {
49    /// 任务列表
50    pub tasks: Vec<TaskListItemV1>,
51    /// 分页令牌
52    #[serde(default)]
53    /// 分页令牌。
54    pub page_token: Option<String>,
55    /// 是否有更多数据
56    #[serde(default)]
57    /// 是否有更多数据。
58    pub has_more: bool,
59}
60
61/// 查询任务请求（v1）
62#[derive(Debug, Clone)]
63/// 查询任务列表请求构建器。
64pub struct ListTaskRequestV1 {
65    config: Arc<Config>,
66    page_token: Option<String>,
67    page_size: Option<i32>,
68}
69
70impl ListTaskRequestV1 {
71    /// 创建新的请求构建器。
72    pub fn new(config: Arc<Config>) -> Self {
73        Self {
74            config,
75            page_token: None,
76            page_size: None,
77        }
78    }
79
80    /// 设置分页令牌
81    pub fn page_token(mut self, page_token: impl Into<String>) -> Self {
82        self.page_token = Some(page_token.into());
83        self
84    }
85
86    /// 设置每页大小
87    pub fn page_size(mut self, page_size: i32) -> Self {
88        self.page_size = Some(page_size);
89        self
90    }
91
92    /// 执行请求
93    pub async fn execute(self) -> SDKResult<ListTaskResponseV1> {
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<ListTaskResponseV1> {
103        let api_endpoint = crate::common::api_endpoints::TaskApiV1::TaskList;
104        let mut request = ApiRequest::<ListTaskResponseV1>::get(api_endpoint.to_url());
105
106        // 添加查询参数
107        if let Some(page_token) = self.page_token {
108            request = request.query("page_token", page_token);
109        }
110        if let Some(page_size) = self.page_size {
111            request = request.query("page_size", page_size.to_string());
112        }
113
114        openlark_core::http::Transport::request_typed(
115            request,
116            &self.config,
117            Some(option),
118            "响应数据为空",
119        )
120        .await
121    }
122}
123
124impl ApiResponseTrait for ListTaskResponseV1 {
125    fn data_format() -> ResponseFormat {
126        ResponseFormat::Data
127    }
128}
129
130#[cfg(test)]
131#[allow(unused_imports)]
132mod tests {
133    use std::sync::Arc;
134
135    use super::*;
136
137    #[test]
138    fn test_list_task_v1_builder() {
139        let config = Arc::new(
140            openlark_core::config::Config::builder()
141                .app_id("test")
142                .app_secret("test")
143                .build(),
144        );
145
146        let request = ListTaskRequestV1::new(config)
147            .page_token("next_page_token")
148            .page_size(20);
149
150        assert_eq!(request.page_token, Some("next_page_token".to_string()));
151        assert_eq!(request.page_size, Some(20));
152    }
153
154    #[test]
155    fn test_task_api_v1_list_url() {
156        let endpoint = crate::common::api_endpoints::TaskApiV1::TaskList;
157        assert_eq!(endpoint.to_url(), "/open-apis/task/v1/tasks");
158    }
159}
openlark_workflow/v1/task/list.rs

openlark_workflow/v1/task/
list.rs
