open-lark 0.14.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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
//! 考勤(Attendance)服务
//!
//! 提供飞书考勤管理的完整功能集,支持考勤数据管理、统计分析、
//! 假期管理、班次设置等企业级考勤管理能力。是企业人事管理的重要组成部分。
//!
//! # 核心功能
//!
//! ## 考勤数据管理
//! - 📊 考勤记录查询和管理
//! - ⏰ 打卡数据统计和分析
//! - 📅 考勤日历和排班管理
//! - 🔍 考勤异常检测和处理
//! - 📈 考勤报表生成和导出
//!
//! ## 假期管理
//! - 🏖️ 假期类型定义和管理
//! - 📝 请假申请和审批流程
//! - 📊 假期余额查询和统计
//! - 📅 假期计划和安排
//! - 🔔 假期提醒和通知
//!
//! ## 班次设置
//! - ⏰ 工作时间和班次配置
//! - 🔄 轮班制度和排班规则
//! - 📍 考勤地点和范围设置
//! - 🎯 弹性工作时间管理
//! - 📊 加班时间统计和管理
//!
//! ## 考勤统计
//! - 📈 个人和团队考勤统计
//! - 📊 出勤率和工时分析
//! - 🎯 考勤目标和绩效评估
//! - 📋 考勤月报和年报
//! - 💰 工资结算相关数据
//!
//! # 使用示例
//!
//! ```rust
//! use open_lark::prelude::*;
//!
//! let client = LarkClient::builder("app_id", "app_secret")
//!     .with_app_type(AppType::SelfBuild)
//!     .build();
//!
//! // 获取考勤服务
//! let attendance = &client.attendance;
//!
//! // 查询用户考勤记录
//! // let attendance_request = GetUserAttendanceRequest::builder()
//! //     .user_id("user_id")
//! //     .start_date("2024-07-01")
//! //     .end_date("2024-07-31")
//! //     .build();
//! // let records = attendance.v1.user_attendance.get(attendance_request, None).await?;
//!
//! // 查询假期余额
//! // let leave_request = GetLeaveBalanceRequest::builder()
//! //     .user_id("user_id")
//! //     .build();
//! // let balance = attendance.v1.leave.get_balance(leave_request, None).await?;
//!
//! // 获取班次信息
//! // let shift_request = ListShiftRequest::builder()
//! //     .page_size(20)
//! //     .build();
//! // let shifts = attendance.v1.shift.list(shift_request, None).await?;
//! ```
//!
//! # API版本
//!
//! 当前支持v1版本,提供基础的考勤管理功能:
//! - 考勤数据查询和统计
//! - 假期管理和请假流程
//! - 班次设置和排班管理
//! - 考勤报表和分析
//!
//! # 考勤管理特性
//!
//! - ⏰ 多种打卡方式支持
//! - 📱 移动端考勤应用
//! - 🔍 智能考勤异常检测
//! - 📊 实时数据同步更新
//! - 🔐 企业级权限控制
//!
//! # 人事集成
//!
//! - 👥 员工信息同步
//! - 💰 薪酬计算数据对接
//! - 📋 绩效考核数据支持
//! - 🔄 HR系统集成
//! - 📊 组织架构联动

use crate::core::{config::Config, trait_system::Service};

pub mod v1;

/// 考勤服务
///
/// 企业级考勤管理的统一入口,提供考勤数据管理、假期管理、
/// 班次设置、统计分析等完整的考勤管理能力。
///
/// # 服务架构
///
/// - **v1**: 考勤管理API v1版本,提供基础功能集
///
/// # 核心特性
///
/// - ⏰ 全面的考勤数据管理
/// - 🏖️ 灵活的假期管理系统
/// - 📊 丰富的统计分析功能
/// - 🔄 智能的排班调度
/// - 📱 移动办公支持
///
/// # 适用场景
///
/// - 企业员工考勤管理
/// - 假期和请假管理
/// - 工时统计和分析
/// - 薪酬计算数据支持
/// - 人事管理系统集成
///
/// # 最佳实践
///
/// - 合理设置考勤规则
/// - 定期分析考勤数据
/// - 及时处理考勤异常
/// - 优化排班和调度
/// - 保护员工隐私数据
pub struct AttendanceService {
    /// v1版本API服务
    pub v1: v1::V1,
}

