openlark-communication 0.15.0

飞书开放平台 Rust SDK - 企业级 API 客户端
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

//! Contact (通讯录) 端点定义
//!
//! 企业通讯录管理，包括用户、部门、用户组、角色等信息。
//!
//! # 使用示例
//!
//! ```rust
//! use openlark_communication::endpoints::contact::*;
//!
//! let users_endpoint = CONTACT_V3_USERS;
//! let departments_endpoint = CONTACT_V3_DEPARTMENTS;
//! ```

// ==================== Contact (通讯录) v1/v2（历史版本）====================

/// Contact 应用管理员管理范围 v1（历史版本）
pub const CONTACT_V1_USER_ADMIN_SCOPE_GET: &str = "/open-apis/contact/v1/user/admin_scope/get";

/// Contact 批量新增用户 v2（历史版本）
pub const CONTACT_V2_USER_BATCH_ADD: &str = "/open-apis/contact/v2/user/batch_add";

/// Contact 批量新增部门 v2（历史版本）
pub const CONTACT_V2_DEPARTMENT_BATCH_ADD: &str = "/open-apis/contact/v2/department/batch_add";

/// Contact 查询批量任务执行状态 v2（历史版本）
pub const CONTACT_V2_TASK_GET: &str = "/open-apis/contact/v2/task/get";

/// Contact 获取角色列表 v2（历史版本）
pub const CONTACT_V2_ROLE_LIST: &str = "/open-apis/contact/v2/role/list";

// ==================== Contact (通讯录) v3 ====================

/// Contact 权限范围 v3
pub const CONTACT_V3_SCOPES: &str = "/open-apis/contact/v3/scopes";

/// Contact 部门 v3
pub const CONTACT_V3_DEPARTMENTS: &str = "/open-apis/contact/v3/departments";
pub const CONTACT_V3_DEPARTMENTS_BATCH: &str = "/open-apis/contact/v3/departments/batch";
pub const CONTACT_V3_DEPARTMENTS_PARENT: &str = "/open-apis/contact/v3/departments/parent";
pub const CONTACT_V3_DEPARTMENTS_SEARCH: &str = "/open-apis/contact/v3/departments/search";
pub const CONTACT_V3_DEPARTMENTS_UNBIND_DEPARTMENT_CHAT: &str =
    "/open-apis/contact/v3/departments/unbind_department_chat";

/// Contact 角色（functional role）v3
pub const CONTACT_V3_FUNCTIONAL_ROLES: &str = "/open-apis/contact/v3/functional_roles";

/// Contact 用户组 v3
pub const CONTACT_V3_GROUP: &str = "/open-apis/contact/v3/group";
pub const CONTACT_V3_GROUP_SIMPLELIST: &str = "/open-apis/contact/v3/group/simplelist";
pub const CONTACT_V3_GROUP_MEMBER_BELONG: &str = "/open-apis/contact/v3/group/member_belong";

/// Contact 企业自定义用户字段 v3
pub const CONTACT_V3_CUSTOM_ATTRS: &str = "/open-apis/contact/v3/custom_attrs";

/// Contact 人员类型 v3
pub const CONTACT_V3_EMPLOYEE_TYPE_ENUMS: &str = "/open-apis/contact/v3/employee_type_enums";

/// Contact 单位 v3
pub const CONTACT_V3_UNIT: &str = "/open-apis/contact/v3/unit";
pub const CONTACT_V3_UNIT_BIND_DEPARTMENT: &str = "/open-apis/contact/v3/unit/bind_department";
pub const CONTACT_V3_UNIT_UNBIND_DEPARTMENT: &str = "/open-apis/contact/v3/unit/unbind_department";
pub const CONTACT_V3_UNIT_LIST_DEPARTMENT: &str = "/open-apis/contact/v3/unit/list_department";

/// Contact 职级 v3
pub const CONTACT_V3_JOB_LEVELS: &str = "/open-apis/contact/v3/job_levels";

/// Contact 序列 v3
pub const CONTACT_V3_JOB_FAMILIES: &str = "/open-apis/contact/v3/job_families";

