@satorijs/adapter-lark 3.8.5 → 3.9.0

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.
Files changed (126) hide show
  1. package/lib/bot.d.ts +1 -1
  2. package/lib/content.d.ts +433 -0
  3. package/lib/http.d.ts +1 -1
  4. package/lib/index.cjs +2796 -1713
  5. package/lib/index.cjs.map +6 -0
  6. package/lib/index.d.ts +4 -2
  7. package/lib/internal.d.ts +38 -0
  8. package/lib/message.d.ts +2 -0
  9. package/lib/types/acs.d.ts +177 -0
  10. package/lib/types/admin.d.ts +270 -0
  11. package/lib/types/aily.d.ts +221 -0
  12. package/lib/types/apaas.d.ts +499 -0
  13. package/lib/types/application.d.ts +406 -0
  14. package/lib/types/approval.d.ts +779 -0
  15. package/lib/types/attendance.d.ts +957 -0
  16. package/lib/types/auth.d.ts +86 -0
  17. package/lib/types/authen.d.ts +191 -0
  18. package/lib/types/baike.d.ts +239 -0
  19. package/lib/types/bitable.d.ts +691 -0
  20. package/lib/types/board.d.ts +19 -0
  21. package/lib/types/calendar.d.ts +653 -0
  22. package/lib/types/cardkit.d.ts +139 -0
  23. package/lib/types/compensation.d.ts +54 -0
  24. package/lib/types/contact.d.ts +1137 -0
  25. package/lib/types/corehr.d.ts +4383 -0
  26. package/lib/types/docs.d.ts +23 -0
  27. package/lib/types/document_ai.d.ts +257 -0
  28. package/lib/types/docx.d.ts +380 -0
  29. package/lib/types/drive.d.ts +1045 -0
  30. package/lib/types/ehr.d.ts +32 -0
  31. package/lib/types/event.d.ts +9 -18
  32. package/lib/types/guild.d.ts +59 -0
  33. package/lib/types/helpdesk.d.ts +738 -0
  34. package/lib/types/hire.d.ts +3150 -0
  35. package/lib/types/human_authentication.d.ts +27 -0
  36. package/lib/types/im.d.ts +1300 -0
  37. package/lib/types/index.d.ts +16432 -34
  38. package/lib/types/lingo.d.ts +254 -0
  39. package/lib/types/mail.d.ts +680 -0
  40. package/lib/types/mdm.d.ts +42 -0
  41. package/lib/types/message/asset.d.ts +40 -0
  42. package/lib/types/minutes.d.ts +31 -0
  43. package/lib/types/moments.d.ts +18 -0
  44. package/lib/types/okr.d.ts +205 -0
  45. package/lib/types/optical_char_recognition.d.ts +17 -0
  46. package/lib/types/passport.d.ts +45 -0
  47. package/lib/types/payroll.d.ts +50 -0
  48. package/lib/types/performance.d.ts +413 -0
  49. package/lib/types/personal_settings.d.ts +87 -0
  50. package/lib/types/report.d.ts +57 -0
  51. package/lib/types/search.d.ts +216 -0
  52. package/lib/types/security_and_compliance.d.ts +24 -0
  53. package/lib/types/sheets.d.ts +326 -0
  54. package/lib/types/speech_to_text.d.ts +39 -0
  55. package/lib/types/task.d.ts +1153 -0
  56. package/lib/types/tenant.d.ts +23 -0
  57. package/lib/types/translation.d.ts +37 -0
  58. package/lib/types/user.d.ts +78 -0
  59. package/lib/types/utils.d.ts +9 -0
  60. package/lib/types/vc.d.ts +948 -0
  61. package/lib/types/verification.d.ts +14 -0
  62. package/lib/types/wiki.d.ts +240 -0
  63. package/lib/types/workplace.d.ts +43 -0
  64. package/lib/utils.d.ts +143 -7
  65. package/package.json +6 -4
  66. package/src/bot.ts +19 -3
  67. package/src/{types/message/content.ts → content.ts} +1 -0
  68. package/src/http.ts +1 -3
  69. package/src/index.ts +4 -2
  70. package/src/internal.ts +144 -0
  71. package/src/message.ts +24 -11
  72. package/src/types/acs.ts +236 -0
  73. package/src/types/admin.ts +328 -0
  74. package/src/types/aily.ts +288 -0
  75. package/src/types/apaas.ts +646 -0
  76. package/src/types/application.ts +520 -0
  77. package/src/types/approval.ts +924 -0
  78. package/src/types/attendance.ts +1153 -0
  79. package/src/types/auth.ts +114 -0
  80. package/src/types/authen.ts +220 -0
  81. package/src/types/baike.ts +306 -0
  82. package/src/types/bitable.ts +879 -0
  83. package/src/types/board.ts +31 -0
  84. package/src/types/calendar.ts +817 -0
  85. package/src/types/cardkit.ts +182 -0
  86. package/src/types/compensation.ts +79 -0
  87. package/src/types/contact.ts +1411 -0
  88. package/src/types/corehr.ts +5288 -0
  89. package/src/types/docs.ts +33 -0
  90. package/src/types/document_ai.ts +352 -0
  91. package/src/types/docx.ts +471 -0
  92. package/src/types/drive.ts +1312 -0
  93. package/src/types/ehr.ts +43 -0
  94. package/src/types/event.ts +15 -21
  95. package/src/types/helpdesk.ts +916 -0
  96. package/src/types/hire.ts +3918 -0
  97. package/src/types/human_authentication.ts +38 -0
  98. package/src/types/im.ts +1605 -0
  99. package/src/types/index.ts +17754 -39
  100. package/src/types/lingo.ts +321 -0
  101. package/src/types/mail.ts +851 -0
  102. package/src/types/mdm.ts +57 -0
  103. package/src/types/minutes.ts +46 -0
  104. package/src/types/moments.ts +28 -0
  105. package/src/types/okr.ts +261 -0
  106. package/src/types/optical_char_recognition.ts +27 -0
  107. package/src/types/passport.ts +61 -0
  108. package/src/types/payroll.ts +69 -0
  109. package/src/types/performance.ts +524 -0
  110. package/src/types/personal_settings.ts +116 -0
  111. package/src/types/report.ts +77 -0
  112. package/src/types/search.ts +268 -0
  113. package/src/types/security_and_compliance.ts +33 -0
  114. package/src/types/sheets.ts +425 -0
  115. package/src/types/speech_to_text.ts +54 -0
  116. package/src/types/task.ts +1464 -0
  117. package/src/types/tenant.ts +36 -0
  118. package/src/types/translation.ts +52 -0
  119. package/src/types/vc.ts +1197 -0
  120. package/src/types/verification.ts +23 -0
  121. package/src/types/wiki.ts +313 -0
  122. package/src/types/workplace.ts +59 -0
  123. package/src/utils.ts +160 -8
  124. package/src/types/api.ts +0 -30835
  125. package/src/types/internal.ts +0 -84
  126. package/src/types/message/index.ts +0 -97
