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
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
use reqwest::Method;
use serde_json::json;

use crate::{
    core::{
        api_resp::BaseResponse, config::Config, constants::AccessTokenType,
        endpoints::attendance::*, http::Transport, req_option::RequestOption,
        trait_system::Service, SDKResult,
    },
    impl_executable_builder_owned,
};

use super::models::{
    QueryStatsFieldsRequest, QueryStatsFieldsRespData, QueryStatsSettingsRequest,
    QueryStatsSettingsRespData, QueryUserStatsDataRequest, QueryUserStatsDataRespData,
    UpdateUserStatsDataRequest, UpdateUserStatsDataRespData,
};

/// 用户统计数据服务
pub struct UserStatsDataService {
    pub config: Config,
}

impl UserStatsDataService {
    /// 更新统计设置
    ///
    /// 该接口用于更新考勤统计的设置,包括统计范围、日期、用户和字段等。
    ///
    /// <https://open.feishu.cn/document/server-docs/attendance-v1/user_stats_data/update>
    pub async fn update(
        &self,
        request: UpdateUserStatsDataRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<UpdateUserStatsDataRespData>> {
        let mut api_req = request.api_req;
        api_req.http_method = Method::POST;
        api_req.api_path = ATTENDANCE_V1_USER_STATS_DATAS_UPDATE.to_string();
        api_req.supported_access_token_types = vec![AccessTokenType::Tenant];

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

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

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

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

    /// 查询统计设置
    ///
    /// 该接口用于查询当前考勤统计的设置信息。
    ///
    /// <https://open.feishu.cn/document/server-docs/attendance-v1/user_stats_data/query>
    pub async fn query_settings(
        &self,
        request: QueryStatsSettingsRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<QueryStatsSettingsRespData>> {
        let mut api_req = request.api_req;
        api_req.http_method = Method::GET;
        api_req.api_path = ATTENDANCE_V1_USER_STATS_DATAS_QUERY.to_string();
        api_req.supported_access_token_types = vec![AccessTokenType::Tenant];

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

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

    /// 查询统计表头
    ///
    /// 该接口用于查询考勤统计的可用字段信息,包括字段名称、类型等。
    ///
    /// <https://open.feishu.cn/document/server-docs/attendance-v1/user_stats_data/query-2>
    pub async fn query_fields(
        &self,
        request: QueryStatsFieldsRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<QueryStatsFieldsRespData>> {
        let mut api_req = request.api_req;
        api_req.http_method = Method::GET;
        api_req.api_path = ATTENDANCE_V1_USER_STATS_DATAS_QUERY_FIELDS.to_string();
        api_req.supported_access_token_types = vec![AccessTokenType::Tenant];

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

        if let Some(locale) = request.locale {
            api_req.query_params.insert("locale", locale);
        }

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

    /// 查询统计数据
    ///
    /// 该接口用于查询用户的考勤统计数据,支持按日期范围、用户和字段进行筛选。
    ///
    /// <https://open.feishu.cn/document/server-docs/attendance-v1/user_stats_data/query-3>
    pub async fn query_data(
        &self,
        request: QueryUserStatsDataRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<QueryUserStatsDataRespData>> {
        let mut api_req = request.api_req;
        api_req.http_method = Method::POST;
        api_req.api_path = ATTENDANCE_V1_USER_STATS_DATAS_QUERY_DATA.to_string();
        api_req.supported_access_token_types = vec![AccessTokenType::Tenant];

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

        if let Some(locale) = request.locale {
            api_req.query_params.insert("locale", locale);
        }

        // 构建请求体
        let body = json!({
            "start_date": request.start_date,
            "end_date": request.end_date,
            "user_ids": request.user_ids,
            "need_fields": request.need_fields
        });

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

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

impl Service for UserStatsDataService {
    fn config(&self) -> &Config {
        &self.config
    }

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

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

// Builder implementations
impl_executable_builder_owned!(
    UpdateUserStatsDataRequest,
    UserStatsDataService,
    UpdateUserStatsDataRequest,
    BaseResponse<UpdateUserStatsDataRespData>,
    update
);

impl_executable_builder_owned!(
    QueryStatsSettingsRequest,
    UserStatsDataService,
    QueryStatsSettingsRequest,
    BaseResponse<QueryStatsSettingsRespData>,
    query_settings
);

impl_executable_builder_owned!(
    QueryStatsFieldsRequest,
    UserStatsDataService,
    QueryStatsFieldsRequest,
    BaseResponse<QueryStatsFieldsRespData>,
    query_fields
);

impl_executable_builder_owned!(
    QueryUserStatsDataRequest,
    UserStatsDataService,
    QueryUserStatsDataRequest,
    BaseResponse<QueryUserStatsDataRespData>,
    query_data
);

#[cfg(test)]
#[allow(unused_variables, unused_unsafe)]
mod tests {
    use super::*;
    use crate::core::{api_req::ApiRequest, config::Config};
    use crate::service::attendance::v1::models::StatsSettings;

    fn create_test_config() -> Config {
        Config::builder()
            .app_id("test_app_id")
            .app_secret("test_app_secret")
            .base_url("https://test.api.com")
            .build()
    }

    fn create_test_service() -> UserStatsDataService {
        UserStatsDataService {
            config: create_test_config(),
        }
    }

    fn create_test_stats_settings() -> StatsSettings {
        StatsSettings {
            stats_scope: 1,
            start_date: "2023-01-01".to_string(),
            end_date: "2023-12-31".to_string(),
            user_ids: vec!["user001".to_string(), "user002".to_string()],
            need_fields: vec!["field1".to_string(), "field2".to_string()],
        }
    }

    #[test]
    fn test_service_creation() {
        let service = create_test_service();
        assert_eq!(service.config.app_id, "test_app_id");
        assert_eq!(service.config.app_secret, "test_app_secret");
        assert_eq!(service.config.base_url, "https://test.api.com");
    }

    #[test]
    fn test_update_user_stats_data_request() {
        let request = UpdateUserStatsDataRequest {
            api_req: ApiRequest::default(),
            employee_type: "employee_id".to_string(),
            stats_setting: create_test_stats_settings(),
        };

        assert_eq!(request.employee_type, "employee_id");
        assert_eq!(request.stats_setting.stats_scope, 1);
        assert_eq!(request.stats_setting.start_date, "2023-01-01");
        assert_eq!(request.stats_setting.end_date, "2023-12-31");
        assert_eq!(request.stats_setting.user_ids.len(), 2);
        assert_eq!(request.stats_setting.need_fields.len(), 2);
    }

    #[test]
    fn test_query_stats_settings_request() {
        let request = QueryStatsSettingsRequest {
            api_req: ApiRequest::default(),
            employee_type: "employee_no".to_string(),
        };

        assert_eq!(request.employee_type, "employee_no");
    }

    #[test]
    fn test_query_stats_fields_request() {
        let request = QueryStatsFieldsRequest {
            api_req: ApiRequest::default(),
            employee_type: "open_id".to_string(),
            locale: Some("zh-CN".to_string()),
        };

        assert_eq!(request.employee_type, "open_id");
        assert_eq!(request.locale, Some("zh-CN".to_string()));
    }

    #[test]
    fn test_query_stats_fields_request_without_locale() {
        let request = QueryStatsFieldsRequest {
            api_req: ApiRequest::default(),
            employee_type: "union_id".to_string(),
            locale: None,
        };

        assert_eq!(request.employee_type, "union_id");
        assert!(request.locale.is_none());
    }

    #[test]
    fn test_query_user_stats_data_request() {
        let request = QueryUserStatsDataRequest {
            api_req: ApiRequest::default(),
            employee_type: "employee_id".to_string(),
            start_date: "2023-01-01".to_string(),
            end_date: "2023-01-31".to_string(),
            user_ids: vec![
                "user001".to_string(),
                "user002".to_string(),
                "user003".to_string(),
            ],
            need_fields: vec!["attendance_days".to_string(), "work_hours".to_string()],
            locale: Some("en-US".to_string()),
        };

        assert_eq!(request.employee_type, "employee_id");
        assert_eq!(request.start_date, "2023-01-01");
        assert_eq!(request.end_date, "2023-01-31");
        assert_eq!(request.user_ids.len(), 3);
        assert_eq!(request.need_fields.len(), 2);
        assert_eq!(request.locale, Some("en-US".to_string()));
    }

    #[test]
    fn test_stats_settings_variations() {
        // Test different scope values
        let settings1 = StatsSettings {
            stats_scope: 1, // 自定义范围
            start_date: "2023-01-01".to_string(),
            end_date: "2023-12-31".to_string(),
            user_ids: vec!["user001".to_string()],
            need_fields: vec!["field1".to_string()],
        };

        let settings2 = StatsSettings {
            stats_scope: 2, // 全部
            start_date: "2023-01-01".to_string(),
            end_date: "2023-12-31".to_string(),
            user_ids: vec![],
            need_fields: vec![],
        };

        assert_eq!(settings1.stats_scope, 1);
        assert_eq!(settings2.stats_scope, 2);
    }

    #[test]
    fn test_different_employee_types() {
        let employee_types = vec!["employee_id", "employee_no", "open_id", "union_id"];

        for emp_type in employee_types {
            let request = QueryStatsSettingsRequest {
                api_req: ApiRequest::default(),
                employee_type: emp_type.to_string(),
            };
            assert_eq!(request.employee_type, emp_type);
        }
    }

    #[test]
    fn test_different_locales() {
        let locales = vec![
            Some("zh-CN".to_string()),
            Some("en-US".to_string()),
            Some("ja-JP".to_string()),
            Some("zh-TW".to_string()),
            Some("ko-KR".to_string()),
            None,
        ];

        for locale in locales {
            let request = QueryStatsFieldsRequest {
                api_req: ApiRequest::default(),
                employee_type: "employee_id".to_string(),
                locale: locale.clone(),
            };
            assert_eq!(request.locale, locale);
        }
    }

    #[test]
    fn test_date_format_variations() {
        let dates = vec![
            ("2023-01-01", "2023-01-31"), // January
            ("2023-02-01", "2023-02-28"), // February
            ("2023-12-01", "2023-12-31"), // December
            ("2023-06-15", "2023-06-15"), // Single day
            ("2020-02-29", "2020-02-29"), // Leap year
            ("1900-01-01", "2099-12-31"), // Wide range
        ];

        for (start_date, end_date) in dates {
            let settings = StatsSettings {
                stats_scope: 1,
                start_date: start_date.to_string(),
                end_date: end_date.to_string(),
                user_ids: vec!["user001".to_string()],
                need_fields: vec!["field1".to_string()],
            };

            assert_eq!(settings.start_date, start_date);
            assert_eq!(settings.end_date, end_date);
        }
    }

    #[test]
    fn test_user_ids_variations() {
        let user_id_lists = vec![
            vec![],                                         // Empty list
            vec!["single_user".to_string()],                // Single user
            vec!["user1".to_string(), "user2".to_string()], // Two users
            vec![
                "user1".to_string(),
                "user2".to_string(),
                "user3".to_string(),
                "user4".to_string(),
                "user5".to_string(),
            ], // Multiple users
            vec![
                "user-with-dashes".to_string(),
                "user_with_underscores".to_string(),
            ], // Special characters
            vec!["用户001".to_string(), "用户002".to_string()], // Unicode
            vec!["user🚀001".to_string(), "user🔐002".to_string()], // Emoji
        ];

        for user_ids in user_id_lists {
            let settings = StatsSettings {
                stats_scope: 1,
                start_date: "2023-01-01".to_string(),
                end_date: "2023-12-31".to_string(),
                user_ids: user_ids.clone(),
                need_fields: vec!["field1".to_string()],
            };

            assert_eq!(settings.user_ids, user_ids);
        }
    }

    #[test]
    fn test_need_fields_variations() {
        let field_lists = vec![
            vec![],                                                        // Empty list
            vec!["attendance_days".to_string()],                           // Single field
            vec!["attendance_days".to_string(), "work_hours".to_string()], // Two fields
            vec![
                "field1".to_string(),
                "field2".to_string(),
                "field3".to_string(),
                "field4".to_string(),
            ], // Multiple fields
            vec![
                "field-with-dashes".to_string(),
                "field_with_underscores".to_string(),
            ], // Special characters
            vec!["考勤天数".to_string(), "工作小时".to_string()],          // Unicode
            vec!["field🎯1".to_string(), "field📊2".to_string()],          // Emoji
        ];

        for need_fields in field_lists {
            let settings = StatsSettings {
                stats_scope: 1,
                start_date: "2023-01-01".to_string(),
                end_date: "2023-12-31".to_string(),
                user_ids: vec!["user001".to_string()],
                need_fields: need_fields.clone(),
            };

            assert_eq!(settings.need_fields, need_fields);
        }
    }

    #[test]
    fn test_stats_scope_edge_cases() {
        let scopes = vec![
            0,   // Edge case: invalid scope
            1,   // 自定义范围
            2,   // 全部
            -1,  // Edge case: negative scope
            999, // Edge case: large scope
        ];

        for scope in scopes {
            let settings = StatsSettings {
                stats_scope: scope,
                start_date: "2023-01-01".to_string(),
                end_date: "2023-12-31".to_string(),
                user_ids: vec!["user001".to_string()],
                need_fields: vec!["field1".to_string()],
            };

            assert_eq!(settings.stats_scope, scope);
        }
    }

    #[test]
    fn test_stats_settings_clone() {
        let original_settings = create_test_stats_settings();
        let cloned_settings = original_settings.clone();

        assert_eq!(original_settings.stats_scope, cloned_settings.stats_scope);
        assert_eq!(original_settings.start_date, cloned_settings.start_date);
        assert_eq!(original_settings.end_date, cloned_settings.end_date);
        assert_eq!(original_settings.user_ids, cloned_settings.user_ids);
        assert_eq!(original_settings.need_fields, cloned_settings.need_fields);
    }

    #[test]
    fn test_stats_settings_debug() {
        let settings = create_test_stats_settings();
        let debug_str = format!("{:?}", settings);

        assert!(debug_str.contains("StatsSettings"));
        assert!(debug_str.contains("2023-01-01"));
        assert!(debug_str.contains("2023-12-31"));
        assert!(debug_str.contains("user001"));
        assert!(debug_str.contains("field1"));
    }

    #[test]
    fn test_request_default_trait() {
        let query_fields_request = QueryStatsFieldsRequest::default();
        assert!(query_fields_request.employee_type.is_empty());
        assert!(query_fields_request.locale.is_none());

        let update_request = UpdateUserStatsDataRequest::default();
        assert!(update_request.employee_type.is_empty());

        let query_settings_request = QueryStatsSettingsRequest::default();
        assert!(query_settings_request.employee_type.is_empty());

        let query_data_request = QueryUserStatsDataRequest::default();
        assert!(query_data_request.employee_type.is_empty());
        assert!(query_data_request.start_date.is_empty());
        assert!(query_data_request.end_date.is_empty());
        assert!(query_data_request.user_ids.is_empty());
        assert!(query_data_request.need_fields.is_empty());
        assert!(query_data_request.locale.is_none());
    }

    #[test]
    fn test_request_build_methods() {
        let update_request = UpdateUserStatsDataRequest {
            api_req: ApiRequest::default(),
            employee_type: "employee_id".to_string(),
            stats_setting: create_test_stats_settings(),
        };
        let built_update = update_request.build();
        assert_eq!(built_update.employee_type, "employee_id");

        let query_settings_request = QueryStatsSettingsRequest {
            api_req: ApiRequest::default(),
            employee_type: "employee_no".to_string(),
        };
        let built_query_settings = query_settings_request.build();
        assert_eq!(built_query_settings.employee_type, "employee_no");

        let query_fields_request = QueryStatsFieldsRequest {
            api_req: ApiRequest::default(),
            employee_type: "open_id".to_string(),
            locale: Some("zh-CN".to_string()),
        };
        let built_query_fields = query_fields_request.build();
        assert_eq!(built_query_fields.employee_type, "open_id");
        assert_eq!(built_query_fields.locale, Some("zh-CN".to_string()));
    }

    #[test]
    fn test_json_serialization() {
        let settings = create_test_stats_settings();

        // Test serialization
        let json_result = serde_json::to_string(&settings);
        assert!(json_result.is_ok());

        let json_str = json_result.unwrap();
        assert!(json_str.contains("2023-01-01"));
        assert!(json_str.contains("2023-12-31"));
        assert!(json_str.contains("user001"));
        assert!(json_str.contains("field1"));

        // Test deserialization
        let deserialized_result: Result<StatsSettings, _> = serde_json::from_str(&json_str);
        assert!(deserialized_result.is_ok());

        let deserialized_settings = deserialized_result.unwrap();
        assert_eq!(deserialized_settings.stats_scope, settings.stats_scope);
        assert_eq!(deserialized_settings.start_date, settings.start_date);
        assert_eq!(deserialized_settings.end_date, settings.end_date);
        assert_eq!(deserialized_settings.user_ids, settings.user_ids);
        assert_eq!(deserialized_settings.need_fields, settings.need_fields);
    }

    #[test]
    fn test_empty_collections_serialization() {
        let settings = StatsSettings {
            stats_scope: 2,
            start_date: "2023-01-01".to_string(),
            end_date: "2023-12-31".to_string(),
            user_ids: vec![],
            need_fields: vec![],
        };

        let json_result = serde_json::to_string(&settings);
        assert!(json_result.is_ok());

        let json_str = json_result.unwrap();
        assert!(json_str.contains("[]") || json_str.contains("user_ids"));
        assert!(json_str.contains("[]") || json_str.contains("need_fields"));
    }

    #[test]
    fn test_large_collections() {
        let large_user_ids: Vec<String> = (0..1000).map(|i| format!("user_{:04}", i)).collect();
        let large_need_fields: Vec<String> = (0..100).map(|i| format!("field_{:03}", i)).collect();

        let settings = StatsSettings {
            stats_scope: 1,
            start_date: "2023-01-01".to_string(),
            end_date: "2023-12-31".to_string(),
            user_ids: large_user_ids.clone(),
            need_fields: large_need_fields.clone(),
        };

        assert_eq!(settings.user_ids.len(), 1000);
        assert_eq!(settings.need_fields.len(), 100);
        assert_eq!(settings.user_ids, large_user_ids);
        assert_eq!(settings.need_fields, large_need_fields);
    }

    #[test]
    fn test_special_date_formats() {
        let date_pairs = vec![
            ("", ""),                         // Empty dates
            ("2023-01-01", ""),               // Empty end date
            ("", "2023-12-31"),               // Empty start date
            ("invalid-date", "also-invalid"), // Invalid format
            ("2023/01/01", "2023/12/31"),     // Different separator
            ("01-01-2023", "31-12-2023"),     // Different order
        ];

        for (start_date, end_date) in date_pairs {
            let settings = StatsSettings {
                stats_scope: 1,
                start_date: start_date.to_string(),
                end_date: end_date.to_string(),
                user_ids: vec!["user001".to_string()],
                need_fields: vec!["field1".to_string()],
            };

            assert_eq!(settings.start_date, start_date);
            assert_eq!(settings.end_date, end_date);
        }
    }

    #[test]
    fn test_memory_efficiency() {
        // Create multiple request instances to test memory usage
        let requests: Vec<UpdateUserStatsDataRequest> = (0..100)
            .map(|i| UpdateUserStatsDataRequest {
                api_req: ApiRequest::default(),
                employee_type: "employee_id".to_string(),
                stats_setting: StatsSettings {
                    stats_scope: i % 3 + 1,
                    start_date: format!("2023-{:02}-01", (i % 12) + 1),
                    end_date: format!("2023-{:02}-28", (i % 12) + 1),
                    user_ids: vec![format!("user_{:03}", i)],
                    need_fields: vec![format!("field_{:03}", i)],
                },
            })
            .collect();

        assert_eq!(requests.len(), 100);

        for (i, request) in requests.iter().enumerate() {
            assert_eq!(request.employee_type, "employee_id");
            assert_eq!(request.stats_setting.stats_scope, (i % 3 + 1) as i32);
            assert_eq!(request.stats_setting.user_ids[0], format!("user_{:03}", i));
            assert_eq!(
                request.stats_setting.need_fields[0],
                format!("field_{:03}", i)
            );
        }
    }
}