open-lark 0.13.0

Enterprise-grade Lark/Feishu Open API SDK with comprehensive Chinese documentation and advanced error handling
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
use reqwest::Method;
use serde_json::json;

use crate::{
    core::{
        api_req::ApiRequest, api_resp::BaseResponse, config::Config, constants::AccessTokenType,
        http::Transport, req_option::RequestOption, SDKResult,
    },
    impl_executable_builder_owned,
};

use super::models::{
    CreateShiftRequest, CreateShiftRespData, DeleteShiftRequest, EmptyResponse, GetShiftRequest,
    ListShiftRequest, QueryShiftRequest, Shift, ShiftListData,
};

pub struct ShiftService {
    pub config: Config,
}

impl ShiftService {
    /// 创建班次
    ///
    /// 创建一个班次,班次是管理考勤打卡规则的载体
    ///
    /// <https://open.feishu.cn/document/server-docs/attendance-v1/shift/create>
    pub async fn create(
        &self,
        request: CreateShiftRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<CreateShiftRespData>> {
        let mut api_req = request.api_req;
        api_req.http_method = Method::POST;
        api_req.api_path = "/open-apis/attendance/v1/shifts".to_string();
        api_req.supported_access_token_types = vec![AccessTokenType::Tenant];

        // 添加必需的查询参数
        api_req
            .query_params
            .insert("employee_type".to_string(), request.employee_type);

        // 构建请求体
        let mut body = json!({
            "shift_name": request.shift_name,
            "punch_times": request.punch_times,
        });

        if let Some(is_flexible) = request.is_flexible {
            body["is_flexible"] = json!(is_flexible);
        }
        if let Some(flexible_minutes) = request.flexible_minutes {
            body["flexible_minutes"] = json!(flexible_minutes);
        }
        if let Some(flexible_rule) = &request.flexible_rule {
            body["flexible_rule"] = json!(flexible_rule);
        }
        if let Some(no_need_off) = request.no_need_off {
            body["no_need_off"] = json!(no_need_off);
        }
        if let Some(punch_time_rule) = &request.punch_time_rule {
            body["punch_time_rule"] = json!(punch_time_rule);
        }
        if let Some(late_minutes_as_late) = request.late_minutes_as_late {
            body["late_minutes_as_late"] = json!(late_minutes_as_late);
        }
        if let Some(late_minutes_as_lack) = request.late_minutes_as_lack {
            body["late_minutes_as_lack"] = json!(late_minutes_as_lack);
        }
        if let Some(early_minutes_as_early) = request.early_minutes_as_early {
            body["early_minutes_as_early"] = json!(early_minutes_as_early);
        }
        if let Some(early_minutes_as_lack) = request.early_minutes_as_lack {
            body["early_minutes_as_lack"] = json!(early_minutes_as_lack);
        }
        if let Some(allow_outside_apply) = request.allow_outside_apply {
            body["allow_outside_apply"] = json!(allow_outside_apply);
        }
        if let Some(outside_apply_limit) = request.outside_apply_limit {
            body["outside_apply_limit"] = json!(outside_apply_limit);
        }
        if let Some(allow_face_punch) = request.allow_face_punch {
            body["allow_face_punch"] = json!(allow_face_punch);
        }
        if let Some(face_punch_cfg) = &request.face_punch_cfg {
            body["face_punch_cfg"] = json!(face_punch_cfg);
        }

        api_req.body = serde_json::to_vec(&body)?;

        // 调试日志:打印API请求内容
        log::debug!("创建班次API请求详情:");
        log::debug!("  路径: {}", api_req.api_path);
        log::debug!("  方法: {:?}", api_req.http_method);
        log::debug!("  查询参数: {:?}", api_req.query_params);
        log::debug!(
            "  请求体: {}",
            serde_json::to_string_pretty(&body).unwrap_or_else(|_| "无法序列化".to_string())
        );

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 删除班次
    ///
    /// 删除一个班次
    ///
    /// <https://open.feishu.cn/document/server-docs/attendance-v1/shift/delete>
    pub async fn delete(
        &self,
        request: DeleteShiftRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<EmptyResponse>> {
        let mut api_req = request.api_req;
        api_req.http_method = Method::DELETE;
        api_req.api_path = format!("/open-apis/attendance/v1/shifts/{}", request.shift_id);
        api_req.supported_access_token_types = vec![AccessTokenType::Tenant];

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 按 ID 查询班次
    ///
    /// 通过班次的 ID 获取班次详情
    ///
    /// <https://open.feishu.cn/document/server-docs/attendance-v1/shift/get>
    pub async fn get(
        &self,
        request: GetShiftRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<Shift>> {
        let mut api_req = request.api_req;
        api_req.http_method = Method::GET;
        api_req.api_path = format!("/open-apis/attendance/v1/shifts/{}", request.shift_id);
        api_req.supported_access_token_types = vec![AccessTokenType::Tenant];

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 按名称查询班次
    ///
    /// 通过班次的名称查询班次信息
    ///
    /// <https://open.feishu.cn/document/server-docs/attendance-v1/shift/query>
    pub async fn query(
        &self,
        request: QueryShiftRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<Shift>> {
        let mut api_req = request.api_req;
        api_req.http_method = Method::POST;
        api_req.api_path = "/open-apis/attendance/v1/shifts/query".to_string();
        api_req.supported_access_token_types = vec![AccessTokenType::Tenant];

        // 添加必需的查询参数
        api_req
            .query_params
            .insert("employee_type".to_string(), request.employee_type.clone());
        api_req
            .query_params
            .insert("shift_name".to_string(), request.shift_name.clone());

        let body = json!({
            "shift_name": request.shift_name
        });

        api_req.body = serde_json::to_vec(&body).map_err(|e| {
            log::error!("序列化请求体失败: {e:?}");
            e
        })?;

        // 调试日志:打印API请求内容
        log::debug!("查询班次API请求详情:");
        log::debug!("  路径: {}", api_req.api_path);
        log::debug!("  方法: {:?}", api_req.http_method);
        log::debug!("  查询参数: {:?}", api_req.query_params);
        log::debug!(
            "  请求体: {}",
            serde_json::to_string_pretty(&body).unwrap_or_else(|_| "无法序列化".to_string())
        );

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }

    /// 查询所有班次
    ///
    /// 分页查询所有班次
    ///
    /// <https://open.feishu.cn/document/server-docs/attendance-v1/shift/list>
    pub async fn list(
        &self,
        request: ListShiftRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<ShiftListData>> {
        let mut api_req = request.api_req;
        api_req.http_method = Method::GET;
        api_req.api_path = "/open-apis/attendance/v1/shifts".to_string();
        api_req.supported_access_token_types = vec![AccessTokenType::Tenant];

        // 添加查询参数
        if let Some(page_size) = request.page_size {
            api_req
                .query_params
                .insert("page_size".to_string(), page_size.to_string());
        }
        if let Some(page_token) = request.page_token {
            api_req
                .query_params
                .insert("page_token".to_string(), page_token);
        }

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }
}

impl CreateShiftRequest {
    pub fn builder() -> CreateShiftRequestBuilder {
        CreateShiftRequestBuilder::default()
    }
}

#[derive(Default)]
pub struct CreateShiftRequestBuilder {
    employee_type: Option<String>,
    shift_name: Option<String>,
    punch_times: Option<i32>,
    is_flexible: Option<bool>,
    flexible_minutes: Option<i32>,
    flexible_rule: Option<Vec<super::models::FlexibleRule>>,
    no_need_off: Option<bool>,
    punch_time_rule: Option<Vec<super::models::PunchTimeRule>>,
    late_minutes_as_late: Option<i32>,
    late_minutes_as_lack: Option<i32>,
    early_minutes_as_early: Option<i32>,
    early_minutes_as_lack: Option<i32>,
    allow_outside_apply: Option<bool>,
    outside_apply_limit: Option<i32>,
    allow_face_punch: Option<bool>,
    face_punch_cfg: Option<super::models::FacePunchConfig>,
}

impl CreateShiftRequestBuilder {
    pub fn employee_type<T: Into<String>>(mut self, employee_type: T) -> Self {
        self.employee_type = Some(employee_type.into());
        self
    }

    pub fn shift_name<T: Into<String>>(mut self, shift_name: T) -> Self {
        self.shift_name = Some(shift_name.into());
        self
    }

    pub fn punch_times(mut self, punch_times: i32) -> Self {
        self.punch_times = Some(punch_times);
        self
    }

    pub fn is_flexible(mut self, is_flexible: bool) -> Self {
        self.is_flexible = Some(is_flexible);
        self
    }

    pub fn flexible_minutes(mut self, flexible_minutes: i32) -> Self {
        self.flexible_minutes = Some(flexible_minutes);
        self
    }

    pub fn flexible_rule(mut self, flexible_rule: Vec<super::models::FlexibleRule>) -> Self {
        self.flexible_rule = Some(flexible_rule);
        self
    }

    pub fn no_need_off(mut self, no_need_off: bool) -> Self {
        self.no_need_off = Some(no_need_off);
        self
    }

    pub fn punch_time_rule(mut self, punch_time_rule: Vec<super::models::PunchTimeRule>) -> Self {
        self.punch_time_rule = Some(punch_time_rule);
        self
    }

    pub fn late_minutes_as_late(mut self, late_minutes_as_late: i32) -> Self {
        self.late_minutes_as_late = Some(late_minutes_as_late);
        self
    }

    pub fn late_minutes_as_lack(mut self, late_minutes_as_lack: i32) -> Self {
        self.late_minutes_as_lack = Some(late_minutes_as_lack);
        self
    }

    pub fn early_minutes_as_early(mut self, early_minutes_as_early: i32) -> Self {
        self.early_minutes_as_early = Some(early_minutes_as_early);
        self
    }

    pub fn early_minutes_as_lack(mut self, early_minutes_as_lack: i32) -> Self {
        self.early_minutes_as_lack = Some(early_minutes_as_lack);
        self
    }

    pub fn allow_outside_apply(mut self, allow_outside_apply: bool) -> Self {
        self.allow_outside_apply = Some(allow_outside_apply);
        self
    }

    pub fn outside_apply_limit(mut self, outside_apply_limit: i32) -> Self {
        self.outside_apply_limit = Some(outside_apply_limit);
        self
    }

    pub fn allow_face_punch(mut self, allow_face_punch: bool) -> Self {
        self.allow_face_punch = Some(allow_face_punch);
        self
    }

    pub fn face_punch_cfg(mut self, face_punch_cfg: super::models::FacePunchConfig) -> Self {
        self.face_punch_cfg = Some(face_punch_cfg);
        self
    }

    pub fn build(self) -> CreateShiftRequest {
        CreateShiftRequest {
            api_req: ApiRequest::default(),
            employee_type: self.employee_type.expect("employee_type is required"),
            shift_name: self.shift_name.expect("shift_name is required"),
            punch_times: self.punch_times.expect("punch_times is required"),
            is_flexible: self.is_flexible,
            flexible_minutes: self.flexible_minutes,
            flexible_rule: self.flexible_rule,
            no_need_off: self.no_need_off,
            punch_time_rule: self.punch_time_rule,
            late_minutes_as_late: self.late_minutes_as_late,
            late_minutes_as_lack: self.late_minutes_as_lack,
            early_minutes_as_early: self.early_minutes_as_early,
            early_minutes_as_lack: self.early_minutes_as_lack,
            allow_outside_apply: self.allow_outside_apply,
            outside_apply_limit: self.outside_apply_limit,
            allow_face_punch: self.allow_face_punch,
            face_punch_cfg: self.face_punch_cfg,
        }
    }
}

// 应用ExecutableBuilder trait到CreateShiftRequestBuilder
impl_executable_builder_owned!(
    CreateShiftRequestBuilder,
    ShiftService,
    CreateShiftRequest,
    BaseResponse<CreateShiftRespData>,
    create
);

impl DeleteShiftRequest {
    pub fn new<T: Into<String>>(shift_id: T) -> Self {
        Self {
            api_req: ApiRequest::default(),
            shift_id: shift_id.into(),
        }
    }
}

impl GetShiftRequest {
    pub fn new<T: Into<String>>(shift_id: T) -> Self {
        Self {
            api_req: ApiRequest::default(),
            shift_id: shift_id.into(),
        }
    }
}

impl QueryShiftRequest {
    pub fn new<T: Into<String>>(employee_type: T, shift_name: T) -> Self {
        Self {
            api_req: ApiRequest::default(),
            employee_type: employee_type.into(),
            shift_name: shift_name.into(),
        }
    }
}

impl ListShiftRequest {
    pub fn new() -> Self {
        Self {
            api_req: ApiRequest::default(),
            page_size: None,
            page_token: None,
        }
    }

    pub fn page_size(mut self, page_size: i32) -> Self {
        self.page_size = Some(page_size);
        self
    }

    pub fn page_token<T: Into<String>>(mut self, page_token: T) -> Self {
        self.page_token = Some(page_token.into());
        self
    }
}