/// Contact 职务 v3
pub const CONTACT_V3_JOB_TITLES: &str = "/open-apis/contact/v3/job_titles";

/// Contact 工作城市 v3
pub const CONTACT_V3_WORK_CITIES: &str = "/open-apis/contact/v3/work_cities";

/// Contact 用户 v3
pub const CONTACT_V3_USERS: &str = "/open-apis/contact/v3/users";
pub const CONTACT_V3_USER: &str = "/open-apis/contact/v3/users/{user_id}";
pub const CONTACT_V3_USERS_BATCH: &str = "/open-apis/contact/v3/users/batch";
pub const CONTACT_V3_USERS_FIND_BY_DEPARTMENT: &str =
    "/open-apis/contact/v3/users/find_by_department";
pub const CONTACT_V3_USERS_BATCH_GET_ID: &str = "/open-apis/contact/v3/users/batch_get_id";
pub const CONTACT_V3_USER_UPDATE_USER_ID: &str =
    "/open-apis/contact/v3/users/{user_id}/update_user_id";
pub const CONTACT_V3_USER_RESURRECT: &str = "/open-apis/contact/v3/users/{user_id}/resurrect";

// ==================== User/Search ====================

/// 搜索用户
pub const SEARCH_V1_USER: &str = "/open-apis/search/v1/user";

/// 查询应用管理员列表
pub const USER_V4_APP_ADMIN_USER_LIST: &str = "/open-apis/user/v4/app_admin_user/list";

// ==================== 兼容性别名 ====================

/// 为保持向后兼容性，提供一些简短的别名
/// IM别名
pub const SEND_MESSAGE: &str = "/open-apis/im/v1/messages";
pub const CHAT_CREATE: &str = "/open-apis/im/v1/chats";

/// VC别名
pub const ROOM_LIST: &str = "/open-apis/vc/v1/rooms";
pub const MEETING_LIST: &str = "/open-apis/vc/v1/meetings";

/// Mail别名
pub const MAILGROUP_LIST: &str = "/open-apis/mail/v1/mailgroups";

#[cfg(test)]
#[allow(unused_imports)]
mod tests {
    use super::*;

    #[test]
    fn test_contact_v3_endpoints() {
        assert!(CONTACT_V3_SCOPES.starts_with("/open-apis/contact/v3/"));
        assert!(CONTACT_V3_DEPARTMENTS.contains("departments"));
        assert!(CONTACT_V3_FUNCTIONAL_ROLES.contains("functional_roles"));
        assert!(CONTACT_V3_GROUP.contains("group"));
        assert!(CONTACT_V3_USERS.contains("users"));
        assert!(CONTACT_V3_JOB_LEVELS.contains("job_levels"));
        assert!(CONTACT_V3_JOB_FAMILIES.contains("job_families"));
        assert!(CONTACT_V3_WORK_CITIES.contains("work_cities"));
    }

    #[test]
    fn test_contact_v2_endpoints() {
        assert!(CONTACT_V2_USER_BATCH_ADD.starts_with("/open-apis/contact/v2/"));
        assert!(CONTACT_V2_DEPARTMENT_BATCH_ADD.contains("department"));
        assert!(CONTACT_V2_TASK_GET.contains("task"));
        assert!(CONTACT_V2_ROLE_LIST.contains("role"));
    }

    #[test]
    fn test_search_endpoints() {
        assert!(SEARCH_V1_USER.starts_with("/open-apis/search/v1/"));
        assert!(USER_V4_APP_ADMIN_USER_LIST.starts_with("/open-apis/user/v4/"));
    }

    #[test]
    fn test_backward_compatibility_aliases() {
        // 测试兼容性别名的值
        assert_eq!(SEND_MESSAGE, "/open-apis/im/v1/messages");
        assert_eq!(CHAT_CREATE, "/open-apis/im/v1/chats");
        assert_eq!(ROOM_LIST, "/open-apis/vc/v1/rooms");
        assert_eq!(MEETING_LIST, "/open-apis/vc/v1/meetings");
        assert_eq!(MAILGROUP_LIST, "/open-apis/mail/v1/mailgroups");
    }
}