impl AttendanceService {
    /// 创建新的考勤服务实例
    ///
    /// # 参数
    /// - `config`: 客户端配置,包含认证信息和API设置
    ///
    /// # 返回值
    /// 配置完成的考勤服务实例
    pub fn new(config: Config) -> Self {
        Self {
            v1: v1::V1::new(config),
        }
    }
}

impl Service for AttendanceService {
    fn config(&self) -> &Config {
        &self.v1.shift.config
    }

    fn service_name() -> &'static str {
        "attendance"
    }

    fn service_version() -> &'static str {
        "v1"
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::time::Duration;

    #[test]
    fn test_attendance_service_creation() {
        let config = Config::default();
        let service = AttendanceService::new(config.clone());

        // Verify all 11 sub-services are configured correctly
        assert_eq!(service.v1.shift.config.app_id, config.app_id);
        assert_eq!(service.v1.shift.config.app_secret, config.app_secret);
        assert_eq!(service.v1.user_daily_shift.config.app_id, config.app_id);
        assert_eq!(service.v1.group.config.app_id, config.app_id);
        assert_eq!(service.v1.user_setting.config.app_id, config.app_id);
        assert_eq!(
            service.v1.user_stats_data.config.app_secret,
            config.app_secret
        );
        assert_eq!(service.v1.user_approval.config.app_id, config.app_id);
        assert_eq!(service.v1.user_task.config.app_id, config.app_id);
        assert_eq!(
            service.v1.user_task_remedy.config.app_secret,
            config.app_secret
        );
        assert_eq!(service.v1.archive_rule.config.app_id, config.app_id);
        assert_eq!(
            service.v1.leave_employ_expire_record.config.app_id,
            config.app_id
        );
        assert_eq!(
            service.v1.leave_accrual_record.config.app_secret,
            config.app_secret
        );
    }

    #[test]
    fn test_attendance_service_with_custom_config() {
        let config = Config::builder()
            .app_id("attendance_test_app")
            .app_secret("attendance_test_secret")
            .req_timeout(Duration::from_secs(350))
            .build();

        let service = AttendanceService::new(config.clone());

        assert_eq!(service.v1.shift.config.app_id, "attendance_test_app");
        assert_eq!(service.v1.shift.config.app_secret, "attendance_test_secret");
        assert_eq!(
            service.v1.shift.config.req_timeout,
            Some(Duration::from_secs(350))
        );
        assert_eq!(
            service.v1.user_daily_shift.config.app_id,
            "attendance_test_app"
        );
        assert_eq!(
            service.v1.group.config.req_timeout,
            Some(Duration::from_secs(350))
        );
        assert_eq!(service.v1.user_setting.config.app_id, "attendance_test_app");
        assert_eq!(
            service.v1.user_stats_data.config.req_timeout,
            Some(Duration::from_secs(350))
        );
        assert_eq!(
            service.v1.user_approval.config.app_id,
            "attendance_test_app"
        );
        assert_eq!(
            service.v1.user_task.config.req_timeout,
            Some(Duration::from_secs(350))
        );
        assert_eq!(
            service.v1.user_task_remedy.config.app_id,
            "attendance_test_app"
        );
        assert_eq!(
            service.v1.archive_rule.config.req_timeout,
            Some(Duration::from_secs(350))
        );
        assert_eq!(
            service.v1.leave_employ_expire_record.config.app_id,
            "attendance_test_app"
        );
        assert_eq!(
            service.v1.leave_accrual_record.config.req_timeout,
            Some(Duration::from_secs(350))
        );
    }

    #[test]
    fn test_attendance_service_config_independence() {
        let config1 = Config::builder().app_id("attendance_app_1").build();

        let config2 = Config::builder().app_id("attendance_app_2").build();

        let service1 = AttendanceService::new(config1);
        let service2 = AttendanceService::new(config2);

        assert_eq!(service1.v1.shift.config.app_id, "attendance_app_1");
        assert_eq!(service2.v1.shift.config.app_id, "attendance_app_2");
        assert_ne!(
            service1.v1.shift.config.app_id,
            service2.v1.shift.config.app_id
        );
        assert_ne!(
            service1.v1.user_daily_shift.config.app_id,
            service2.v1.user_daily_shift.config.app_id
        );
        assert_ne!(
            service1.v1.group.config.app_id,
            service2.v1.group.config.app_id
        );
        assert_ne!(
            service1.v1.user_setting.config.app_id,
            service2.v1.user_setting.config.app_id
        );
        assert_ne!(
            service1.v1.user_stats_data.config.app_id,
            service2.v1.user_stats_data.config.app_id
        );
        assert_ne!(
            service1.v1.user_approval.config.app_id,
            service2.v1.user_approval.config.app_id
        );
        assert_ne!(
            service1.v1.user_task.config.app_id,
            service2.v1.user_task.config.app_id
        );
        assert_ne!(
            service1.v1.user_task_remedy.config.app_id,
            service2.v1.user_task_remedy.config.app_id
        );
        assert_ne!(
            service1.v1.archive_rule.config.app_id,
            service2.v1.archive_rule.config.app_id
        );
        assert_ne!(
            service1.v1.leave_employ_expire_record.config.app_id,
            service2.v1.leave_employ_expire_record.config.app_id
        );
        assert_ne!(
            service1.v1.leave_accrual_record.config.app_id,
            service2.v1.leave_accrual_record.config.app_id
        );
    }

    #[test]
    fn test_attendance_service_sub_services_accessible() {
        let config = Config::default();
        let service = AttendanceService::new(config.clone());

        // Test that all sub-services are accessible
        assert_eq!(service.v1.shift.config.app_id, config.app_id);
        assert_eq!(service.v1.user_daily_shift.config.app_id, config.app_id);
        assert_eq!(service.v1.group.config.app_id, config.app_id);
        assert_eq!(service.v1.user_setting.config.app_id, config.app_id);
        assert_eq!(service.v1.user_stats_data.config.app_id, config.app_id);
        assert_eq!(service.v1.user_approval.config.app_id, config.app_id);
        assert_eq!(service.v1.user_task.config.app_id, config.app_id);
        assert_eq!(service.v1.user_task_remedy.config.app_id, config.app_id);
        assert_eq!(service.v1.archive_rule.config.app_id, config.app_id);
        assert_eq!(
            service.v1.leave_employ_expire_record.config.app_id,
            config.app_id
        );
        assert_eq!(service.v1.leave_accrual_record.config.app_id, config.app_id);
    }

    #[test]
    fn test_attendance_service_config_cloning() {
        let config = Config::builder()
            .app_id("clone_test_app")
            .app_secret("clone_test_secret")
            .build();

        let service = AttendanceService::new(config.clone());

        assert_eq!(service.v1.shift.config.app_id, "clone_test_app");
        assert_eq!(service.v1.shift.config.app_secret, "clone_test_secret");
        assert_eq!(
            service.v1.user_daily_shift.config.app_secret,
            "clone_test_secret"
        );
        assert_eq!(service.v1.group.config.app_id, "clone_test_app");
        assert_eq!(
            service.v1.user_setting.config.app_secret,
            "clone_test_secret"
        );
        assert_eq!(service.v1.user_stats_data.config.app_id, "clone_test_app");
        assert_eq!(
            service.v1.user_approval.config.app_secret,
            "clone_test_secret"
        );
        assert_eq!(service.v1.user_task.config.app_id, "clone_test_app");
        assert_eq!(
            service.v1.user_task_remedy.config.app_secret,
            "clone_test_secret"
        );
        assert_eq!(service.v1.archive_rule.config.app_id, "clone_test_app");
        assert_eq!(
            service.v1.leave_employ_expire_record.config.app_secret,
            "clone_test_secret"
        );
        assert_eq!(
            service.v1.leave_accrual_record.config.app_id,
            "clone_test_app"
        );
    }

    #[test]
    fn test_attendance_service_timeout_propagation() {
        let config = Config::builder()
            .req_timeout(Duration::from_secs(360))
            .build();

        let service = AttendanceService::new(config);

        // Verify timeout is propagated to all sub-services
        assert_eq!(
            service.v1.shift.config.req_timeout,
            Some(Duration::from_secs(360))
        );
        assert_eq!(
            service.v1.user_daily_shift.config.req_timeout,
            Some(Duration::from_secs(360))
        );
        assert_eq!(
            service.v1.group.config.req_timeout,
            Some(Duration::from_secs(360))
        );
        assert_eq!(
            service.v1.user_setting.config.req_timeout,
            Some(Duration::from_secs(360))
        );
        assert_eq!(
            service.v1.user_stats_data.config.req_timeout,
            Some(Duration::from_secs(360))
        );
        assert_eq!(
            service.v1.user_approval.config.req_timeout,
            Some(Duration::from_secs(360))
        );
        assert_eq!(
            service.v1.user_task.config.req_timeout,
            Some(Duration::from_secs(360))
        );
        assert_eq!(
            service.v1.user_task_remedy.config.req_timeout,
            Some(Duration::from_secs(360))
        );
        assert_eq!(
            service.v1.archive_rule.config.req_timeout,
            Some(Duration::from_secs(360))
        );
        assert_eq!(
            service.v1.leave_employ_expire_record.config.req_timeout,
            Some(Duration::from_secs(360))
        );
        assert_eq!(
            service.v1.leave_accrual_record.config.req_timeout,
            Some(Duration::from_secs(360))
        );
    }

    #[test]
    fn test_attendance_service_multiple_instances() {
        let config = Config::default();

        let service1 = AttendanceService::new(config.clone());
        let service2 = AttendanceService::new(config.clone());

        // Both services should have the same config values
        assert_eq!(
            service1.v1.shift.config.app_id,
            service2.v1.shift.config.app_id
        );
        assert_eq!(
            service1.v1.shift.config.app_secret,
            service2.v1.shift.config.app_secret
        );
        assert_eq!(
            service1.v1.user_daily_shift.config.app_id,
            service2.v1.user_daily_shift.config.app_id
        );
        assert_eq!(
            service1.v1.group.config.app_secret,
            service2.v1.group.config.app_secret
        );
        assert_eq!(
            service1.v1.user_setting.config.app_id,
            service2.v1.user_setting.config.app_id
        );
        assert_eq!(
            service1.v1.user_stats_data.config.app_secret,
            service2.v1.user_stats_data.config.app_secret
        );
        assert_eq!(
            service1.v1.user_approval.config.app_id,
            service2.v1.user_approval.config.app_id
        );
        assert_eq!(
            service1.v1.user_task.config.app_secret,
            service2.v1.user_task.config.app_secret
        );
        assert_eq!(
            service1.v1.user_task_remedy.config.app_id,
            service2.v1.user_task_remedy.config.app_id
        );
        assert_eq!(
            service1.v1.archive_rule.config.app_secret,
            service2.v1.archive_rule.config.app_secret
        );
        assert_eq!(
            service1.v1.leave_employ_expire_record.config.app_id,
            service2.v1.leave_employ_expire_record.config.app_id
        );
        assert_eq!(
            service1.v1.leave_accrual_record.config.app_secret,
            service2.v1.leave_accrual_record.config.app_secret
        );
    }

    #[test]
    fn test_attendance_service_config_consistency() {
        let config = Config::builder()
            .app_id("consistency_test")
            .app_secret("consistency_secret")
            .req_timeout(Duration::from_secs(370))
            .build();

        let service = AttendanceService::new(config);

        // Verify all sub-services have consistent configurations
        let configs = [
            &service.v1.shift.config,
            &service.v1.user_daily_shift.config,
            &service.v1.group.config,
            &service.v1.user_setting.config,
            &service.v1.user_stats_data.config,
            &service.v1.user_approval.config,
            &service.v1.user_task.config,
            &service.v1.user_task_remedy.config,
            &service.v1.archive_rule.config,
            &service.v1.leave_employ_expire_record.config,
            &service.v1.leave_accrual_record.config,
        ];

        for config in &configs {
            assert_eq!(config.app_id, "consistency_test");
            assert_eq!(config.app_secret, "consistency_secret");
            assert_eq!(config.req_timeout, Some(Duration::from_secs(370)));
        }
    }
}