@satorijs/adapter-lark 3.10.6 → 3.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/content.d.ts +211 -93
- package/lib/index.cjs +2954 -2474
- package/lib/internal.d.ts +4 -4
- package/lib/message.d.ts +2 -3
- package/lib/types/acs.d.ts +212 -172
- package/lib/types/admin.d.ts +331 -291
- package/lib/types/aily.d.ts +331 -216
- package/lib/types/apaas.d.ts +646 -494
- package/lib/types/application.d.ts +559 -458
- package/lib/types/approval.d.ts +826 -791
- package/lib/types/attendance.d.ts +1094 -994
- package/lib/types/auth.d.ts +66 -61
- package/lib/types/authen.d.ts +221 -186
- package/lib/types/baike.d.ts +258 -233
- package/lib/types/base.d.ts +74 -0
- package/lib/types/bitable.d.ts +830 -770
- package/lib/types/board.d.ts +29 -14
- package/lib/types/calendar.d.ts +660 -605
- package/lib/types/cardkit.d.ts +149 -134
- package/lib/types/compensation.d.ts +84 -49
- package/lib/types/contact.d.ts +1279 -1204
- package/lib/types/corehr.d.ts +4982 -4526
- package/lib/types/directory.d.ts +447 -0
- package/lib/types/docs.d.ts +28 -18
- package/lib/types/document_ai.d.ts +347 -252
- package/lib/types/docx.d.ts +428 -383
- package/lib/types/drive.d.ts +1093 -1048
- package/lib/types/ehr.d.ts +66 -51
- package/lib/types/event.d.ts +16 -6
- package/lib/types/helpdesk.d.ts +816 -741
- package/lib/types/hire.d.ts +3955 -3589
- package/lib/types/human_authentication.d.ts +32 -22
- package/lib/types/im.d.ts +1420 -1295
- package/lib/types/index.d.ts +1422 -330
- package/lib/types/lingo.d.ts +279 -249
- package/lib/types/mail.d.ts +1032 -675
- package/lib/types/mdm.d.ts +105 -37
- package/lib/types/minutes.d.ts +73 -26
- package/lib/types/moments.d.ts +23 -13
- package/lib/types/okr.d.ts +266 -225
- package/lib/types/optical_char_recognition.d.ts +22 -12
- package/lib/types/passport.d.ts +58 -48
- package/lib/types/payroll.d.ts +210 -53
- package/lib/types/performance.d.ts +463 -414
- package/lib/types/personal_settings.d.ts +93 -82
- package/lib/types/report.d.ts +79 -58
- package/lib/types/search.d.ts +265 -235
- package/lib/types/security_and_compliance.d.ts +30 -19
- package/lib/types/sheets.d.ts +356 -321
- package/lib/types/speech_to_text.d.ts +44 -34
- package/lib/types/task.d.ts +998 -1087
- package/lib/types/tenant.d.ts +25 -15
- package/lib/types/translation.d.ts +42 -32
- package/lib/types/trust_party.d.ts +81 -0
- package/lib/types/vc.d.ts +1218 -1123
- package/lib/types/verification.d.ts +11 -6
- package/lib/types/wiki.d.ts +270 -235
- package/lib/types/workplace.d.ts +58 -38
- package/lib/utils.d.ts +2 -2
- package/package.json +4 -4
- package/src/bot.ts +15 -15
- package/src/content.ts +230 -107
- package/src/internal.ts +29 -12
- package/src/message.ts +82 -111
- package/src/types/acs.ts +234 -186
- package/src/types/admin.ts +353 -305
- package/src/types/aily.ts +375 -233
- package/src/types/apaas.ts +754 -568
- package/src/types/application.ts +633 -507
- package/src/types/approval.ts +914 -872
- package/src/types/attendance.ts +1226 -1104
- package/src/types/auth.ts +72 -66
- package/src/types/authen.ts +233 -191
- package/src/types/baike.ts +276 -246
- package/src/types/base.ts +93 -0
- package/src/types/bitable.ts +966 -894
- package/src/types/board.ts +34 -16
- package/src/types/calendar.ts +751 -685
- package/src/types/cardkit.ts +164 -146
- package/src/types/compensation.ts +97 -55
- package/src/types/contact.ts +1465 -1375
- package/src/types/corehr.ts +5664 -5077
- package/src/types/directory.ts +569 -0
- package/src/types/docs.ts +31 -19
- package/src/types/document_ai.ts +401 -287
- package/src/types/docx.ts +492 -438
- package/src/types/drive.ts +1266 -1213
- package/src/types/ehr.ts +71 -53
- package/src/types/event.ts +19 -7
- package/src/types/helpdesk.ts +930 -840
- package/src/types/hire.ts +4453 -4019
- package/src/types/human_authentication.ts +35 -23
- package/src/types/im.ts +1626 -1476
- package/src/types/index.ts +1532 -346
- package/src/types/lingo.ts +299 -263
- package/src/types/mail.ts +1231 -779
- package/src/types/mdm.ts +122 -39
- package/src/types/minutes.ts +88 -28
- package/src/types/moments.ts +26 -14
- package/src/types/okr.ts +286 -238
- package/src/types/optical_char_recognition.ts +25 -13
- package/src/types/passport.ts +62 -50
- package/src/types/payroll.ts +254 -57
- package/src/types/performance.ts +528 -467
- package/src/types/personal_settings.ts +101 -89
- package/src/types/report.ts +86 -62
- package/src/types/search.ts +285 -249
- package/src/types/security_and_compliance.ts +33 -21
- package/src/types/sheets.ts +421 -379
- package/src/types/speech_to_text.ts +48 -36
- package/src/types/task.ts +1152 -1260
- package/src/types/tenant.ts +29 -17
- package/src/types/translation.ts +46 -34
- package/src/types/trust_party.ts +110 -0
- package/src/types/vc.ts +1397 -1283
- package/src/types/verification.ts +13 -7
- package/src/types/wiki.ts +293 -251
- package/src/types/workplace.ts +65 -41
- package/src/utils.ts +3 -3
package/src/types/mail.ts
CHANGED
|
@@ -1,851 +1,1303 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { Internal, Pagination } from '../internal'
|
|
1
|
+
import * as Lark from '.'
|
|
2
|
+
import { Internal, Paginated, Pagination } from '../internal'
|
|
3
3
|
|
|
4
4
|
declare module '../internal' {
|
|
5
5
|
interface Internal {
|
|
6
|
-
|
|
7
|
-
* 发送邮件
|
|
8
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message/send
|
|
9
|
-
*/
|
|
10
|
-
sendMailUserMailboxMessage(user_mailbox_id: string, body: SendMailUserMailboxMessageRequest): Promise<void>
|
|
11
|
-
/**
|
|
12
|
-
* 创建邮件组
|
|
13
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/create
|
|
14
|
-
*/
|
|
15
|
-
createMailMailgroup(body: CreateMailMailgroupRequest): Promise<CreateMailMailgroupResponse>
|
|
16
|
-
/**
|
|
17
|
-
* 删除邮件组
|
|
18
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/delete
|
|
19
|
-
*/
|
|
20
|
-
deleteMailMailgroup(mailgroup_id: string): Promise<void>
|
|
21
|
-
/**
|
|
22
|
-
* 修改邮件组部分信息
|
|
23
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/patch
|
|
24
|
-
*/
|
|
25
|
-
patchMailMailgroup(mailgroup_id: string, body: PatchMailMailgroupRequest): Promise<PatchMailMailgroupResponse>
|
|
26
|
-
/**
|
|
27
|
-
* 修改邮件组全部信息
|
|
28
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/update
|
|
29
|
-
*/
|
|
30
|
-
updateMailMailgroup(mailgroup_id: string, body: UpdateMailMailgroupRequest): Promise<UpdateMailMailgroupResponse>
|
|
31
|
-
/**
|
|
32
|
-
* 查询指定邮件组
|
|
33
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/get
|
|
34
|
-
*/
|
|
35
|
-
getMailMailgroup(mailgroup_id: string): Promise<GetMailMailgroupResponse>
|
|
36
|
-
/**
|
|
37
|
-
* 批量获取邮件组
|
|
38
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/list
|
|
39
|
-
*/
|
|
40
|
-
listMailMailgroup(query?: ListMailMailgroupQuery): Paginated<Mailgroup>
|
|
41
|
-
/**
|
|
42
|
-
* 批量创建邮件组管理员
|
|
43
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_create
|
|
44
|
-
*/
|
|
45
|
-
batchCreateMailMailgroupManager(mailgroup_id: string, body: BatchCreateMailMailgroupManagerRequest, query?: BatchCreateMailMailgroupManagerQuery): Promise<void>
|
|
46
|
-
/**
|
|
47
|
-
* 批量删除邮件组管理员
|
|
48
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_delete
|
|
49
|
-
*/
|
|
50
|
-
batchDeleteMailMailgroupManager(mailgroup_id: string, body: BatchDeleteMailMailgroupManagerRequest, query?: BatchDeleteMailMailgroupManagerQuery): Promise<void>
|
|
51
|
-
/**
|
|
52
|
-
* 批量获取邮件组管理员
|
|
53
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/list
|
|
54
|
-
*/
|
|
55
|
-
listMailMailgroupManager(mailgroup_id: string, query?: ListMailMailgroupManagerQuery): Paginated<MailgroupManager>
|
|
56
|
-
/**
|
|
57
|
-
* 创建邮件组成员
|
|
58
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/create
|
|
59
|
-
*/
|
|
60
|
-
createMailMailgroupMember(mailgroup_id: string, body: CreateMailMailgroupMemberRequest, query?: CreateMailMailgroupMemberQuery): Promise<CreateMailMailgroupMemberResponse>
|
|
61
|
-
/**
|
|
62
|
-
* 删除邮件组成员
|
|
63
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/delete
|
|
64
|
-
*/
|
|
65
|
-
deleteMailMailgroupMember(mailgroup_id: string, member_id: string): Promise<void>
|
|
66
|
-
/**
|
|
67
|
-
* 查询指定邮件组成员
|
|
68
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/get
|
|
69
|
-
*/
|
|
70
|
-
getMailMailgroupMember(mailgroup_id: string, member_id: string, query?: GetMailMailgroupMemberQuery): Promise<GetMailMailgroupMemberResponse>
|
|
71
|
-
/**
|
|
72
|
-
* 获取所有邮件组成员
|
|
73
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/list
|
|
74
|
-
*/
|
|
75
|
-
listMailMailgroupMember(mailgroup_id: string, query?: ListMailMailgroupMemberQuery): Paginated<MailgroupMember>
|
|
76
|
-
/**
|
|
77
|
-
* 批量创建邮件组成员
|
|
78
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_create
|
|
79
|
-
*/
|
|
80
|
-
batchCreateMailMailgroupMember(mailgroup_id: string, body: BatchCreateMailMailgroupMemberRequest, query?: BatchCreateMailMailgroupMemberQuery): Promise<BatchCreateMailMailgroupMemberResponse>
|
|
81
|
-
/**
|
|
82
|
-
* 批量删除邮件组成员
|
|
83
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_delete
|
|
84
|
-
*/
|
|
85
|
-
batchDeleteMailMailgroupMember(mailgroup_id: string, body: BatchDeleteMailMailgroupMemberRequest): Promise<void>
|
|
86
|
-
/**
|
|
87
|
-
* 创建邮件组别名
|
|
88
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/create
|
|
89
|
-
*/
|
|
90
|
-
createMailMailgroupAlias(mailgroup_id: string, body: CreateMailMailgroupAliasRequest): Promise<CreateMailMailgroupAliasResponse>
|
|
91
|
-
/**
|
|
92
|
-
* 删除邮件组别名
|
|
93
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/delete
|
|
94
|
-
*/
|
|
95
|
-
deleteMailMailgroupAlias(mailgroup_id: string, alias_id: string): Promise<void>
|
|
96
|
-
/**
|
|
97
|
-
* 获取邮件组所有别名
|
|
98
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/list
|
|
99
|
-
*/
|
|
100
|
-
listMailMailgroupAlias(mailgroup_id: string): Promise<ListMailMailgroupAliasResponse>
|
|
101
|
-
/**
|
|
102
|
-
* 创建邮件组权限成员
|
|
103
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/create
|
|
104
|
-
*/
|
|
105
|
-
createMailMailgroupPermissionMember(mailgroup_id: string, body: CreateMailMailgroupPermissionMemberRequest, query?: CreateMailMailgroupPermissionMemberQuery): Promise<CreateMailMailgroupPermissionMemberResponse>
|
|
106
|
-
/**
|
|
107
|
-
* 删除邮件组权限成员
|
|
108
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/delete
|
|
109
|
-
*/
|
|
110
|
-
deleteMailMailgroupPermissionMember(mailgroup_id: string, permission_member_id: string): Promise<void>
|
|
111
|
-
/**
|
|
112
|
-
* 获取邮件组权限成员
|
|
113
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/get
|
|
114
|
-
*/
|
|
115
|
-
getMailMailgroupPermissionMember(mailgroup_id: string, permission_member_id: string, query?: GetMailMailgroupPermissionMemberQuery): Promise<GetMailMailgroupPermissionMemberResponse>
|
|
116
|
-
/**
|
|
117
|
-
* 批量获取邮件组权限成员
|
|
118
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/list
|
|
119
|
-
*/
|
|
120
|
-
listMailMailgroupPermissionMember(mailgroup_id: string, query?: ListMailMailgroupPermissionMemberQuery): Paginated<MailgroupPermissionMember>
|
|
121
|
-
/**
|
|
122
|
-
* 批量创建邮件组权限成员
|
|
123
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_create
|
|
124
|
-
*/
|
|
125
|
-
batchCreateMailMailgroupPermissionMember(mailgroup_id: string, body: BatchCreateMailMailgroupPermissionMemberRequest, query?: BatchCreateMailMailgroupPermissionMemberQuery): Promise<BatchCreateMailMailgroupPermissionMemberResponse>
|
|
126
|
-
/**
|
|
127
|
-
* 批量删除邮件组权限成员
|
|
128
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_delete
|
|
129
|
-
*/
|
|
130
|
-
batchDeleteMailMailgroupPermissionMember(mailgroup_id: string, body: BatchDeleteMailMailgroupPermissionMemberRequest): Promise<void>
|
|
131
|
-
/**
|
|
132
|
-
* 创建公共邮箱
|
|
133
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/create
|
|
134
|
-
*/
|
|
135
|
-
createMailPublicMailbox(body: CreateMailPublicMailboxRequest): Promise<CreateMailPublicMailboxResponse>
|
|
136
|
-
/**
|
|
137
|
-
* 修改公共邮箱部分信息
|
|
138
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/patch
|
|
139
|
-
*/
|
|
140
|
-
patchMailPublicMailbox(public_mailbox_id: string, body: PatchMailPublicMailboxRequest): Promise<PatchMailPublicMailboxResponse>
|
|
141
|
-
/**
|
|
142
|
-
* 修改公共邮箱全部信息
|
|
143
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/update
|
|
144
|
-
*/
|
|
145
|
-
updateMailPublicMailbox(public_mailbox_id: string, body: UpdateMailPublicMailboxRequest): Promise<UpdateMailPublicMailboxResponse>
|
|
146
|
-
/**
|
|
147
|
-
* 查询指定公共邮箱
|
|
148
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/get
|
|
149
|
-
*/
|
|
150
|
-
getMailPublicMailbox(public_mailbox_id: string): Promise<GetMailPublicMailboxResponse>
|
|
151
|
-
/**
|
|
152
|
-
* 查询所有公共邮箱
|
|
153
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/list
|
|
154
|
-
*/
|
|
155
|
-
listMailPublicMailbox(query?: Pagination): Paginated<PublicMailbox>
|
|
156
|
-
/**
|
|
157
|
-
* 永久删除公共邮箱
|
|
158
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/delete
|
|
159
|
-
*/
|
|
160
|
-
deleteMailPublicMailbox(public_mailbox_id: string): Promise<void>
|
|
161
|
-
/**
|
|
162
|
-
* 添加公共邮箱成员
|
|
163
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/create
|
|
164
|
-
*/
|
|
165
|
-
createMailPublicMailboxMember(public_mailbox_id: string, body: CreateMailPublicMailboxMemberRequest, query?: CreateMailPublicMailboxMemberQuery): Promise<CreateMailPublicMailboxMemberResponse>
|
|
166
|
-
/**
|
|
167
|
-
* 删除公共邮箱单个成员
|
|
168
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/delete
|
|
169
|
-
*/
|
|
170
|
-
deleteMailPublicMailboxMember(public_mailbox_id: string, member_id: string): Promise<void>
|
|
171
|
-
/**
|
|
172
|
-
* 删除公共邮箱所有成员
|
|
173
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/clear
|
|
174
|
-
*/
|
|
175
|
-
clearMailPublicMailboxMember(public_mailbox_id: string): Promise<void>
|
|
176
|
-
/**
|
|
177
|
-
* 查询指定公共邮箱成员信息
|
|
178
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/get
|
|
179
|
-
*/
|
|
180
|
-
getMailPublicMailboxMember(public_mailbox_id: string, member_id: string, query?: GetMailPublicMailboxMemberQuery): Promise<GetMailPublicMailboxMemberResponse>
|
|
181
|
-
/**
|
|
182
|
-
* 查询所有公共邮箱成员信息
|
|
183
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/list
|
|
184
|
-
*/
|
|
185
|
-
listMailPublicMailboxMember(public_mailbox_id: string, query?: ListMailPublicMailboxMemberQuery): Paginated<PublicMailboxMember>
|
|
186
|
-
/**
|
|
187
|
-
* 批量添加公共邮箱成员
|
|
188
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_create
|
|
189
|
-
*/
|
|
190
|
-
batchCreateMailPublicMailboxMember(public_mailbox_id: string, body: BatchCreateMailPublicMailboxMemberRequest, query?: BatchCreateMailPublicMailboxMemberQuery): Promise<BatchCreateMailPublicMailboxMemberResponse>
|
|
191
|
-
/**
|
|
192
|
-
* 批量删除公共邮箱成员
|
|
193
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_delete
|
|
194
|
-
*/
|
|
195
|
-
batchDeleteMailPublicMailboxMember(public_mailbox_id: string, body: BatchDeleteMailPublicMailboxMemberRequest): Promise<void>
|
|
196
|
-
/**
|
|
197
|
-
* 创建公共邮箱别名
|
|
198
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/create
|
|
199
|
-
*/
|
|
200
|
-
createMailPublicMailboxAlias(public_mailbox_id: string, body: CreateMailPublicMailboxAliasRequest): Promise<CreateMailPublicMailboxAliasResponse>
|
|
201
|
-
/**
|
|
202
|
-
* 删除公共邮箱别名
|
|
203
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/delete
|
|
204
|
-
*/
|
|
205
|
-
deleteMailPublicMailboxAlias(public_mailbox_id: string, alias_id: string): Promise<void>
|
|
206
|
-
/**
|
|
207
|
-
* 查询公共邮箱的所有别名
|
|
208
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/list
|
|
209
|
-
*/
|
|
210
|
-
listMailPublicMailboxAlias(public_mailbox_id: string): Promise<ListMailPublicMailboxAliasResponse>
|
|
211
|
-
/**
|
|
212
|
-
* 从回收站删除用户邮箱地址
|
|
213
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox/delete
|
|
214
|
-
*/
|
|
215
|
-
deleteMailUserMailbox(user_mailbox_id: string, query?: DeleteMailUserMailboxQuery): Promise<void>
|
|
216
|
-
/**
|
|
217
|
-
* 创建用户邮箱别名
|
|
218
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/create
|
|
219
|
-
*/
|
|
220
|
-
createMailUserMailboxAlias(user_mailbox_id: string, body: CreateMailUserMailboxAliasRequest): Promise<CreateMailUserMailboxAliasResponse>
|
|
221
|
-
/**
|
|
222
|
-
* 删除用户邮箱别名
|
|
223
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/delete
|
|
224
|
-
*/
|
|
225
|
-
deleteMailUserMailboxAlias(user_mailbox_id: string, alias_id: string): Promise<void>
|
|
226
|
-
/**
|
|
227
|
-
* 获取用户邮箱所有别名
|
|
228
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/list
|
|
229
|
-
*/
|
|
230
|
-
listMailUserMailboxAlias(user_mailbox_id: string, query?: Pagination): Promise<ListMailUserMailboxAliasResponse>
|
|
231
|
-
/**
|
|
232
|
-
* 查询邮箱地址状态
|
|
233
|
-
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user/query
|
|
234
|
-
*/
|
|
235
|
-
queryMailUser(body: QueryMailUserRequest): Promise<QueryMailUserResponse>
|
|
6
|
+
mail: Mail.Methods
|
|
236
7
|
}
|
|
237
8
|
}
|
|
238
9
|
|
|
239
|
-
export
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
/** 抄送 */
|
|
247
|
-
cc?: MailAddress[]
|
|
248
|
-
/** 秘送 */
|
|
249
|
-
bcc?: MailAddress[]
|
|
250
|
-
/** 发件人 */
|
|
251
|
-
head_from?: MailAddress
|
|
252
|
-
/** 正文(base64url) */
|
|
253
|
-
body_html?: string
|
|
254
|
-
/** 正文纯文本(base64url) */
|
|
255
|
-
body_plain_text?: string
|
|
256
|
-
/** 邮件附件列表 */
|
|
257
|
-
attachments?: Attachment[]
|
|
258
|
-
/** 会话id */
|
|
259
|
-
thread_id?: string
|
|
260
|
-
}
|
|
261
|
-
|
|
262
|
-
export interface CreateMailMailgroupRequest {
|
|
263
|
-
/** The mail group's email address */
|
|
264
|
-
email?: string
|
|
265
|
-
/** The mail group's display name */
|
|
266
|
-
name?: string
|
|
267
|
-
/** The mail group's description */
|
|
268
|
-
description?: string
|
|
269
|
-
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
270
|
-
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
271
|
-
}
|
|
272
|
-
|
|
273
|
-
export interface CreateMailMailgroupResponse {
|
|
274
|
-
/** The unique ID of a mail group */
|
|
275
|
-
mailgroup_id?: string
|
|
276
|
-
/** The mail group's email address */
|
|
277
|
-
email?: string
|
|
278
|
-
/** The mail group's display name */
|
|
279
|
-
name?: string
|
|
280
|
-
/** The mail group's description */
|
|
281
|
-
description?: string
|
|
282
|
-
/** The number of mail group's direct members */
|
|
283
|
-
direct_members_count?: string
|
|
284
|
-
/** Value is true if this mail group has external member */
|
|
285
|
-
include_external_member?: boolean
|
|
286
|
-
/** Value is true if all company members are in this mail group */
|
|
287
|
-
include_all_company_member?: boolean
|
|
288
|
-
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
289
|
-
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
290
|
-
}
|
|
291
|
-
|
|
292
|
-
export interface PatchMailMailgroupRequest {
|
|
293
|
-
/** The public mailbox's new primary email address */
|
|
294
|
-
email?: string
|
|
295
|
-
/** The mail group's display name */
|
|
296
|
-
name?: string
|
|
297
|
-
/** The mail group's description */
|
|
298
|
-
description?: string
|
|
299
|
-
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
300
|
-
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
301
|
-
}
|
|
302
|
-
|
|
303
|
-
export interface PatchMailMailgroupResponse {
|
|
304
|
-
/** The unique ID of a mail group */
|
|
305
|
-
mailgroup_id?: string
|
|
306
|
-
/** The mail group's email address */
|
|
307
|
-
email?: string
|
|
308
|
-
/** The mail group's display name */
|
|
309
|
-
name?: string
|
|
310
|
-
/** The mail group's description */
|
|
311
|
-
description?: string
|
|
312
|
-
/** The number of mail group's direct members */
|
|
313
|
-
direct_members_count?: string
|
|
314
|
-
/** Value is true if this mail group has external member */
|
|
315
|
-
include_external_member?: boolean
|
|
316
|
-
/** Value is true if all company members are in this mail group */
|
|
317
|
-
include_all_company_member?: boolean
|
|
318
|
-
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
319
|
-
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
320
|
-
}
|
|
321
|
-
|
|
322
|
-
export interface UpdateMailMailgroupRequest {
|
|
323
|
-
/** The public mailbox's new primary email address */
|
|
324
|
-
email?: string
|
|
325
|
-
/** The mail group's display name */
|
|
326
|
-
name?: string
|
|
327
|
-
/** The mail group's description */
|
|
328
|
-
description?: string
|
|
329
|
-
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
330
|
-
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
331
|
-
}
|
|
332
|
-
|
|
333
|
-
export interface UpdateMailMailgroupResponse {
|
|
334
|
-
/** The unique ID of a mail group */
|
|
335
|
-
mailgroup_id?: string
|
|
336
|
-
/** The mail group's email address */
|
|
337
|
-
email?: string
|
|
338
|
-
/** The mail group's display name */
|
|
339
|
-
name?: string
|
|
340
|
-
/** The mail group's description */
|
|
341
|
-
description?: string
|
|
342
|
-
/** The number of mail group's direct members */
|
|
343
|
-
direct_members_count?: string
|
|
344
|
-
/** Value is true if this mail group has external member */
|
|
345
|
-
include_external_member?: boolean
|
|
346
|
-
/** Value is true if all company members are in this mail group */
|
|
347
|
-
include_all_company_member?: boolean
|
|
348
|
-
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
349
|
-
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
350
|
-
}
|
|
351
|
-
|
|
352
|
-
export interface GetMailMailgroupResponse {
|
|
353
|
-
/** The unique ID of a mail group */
|
|
354
|
-
mailgroup_id?: string
|
|
355
|
-
/** The mail group's email address */
|
|
356
|
-
email?: string
|
|
357
|
-
/** The mail group's display name */
|
|
358
|
-
name?: string
|
|
359
|
-
/** The mail group's description */
|
|
360
|
-
description?: string
|
|
361
|
-
/** The number of mail group's direct members */
|
|
362
|
-
direct_members_count?: string
|
|
363
|
-
/** Value is true if this mail group has external member */
|
|
364
|
-
include_external_member?: boolean
|
|
365
|
-
/** Value is true if all company members are in this mail group */
|
|
366
|
-
include_all_company_member?: boolean
|
|
367
|
-
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
368
|
-
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
369
|
-
}
|
|
370
|
-
|
|
371
|
-
export interface ListMailMailgroupQuery extends Pagination {
|
|
372
|
-
/** 邮件组管理员用户ID,用于获取该用户有管理权限的邮件组 */
|
|
373
|
-
manager_user_id?: string
|
|
374
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
375
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
376
|
-
}
|
|
377
|
-
|
|
378
|
-
export interface BatchCreateMailMailgroupManagerRequest {
|
|
379
|
-
/** 邮件组管理员列表 */
|
|
380
|
-
mailgroup_manager_list?: MailgroupManager[]
|
|
381
|
-
}
|
|
382
|
-
|
|
383
|
-
export interface BatchCreateMailMailgroupManagerQuery {
|
|
384
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
385
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
386
|
-
}
|
|
387
|
-
|
|
388
|
-
export interface BatchDeleteMailMailgroupManagerRequest {
|
|
389
|
-
/** 邮件组管理员列表 */
|
|
390
|
-
mailgroup_manager_list?: MailgroupManager[]
|
|
391
|
-
}
|
|
392
|
-
|
|
393
|
-
export interface BatchDeleteMailMailgroupManagerQuery {
|
|
394
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
395
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
396
|
-
}
|
|
397
|
-
|
|
398
|
-
export interface ListMailMailgroupManagerQuery extends Pagination {
|
|
399
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
400
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
401
|
-
}
|
|
402
|
-
|
|
403
|
-
export interface CreateMailMailgroupMemberRequest {
|
|
404
|
-
/** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */
|
|
405
|
-
email?: string
|
|
406
|
-
/** The member's user id. Value is valid when type is USER */
|
|
407
|
-
user_id?: string
|
|
408
|
-
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
409
|
-
department_id?: string
|
|
410
|
-
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
|
|
411
|
-
type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER'
|
|
412
|
-
}
|
|
413
|
-
|
|
414
|
-
export interface CreateMailMailgroupMemberQuery {
|
|
415
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
416
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
417
|
-
/** 此次调用中使用的部门ID的类型 */
|
|
418
|
-
department_id_type?: 'department_id' | 'open_department_id'
|
|
419
|
-
}
|
|
420
|
-
|
|
421
|
-
export interface CreateMailMailgroupMemberResponse {
|
|
422
|
-
/** The unique ID of a member in this mail group */
|
|
423
|
-
member_id?: string
|
|
424
|
-
/** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */
|
|
425
|
-
email?: string
|
|
426
|
-
/** The member's user id. Value is valid when type is USER */
|
|
427
|
-
user_id?: string
|
|
428
|
-
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
429
|
-
department_id?: string
|
|
430
|
-
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
|
|
431
|
-
type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER'
|
|
432
|
-
}
|
|
433
|
-
|
|
434
|
-
export interface GetMailMailgroupMemberQuery {
|
|
435
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
436
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
437
|
-
/** 此次调用中使用的部门ID的类型 */
|
|
438
|
-
department_id_type?: 'department_id' | 'open_department_id'
|
|
439
|
-
}
|
|
440
|
-
|
|
441
|
-
export interface GetMailMailgroupMemberResponse {
|
|
442
|
-
/** The unique ID of a member in this mail group */
|
|
443
|
-
member_id?: string
|
|
444
|
-
/** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */
|
|
445
|
-
email?: string
|
|
446
|
-
/** The member's user id. Value is valid when type is USER */
|
|
447
|
-
user_id?: string
|
|
448
|
-
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
449
|
-
department_id?: string
|
|
450
|
-
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
|
|
451
|
-
type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER'
|
|
452
|
-
}
|
|
453
|
-
|
|
454
|
-
export interface ListMailMailgroupMemberQuery extends Pagination {
|
|
455
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
456
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
457
|
-
/** 此次调用中使用的部门ID的类型 */
|
|
458
|
-
department_id_type?: 'department_id' | 'open_department_id'
|
|
459
|
-
}
|
|
460
|
-
|
|
461
|
-
export interface BatchCreateMailMailgroupMemberRequest {
|
|
462
|
-
/** 本次添加的邮件组成员列表 */
|
|
463
|
-
items?: MailgroupMember[]
|
|
464
|
-
}
|
|
465
|
-
|
|
466
|
-
export interface BatchCreateMailMailgroupMemberQuery {
|
|
467
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
468
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
469
|
-
/** 此次调用中使用的部门ID的类型 */
|
|
470
|
-
department_id_type?: 'department_id' | 'open_department_id'
|
|
471
|
-
}
|
|
472
|
-
|
|
473
|
-
export interface BatchCreateMailMailgroupMemberResponse {
|
|
474
|
-
/** 添加成功后的邮件组成员信息列表 */
|
|
475
|
-
items?: MailgroupMember[]
|
|
476
|
-
}
|
|
477
|
-
|
|
478
|
-
export interface BatchDeleteMailMailgroupMemberRequest {
|
|
479
|
-
/** 本次调用删除的成员ID列表 */
|
|
480
|
-
member_id_list?: string[]
|
|
481
|
-
}
|
|
482
|
-
|
|
483
|
-
export interface CreateMailMailgroupAliasRequest {
|
|
484
|
-
/** 邮箱别名 */
|
|
485
|
-
email_alias?: string
|
|
486
|
-
}
|
|
487
|
-
|
|
488
|
-
export interface CreateMailMailgroupAliasResponse {
|
|
489
|
-
/** 邮件组别名 */
|
|
490
|
-
mailgroup_alias?: EmailAlias
|
|
491
|
-
}
|
|
492
|
-
|
|
493
|
-
export interface ListMailMailgroupAliasResponse {
|
|
494
|
-
/** 邮件组别名 */
|
|
495
|
-
items?: EmailAlias[]
|
|
496
|
-
}
|
|
497
|
-
|
|
498
|
-
export interface CreateMailMailgroupPermissionMemberRequest {
|
|
499
|
-
/** The member's user id. Value is valid when type is USER */
|
|
500
|
-
user_id?: string
|
|
501
|
-
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
502
|
-
department_id?: string
|
|
503
|
-
/** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
|
|
504
|
-
email?: string
|
|
505
|
-
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
|
|
506
|
-
type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX'
|
|
507
|
-
}
|
|
508
|
-
|
|
509
|
-
export interface CreateMailMailgroupPermissionMemberQuery {
|
|
510
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
511
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
512
|
-
/** 此次调用中使用的部门ID的类型 */
|
|
513
|
-
department_id_type?: 'department_id' | 'open_department_id'
|
|
514
|
-
}
|
|
515
|
-
|
|
516
|
-
export interface CreateMailMailgroupPermissionMemberResponse {
|
|
517
|
-
/** The unique ID of a member in this permission group */
|
|
518
|
-
permission_member_id?: string
|
|
519
|
-
/** The member's user id. Value is valid when type is USER */
|
|
520
|
-
user_id?: string
|
|
521
|
-
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
522
|
-
department_id?: string
|
|
523
|
-
/** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
|
|
524
|
-
email?: string
|
|
525
|
-
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
|
|
526
|
-
type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX'
|
|
527
|
-
}
|
|
528
|
-
|
|
529
|
-
export interface GetMailMailgroupPermissionMemberQuery {
|
|
530
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
531
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
532
|
-
/** 此次调用中使用的部门ID的类型 */
|
|
533
|
-
department_id_type?: 'department_id' | 'open_department_id'
|
|
534
|
-
}
|
|
535
|
-
|
|
536
|
-
export interface GetMailMailgroupPermissionMemberResponse {
|
|
537
|
-
/** The unique ID of a member in this permission group */
|
|
538
|
-
permission_member_id?: string
|
|
539
|
-
/** The member's user id. Value is valid when type is USER */
|
|
540
|
-
user_id?: string
|
|
541
|
-
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
542
|
-
department_id?: string
|
|
543
|
-
/** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
|
|
544
|
-
email?: string
|
|
545
|
-
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
|
|
546
|
-
type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX'
|
|
547
|
-
}
|
|
548
|
-
|
|
549
|
-
export interface ListMailMailgroupPermissionMemberQuery extends Pagination {
|
|
550
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
551
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
552
|
-
/** 此次调用中使用的部门ID的类型 */
|
|
553
|
-
department_id_type?: 'department_id' | 'open_department_id'
|
|
554
|
-
}
|
|
555
|
-
|
|
556
|
-
export interface BatchCreateMailMailgroupPermissionMemberRequest {
|
|
557
|
-
/** 本次添加的邮件组权限成员列表 */
|
|
558
|
-
items?: MailgroupPermissionMember[]
|
|
559
|
-
}
|
|
560
|
-
|
|
561
|
-
export interface BatchCreateMailMailgroupPermissionMemberQuery {
|
|
562
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
563
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
564
|
-
/** 此次调用中使用的部门ID的类型 */
|
|
565
|
-
department_id_type?: 'department_id' | 'open_department_id'
|
|
566
|
-
}
|
|
567
|
-
|
|
568
|
-
export interface BatchCreateMailMailgroupPermissionMemberResponse {
|
|
569
|
-
/** 添加成功后的邮件组权限成员信息列表 */
|
|
570
|
-
items?: MailgroupPermissionMember[]
|
|
571
|
-
}
|
|
572
|
-
|
|
573
|
-
export interface BatchDeleteMailMailgroupPermissionMemberRequest {
|
|
574
|
-
/** 本次调用删除的权限成员ID列表 */
|
|
575
|
-
permission_member_id_list: string[]
|
|
576
|
-
}
|
|
577
|
-
|
|
578
|
-
export interface CreateMailPublicMailboxRequest {
|
|
579
|
-
/** The public mailbox's email address */
|
|
580
|
-
email?: string
|
|
581
|
-
/** The public mailbox's display name */
|
|
582
|
-
name?: string
|
|
583
|
-
/** 数据驻留地 */
|
|
584
|
-
geo?: string
|
|
585
|
-
}
|
|
586
|
-
|
|
587
|
-
export interface CreateMailPublicMailboxResponse {
|
|
588
|
-
/** The unique ID of a public mailbox */
|
|
589
|
-
public_mailbox_id?: string
|
|
590
|
-
/** The public mailbox's email address */
|
|
591
|
-
email?: string
|
|
592
|
-
/** The public mailbox's display name */
|
|
593
|
-
name?: string
|
|
594
|
-
/** 数据驻留地 */
|
|
595
|
-
geo?: string
|
|
596
|
-
}
|
|
597
|
-
|
|
598
|
-
export interface PatchMailPublicMailboxRequest {
|
|
599
|
-
/** The public mailbox's new primary email address */
|
|
600
|
-
email?: string
|
|
601
|
-
/** The public mailbox's display name */
|
|
602
|
-
name?: string
|
|
603
|
-
}
|
|
604
|
-
|
|
605
|
-
export interface PatchMailPublicMailboxResponse {
|
|
606
|
-
/** The unique ID of a public mailbox */
|
|
607
|
-
public_mailbox_id?: string
|
|
608
|
-
/** The public mailbox's email address */
|
|
609
|
-
email?: string
|
|
610
|
-
/** The public mailbox's display name */
|
|
611
|
-
name?: string
|
|
612
|
-
}
|
|
613
|
-
|
|
614
|
-
export interface UpdateMailPublicMailboxRequest {
|
|
615
|
-
/** The public mailbox's new primary email address */
|
|
616
|
-
email?: string
|
|
617
|
-
/** The public mailbox's display name */
|
|
618
|
-
name?: string
|
|
619
|
-
}
|
|
620
|
-
|
|
621
|
-
export interface UpdateMailPublicMailboxResponse {
|
|
622
|
-
/** The unique ID of a public mailbox */
|
|
623
|
-
public_mailbox_id?: string
|
|
624
|
-
/** The public mailbox's email address */
|
|
625
|
-
email?: string
|
|
626
|
-
/** The public mailbox's display name */
|
|
627
|
-
name?: string
|
|
628
|
-
}
|
|
629
|
-
|
|
630
|
-
export interface GetMailPublicMailboxResponse {
|
|
631
|
-
/** The unique ID of a public mailbox */
|
|
632
|
-
public_mailbox_id?: string
|
|
633
|
-
/** The public mailbox's email address */
|
|
634
|
-
email?: string
|
|
635
|
-
/** The public mailbox's display name */
|
|
636
|
-
name?: string
|
|
637
|
-
/** 数据驻留地 */
|
|
638
|
-
geo?: string
|
|
639
|
-
}
|
|
640
|
-
|
|
641
|
-
export interface CreateMailPublicMailboxMemberRequest {
|
|
642
|
-
/** The member's user id. Value is valid when type is USER */
|
|
643
|
-
user_id?: string
|
|
644
|
-
/** The type of member. Possible values are:- USER: internal user in the team */
|
|
645
|
-
type?: 'USER'
|
|
646
|
-
}
|
|
647
|
-
|
|
648
|
-
export interface CreateMailPublicMailboxMemberQuery {
|
|
649
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
650
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
651
|
-
}
|
|
652
|
-
|
|
653
|
-
export interface CreateMailPublicMailboxMemberResponse {
|
|
654
|
-
/** The unique ID of a member in this public mailbox */
|
|
655
|
-
member_id?: string
|
|
656
|
-
/** The member's user id. Value is valid when type is USER */
|
|
657
|
-
user_id?: string
|
|
658
|
-
/** The type of member. Possible values are:- USER: internal user in the team */
|
|
659
|
-
type?: 'USER'
|
|
660
|
-
}
|
|
661
|
-
|
|
662
|
-
export interface GetMailPublicMailboxMemberQuery {
|
|
663
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
664
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
665
|
-
}
|
|
666
|
-
|
|
667
|
-
export interface GetMailPublicMailboxMemberResponse {
|
|
668
|
-
/** The unique ID of a member in this public mailbox */
|
|
669
|
-
member_id?: string
|
|
670
|
-
/** The member's user id. Value is valid when type is USER */
|
|
671
|
-
user_id?: string
|
|
672
|
-
/** The type of member. Possible values are:- USER: internal user in the team */
|
|
673
|
-
type?: 'USER'
|
|
674
|
-
}
|
|
675
|
-
|
|
676
|
-
export interface ListMailPublicMailboxMemberQuery extends Pagination {
|
|
677
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
678
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
679
|
-
}
|
|
680
|
-
|
|
681
|
-
export interface BatchCreateMailPublicMailboxMemberRequest {
|
|
682
|
-
/** 本次调用添加的公共邮箱成员列表 */
|
|
683
|
-
items: PublicMailboxMember[]
|
|
684
|
-
}
|
|
685
|
-
|
|
686
|
-
export interface BatchCreateMailPublicMailboxMemberQuery {
|
|
687
|
-
/** 此次调用中使用的用户ID的类型 */
|
|
688
|
-
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
689
|
-
}
|
|
690
|
-
|
|
691
|
-
export interface BatchCreateMailPublicMailboxMemberResponse {
|
|
692
|
-
/** 添加成功后的公共邮箱成员信息列表 */
|
|
693
|
-
items?: PublicMailboxMember[]
|
|
694
|
-
}
|
|
695
|
-
|
|
696
|
-
export interface BatchDeleteMailPublicMailboxMemberRequest {
|
|
697
|
-
/** 本次调用删除的公共邮箱成员ID列表 */
|
|
698
|
-
member_id_list: string[]
|
|
699
|
-
}
|
|
700
|
-
|
|
701
|
-
export interface CreateMailPublicMailboxAliasRequest {
|
|
702
|
-
/** 邮箱别名 */
|
|
703
|
-
email_alias?: string
|
|
704
|
-
}
|
|
705
|
-
|
|
706
|
-
export interface CreateMailPublicMailboxAliasResponse {
|
|
707
|
-
/** 公共邮箱别名 */
|
|
708
|
-
public_mailbox_alias?: EmailAlias
|
|
709
|
-
}
|
|
710
|
-
|
|
711
|
-
export interface ListMailPublicMailboxAliasResponse {
|
|
712
|
-
/** 公共邮箱别名 */
|
|
713
|
-
items?: EmailAlias[]
|
|
714
|
-
}
|
|
715
|
-
|
|
716
|
-
export interface DeleteMailUserMailboxQuery {
|
|
717
|
-
/** 用于接受转移的邮箱地址 */
|
|
718
|
-
transfer_mailbox?: string
|
|
719
|
-
}
|
|
720
|
-
|
|
721
|
-
export interface CreateMailUserMailboxAliasRequest {
|
|
722
|
-
/** 邮箱别名 */
|
|
723
|
-
email_alias?: string
|
|
724
|
-
}
|
|
10
|
+
export namespace Mail {
|
|
11
|
+
export interface Methods {
|
|
12
|
+
userMailbox: UserMailbox.Methods
|
|
13
|
+
mailgroup: Mailgroup.Methods
|
|
14
|
+
publicMailbox: PublicMailbox.Methods
|
|
15
|
+
user: User.Methods
|
|
16
|
+
}
|
|
725
17
|
|
|
726
|
-
export
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
18
|
+
export namespace UserMailbox {
|
|
19
|
+
export interface Methods {
|
|
20
|
+
folder: Folder.Methods
|
|
21
|
+
message: Message.Methods
|
|
22
|
+
event: Event.Methods
|
|
23
|
+
rule: Rule.Methods
|
|
24
|
+
mailContact: MailContact.Methods
|
|
25
|
+
alias: Alias.Methods
|
|
26
|
+
/**
|
|
27
|
+
* 从回收站删除用户邮箱地址
|
|
28
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox/delete
|
|
29
|
+
*/
|
|
30
|
+
delete(user_mailbox_id: string, query?: DeleteQuery): Promise<void>
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
export interface DeleteQuery {
|
|
34
|
+
/** 用于接受转移的邮箱地址 */
|
|
35
|
+
transfer_mailbox?: string
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export namespace Folder {
|
|
39
|
+
export interface Methods {
|
|
40
|
+
/**
|
|
41
|
+
* 创建邮箱文件夹
|
|
42
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-folder/create
|
|
43
|
+
*/
|
|
44
|
+
create(user_mailbox_id: string, body: CreateRequest): Promise<CreateResponse>
|
|
45
|
+
/**
|
|
46
|
+
* 删除邮箱文件夹
|
|
47
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-folder/delete
|
|
48
|
+
*/
|
|
49
|
+
delete(user_mailbox_id: string, folder_id: string): Promise<void>
|
|
50
|
+
/**
|
|
51
|
+
* 修改邮箱文件夹
|
|
52
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-folder/patch
|
|
53
|
+
*/
|
|
54
|
+
patch(user_mailbox_id: string, folder_id: string, body: PatchRequest): Promise<void>
|
|
55
|
+
/**
|
|
56
|
+
* 列出邮箱文件夹
|
|
57
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-folder/list
|
|
58
|
+
*/
|
|
59
|
+
list(user_mailbox_id: string, query?: ListQuery): Promise<ListResponse>
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export interface CreateRequest {
|
|
63
|
+
/** 文件夹名称 */
|
|
64
|
+
name: string
|
|
65
|
+
/** 父文件夹 id,该值为 0 表示根文件夹 */
|
|
66
|
+
parent_folder_id: string
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export interface CreateResponse {
|
|
70
|
+
/** 文件夹实体 */
|
|
71
|
+
folder?: Lark.Folder
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
export interface PatchRequest {
|
|
75
|
+
/** 文件夹名称 */
|
|
76
|
+
name?: string
|
|
77
|
+
/** 父文件夹 id,该值为 0 表示根文件夹 */
|
|
78
|
+
parent_folder_id?: string
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
export const enum ListQueryFolderType {
|
|
82
|
+
/** 系统文件夹 */
|
|
83
|
+
System = 1,
|
|
84
|
+
/** 用户文件夹 */
|
|
85
|
+
User = 2,
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
export interface ListQuery {
|
|
89
|
+
/** 文件夹类型 */
|
|
90
|
+
folder_type?: ListQueryFolderType
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
export interface ListResponse {
|
|
94
|
+
/** 文件夹列表 */
|
|
95
|
+
items?: Lark.Folder[]
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
export namespace Message {
|
|
100
|
+
export interface Methods {
|
|
101
|
+
attachment: Attachment.Methods
|
|
102
|
+
/**
|
|
103
|
+
* 获取邮件卡片的邮件列表
|
|
104
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message/get_by_card
|
|
105
|
+
*/
|
|
106
|
+
getByCard(user_mailbox_id: string, query?: GetByCardQuery): Promise<GetByCardResponse>
|
|
107
|
+
/**
|
|
108
|
+
* 列出邮件
|
|
109
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message/list
|
|
110
|
+
*/
|
|
111
|
+
list(user_mailbox_id: string, query?: ListQuery): Paginated<string>
|
|
112
|
+
/**
|
|
113
|
+
* 获取邮件详情
|
|
114
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message/get
|
|
115
|
+
*/
|
|
116
|
+
get(user_mailbox_id: string, message_id: string): Promise<GetResponse>
|
|
117
|
+
/**
|
|
118
|
+
* 发送邮件
|
|
119
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message/send
|
|
120
|
+
*/
|
|
121
|
+
send(user_mailbox_id: string, body: SendRequest): Promise<void>
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
export interface GetByCardQuery {
|
|
125
|
+
/** 卡片ID */
|
|
126
|
+
card_id: string
|
|
127
|
+
/** 卡片OwnerID */
|
|
128
|
+
owner_id: string
|
|
129
|
+
/** 用户ID类型 */
|
|
130
|
+
user_id_type?: 'open_id' | 'user_id' | 'union_id'
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
export interface GetByCardResponse {
|
|
134
|
+
/** 邮件Owner信息 */
|
|
135
|
+
owner_info: Lark.UserInfo
|
|
136
|
+
/** 邮件ID列表 */
|
|
137
|
+
message_ids: string[]
|
|
138
|
+
/** 卡片ID */
|
|
139
|
+
card_id: string
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
export interface ListQuery extends Pagination {
|
|
143
|
+
/** 文件夹 id */
|
|
144
|
+
folder_id: string
|
|
145
|
+
/** 是否只查询未读邮件 */
|
|
146
|
+
only_unread?: boolean
|
|
147
|
+
}
|
|
148
|
+
|
|
149
|
+
export interface GetResponse {
|
|
150
|
+
/** 邮件体 */
|
|
151
|
+
message?: Lark.Message
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
export interface SendRequest {
|
|
155
|
+
/** MIME邮件数据,基于base64url编码 */
|
|
156
|
+
raw?: string
|
|
157
|
+
/** 主题 */
|
|
158
|
+
subject?: string
|
|
159
|
+
/** 收件人 */
|
|
160
|
+
to?: Lark.MailAddress[]
|
|
161
|
+
/** 抄送 */
|
|
162
|
+
cc?: Lark.MailAddress[]
|
|
163
|
+
/** 秘送 */
|
|
164
|
+
bcc?: Lark.MailAddress[]
|
|
165
|
+
/** 发件人 */
|
|
166
|
+
head_from?: Lark.MailAddress
|
|
167
|
+
/** 正文(base64url) */
|
|
168
|
+
body_html?: string
|
|
169
|
+
/** 正文纯文本(base64url) */
|
|
170
|
+
body_plain_text?: string
|
|
171
|
+
/** 邮件附件列表 */
|
|
172
|
+
attachments?: Lark.Attachment[]
|
|
173
|
+
/** 会话id */
|
|
174
|
+
thread_id?: string
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
export namespace Attachment {
|
|
178
|
+
export interface Methods {
|
|
179
|
+
/**
|
|
180
|
+
* 获取附件下载链接
|
|
181
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message-attachment/download_url
|
|
182
|
+
*/
|
|
183
|
+
downloadUrl(user_mailbox_id: string, message_id: string, query?: DownloadUrlQuery): Promise<DownloadUrlResponse>
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
export interface DownloadUrlQuery {
|
|
187
|
+
/** 附件 id 列表 */
|
|
188
|
+
attachment_ids: string[]
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
export interface DownloadUrlResponse {
|
|
192
|
+
/** 下载链接列表 */
|
|
193
|
+
download_urls?: Lark.AttachmentDownloadUrlItem[]
|
|
194
|
+
/** 获取失败的附件 id 列表 */
|
|
195
|
+
failed_ids?: string[]
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
export namespace Event {
|
|
201
|
+
export interface Methods {
|
|
202
|
+
/**
|
|
203
|
+
* 订阅事件
|
|
204
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-event/subscribe
|
|
205
|
+
*/
|
|
206
|
+
subscribe(user_mailbox_id: string, body: SubscribeRequest): Promise<void>
|
|
207
|
+
/**
|
|
208
|
+
* 获取订阅状态
|
|
209
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-event/subscription
|
|
210
|
+
*/
|
|
211
|
+
subscription(user_mailbox_id: string): Promise<SubscriptionResponse>
|
|
212
|
+
/**
|
|
213
|
+
* 取消订阅
|
|
214
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-event/unsubscribe
|
|
215
|
+
*/
|
|
216
|
+
unsubscribe(user_mailbox_id: string, body: UnsubscribeRequest): Promise<void>
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
export const enum SubscribeRequestEventType {
|
|
220
|
+
/** 邮件相关事件 */
|
|
221
|
+
Message = 1,
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
export interface SubscribeRequest {
|
|
225
|
+
/** 事件类型 */
|
|
226
|
+
event_type: SubscribeRequestEventType
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
export interface SubscriptionResponse {
|
|
230
|
+
/** 订阅的事件列表 */
|
|
231
|
+
event_types?: number[]
|
|
232
|
+
}
|
|
233
|
+
|
|
234
|
+
export const enum UnsubscribeRequestEventType {
|
|
235
|
+
/** 邮件相关事件 */
|
|
236
|
+
Message = 1,
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
export interface UnsubscribeRequest {
|
|
240
|
+
/** 事件类型 */
|
|
241
|
+
event_type: UnsubscribeRequestEventType
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
export namespace Rule {
|
|
246
|
+
export interface Methods {
|
|
247
|
+
/**
|
|
248
|
+
* 创建收信规则
|
|
249
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-rule/create
|
|
250
|
+
*/
|
|
251
|
+
create(user_mailbox_id: string, body: CreateRequest): Promise<CreateResponse>
|
|
252
|
+
/**
|
|
253
|
+
* 删除收信规则
|
|
254
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-rule/delete
|
|
255
|
+
*/
|
|
256
|
+
delete(user_mailbox_id: string, rule_id: string): Promise<void>
|
|
257
|
+
/**
|
|
258
|
+
* 更新收信规则
|
|
259
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-rule/update
|
|
260
|
+
*/
|
|
261
|
+
update(user_mailbox_id: string, rule_id: string, body: UpdateRequest): Promise<void>
|
|
262
|
+
/**
|
|
263
|
+
* 列出收信规则
|
|
264
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-rule/list
|
|
265
|
+
*/
|
|
266
|
+
list(user_mailbox_id: string): Promise<ListResponse>
|
|
267
|
+
/**
|
|
268
|
+
* 对收信规则进行排序
|
|
269
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-rule/reorder
|
|
270
|
+
*/
|
|
271
|
+
reorder(user_mailbox_id: string, body: ReorderRequest): Promise<void>
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
export interface CreateRequest {
|
|
275
|
+
/** 匹配条件 */
|
|
276
|
+
condition: Lark.RuleCondition
|
|
277
|
+
/** 匹配命中后的操作 */
|
|
278
|
+
action: Lark.RuleAction
|
|
279
|
+
/** 是否终点规则 */
|
|
280
|
+
ignore_the_rest_of_rules: boolean
|
|
281
|
+
/** 规则名称 */
|
|
282
|
+
name: string
|
|
283
|
+
/** 是否启用 */
|
|
284
|
+
is_enable: boolean
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
export interface CreateResponse {
|
|
288
|
+
/** 规则实体 */
|
|
289
|
+
rule?: Lark.Rule
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
export interface UpdateRequest {
|
|
293
|
+
/** 匹配条件 */
|
|
294
|
+
condition: Lark.RuleCondition
|
|
295
|
+
/** 匹配命中后的操作 */
|
|
296
|
+
action: Lark.RuleAction
|
|
297
|
+
/** 是否终点规则 */
|
|
298
|
+
ignore_the_rest_of_rules: boolean
|
|
299
|
+
/** 规则名称 */
|
|
300
|
+
name: string
|
|
301
|
+
/** 是否启用 */
|
|
302
|
+
is_enable: boolean
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
export interface ListResponse {
|
|
306
|
+
/** 规则列表 */
|
|
307
|
+
items?: Lark.Rule[]
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
export interface ReorderRequest {
|
|
311
|
+
/** 规则 id 列表 */
|
|
312
|
+
rule_ids: string[]
|
|
313
|
+
}
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
export namespace MailContact {
|
|
317
|
+
export interface Methods {
|
|
318
|
+
/**
|
|
319
|
+
* 创建邮箱联系人
|
|
320
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-mail_contact/create
|
|
321
|
+
*/
|
|
322
|
+
create(user_mailbox_id: string, body: CreateRequest): Promise<CreateResponse>
|
|
323
|
+
/**
|
|
324
|
+
* 删除邮箱联系人
|
|
325
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-mail_contact/delete
|
|
326
|
+
*/
|
|
327
|
+
delete(user_mailbox_id: string, mail_contact_id: string): Promise<void>
|
|
328
|
+
/**
|
|
329
|
+
* 修改邮箱联系人信息
|
|
330
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-mail_contact/patch
|
|
331
|
+
*/
|
|
332
|
+
patch(user_mailbox_id: string, mail_contact_id: string, body: PatchRequest): Promise<void>
|
|
333
|
+
/**
|
|
334
|
+
* 列出邮箱联系人
|
|
335
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-mail_contact/list
|
|
336
|
+
*/
|
|
337
|
+
list(user_mailbox_id: string, query?: Pagination): Paginated<Lark.MailContact>
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
export interface CreateRequest {
|
|
341
|
+
/** 联系人姓名 */
|
|
342
|
+
name: string
|
|
343
|
+
/** 联系人公司 */
|
|
344
|
+
company?: string
|
|
345
|
+
/** 联系人手机号 */
|
|
346
|
+
phone?: string
|
|
347
|
+
/** 联系人邮箱 */
|
|
348
|
+
mail_address?: string
|
|
349
|
+
/** 联系人标签 */
|
|
350
|
+
tag?: string
|
|
351
|
+
/** 联系人备注 */
|
|
352
|
+
remark?: string
|
|
353
|
+
/** 联系人职位 */
|
|
354
|
+
position?: string
|
|
355
|
+
}
|
|
356
|
+
|
|
357
|
+
export interface CreateResponse {
|
|
358
|
+
/** 联系人实体 */
|
|
359
|
+
mail_contact?: Lark.MailContact
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
export interface PatchRequest {
|
|
363
|
+
/** 联系人姓名 */
|
|
364
|
+
name: string
|
|
365
|
+
/** 联系人公司 */
|
|
366
|
+
company?: string
|
|
367
|
+
/** 联系人手机号 */
|
|
368
|
+
phone?: string
|
|
369
|
+
/** 联系人邮箱 */
|
|
370
|
+
mail_address?: string
|
|
371
|
+
/** 联系人标签 */
|
|
372
|
+
tag?: string
|
|
373
|
+
/** 联系人备注 */
|
|
374
|
+
remark?: string
|
|
375
|
+
/** 联系人职位 */
|
|
376
|
+
position?: string
|
|
377
|
+
}
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
export namespace Alias {
|
|
381
|
+
export interface Methods {
|
|
382
|
+
/**
|
|
383
|
+
* 创建用户邮箱别名
|
|
384
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/create
|
|
385
|
+
*/
|
|
386
|
+
create(user_mailbox_id: string, body: CreateRequest): Promise<CreateResponse>
|
|
387
|
+
/**
|
|
388
|
+
* 删除用户邮箱别名
|
|
389
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/delete
|
|
390
|
+
*/
|
|
391
|
+
delete(user_mailbox_id: string, alias_id: string): Promise<void>
|
|
392
|
+
/**
|
|
393
|
+
* 获取用户邮箱所有别名
|
|
394
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/list
|
|
395
|
+
*/
|
|
396
|
+
list(user_mailbox_id: string, query?: Pagination): Promise<ListResponse>
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
export interface CreateRequest {
|
|
400
|
+
/** 邮箱别名 */
|
|
401
|
+
email_alias?: string
|
|
402
|
+
}
|
|
403
|
+
|
|
404
|
+
export interface CreateResponse {
|
|
405
|
+
/** 用户邮箱别名 */
|
|
406
|
+
user_mailbox_alias?: Lark.EmailAlias
|
|
407
|
+
}
|
|
408
|
+
|
|
409
|
+
export interface ListResponse {
|
|
410
|
+
/** 用户邮箱别名 */
|
|
411
|
+
items?: Lark.EmailAlias[]
|
|
412
|
+
}
|
|
413
|
+
}
|
|
414
|
+
}
|
|
730
415
|
|
|
731
|
-
export
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
416
|
+
export namespace Mailgroup {
|
|
417
|
+
export interface Methods {
|
|
418
|
+
manager: Manager.Methods
|
|
419
|
+
member: Member.Methods
|
|
420
|
+
alias: Alias.Methods
|
|
421
|
+
permissionMember: PermissionMember.Methods
|
|
422
|
+
/**
|
|
423
|
+
* 创建邮件组
|
|
424
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/create
|
|
425
|
+
*/
|
|
426
|
+
create(body: CreateRequest): Promise<CreateResponse>
|
|
427
|
+
/**
|
|
428
|
+
* 删除邮件组
|
|
429
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/delete
|
|
430
|
+
*/
|
|
431
|
+
delete(mailgroup_id: string): Promise<void>
|
|
432
|
+
/**
|
|
433
|
+
* 修改邮件组部分信息
|
|
434
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/patch
|
|
435
|
+
*/
|
|
436
|
+
patch(mailgroup_id: string, body: PatchRequest): Promise<PatchResponse>
|
|
437
|
+
/**
|
|
438
|
+
* 修改邮件组全部信息
|
|
439
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/update
|
|
440
|
+
*/
|
|
441
|
+
update(mailgroup_id: string, body: UpdateRequest): Promise<UpdateResponse>
|
|
442
|
+
/**
|
|
443
|
+
* 查询指定邮件组
|
|
444
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/get
|
|
445
|
+
*/
|
|
446
|
+
get(mailgroup_id: string): Promise<GetResponse>
|
|
447
|
+
/**
|
|
448
|
+
* 批量获取邮件组
|
|
449
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/list
|
|
450
|
+
*/
|
|
451
|
+
list(query?: ListQuery): Paginated<Lark.Mailgroup>
|
|
452
|
+
}
|
|
453
|
+
|
|
454
|
+
export interface CreateRequest {
|
|
455
|
+
/** The mail group's email address */
|
|
456
|
+
email?: string
|
|
457
|
+
/** The mail group's display name */
|
|
458
|
+
name?: string
|
|
459
|
+
/** The mail group's description */
|
|
460
|
+
description?: string
|
|
461
|
+
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
462
|
+
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
export interface CreateResponse {
|
|
466
|
+
/** The unique ID of a mail group */
|
|
467
|
+
mailgroup_id?: string
|
|
468
|
+
/** The mail group's email address */
|
|
469
|
+
email?: string
|
|
470
|
+
/** The mail group's display name */
|
|
471
|
+
name?: string
|
|
472
|
+
/** The mail group's description */
|
|
473
|
+
description?: string
|
|
474
|
+
/** The number of mail group's direct members */
|
|
475
|
+
direct_members_count?: string
|
|
476
|
+
/** Value is true if this mail group has external member */
|
|
477
|
+
include_external_member?: boolean
|
|
478
|
+
/** Value is true if all company members are in this mail group */
|
|
479
|
+
include_all_company_member?: boolean
|
|
480
|
+
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
481
|
+
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
482
|
+
}
|
|
483
|
+
|
|
484
|
+
export interface PatchRequest {
|
|
485
|
+
/** The public mailbox's new primary email address */
|
|
486
|
+
email?: string
|
|
487
|
+
/** The mail group's display name */
|
|
488
|
+
name?: string
|
|
489
|
+
/** The mail group's description */
|
|
490
|
+
description?: string
|
|
491
|
+
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
492
|
+
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
493
|
+
}
|
|
494
|
+
|
|
495
|
+
export interface PatchResponse {
|
|
496
|
+
/** The unique ID of a mail group */
|
|
497
|
+
mailgroup_id?: string
|
|
498
|
+
/** The mail group's email address */
|
|
499
|
+
email?: string
|
|
500
|
+
/** The mail group's display name */
|
|
501
|
+
name?: string
|
|
502
|
+
/** The mail group's description */
|
|
503
|
+
description?: string
|
|
504
|
+
/** The number of mail group's direct members */
|
|
505
|
+
direct_members_count?: string
|
|
506
|
+
/** Value is true if this mail group has external member */
|
|
507
|
+
include_external_member?: boolean
|
|
508
|
+
/** Value is true if all company members are in this mail group */
|
|
509
|
+
include_all_company_member?: boolean
|
|
510
|
+
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
511
|
+
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
512
|
+
}
|
|
513
|
+
|
|
514
|
+
export interface UpdateRequest {
|
|
515
|
+
/** The public mailbox's new primary email address */
|
|
516
|
+
email?: string
|
|
517
|
+
/** The mail group's display name */
|
|
518
|
+
name?: string
|
|
519
|
+
/** The mail group's description */
|
|
520
|
+
description?: string
|
|
521
|
+
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
522
|
+
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
523
|
+
}
|
|
524
|
+
|
|
525
|
+
export interface UpdateResponse {
|
|
526
|
+
/** The unique ID of a mail group */
|
|
527
|
+
mailgroup_id?: string
|
|
528
|
+
/** The mail group's email address */
|
|
529
|
+
email?: string
|
|
530
|
+
/** The mail group's display name */
|
|
531
|
+
name?: string
|
|
532
|
+
/** The mail group's description */
|
|
533
|
+
description?: string
|
|
534
|
+
/** The number of mail group's direct members */
|
|
535
|
+
direct_members_count?: string
|
|
536
|
+
/** Value is true if this mail group has external member */
|
|
537
|
+
include_external_member?: boolean
|
|
538
|
+
/** Value is true if all company members are in this mail group */
|
|
539
|
+
include_all_company_member?: boolean
|
|
540
|
+
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
541
|
+
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
export interface GetResponse {
|
|
545
|
+
/** The unique ID of a mail group */
|
|
546
|
+
mailgroup_id?: string
|
|
547
|
+
/** The mail group's email address */
|
|
548
|
+
email?: string
|
|
549
|
+
/** The mail group's display name */
|
|
550
|
+
name?: string
|
|
551
|
+
/** The mail group's description */
|
|
552
|
+
description?: string
|
|
553
|
+
/** The number of mail group's direct members */
|
|
554
|
+
direct_members_count?: string
|
|
555
|
+
/** Value is true if this mail group has external member */
|
|
556
|
+
include_external_member?: boolean
|
|
557
|
+
/** Value is true if all company members are in this mail group */
|
|
558
|
+
include_all_company_member?: boolean
|
|
559
|
+
/** Who can send mail to this mail group. Possible values are:- ANYONE: Any Internet user can send mail to this mail group- ALL_INTERNAL_USERS: Anyone in the team can send mail to this mail group- ALL_GROUP_MEMBERS: Any group member can send mail to this mail group- CUSTOM_MEMBERS: Only custom members can send mail to this mail group, define in mailgroup.permission_members resoure */
|
|
560
|
+
who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS'
|
|
561
|
+
}
|
|
562
|
+
|
|
563
|
+
export interface ListQuery extends Pagination {
|
|
564
|
+
/** 邮件组管理员用户ID,用于获取该用户有管理权限的邮件组 */
|
|
565
|
+
manager_user_id?: string
|
|
566
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
567
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
568
|
+
}
|
|
569
|
+
|
|
570
|
+
export namespace Manager {
|
|
571
|
+
export interface Methods {
|
|
572
|
+
/**
|
|
573
|
+
* 批量创建邮件组管理员
|
|
574
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_create
|
|
575
|
+
*/
|
|
576
|
+
batchCreate(mailgroup_id: string, body: BatchCreateRequest, query?: BatchCreateQuery): Promise<void>
|
|
577
|
+
/**
|
|
578
|
+
* 批量删除邮件组管理员
|
|
579
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_delete
|
|
580
|
+
*/
|
|
581
|
+
batchDelete(mailgroup_id: string, body: BatchDeleteRequest, query?: BatchDeleteQuery): Promise<void>
|
|
582
|
+
/**
|
|
583
|
+
* 批量获取邮件组管理员
|
|
584
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/list
|
|
585
|
+
*/
|
|
586
|
+
list(mailgroup_id: string, query?: ListQuery): Paginated<Lark.MailgroupManager>
|
|
587
|
+
}
|
|
588
|
+
|
|
589
|
+
export interface BatchCreateRequest {
|
|
590
|
+
/** 邮件组管理员列表 */
|
|
591
|
+
mailgroup_manager_list?: Lark.MailgroupManager[]
|
|
592
|
+
}
|
|
593
|
+
|
|
594
|
+
export interface BatchCreateQuery {
|
|
595
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
596
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
export interface BatchDeleteRequest {
|
|
600
|
+
/** 邮件组管理员列表 */
|
|
601
|
+
mailgroup_manager_list?: Lark.MailgroupManager[]
|
|
602
|
+
}
|
|
603
|
+
|
|
604
|
+
export interface BatchDeleteQuery {
|
|
605
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
606
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
export interface ListQuery extends Pagination {
|
|
610
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
611
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
612
|
+
}
|
|
613
|
+
}
|
|
614
|
+
|
|
615
|
+
export namespace Member {
|
|
616
|
+
export interface Methods {
|
|
617
|
+
/**
|
|
618
|
+
* 创建邮件组成员
|
|
619
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/create
|
|
620
|
+
*/
|
|
621
|
+
create(mailgroup_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
|
|
622
|
+
/**
|
|
623
|
+
* 删除邮件组成员
|
|
624
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/delete
|
|
625
|
+
*/
|
|
626
|
+
delete(mailgroup_id: string, member_id: string): Promise<void>
|
|
627
|
+
/**
|
|
628
|
+
* 查询指定邮件组成员
|
|
629
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/get
|
|
630
|
+
*/
|
|
631
|
+
get(mailgroup_id: string, member_id: string, query?: GetQuery): Promise<GetResponse>
|
|
632
|
+
/**
|
|
633
|
+
* 获取所有邮件组成员
|
|
634
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/list
|
|
635
|
+
*/
|
|
636
|
+
list(mailgroup_id: string, query?: ListQuery): Paginated<Lark.MailgroupMember>
|
|
637
|
+
/**
|
|
638
|
+
* 批量创建邮件组成员
|
|
639
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_create
|
|
640
|
+
*/
|
|
641
|
+
batchCreate(mailgroup_id: string, body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>
|
|
642
|
+
/**
|
|
643
|
+
* 批量删除邮件组成员
|
|
644
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_delete
|
|
645
|
+
*/
|
|
646
|
+
batchDelete(mailgroup_id: string, body: BatchDeleteRequest): Promise<void>
|
|
647
|
+
}
|
|
648
|
+
|
|
649
|
+
export interface CreateRequest {
|
|
650
|
+
/** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */
|
|
651
|
+
email?: string
|
|
652
|
+
/** The member's user id. Value is valid when type is USER */
|
|
653
|
+
user_id?: string
|
|
654
|
+
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
655
|
+
department_id?: string
|
|
656
|
+
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
|
|
657
|
+
type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER'
|
|
658
|
+
}
|
|
659
|
+
|
|
660
|
+
export interface CreateQuery {
|
|
661
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
662
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
663
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
664
|
+
department_id_type?: 'department_id' | 'open_department_id'
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
export interface CreateResponse {
|
|
668
|
+
/** The unique ID of a member in this mail group */
|
|
669
|
+
member_id?: string
|
|
670
|
+
/** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */
|
|
671
|
+
email?: string
|
|
672
|
+
/** The member's user id. Value is valid when type is USER */
|
|
673
|
+
user_id?: string
|
|
674
|
+
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
675
|
+
department_id?: string
|
|
676
|
+
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
|
|
677
|
+
type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER'
|
|
678
|
+
}
|
|
679
|
+
|
|
680
|
+
export interface GetQuery {
|
|
681
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
682
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
683
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
684
|
+
department_id_type?: 'department_id' | 'open_department_id'
|
|
685
|
+
}
|
|
686
|
+
|
|
687
|
+
export interface GetResponse {
|
|
688
|
+
/** The unique ID of a member in this mail group */
|
|
689
|
+
member_id?: string
|
|
690
|
+
/** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */
|
|
691
|
+
email?: string
|
|
692
|
+
/** The member's user id. Value is valid when type is USER */
|
|
693
|
+
user_id?: string
|
|
694
|
+
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
695
|
+
department_id?: string
|
|
696
|
+
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department- COMPANY: member is the company- EXTERNAL_USER: internet user outside the organization- MAIL_GROUP: member is another mail group- PUBLIC_MAILBOX: member is a public mailbox- OTHER_MEMBER: other internal member */
|
|
697
|
+
type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER'
|
|
698
|
+
}
|
|
699
|
+
|
|
700
|
+
export interface ListQuery extends Pagination {
|
|
701
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
702
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
703
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
704
|
+
department_id_type?: 'department_id' | 'open_department_id'
|
|
705
|
+
}
|
|
706
|
+
|
|
707
|
+
export interface BatchCreateRequest {
|
|
708
|
+
/** 本次添加的邮件组成员列表 */
|
|
709
|
+
items?: Lark.MailgroupMember[]
|
|
710
|
+
}
|
|
711
|
+
|
|
712
|
+
export interface BatchCreateQuery {
|
|
713
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
714
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
715
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
716
|
+
department_id_type?: 'department_id' | 'open_department_id'
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
export interface BatchCreateResponse {
|
|
720
|
+
/** 添加成功后的邮件组成员信息列表 */
|
|
721
|
+
items?: Lark.MailgroupMember[]
|
|
722
|
+
}
|
|
723
|
+
|
|
724
|
+
export interface BatchDeleteRequest {
|
|
725
|
+
/** 本次调用删除的成员ID列表 */
|
|
726
|
+
member_id_list?: string[]
|
|
727
|
+
}
|
|
728
|
+
}
|
|
729
|
+
|
|
730
|
+
export namespace Alias {
|
|
731
|
+
export interface Methods {
|
|
732
|
+
/**
|
|
733
|
+
* 创建邮件组别名
|
|
734
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/create
|
|
735
|
+
*/
|
|
736
|
+
create(mailgroup_id: string, body: CreateRequest): Promise<CreateResponse>
|
|
737
|
+
/**
|
|
738
|
+
* 删除邮件组别名
|
|
739
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/delete
|
|
740
|
+
*/
|
|
741
|
+
delete(mailgroup_id: string, alias_id: string): Promise<void>
|
|
742
|
+
/**
|
|
743
|
+
* 获取邮件组所有别名
|
|
744
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/list
|
|
745
|
+
*/
|
|
746
|
+
list(mailgroup_id: string): Promise<ListResponse>
|
|
747
|
+
}
|
|
748
|
+
|
|
749
|
+
export interface CreateRequest {
|
|
750
|
+
/** 邮箱别名 */
|
|
751
|
+
email_alias?: string
|
|
752
|
+
}
|
|
753
|
+
|
|
754
|
+
export interface CreateResponse {
|
|
755
|
+
/** 邮件组别名 */
|
|
756
|
+
mailgroup_alias?: Lark.EmailAlias
|
|
757
|
+
}
|
|
758
|
+
|
|
759
|
+
export interface ListResponse {
|
|
760
|
+
/** 邮件组别名 */
|
|
761
|
+
items?: Lark.EmailAlias[]
|
|
762
|
+
}
|
|
763
|
+
}
|
|
764
|
+
|
|
765
|
+
export namespace PermissionMember {
|
|
766
|
+
export interface Methods {
|
|
767
|
+
/**
|
|
768
|
+
* 创建邮件组权限成员
|
|
769
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/create
|
|
770
|
+
*/
|
|
771
|
+
create(mailgroup_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
|
|
772
|
+
/**
|
|
773
|
+
* 删除邮件组权限成员
|
|
774
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/delete
|
|
775
|
+
*/
|
|
776
|
+
delete(mailgroup_id: string, permission_member_id: string): Promise<void>
|
|
777
|
+
/**
|
|
778
|
+
* 获取邮件组权限成员
|
|
779
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/get
|
|
780
|
+
*/
|
|
781
|
+
get(mailgroup_id: string, permission_member_id: string, query?: GetQuery): Promise<GetResponse>
|
|
782
|
+
/**
|
|
783
|
+
* 批量获取邮件组权限成员
|
|
784
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/list
|
|
785
|
+
*/
|
|
786
|
+
list(mailgroup_id: string, query?: ListQuery): Paginated<Lark.MailgroupPermissionMember>
|
|
787
|
+
/**
|
|
788
|
+
* 批量创建邮件组权限成员
|
|
789
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_create
|
|
790
|
+
*/
|
|
791
|
+
batchCreate(mailgroup_id: string, body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>
|
|
792
|
+
/**
|
|
793
|
+
* 批量删除邮件组权限成员
|
|
794
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_delete
|
|
795
|
+
*/
|
|
796
|
+
batchDelete(mailgroup_id: string, body: BatchDeleteRequest): Promise<void>
|
|
797
|
+
}
|
|
798
|
+
|
|
799
|
+
export interface CreateRequest {
|
|
800
|
+
/** The member's user id. Value is valid when type is USER */
|
|
801
|
+
user_id?: string
|
|
802
|
+
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
803
|
+
department_id?: string
|
|
804
|
+
/** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
|
|
805
|
+
email?: string
|
|
806
|
+
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
|
|
807
|
+
type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX'
|
|
808
|
+
}
|
|
809
|
+
|
|
810
|
+
export interface CreateQuery {
|
|
811
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
812
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
813
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
814
|
+
department_id_type?: 'department_id' | 'open_department_id'
|
|
815
|
+
}
|
|
816
|
+
|
|
817
|
+
export interface CreateResponse {
|
|
818
|
+
/** The unique ID of a member in this permission group */
|
|
819
|
+
permission_member_id?: string
|
|
820
|
+
/** The member's user id. Value is valid when type is USER */
|
|
821
|
+
user_id?: string
|
|
822
|
+
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
823
|
+
department_id?: string
|
|
824
|
+
/** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
|
|
825
|
+
email?: string
|
|
826
|
+
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
|
|
827
|
+
type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX'
|
|
828
|
+
}
|
|
829
|
+
|
|
830
|
+
export interface GetQuery {
|
|
831
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
832
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
833
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
834
|
+
department_id_type?: 'department_id' | 'open_department_id'
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
export interface GetResponse {
|
|
838
|
+
/** The unique ID of a member in this permission group */
|
|
839
|
+
permission_member_id?: string
|
|
840
|
+
/** The member's user id. Value is valid when type is USER */
|
|
841
|
+
user_id?: string
|
|
842
|
+
/** The member's department id. Value is valid when type is DEPARTMENT */
|
|
843
|
+
department_id?: string
|
|
844
|
+
/** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
|
|
845
|
+
email?: string
|
|
846
|
+
/** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
|
|
847
|
+
type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX'
|
|
848
|
+
}
|
|
849
|
+
|
|
850
|
+
export interface ListQuery extends Pagination {
|
|
851
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
852
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
853
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
854
|
+
department_id_type?: 'department_id' | 'open_department_id'
|
|
855
|
+
}
|
|
856
|
+
|
|
857
|
+
export interface BatchCreateRequest {
|
|
858
|
+
/** 本次添加的邮件组权限成员列表 */
|
|
859
|
+
items?: Lark.MailgroupPermissionMember[]
|
|
860
|
+
}
|
|
861
|
+
|
|
862
|
+
export interface BatchCreateQuery {
|
|
863
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
864
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
865
|
+
/** 此次调用中使用的部门ID的类型 */
|
|
866
|
+
department_id_type?: 'department_id' | 'open_department_id'
|
|
867
|
+
}
|
|
868
|
+
|
|
869
|
+
export interface BatchCreateResponse {
|
|
870
|
+
/** 添加成功后的邮件组权限成员信息列表 */
|
|
871
|
+
items?: Lark.MailgroupPermissionMember[]
|
|
872
|
+
}
|
|
873
|
+
|
|
874
|
+
export interface BatchDeleteRequest {
|
|
875
|
+
/** 本次调用删除的权限成员ID列表 */
|
|
876
|
+
permission_member_id_list: string[]
|
|
877
|
+
}
|
|
878
|
+
}
|
|
879
|
+
}
|
|
735
880
|
|
|
736
|
-
export
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
881
|
+
export namespace PublicMailbox {
|
|
882
|
+
export interface Methods {
|
|
883
|
+
member: Member.Methods
|
|
884
|
+
alias: Alias.Methods
|
|
885
|
+
/**
|
|
886
|
+
* 创建公共邮箱
|
|
887
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/create
|
|
888
|
+
*/
|
|
889
|
+
create(body: CreateRequest): Promise<CreateResponse>
|
|
890
|
+
/**
|
|
891
|
+
* 修改公共邮箱部分信息
|
|
892
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/patch
|
|
893
|
+
*/
|
|
894
|
+
patch(public_mailbox_id: string, body: PatchRequest): Promise<PatchResponse>
|
|
895
|
+
/**
|
|
896
|
+
* 修改公共邮箱全部信息
|
|
897
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/update
|
|
898
|
+
*/
|
|
899
|
+
update(public_mailbox_id: string, body: UpdateRequest): Promise<UpdateResponse>
|
|
900
|
+
/**
|
|
901
|
+
* 查询指定公共邮箱
|
|
902
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/get
|
|
903
|
+
*/
|
|
904
|
+
get(public_mailbox_id: string): Promise<GetResponse>
|
|
905
|
+
/**
|
|
906
|
+
* 查询所有公共邮箱
|
|
907
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/list
|
|
908
|
+
*/
|
|
909
|
+
list(query?: Pagination): Paginated<Lark.PublicMailbox>
|
|
910
|
+
/**
|
|
911
|
+
* 将公共邮箱移至回收站
|
|
912
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/remove_to_recycle_bin
|
|
913
|
+
*/
|
|
914
|
+
removeToRecycleBin(public_mailbox_id: string, body: RemoveToRecycleBinRequest): Promise<void>
|
|
915
|
+
/**
|
|
916
|
+
* 永久删除公共邮箱
|
|
917
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/delete
|
|
918
|
+
*/
|
|
919
|
+
delete(public_mailbox_id: string): Promise<void>
|
|
920
|
+
}
|
|
921
|
+
|
|
922
|
+
export interface CreateRequest {
|
|
923
|
+
/** The public mailbox's email address */
|
|
924
|
+
email?: string
|
|
925
|
+
/** The public mailbox's display name */
|
|
926
|
+
name?: string
|
|
927
|
+
/** 数据驻留地 */
|
|
928
|
+
geo?: string
|
|
929
|
+
}
|
|
930
|
+
|
|
931
|
+
export interface CreateResponse {
|
|
932
|
+
/** The unique ID of a public mailbox */
|
|
933
|
+
public_mailbox_id?: string
|
|
934
|
+
/** The public mailbox's email address */
|
|
935
|
+
email?: string
|
|
936
|
+
/** The public mailbox's display name */
|
|
937
|
+
name?: string
|
|
938
|
+
/** 数据驻留地 */
|
|
939
|
+
geo?: string
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
export interface PatchRequest {
|
|
943
|
+
/** The public mailbox's new primary email address */
|
|
944
|
+
email?: string
|
|
945
|
+
/** The public mailbox's display name */
|
|
946
|
+
name?: string
|
|
947
|
+
}
|
|
948
|
+
|
|
949
|
+
export interface PatchResponse {
|
|
950
|
+
/** The unique ID of a public mailbox */
|
|
951
|
+
public_mailbox_id?: string
|
|
952
|
+
/** The public mailbox's email address */
|
|
953
|
+
email?: string
|
|
954
|
+
/** The public mailbox's display name */
|
|
955
|
+
name?: string
|
|
956
|
+
}
|
|
957
|
+
|
|
958
|
+
export interface UpdateRequest {
|
|
959
|
+
/** The public mailbox's new primary email address */
|
|
960
|
+
email?: string
|
|
961
|
+
/** The public mailbox's display name */
|
|
962
|
+
name?: string
|
|
963
|
+
}
|
|
964
|
+
|
|
965
|
+
export interface UpdateResponse {
|
|
966
|
+
/** The unique ID of a public mailbox */
|
|
967
|
+
public_mailbox_id?: string
|
|
968
|
+
/** The public mailbox's email address */
|
|
969
|
+
email?: string
|
|
970
|
+
/** The public mailbox's display name */
|
|
971
|
+
name?: string
|
|
972
|
+
}
|
|
973
|
+
|
|
974
|
+
export interface GetResponse {
|
|
975
|
+
/** The unique ID of a public mailbox */
|
|
976
|
+
public_mailbox_id?: string
|
|
977
|
+
/** The public mailbox's email address */
|
|
978
|
+
email?: string
|
|
979
|
+
/** The public mailbox's display name */
|
|
980
|
+
name?: string
|
|
981
|
+
/** 数据驻留地 */
|
|
982
|
+
geo?: string
|
|
983
|
+
}
|
|
984
|
+
|
|
985
|
+
export interface RemoveToRecycleBinRequest {
|
|
986
|
+
/** 接收删除邮件的邮箱地址,不填则删除该公共邮箱的邮件 */
|
|
987
|
+
to_mail_address?: string
|
|
988
|
+
}
|
|
989
|
+
|
|
990
|
+
export namespace Member {
|
|
991
|
+
export interface Methods {
|
|
992
|
+
/**
|
|
993
|
+
* 添加公共邮箱成员
|
|
994
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/create
|
|
995
|
+
*/
|
|
996
|
+
create(public_mailbox_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
|
|
997
|
+
/**
|
|
998
|
+
* 删除公共邮箱单个成员
|
|
999
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/delete
|
|
1000
|
+
*/
|
|
1001
|
+
delete(public_mailbox_id: string, member_id: string): Promise<void>
|
|
1002
|
+
/**
|
|
1003
|
+
* 删除公共邮箱所有成员
|
|
1004
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/clear
|
|
1005
|
+
*/
|
|
1006
|
+
clear(public_mailbox_id: string): Promise<void>
|
|
1007
|
+
/**
|
|
1008
|
+
* 查询指定公共邮箱成员信息
|
|
1009
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/get
|
|
1010
|
+
*/
|
|
1011
|
+
get(public_mailbox_id: string, member_id: string, query?: GetQuery): Promise<GetResponse>
|
|
1012
|
+
/**
|
|
1013
|
+
* 查询所有公共邮箱成员信息
|
|
1014
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/list
|
|
1015
|
+
*/
|
|
1016
|
+
list(public_mailbox_id: string, query?: ListQuery): Paginated<Lark.PublicMailboxMember>
|
|
1017
|
+
/**
|
|
1018
|
+
* 批量添加公共邮箱成员
|
|
1019
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_create
|
|
1020
|
+
*/
|
|
1021
|
+
batchCreate(public_mailbox_id: string, body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>
|
|
1022
|
+
/**
|
|
1023
|
+
* 批量删除公共邮箱成员
|
|
1024
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_delete
|
|
1025
|
+
*/
|
|
1026
|
+
batchDelete(public_mailbox_id: string, body: BatchDeleteRequest): Promise<void>
|
|
1027
|
+
}
|
|
1028
|
+
|
|
1029
|
+
export interface CreateRequest {
|
|
1030
|
+
/** The member's user id. Value is valid when type is USER */
|
|
1031
|
+
user_id?: string
|
|
1032
|
+
/** The type of member. Possible values are:- USER: internal user in the team */
|
|
1033
|
+
type?: 'USER'
|
|
1034
|
+
}
|
|
1035
|
+
|
|
1036
|
+
export interface CreateQuery {
|
|
1037
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
1038
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
1039
|
+
}
|
|
1040
|
+
|
|
1041
|
+
export interface CreateResponse {
|
|
1042
|
+
/** The unique ID of a member in this public mailbox */
|
|
1043
|
+
member_id?: string
|
|
1044
|
+
/** The member's user id. Value is valid when type is USER */
|
|
1045
|
+
user_id?: string
|
|
1046
|
+
/** The type of member. Possible values are:- USER: internal user in the team */
|
|
1047
|
+
type?: 'USER'
|
|
1048
|
+
}
|
|
1049
|
+
|
|
1050
|
+
export interface GetQuery {
|
|
1051
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
1052
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
1053
|
+
}
|
|
1054
|
+
|
|
1055
|
+
export interface GetResponse {
|
|
1056
|
+
/** The unique ID of a member in this public mailbox */
|
|
1057
|
+
member_id?: string
|
|
1058
|
+
/** The member's user id. Value is valid when type is USER */
|
|
1059
|
+
user_id?: string
|
|
1060
|
+
/** The type of member. Possible values are:- USER: internal user in the team */
|
|
1061
|
+
type?: 'USER'
|
|
1062
|
+
}
|
|
1063
|
+
|
|
1064
|
+
export interface ListQuery extends Pagination {
|
|
1065
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
1066
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
1067
|
+
}
|
|
1068
|
+
|
|
1069
|
+
export interface BatchCreateRequest {
|
|
1070
|
+
/** 本次调用添加的公共邮箱成员列表 */
|
|
1071
|
+
items: Lark.PublicMailboxMember[]
|
|
1072
|
+
}
|
|
1073
|
+
|
|
1074
|
+
export interface BatchCreateQuery {
|
|
1075
|
+
/** 此次调用中使用的用户ID的类型 */
|
|
1076
|
+
user_id_type?: 'user_id' | 'union_id' | 'open_id'
|
|
1077
|
+
}
|
|
1078
|
+
|
|
1079
|
+
export interface BatchCreateResponse {
|
|
1080
|
+
/** 添加成功后的公共邮箱成员信息列表 */
|
|
1081
|
+
items?: Lark.PublicMailboxMember[]
|
|
1082
|
+
}
|
|
1083
|
+
|
|
1084
|
+
export interface BatchDeleteRequest {
|
|
1085
|
+
/** 本次调用删除的公共邮箱成员ID列表 */
|
|
1086
|
+
member_id_list: string[]
|
|
1087
|
+
}
|
|
1088
|
+
}
|
|
1089
|
+
|
|
1090
|
+
export namespace Alias {
|
|
1091
|
+
export interface Methods {
|
|
1092
|
+
/**
|
|
1093
|
+
* 创建公共邮箱别名
|
|
1094
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/create
|
|
1095
|
+
*/
|
|
1096
|
+
create(public_mailbox_id: string, body: CreateRequest): Promise<CreateResponse>
|
|
1097
|
+
/**
|
|
1098
|
+
* 删除公共邮箱别名
|
|
1099
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/delete
|
|
1100
|
+
*/
|
|
1101
|
+
delete(public_mailbox_id: string, alias_id: string): Promise<void>
|
|
1102
|
+
/**
|
|
1103
|
+
* 查询公共邮箱的所有别名
|
|
1104
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/list
|
|
1105
|
+
*/
|
|
1106
|
+
list(public_mailbox_id: string): Promise<ListResponse>
|
|
1107
|
+
}
|
|
1108
|
+
|
|
1109
|
+
export interface CreateRequest {
|
|
1110
|
+
/** 邮箱别名 */
|
|
1111
|
+
email_alias?: string
|
|
1112
|
+
}
|
|
1113
|
+
|
|
1114
|
+
export interface CreateResponse {
|
|
1115
|
+
/** 公共邮箱别名 */
|
|
1116
|
+
public_mailbox_alias?: Lark.EmailAlias
|
|
1117
|
+
}
|
|
1118
|
+
|
|
1119
|
+
export interface ListResponse {
|
|
1120
|
+
/** 公共邮箱别名 */
|
|
1121
|
+
items?: Lark.EmailAlias[]
|
|
1122
|
+
}
|
|
1123
|
+
}
|
|
1124
|
+
}
|
|
740
1125
|
|
|
741
|
-
export
|
|
742
|
-
|
|
743
|
-
|
|
1126
|
+
export namespace User {
|
|
1127
|
+
export interface Methods {
|
|
1128
|
+
/**
|
|
1129
|
+
* 查询邮箱地址状态
|
|
1130
|
+
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user/query
|
|
1131
|
+
*/
|
|
1132
|
+
query(body: QueryRequest): Promise<QueryResponse>
|
|
1133
|
+
}
|
|
1134
|
+
|
|
1135
|
+
export interface QueryRequest {
|
|
1136
|
+
/** 需要查询的邮箱地址列表 */
|
|
1137
|
+
email_list: string[]
|
|
1138
|
+
}
|
|
1139
|
+
|
|
1140
|
+
export interface QueryResponse {
|
|
1141
|
+
/** 邮箱地址返回 */
|
|
1142
|
+
user_list?: Lark.User[]
|
|
1143
|
+
}
|
|
1144
|
+
}
|
|
744
1145
|
}
|
|
745
1146
|
|
|
746
1147
|
Internal.define({
|
|
1148
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/folders': {
|
|
1149
|
+
POST: 'mail.userMailbox.folder.create',
|
|
1150
|
+
GET: 'mail.userMailbox.folder.list',
|
|
1151
|
+
},
|
|
1152
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/folders/{folder_id}': {
|
|
1153
|
+
DELETE: 'mail.userMailbox.folder.delete',
|
|
1154
|
+
PATCH: 'mail.userMailbox.folder.patch',
|
|
1155
|
+
},
|
|
1156
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/messages/get_by_card': {
|
|
1157
|
+
GET: 'mail.userMailbox.message.getByCard',
|
|
1158
|
+
},
|
|
1159
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/messages': {
|
|
1160
|
+
GET: { name: 'mail.userMailbox.message.list', pagination: { argIndex: 1 } },
|
|
1161
|
+
},
|
|
1162
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/messages/{message_id}': {
|
|
1163
|
+
GET: 'mail.userMailbox.message.get',
|
|
1164
|
+
},
|
|
747
1165
|
'/mail/v1/user_mailboxes/{user_mailbox_id}/messages/send': {
|
|
748
|
-
POST: '
|
|
1166
|
+
POST: 'mail.userMailbox.message.send',
|
|
1167
|
+
},
|
|
1168
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/messages/{message_id}/attachments/download_url': {
|
|
1169
|
+
GET: 'mail.userMailbox.message.attachment.downloadUrl',
|
|
1170
|
+
},
|
|
1171
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/event/subscribe': {
|
|
1172
|
+
POST: 'mail.userMailbox.event.subscribe',
|
|
1173
|
+
},
|
|
1174
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/event/subscription': {
|
|
1175
|
+
GET: 'mail.userMailbox.event.subscription',
|
|
1176
|
+
},
|
|
1177
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/event/unsubscribe': {
|
|
1178
|
+
POST: 'mail.userMailbox.event.unsubscribe',
|
|
1179
|
+
},
|
|
1180
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/rules': {
|
|
1181
|
+
POST: 'mail.userMailbox.rule.create',
|
|
1182
|
+
GET: 'mail.userMailbox.rule.list',
|
|
1183
|
+
},
|
|
1184
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/rules/{rule_id}': {
|
|
1185
|
+
DELETE: 'mail.userMailbox.rule.delete',
|
|
1186
|
+
PUT: 'mail.userMailbox.rule.update',
|
|
1187
|
+
},
|
|
1188
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/rules/reorder': {
|
|
1189
|
+
POST: 'mail.userMailbox.rule.reorder',
|
|
1190
|
+
},
|
|
1191
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/mail_contacts': {
|
|
1192
|
+
POST: 'mail.userMailbox.mailContact.create',
|
|
1193
|
+
GET: { name: 'mail.userMailbox.mailContact.list', pagination: { argIndex: 1 } },
|
|
1194
|
+
},
|
|
1195
|
+
'/mail/v1/user_mailboxes/{user_mailbox_id}/mail_contacts/{mail_contact_id}': {
|
|
1196
|
+
DELETE: 'mail.userMailbox.mailContact.delete',
|
|
1197
|
+
PATCH: 'mail.userMailbox.mailContact.patch',
|
|
749
1198
|
},
|
|
750
1199
|
'/mail/v1/mailgroups': {
|
|
751
|
-
POST: '
|
|
752
|
-
GET: { name: '
|
|
1200
|
+
POST: 'mail.mailgroup.create',
|
|
1201
|
+
GET: { name: 'mail.mailgroup.list', pagination: { argIndex: 0 } },
|
|
753
1202
|
},
|
|
754
1203
|
'/mail/v1/mailgroups/{mailgroup_id}': {
|
|
755
|
-
DELETE: '
|
|
756
|
-
PATCH: '
|
|
757
|
-
PUT: '
|
|
758
|
-
GET: '
|
|
1204
|
+
DELETE: 'mail.mailgroup.delete',
|
|
1205
|
+
PATCH: 'mail.mailgroup.patch',
|
|
1206
|
+
PUT: 'mail.mailgroup.update',
|
|
1207
|
+
GET: 'mail.mailgroup.get',
|
|
759
1208
|
},
|
|
760
1209
|
'/mail/v1/mailgroups/{mailgroup_id}/managers/batch_create': {
|
|
761
|
-
POST: '
|
|
1210
|
+
POST: 'mail.mailgroup.manager.batchCreate',
|
|
762
1211
|
},
|
|
763
1212
|
'/mail/v1/mailgroups/{mailgroup_id}/managers/batch_delete': {
|
|
764
|
-
POST: '
|
|
1213
|
+
POST: 'mail.mailgroup.manager.batchDelete',
|
|
765
1214
|
},
|
|
766
1215
|
'/mail/v1/mailgroups/{mailgroup_id}/managers': {
|
|
767
|
-
GET: { name: '
|
|
1216
|
+
GET: { name: 'mail.mailgroup.manager.list', pagination: { argIndex: 1 } },
|
|
768
1217
|
},
|
|
769
1218
|
'/mail/v1/mailgroups/{mailgroup_id}/members': {
|
|
770
|
-
POST: '
|
|
771
|
-
GET: { name: '
|
|
1219
|
+
POST: 'mail.mailgroup.member.create',
|
|
1220
|
+
GET: { name: 'mail.mailgroup.member.list', pagination: { argIndex: 1 } },
|
|
772
1221
|
},
|
|
773
1222
|
'/mail/v1/mailgroups/{mailgroup_id}/members/{member_id}': {
|
|
774
|
-
DELETE: '
|
|
775
|
-
GET: '
|
|
1223
|
+
DELETE: 'mail.mailgroup.member.delete',
|
|
1224
|
+
GET: 'mail.mailgroup.member.get',
|
|
776
1225
|
},
|
|
777
1226
|
'/mail/v1/mailgroups/{mailgroup_id}/members/batch_create': {
|
|
778
|
-
POST: '
|
|
1227
|
+
POST: 'mail.mailgroup.member.batchCreate',
|
|
779
1228
|
},
|
|
780
1229
|
'/mail/v1/mailgroups/{mailgroup_id}/members/batch_delete': {
|
|
781
|
-
DELETE: '
|
|
1230
|
+
DELETE: 'mail.mailgroup.member.batchDelete',
|
|
782
1231
|
},
|
|
783
1232
|
'/mail/v1/mailgroups/{mailgroup_id}/aliases': {
|
|
784
|
-
POST: '
|
|
785
|
-
GET: '
|
|
1233
|
+
POST: 'mail.mailgroup.alias.create',
|
|
1234
|
+
GET: 'mail.mailgroup.alias.list',
|
|
786
1235
|
},
|
|
787
1236
|
'/mail/v1/mailgroups/{mailgroup_id}/aliases/{alias_id}': {
|
|
788
|
-
DELETE: '
|
|
1237
|
+
DELETE: 'mail.mailgroup.alias.delete',
|
|
789
1238
|
},
|
|
790
1239
|
'/mail/v1/mailgroups/{mailgroup_id}/permission_members': {
|
|
791
|
-
POST: '
|
|
792
|
-
GET: { name: '
|
|
1240
|
+
POST: 'mail.mailgroup.permissionMember.create',
|
|
1241
|
+
GET: { name: 'mail.mailgroup.permissionMember.list', pagination: { argIndex: 1 } },
|
|
793
1242
|
},
|
|
794
1243
|
'/mail/v1/mailgroups/{mailgroup_id}/permission_members/{permission_member_id}': {
|
|
795
|
-
DELETE: '
|
|
796
|
-
GET: '
|
|
1244
|
+
DELETE: 'mail.mailgroup.permissionMember.delete',
|
|
1245
|
+
GET: 'mail.mailgroup.permissionMember.get',
|
|
797
1246
|
},
|
|
798
1247
|
'/mail/v1/mailgroups/{mailgroup_id}/permission_members/batch_create': {
|
|
799
|
-
POST: '
|
|
1248
|
+
POST: 'mail.mailgroup.permissionMember.batchCreate',
|
|
800
1249
|
},
|
|
801
1250
|
'/mail/v1/mailgroups/{mailgroup_id}/permission_members/batch_delete': {
|
|
802
|
-
DELETE: '
|
|
1251
|
+
DELETE: 'mail.mailgroup.permissionMember.batchDelete',
|
|
803
1252
|
},
|
|
804
1253
|
'/mail/v1/public_mailboxes': {
|
|
805
|
-
POST: '
|
|
806
|
-
GET: { name: '
|
|
1254
|
+
POST: 'mail.publicMailbox.create',
|
|
1255
|
+
GET: { name: 'mail.publicMailbox.list', pagination: { argIndex: 0 } },
|
|
807
1256
|
},
|
|
808
1257
|
'/mail/v1/public_mailboxes/{public_mailbox_id}': {
|
|
809
|
-
PATCH: '
|
|
810
|
-
PUT: '
|
|
811
|
-
GET: '
|
|
812
|
-
DELETE: '
|
|
1258
|
+
PATCH: 'mail.publicMailbox.patch',
|
|
1259
|
+
PUT: 'mail.publicMailbox.update',
|
|
1260
|
+
GET: 'mail.publicMailbox.get',
|
|
1261
|
+
DELETE: 'mail.publicMailbox.delete',
|
|
1262
|
+
},
|
|
1263
|
+
'/mail/v1/public_mailboxes/{public_mailbox_id}/remove_to_recycle_bin': {
|
|
1264
|
+
DELETE: 'mail.publicMailbox.removeToRecycleBin',
|
|
813
1265
|
},
|
|
814
1266
|
'/mail/v1/public_mailboxes/{public_mailbox_id}/members': {
|
|
815
|
-
POST: '
|
|
816
|
-
GET: { name: '
|
|
1267
|
+
POST: 'mail.publicMailbox.member.create',
|
|
1268
|
+
GET: { name: 'mail.publicMailbox.member.list', pagination: { argIndex: 1 } },
|
|
817
1269
|
},
|
|
818
1270
|
'/mail/v1/public_mailboxes/{public_mailbox_id}/members/{member_id}': {
|
|
819
|
-
DELETE: '
|
|
820
|
-
GET: '
|
|
1271
|
+
DELETE: 'mail.publicMailbox.member.delete',
|
|
1272
|
+
GET: 'mail.publicMailbox.member.get',
|
|
821
1273
|
},
|
|
822
1274
|
'/mail/v1/public_mailboxes/{public_mailbox_id}/members/clear': {
|
|
823
|
-
POST: '
|
|
1275
|
+
POST: 'mail.publicMailbox.member.clear',
|
|
824
1276
|
},
|
|
825
1277
|
'/mail/v1/public_mailboxes/{public_mailbox_id}/members/batch_create': {
|
|
826
|
-
POST: '
|
|
1278
|
+
POST: 'mail.publicMailbox.member.batchCreate',
|
|
827
1279
|
},
|
|
828
1280
|
'/mail/v1/public_mailboxes/{public_mailbox_id}/members/batch_delete': {
|
|
829
|
-
DELETE: '
|
|
1281
|
+
DELETE: 'mail.publicMailbox.member.batchDelete',
|
|
830
1282
|
},
|
|
831
1283
|
'/mail/v1/public_mailboxes/{public_mailbox_id}/aliases': {
|
|
832
|
-
POST: '
|
|
833
|
-
GET: '
|
|
1284
|
+
POST: 'mail.publicMailbox.alias.create',
|
|
1285
|
+
GET: 'mail.publicMailbox.alias.list',
|
|
834
1286
|
},
|
|
835
1287
|
'/mail/v1/public_mailboxes/{public_mailbox_id}/aliases/{alias_id}': {
|
|
836
|
-
DELETE: '
|
|
1288
|
+
DELETE: 'mail.publicMailbox.alias.delete',
|
|
837
1289
|
},
|
|
838
1290
|
'/mail/v1/user_mailboxes/{user_mailbox_id}': {
|
|
839
|
-
DELETE: '
|
|
1291
|
+
DELETE: 'mail.userMailbox.delete',
|
|
840
1292
|
},
|
|
841
1293
|
'/mail/v1/user_mailboxes/{user_mailbox_id}/aliases': {
|
|
842
|
-
POST: '
|
|
843
|
-
GET: '
|
|
1294
|
+
POST: 'mail.userMailbox.alias.create',
|
|
1295
|
+
GET: 'mail.userMailbox.alias.list',
|
|
844
1296
|
},
|
|
845
1297
|
'/mail/v1/user_mailboxes/{user_mailbox_id}/aliases/{alias_id}': {
|
|
846
|
-
DELETE: '
|
|
1298
|
+
DELETE: 'mail.userMailbox.alias.delete',
|
|
847
1299
|
},
|
|
848
1300
|
'/mail/v1/users/query': {
|
|
849
|
-
POST: '
|
|
1301
|
+
POST: 'mail.user.query',
|
|
850
1302
|
},
|
|
851
1303
|
})
|