@@ -0,0 +1,680 @@
1
+ import { Attachment, EmailAlias, MailAddress, Mailgroup, MailgroupManager, MailgroupMember, MailgroupPermissionMember, PublicMailbox, PublicMailboxMember, User } from '.';
2
+ import { Pagination } from '../internal';
3
+ declare module '../internal' {
4
+ interface Internal {
5
+ /**
6
+ * 发送邮件
7
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-message/send
8
+ */
9
+ sendMailUserMailboxMessage(user_mailbox_id: string, body: SendMailUserMailboxMessageRequest): Promise<void>;
10
+ /**
11
+ * 创建邮件组
12
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/create
13
+ */
14
+ createMailMailgroup(body: CreateMailMailgroupRequest): Promise<CreateMailMailgroupResponse>;
15
+ /**
16
+ * 删除邮件组
17
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/delete
18
+ */
19
+ deleteMailMailgroup(mailgroup_id: string): Promise<void>;
20
+ /**
21
+ * 修改邮件组部分信息
22
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/patch
23
+ */
24
+ patchMailMailgroup(mailgroup_id: string, body: PatchMailMailgroupRequest): Promise<PatchMailMailgroupResponse>;
25
+ /**
26
+ * 修改邮件组全部信息
27
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/update
28
+ */
29
+ updateMailMailgroup(mailgroup_id: string, body: UpdateMailMailgroupRequest): Promise<UpdateMailMailgroupResponse>;
30
+ /**
31
+ * 查询指定邮件组
32
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/get
33
+ */
34
+ getMailMailgroup(mailgroup_id: string): Promise<GetMailMailgroupResponse>;
35
+ /**
36
+ * 批量获取邮件组
37
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup/list
38
+ */
39
+ listMailMailgroup(query?: ListMailMailgroupQuery): Paginated<Mailgroup>;
40
+ /**
41
+ * 批量创建邮件组管理员
42
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_create
43
+ */
44
+ batchCreateMailMailgroupManager(mailgroup_id: string, body: BatchCreateMailMailgroupManagerRequest, query?: BatchCreateMailMailgroupManagerQuery): Promise<void>;
45
+ /**
46
+ * 批量删除邮件组管理员
47
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/batch_delete
48
+ */
49
+ batchDeleteMailMailgroupManager(mailgroup_id: string, body: BatchDeleteMailMailgroupManagerRequest, query?: BatchDeleteMailMailgroupManagerQuery): Promise<void>;
50
+ /**
51
+ * 批量获取邮件组管理员
52
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-manager/list
53
+ */
54
+ listMailMailgroupManager(mailgroup_id: string, query?: ListMailMailgroupManagerQuery): Paginated<MailgroupManager>;
55
+ /**
56
+ * 创建邮件组成员
57
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/create
58
+ */
59
+ createMailMailgroupMember(mailgroup_id: string, body: CreateMailMailgroupMemberRequest, query?: CreateMailMailgroupMemberQuery): Promise<CreateMailMailgroupMemberResponse>;
60
+ /**
61
+ * 删除邮件组成员
62
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/delete
63
+ */
64
+ deleteMailMailgroupMember(mailgroup_id: string, member_id: string): Promise<void>;
65
+ /**
66
+ * 查询指定邮件组成员
67
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/get
68
+ */
69
+ getMailMailgroupMember(mailgroup_id: string, member_id: string, query?: GetMailMailgroupMemberQuery): Promise<GetMailMailgroupMemberResponse>;
70
+ /**
71
+ * 获取所有邮件组成员
72
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/list
73
+ */
74
+ listMailMailgroupMember(mailgroup_id: string, query?: ListMailMailgroupMemberQuery): Paginated<MailgroupMember>;
75
+ /**
76
+ * 批量创建邮件组成员
77
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_create
78
+ */
79
+ batchCreateMailMailgroupMember(mailgroup_id: string, body: BatchCreateMailMailgroupMemberRequest, query?: BatchCreateMailMailgroupMemberQuery): Promise<BatchCreateMailMailgroupMemberResponse>;
80
+ /**
81
+ * 批量删除邮件组成员
82
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-member/batch_delete
83
+ */
84
+ batchDeleteMailMailgroupMember(mailgroup_id: string, body: BatchDeleteMailMailgroupMemberRequest): Promise<void>;
85
+ /**
86
+ * 创建邮件组别名
87
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/create
88
+ */
89
+ createMailMailgroupAlias(mailgroup_id: string, body: CreateMailMailgroupAliasRequest): Promise<CreateMailMailgroupAliasResponse>;
90
+ /**
91
+ * 删除邮件组别名
92
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/delete
93
+ */
94
+ deleteMailMailgroupAlias(mailgroup_id: string, alias_id: string): Promise<void>;
95
+ /**
96
+ * 获取邮件组所有别名
97
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-alias/list
98
+ */
99
+ listMailMailgroupAlias(mailgroup_id: string): Promise<ListMailMailgroupAliasResponse>;
100
+ /**
101
+ * 创建邮件组权限成员
102
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/create
103
+ */
104
+ createMailMailgroupPermissionMember(mailgroup_id: string, body: CreateMailMailgroupPermissionMemberRequest, query?: CreateMailMailgroupPermissionMemberQuery): Promise<CreateMailMailgroupPermissionMemberResponse>;
105
+ /**
106
+ * 删除邮件组权限成员
107
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/delete
108
+ */
109
+ deleteMailMailgroupPermissionMember(mailgroup_id: string, permission_member_id: string): Promise<void>;
110
+ /**
111
+ * 获取邮件组权限成员
112
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/get
113
+ */
114
+ getMailMailgroupPermissionMember(mailgroup_id: string, permission_member_id: string, query?: GetMailMailgroupPermissionMemberQuery): Promise<GetMailMailgroupPermissionMemberResponse>;
115
+ /**
116
+ * 批量获取邮件组权限成员
117
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/list
118
+ */
119
+ listMailMailgroupPermissionMember(mailgroup_id: string, query?: ListMailMailgroupPermissionMemberQuery): Paginated<MailgroupPermissionMember>;
120
+ /**
121
+ * 批量创建邮件组权限成员
122
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_create
123
+ */
124
+ batchCreateMailMailgroupPermissionMember(mailgroup_id: string, body: BatchCreateMailMailgroupPermissionMemberRequest, query?: BatchCreateMailMailgroupPermissionMemberQuery): Promise<BatchCreateMailMailgroupPermissionMemberResponse>;
125
+ /**
126
+ * 批量删除邮件组权限成员
127
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/mailgroup-permission_member/batch_delete
128
+ */
129
+ batchDeleteMailMailgroupPermissionMember(mailgroup_id: string, body: BatchDeleteMailMailgroupPermissionMemberRequest): Promise<void>;
130
+ /**
131
+ * 创建公共邮箱
132
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/create
133
+ */
134
+ createMailPublicMailbox(body: CreateMailPublicMailboxRequest): Promise<CreateMailPublicMailboxResponse>;
135
+ /**
136
+ * 修改公共邮箱部分信息
137
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/patch
138
+ */
139
+ patchMailPublicMailbox(public_mailbox_id: string, body: PatchMailPublicMailboxRequest): Promise<PatchMailPublicMailboxResponse>;
140
+ /**
141
+ * 修改公共邮箱全部信息
142
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/update
143
+ */
144
+ updateMailPublicMailbox(public_mailbox_id: string, body: UpdateMailPublicMailboxRequest): Promise<UpdateMailPublicMailboxResponse>;
145
+ /**
146
+ * 查询指定公共邮箱
147
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/get
148
+ */
149
+ getMailPublicMailbox(public_mailbox_id: string): Promise<GetMailPublicMailboxResponse>;
150
+ /**
151
+ * 查询所有公共邮箱
152
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/list
153
+ */
154
+ listMailPublicMailbox(query?: Pagination): Paginated<PublicMailbox>;
155
+ /**
156
+ * 永久删除公共邮箱
157
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox/delete
158
+ */
159
+ deleteMailPublicMailbox(public_mailbox_id: string): Promise<void>;
160
+ /**
161
+ * 添加公共邮箱成员
162
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/create
163
+ */
164
+ createMailPublicMailboxMember(public_mailbox_id: string, body: CreateMailPublicMailboxMemberRequest, query?: CreateMailPublicMailboxMemberQuery): Promise<CreateMailPublicMailboxMemberResponse>;
165
+ /**
166
+ * 删除公共邮箱单个成员
167
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/delete
168
+ */
169
+ deleteMailPublicMailboxMember(public_mailbox_id: string, member_id: string): Promise<void>;
170
+ /**
171
+ * 删除公共邮箱所有成员
172
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/clear
173
+ */
174
+ clearMailPublicMailboxMember(public_mailbox_id: string): Promise<void>;
175
+ /**
176
+ * 查询指定公共邮箱成员信息
177
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/get
178
+ */
179
+ getMailPublicMailboxMember(public_mailbox_id: string, member_id: string, query?: GetMailPublicMailboxMemberQuery): Promise<GetMailPublicMailboxMemberResponse>;
180
+ /**
181
+ * 查询所有公共邮箱成员信息
182
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/list
183
+ */
184
+ listMailPublicMailboxMember(public_mailbox_id: string, query?: ListMailPublicMailboxMemberQuery): Paginated<PublicMailboxMember>;
185
+ /**
186
+ * 批量添加公共邮箱成员
187
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_create
188
+ */
189
+ batchCreateMailPublicMailboxMember(public_mailbox_id: string, body: BatchCreateMailPublicMailboxMemberRequest, query?: BatchCreateMailPublicMailboxMemberQuery): Promise<BatchCreateMailPublicMailboxMemberResponse>;
190
+ /**
191
+ * 批量删除公共邮箱成员
192
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-member/batch_delete
193
+ */
194
+ batchDeleteMailPublicMailboxMember(public_mailbox_id: string, body: BatchDeleteMailPublicMailboxMemberRequest): Promise<void>;
195
+ /**
196
+ * 创建公共邮箱别名
197
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/create
198
+ */
199
+ createMailPublicMailboxAlias(public_mailbox_id: string, body: CreateMailPublicMailboxAliasRequest): Promise<CreateMailPublicMailboxAliasResponse>;
200
+ /**
201
+ * 删除公共邮箱别名
202
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/delete
203
+ */
204
+ deleteMailPublicMailboxAlias(public_mailbox_id: string, alias_id: string): Promise<void>;
205
+ /**
206
+ * 查询公共邮箱的所有别名
207
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/public_mailbox-alias/list
208
+ */
209
+ listMailPublicMailboxAlias(public_mailbox_id: string): Promise<ListMailPublicMailboxAliasResponse>;
210
+ /**
211
+ * 从回收站删除用户邮箱地址
212
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox/delete
213
+ */
214
+ deleteMailUserMailbox(user_mailbox_id: string, query?: DeleteMailUserMailboxQuery): Promise<void>;
215
+ /**
216
+ * 创建用户邮箱别名
217
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/create
218
+ */
219
+ createMailUserMailboxAlias(user_mailbox_id: string, body: CreateMailUserMailboxAliasRequest): Promise<CreateMailUserMailboxAliasResponse>;
220
+ /**
221
+ * 删除用户邮箱别名
222
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/delete
223
+ */
224
+ deleteMailUserMailboxAlias(user_mailbox_id: string, alias_id: string): Promise<void>;
225
+ /**
226
+ * 获取用户邮箱所有别名
227
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user_mailbox-alias/list
228
+ */
229
+ listMailUserMailboxAlias(user_mailbox_id: string, query?: Pagination): Promise<ListMailUserMailboxAliasResponse>;
230
+ /**
231
+ * 查询邮箱地址状态
232
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/mail-v1/user/query
233
+ */
234
+ queryMailUser(body: QueryMailUserRequest): Promise<QueryMailUserResponse>;
235
+ }
236
+ }
237
+ export interface SendMailUserMailboxMessageRequest {
238
+ /** MIME邮件数据,基于base64url编码 */
239
+ raw?: string;
240
+ /** 主题 */
241
+ subject?: string;
242
+ /** 收件人 */
243
+ to?: MailAddress[];
244
+ /** 抄送 */
245
+ cc?: MailAddress[];
246
+ /** 秘送 */
247
+ bcc?: MailAddress[];
248
+ /** 发件人 */
249
+ head_from?: MailAddress;
250
+ /** 正文(base64url) */
251
+ body_html?: string;
252
+ /** 正文纯文本(base64url) */
253
+ body_plain_text?: string;
254
+ /** 邮件附件列表 */
255
+ attachments?: Attachment[];
256
+ /** 会话id */
257
+ thread_id?: string;
258
+ }
259
+ export interface CreateMailMailgroupRequest {
260
+ /** The mail group's email address */
261
+ email?: string;
262
+ /** The mail group's display name */
263
+ name?: string;
264
+ /** The mail group's description */
265
+ description?: string;
266
+ /** 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 */
267
+ who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
268
+ }
269
+ export interface PatchMailMailgroupRequest {
270
+ /** The public mailbox's new primary email address */
271
+ email?: string;
272
+ /** The mail group's display name */
273
+ name?: string;
274
+ /** The mail group's description */
275
+ description?: string;
276
+ /** 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 */
277
+ who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
278
+ }
279
+ export interface UpdateMailMailgroupRequest {
280
+ /** The public mailbox's new primary email address */
281
+ email?: string;
282
+ /** The mail group's display name */
283
+ name?: string;
284
+ /** The mail group's description */
285
+ description?: string;
286
+ /** 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 */
287
+ who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
288
+ }
289
+ export interface ListMailMailgroupQuery extends Pagination {
290
+ /** 邮件组管理员用户ID,用于获取该用户有管理权限的邮件组 */
291
+ manager_user_id?: string;
292
+ /** 此次调用中使用的用户ID的类型 */
293
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
294
+ }
295
+ export interface BatchCreateMailMailgroupManagerRequest {
296
+ /** 邮件组管理员列表 */
297
+ mailgroup_manager_list?: MailgroupManager[];
298
+ }
299
+ export interface BatchCreateMailMailgroupManagerQuery {
300
+ /** 此次调用中使用的用户ID的类型 */
301
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
302
+ }
303
+ export interface BatchDeleteMailMailgroupManagerRequest {
304
+ /** 邮件组管理员列表 */
305
+ mailgroup_manager_list?: MailgroupManager[];
306
+ }
307
+ export interface BatchDeleteMailMailgroupManagerQuery {
308
+ /** 此次调用中使用的用户ID的类型 */
309
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
310
+ }
311
+ export interface ListMailMailgroupManagerQuery extends Pagination {
312
+ /** 此次调用中使用的用户ID的类型 */
313
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
314
+ }
315
+ export interface CreateMailMailgroupMemberRequest {
316
+ /** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */
317
+ email?: string;
318
+ /** The member's user id. Value is valid when type is USER */
319
+ user_id?: string;
320
+ /** The member's department id. Value is valid when type is DEPARTMENT */
321
+ department_id?: string;
322
+ /** 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 */
323
+ type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER';
324
+ }
325
+ export interface CreateMailMailgroupMemberQuery {
326
+ /** 此次调用中使用的用户ID的类型 */
327
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
328
+ /** 此次调用中使用的部门ID的类型 */
329
+ department_id_type?: 'department_id' | 'open_department_id';
330
+ }
331
+ export interface GetMailMailgroupMemberQuery {
332
+ /** 此次调用中使用的用户ID的类型 */
333
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
334
+ /** 此次调用中使用的部门ID的类型 */
335
+ department_id_type?: 'department_id' | 'open_department_id';
336
+ }
337
+ export interface ListMailMailgroupMemberQuery extends Pagination {
338
+ /** 此次调用中使用的用户ID的类型 */
339
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
340
+ /** 此次调用中使用的部门ID的类型 */
341
+ department_id_type?: 'department_id' | 'open_department_id';
342
+ }
343
+ export interface BatchCreateMailMailgroupMemberRequest {
344
+ /** 本次添加的邮件组成员列表 */
345
+ items?: MailgroupMember[];
346
+ }
347
+ export interface BatchCreateMailMailgroupMemberQuery {
348
+ /** 此次调用中使用的用户ID的类型 */
349
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
350
+ /** 此次调用中使用的部门ID的类型 */
351
+ department_id_type?: 'department_id' | 'open_department_id';
352
+ }
353
+ export interface BatchDeleteMailMailgroupMemberRequest {
354
+ /** 本次调用删除的成员ID列表 */
355
+ member_id_list?: string[];
356
+ }
357
+ export interface CreateMailMailgroupAliasRequest {
358
+ /** 邮箱别名 */
359
+ email_alias?: string;
360
+ }
361
+ export interface CreateMailMailgroupPermissionMemberRequest {
362
+ /** The member's user id. Value is valid when type is USER */
363
+ user_id?: string;
364
+ /** The member's department id. Value is valid when type is DEPARTMENT */
365
+ department_id?: string;
366
+ /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
367
+ email?: string;
368
+ /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
369
+ type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX';
370
+ }
371
+ export interface CreateMailMailgroupPermissionMemberQuery {
372
+ /** 此次调用中使用的用户ID的类型 */
373
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
374
+ /** 此次调用中使用的部门ID的类型 */
375
+ department_id_type?: 'department_id' | 'open_department_id';
376
+ }
377
+ export interface GetMailMailgroupPermissionMemberQuery {
378
+ /** 此次调用中使用的用户ID的类型 */
379
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
380
+ /** 此次调用中使用的部门ID的类型 */
381
+ department_id_type?: 'department_id' | 'open_department_id';
382
+ }
383
+ export interface ListMailMailgroupPermissionMemberQuery extends Pagination {
384
+ /** 此次调用中使用的用户ID的类型 */
385
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
386
+ /** 此次调用中使用的部门ID的类型 */
387
+ department_id_type?: 'department_id' | 'open_department_id';
388
+ }
389
+ export interface BatchCreateMailMailgroupPermissionMemberRequest {
390
+ /** 本次添加的邮件组权限成员列表 */
391
+ items?: MailgroupPermissionMember[];
392
+ }
393
+ export interface BatchCreateMailMailgroupPermissionMemberQuery {
394
+ /** 此次调用中使用的用户ID的类型 */
395
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
396
+ /** 此次调用中使用的部门ID的类型 */
397
+ department_id_type?: 'department_id' | 'open_department_id';
398
+ }
399
+ export interface BatchDeleteMailMailgroupPermissionMemberRequest {
400
+ /** 本次调用删除的权限成员ID列表 */
401
+ permission_member_id_list: string[];
402
+ }
403
+ export interface CreateMailPublicMailboxRequest {
404
+ /** The public mailbox's email address */
405
+ email?: string;
406
+ /** The public mailbox's display name */
407
+ name?: string;
408
+ /** 数据驻留地 */
409
+ geo?: string;
410
+ }
411
+ export interface PatchMailPublicMailboxRequest {
412
+ /** The public mailbox's new primary email address */
413
+ email?: string;
414
+ /** The public mailbox's display name */
415
+ name?: string;
416
+ }
417
+ export interface UpdateMailPublicMailboxRequest {
418
+ /** The public mailbox's new primary email address */
419
+ email?: string;
420
+ /** The public mailbox's display name */
421
+ name?: string;
422
+ }
423
+ export interface CreateMailPublicMailboxMemberRequest {
424
+ /** The member's user id. Value is valid when type is USER */
425
+ user_id?: string;
426
+ /** The type of member. Possible values are:- USER: internal user in the team */
427
+ type?: 'USER';
428
+ }
429
+ export interface CreateMailPublicMailboxMemberQuery {
430
+ /** 此次调用中使用的用户ID的类型 */
431
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
432
+ }
433
+ export interface GetMailPublicMailboxMemberQuery {
434
+ /** 此次调用中使用的用户ID的类型 */
435
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
436
+ }
437
+ export interface ListMailPublicMailboxMemberQuery extends Pagination {
438
+ /** 此次调用中使用的用户ID的类型 */
439
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
440
+ }
441
+ export interface BatchCreateMailPublicMailboxMemberRequest {
442
+ /** 本次调用添加的公共邮箱成员列表 */
443
+ items: PublicMailboxMember[];
444
+ }
445
+ export interface BatchCreateMailPublicMailboxMemberQuery {
446
+ /** 此次调用中使用的用户ID的类型 */
447
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
448
+ }
449
+ export interface BatchDeleteMailPublicMailboxMemberRequest {
450
+ /** 本次调用删除的公共邮箱成员ID列表 */
451
+ member_id_list: string[];
452
+ }
453
+ export interface CreateMailPublicMailboxAliasRequest {
454
+ /** 邮箱别名 */
455
+ email_alias?: string;
456
+ }
457
+ export interface DeleteMailUserMailboxQuery {
458
+ /** 用于接受转移的邮箱地址 */
459
+ transfer_mailbox?: string;
460
+ }
461
+ export interface CreateMailUserMailboxAliasRequest {
462
+ /** 邮箱别名 */
463
+ email_alias?: string;
464
+ }
465
+ export interface QueryMailUserRequest {
466
+ /** 需要查询的邮箱地址列表 */
467
+ email_list: string[];
468
+ }
469
+ export interface CreateMailMailgroupResponse {
470
+ /** The unique ID of a mail group */
471
+ mailgroup_id?: string;
472
+ /** The mail group's email address */
473
+ email?: string;
474
+ /** The mail group's display name */
475
+ name?: string;
476
+ /** The mail group's description */
477
+ description?: string;
478
+ /** The number of mail group's direct members */
479
+ direct_members_count?: string;
480
+ /** Value is true if this mail group has external member */
481
+ include_external_member?: boolean;
482
+ /** Value is true if all company members are in this mail group */
483
+ include_all_company_member?: boolean;
484
+ /** 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 */
485
+ who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
486
+ }
487
+ export interface PatchMailMailgroupResponse {
488
+ /** The unique ID of a mail group */
489
+ mailgroup_id?: string;
490
+ /** The mail group's email address */
491
+ email?: string;
492
+ /** The mail group's display name */
493
+ name?: string;
494
+ /** The mail group's description */
495
+ description?: string;
496
+ /** The number of mail group's direct members */
497
+ direct_members_count?: string;
498
+ /** Value is true if this mail group has external member */
499
+ include_external_member?: boolean;
500
+ /** Value is true if all company members are in this mail group */
501
+ include_all_company_member?: boolean;
502
+ /** 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 */
503
+ who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
504
+ }
505
+ export interface UpdateMailMailgroupResponse {
506
+ /** The unique ID of a mail group */
507
+ mailgroup_id?: string;
508
+ /** The mail group's email address */
509
+ email?: string;
510
+ /** The mail group's display name */
511
+ name?: string;
512
+ /** The mail group's description */
513
+ description?: string;
514
+ /** The number of mail group's direct members */
515
+ direct_members_count?: string;
516
+ /** Value is true if this mail group has external member */
517
+ include_external_member?: boolean;
518
+ /** Value is true if all company members are in this mail group */
519
+ include_all_company_member?: boolean;
520
+ /** 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 */
521
+ who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
522
+ }
523
+ export interface GetMailMailgroupResponse {
524
+ /** The unique ID of a mail group */
525
+ mailgroup_id?: string;
526
+ /** The mail group's email address */
527
+ email?: string;
528
+ /** The mail group's display name */
529
+ name?: string;
530
+ /** The mail group's description */
531
+ description?: string;
532
+ /** The number of mail group's direct members */
533
+ direct_members_count?: string;
534
+ /** Value is true if this mail group has external member */
535
+ include_external_member?: boolean;
536
+ /** Value is true if all company members are in this mail group */
537
+ include_all_company_member?: boolean;
538
+ /** 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 */
539
+ who_can_send_mail?: 'ANYONE' | 'ALL_INTERNAL_USERS' | 'ALL_GROUP_MEMBERS' | 'CUSTOM_MEMBERS';
540
+ }
541
+ export interface CreateMailMailgroupMemberResponse {
542
+ /** The unique ID of a member in this mail group */
543
+ member_id?: string;
544
+ /** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */
545
+ email?: string;
546
+ /** The member's user id. Value is valid when type is USER */
547
+ user_id?: string;
548
+ /** The member's department id. Value is valid when type is DEPARTMENT */
549
+ department_id?: string;
550
+ /** 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 */
551
+ type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER';
552
+ }
553
+ export interface GetMailMailgroupMemberResponse {
554
+ /** The unique ID of a member in this mail group */
555
+ member_id?: string;
556
+ /** The member's email address. Value is valid when type is one of USER/EXTERNAL_USER/MAIL_GROUP/PUBLIC_MAILBOX/OTHER_MEMBER */
557
+ email?: string;
558
+ /** The member's user id. Value is valid when type is USER */
559
+ user_id?: string;
560
+ /** The member's department id. Value is valid when type is DEPARTMENT */
561
+ department_id?: string;
562
+ /** 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 */
563
+ type?: 'USER' | 'DEPARTMENT' | 'COMPANY' | 'EXTERNAL_USER' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX' | 'OTHER_MEMBER';
564
+ }
565
+ export interface BatchCreateMailMailgroupMemberResponse {
566
+ /** 添加成功后的邮件组成员信息列表 */
567
+ items?: MailgroupMember[];
568
+ }
569
+ export interface CreateMailMailgroupAliasResponse {
570
+ /** 邮件组别名 */
571
+ mailgroup_alias?: EmailAlias;
572
+ }
573
+ export interface ListMailMailgroupAliasResponse {
574
+ /** 邮件组别名 */
575
+ items?: EmailAlias[];
576
+ }
577
+ export interface CreateMailMailgroupPermissionMemberResponse {
578
+ /** The unique ID of a member in this permission group */
579
+ permission_member_id?: string;
580
+ /** The member's user id. Value is valid when type is USER */
581
+ user_id?: string;
582
+ /** The member's department id. Value is valid when type is DEPARTMENT */
583
+ department_id?: string;
584
+ /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
585
+ email?: string;
586
+ /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
587
+ type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX';
588
+ }
589
+ export interface GetMailMailgroupPermissionMemberResponse {
590
+ /** The unique ID of a member in this permission group */
591
+ permission_member_id?: string;
592
+ /** The member's user id. Value is valid when type is USER */
593
+ user_id?: string;
594
+ /** The member's department id. Value is valid when type is DEPARTMENT */
595
+ department_id?: string;
596
+ /** The member's email address. Value is valid when type is MAIL_GROUP/PUBLIC_MAILBOX */
597
+ email?: string;
598
+ /** The type of member. Possible values are:- USER: internal user in the team- DEPARTMENT: member is a department */
599
+ type?: 'USER' | 'DEPARTMENT' | 'MAIL_GROUP' | 'PUBLIC_MAILBOX';
600
+ }
601
+ export interface BatchCreateMailMailgroupPermissionMemberResponse {
602
+ /** 添加成功后的邮件组权限成员信息列表 */
603
+ items?: MailgroupPermissionMember[];
604
+ }
605
+ export interface CreateMailPublicMailboxResponse {
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
+ geo?: string;
614
+ }
615
+ export interface PatchMailPublicMailboxResponse {
616
+ /** The unique ID of a public mailbox */
617
+ public_mailbox_id?: string;
618
+ /** The public mailbox's email address */
619
+ email?: string;
620
+ /** The public mailbox's display name */
621
+ name?: string;
622
+ }
623
+ export interface UpdateMailPublicMailboxResponse {
624
+ /** The unique ID of a public mailbox */
625
+ public_mailbox_id?: string;
626
+ /** The public mailbox's email address */
627
+ email?: string;
628
+ /** The public mailbox's display name */
629
+ name?: string;
630
+ }
631
+ export interface GetMailPublicMailboxResponse {
632
+ /** The unique ID of a public mailbox */
633
+ public_mailbox_id?: string;
634
+ /** The public mailbox's email address */
635
+ email?: string;
636
+ /** The public mailbox's display name */
637
+ name?: string;
638
+ /** 数据驻留地 */
639
+ geo?: string;
640
+ }
641
+ export interface CreateMailPublicMailboxMemberResponse {
642
+ /** The unique ID of a member in this public mailbox */
643
+ member_id?: string;
644
+ /** The member's user id. Value is valid when type is USER */
645
+ user_id?: string;
646
+ /** The type of member. Possible values are:- USER: internal user in the team */
647
+ type?: 'USER';
648
+ }
649
+ export interface GetMailPublicMailboxMemberResponse {
650
+ /** The unique ID of a member in this public mailbox */
651
+ member_id?: string;
652
+ /** The member's user id. Value is valid when type is USER */
653
+ user_id?: string;
654
+ /** The type of member. Possible values are:- USER: internal user in the team */
655
+ type?: 'USER';
656
+ }
657
+ export interface BatchCreateMailPublicMailboxMemberResponse {
658
+ /** 添加成功后的公共邮箱成员信息列表 */
659
+ items?: PublicMailboxMember[];
660
+ }
661
+ export interface CreateMailPublicMailboxAliasResponse {
662
+ /** 公共邮箱别名 */
663
+ public_mailbox_alias?: EmailAlias;
664
+ }
665
+ export interface ListMailPublicMailboxAliasResponse {
666
+ /** 公共邮箱别名 */
667
+ items?: EmailAlias[];
668
+ }
669
+ export interface CreateMailUserMailboxAliasResponse {
670
+ /** 用户邮箱别名 */
671
+ user_mailbox_alias?: EmailAlias;
672
+ }
673
+ export interface ListMailUserMailboxAliasResponse {
674
+ /** 用户邮箱别名 */
675
+ items?: EmailAlias[];
676
+ }
677
+ export interface QueryMailUserResponse {
678
+ /** 邮箱地址返回 */
679
+ user_list?: User[];
680
+ }