@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.
Files changed (119) hide show
  1. package/lib/content.d.ts +211 -93
  2. package/lib/index.cjs +2954 -2474
  3. package/lib/internal.d.ts +4 -4
  4. package/lib/message.d.ts +2 -3
  5. package/lib/types/acs.d.ts +212 -172
  6. package/lib/types/admin.d.ts +331 -291
  7. package/lib/types/aily.d.ts +331 -216
  8. package/lib/types/apaas.d.ts +646 -494
  9. package/lib/types/application.d.ts +559 -458
  10. package/lib/types/approval.d.ts +826 -791
  11. package/lib/types/attendance.d.ts +1094 -994
  12. package/lib/types/auth.d.ts +66 -61
  13. package/lib/types/authen.d.ts +221 -186
  14. package/lib/types/baike.d.ts +258 -233
  15. package/lib/types/base.d.ts +74 -0
  16. package/lib/types/bitable.d.ts +830 -770
  17. package/lib/types/board.d.ts +29 -14
  18. package/lib/types/calendar.d.ts +660 -605
  19. package/lib/types/cardkit.d.ts +149 -134
  20. package/lib/types/compensation.d.ts +84 -49
  21. package/lib/types/contact.d.ts +1279 -1204
  22. package/lib/types/corehr.d.ts +4982 -4526
  23. package/lib/types/directory.d.ts +447 -0
  24. package/lib/types/docs.d.ts +28 -18
  25. package/lib/types/document_ai.d.ts +347 -252
  26. package/lib/types/docx.d.ts +428 -383
  27. package/lib/types/drive.d.ts +1093 -1048
  28. package/lib/types/ehr.d.ts +66 -51
  29. package/lib/types/event.d.ts +16 -6
  30. package/lib/types/helpdesk.d.ts +816 -741
  31. package/lib/types/hire.d.ts +3955 -3589
  32. package/lib/types/human_authentication.d.ts +32 -22
  33. package/lib/types/im.d.ts +1420 -1295
  34. package/lib/types/index.d.ts +1422 -330
  35. package/lib/types/lingo.d.ts +279 -249
  36. package/lib/types/mail.d.ts +1032 -675
  37. package/lib/types/mdm.d.ts +105 -37
  38. package/lib/types/minutes.d.ts +73 -26
  39. package/lib/types/moments.d.ts +23 -13
  40. package/lib/types/okr.d.ts +266 -225
  41. package/lib/types/optical_char_recognition.d.ts +22 -12
  42. package/lib/types/passport.d.ts +58 -48
  43. package/lib/types/payroll.d.ts +210 -53
  44. package/lib/types/performance.d.ts +463 -414
  45. package/lib/types/personal_settings.d.ts +93 -82
  46. package/lib/types/report.d.ts +79 -58
  47. package/lib/types/search.d.ts +265 -235
  48. package/lib/types/security_and_compliance.d.ts +30 -19
  49. package/lib/types/sheets.d.ts +356 -321
  50. package/lib/types/speech_to_text.d.ts +44 -34
  51. package/lib/types/task.d.ts +998 -1087
  52. package/lib/types/tenant.d.ts +25 -15
  53. package/lib/types/translation.d.ts +42 -32
  54. package/lib/types/trust_party.d.ts +81 -0
  55. package/lib/types/vc.d.ts +1218 -1123
  56. package/lib/types/verification.d.ts +11 -6
  57. package/lib/types/wiki.d.ts +270 -235
  58. package/lib/types/workplace.d.ts +58 -38
  59. package/lib/utils.d.ts +2 -2
  60. package/package.json +4 -4
  61. package/src/bot.ts +15 -15
  62. package/src/content.ts +230 -107
  63. package/src/internal.ts +29 -12
  64. package/src/message.ts +82 -111
  65. package/src/types/acs.ts +234 -186
  66. package/src/types/admin.ts +353 -305
  67. package/src/types/aily.ts +375 -233
  68. package/src/types/apaas.ts +754 -568
  69. package/src/types/application.ts +633 -507
  70. package/src/types/approval.ts +914 -872
  71. package/src/types/attendance.ts +1226 -1104
  72. package/src/types/auth.ts +72 -66
  73. package/src/types/authen.ts +233 -191
  74. package/src/types/baike.ts +276 -246
  75. package/src/types/base.ts +93 -0
  76. package/src/types/bitable.ts +966 -894
  77. package/src/types/board.ts +34 -16
  78. package/src/types/calendar.ts +751 -685
  79. package/src/types/cardkit.ts +164 -146
  80. package/src/types/compensation.ts +97 -55
  81. package/src/types/contact.ts +1465 -1375
  82. package/src/types/corehr.ts +5664 -5077
  83. package/src/types/directory.ts +569 -0
  84. package/src/types/docs.ts +31 -19
  85. package/src/types/document_ai.ts +401 -287
  86. package/src/types/docx.ts +492 -438
  87. package/src/types/drive.ts +1266 -1213
  88. package/src/types/ehr.ts +71 -53
  89. package/src/types/event.ts +19 -7
  90. package/src/types/helpdesk.ts +930 -840
  91. package/src/types/hire.ts +4453 -4019
  92. package/src/types/human_authentication.ts +35 -23
  93. package/src/types/im.ts +1626 -1476
  94. package/src/types/index.ts +1532 -346
  95. package/src/types/lingo.ts +299 -263
  96. package/src/types/mail.ts +1231 -779
  97. package/src/types/mdm.ts +122 -39
  98. package/src/types/minutes.ts +88 -28
  99. package/src/types/moments.ts +26 -14
  100. package/src/types/okr.ts +286 -238
  101. package/src/types/optical_char_recognition.ts +25 -13
  102. package/src/types/passport.ts +62 -50
  103. package/src/types/payroll.ts +254 -57
  104. package/src/types/performance.ts +528 -467
  105. package/src/types/personal_settings.ts +101 -89
  106. package/src/types/report.ts +86 -62
  107. package/src/types/search.ts +285 -249
  108. package/src/types/security_and_compliance.ts +33 -21
  109. package/src/types/sheets.ts +421 -379
  110. package/src/types/speech_to_text.ts +48 -36
  111. package/src/types/task.ts +1152 -1260
  112. package/src/types/tenant.ts +29 -17
  113. package/src/types/translation.ts +46 -34
  114. package/src/types/trust_party.ts +110 -0
  115. package/src/types/vc.ts +1397 -1283
  116. package/src/types/verification.ts +13 -7
  117. package/src/types/wiki.ts +293 -251
  118. package/src/types/workplace.ts +65 -41
  119. package/src/utils.ts +3 -3
@@ -1,233 +1,274 @@
1
- import { ContentBlock, OkrBatch, OkrReview, Period, PeriodRule } from '.';
1
+ import * as Lark from '.';
2
+ import { Paginated, Pagination } from '../internal';
2
3
  declare module '../internal' {
3
4
  interface Internal {
4
- /**
5
- * 创建 OKR 周期
6
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/create
7
- */
8
- createOkrPeriod(body: CreateOkrPeriodRequest): Promise<CreateOkrPeriodResponse>;
9
- /**
10
- * 修改 OKR 周期状态
11
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/patch
12
- */
13
- patchOkrPeriod(period_id: string, body: PatchOkrPeriodRequest): Promise<PatchOkrPeriodResponse>;
14
- /**
15
- * 获取 OKR 周期列表
16
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/list
17
- */
18
- listOkrPeriod(query?: Pagination): Paginated<Period>;
19
- /**
20
- * 获取 OKR 周期规则
21
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period_rule/list
22
- */
23
- listOkrPeriodRule(): Promise<ListOkrPeriodRuleResponse>;
24
- /**
25
- * 获取用户的 OKR 列表
26
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/user-okr/list
27
- */
28
- listOkrUserOkr(user_id: string, query?: ListOkrUserOkrQuery): Promise<ListOkrUserOkrResponse>;
5
+ okr: Okr.Methods;
6
+ }
7
+ }
8
+ export declare namespace Okr {
9
+ interface Methods {
10
+ period: Period.Methods;
11
+ periodRule: PeriodRule.Methods;
12
+ user: User.Methods;
13
+ progressRecord: ProgressRecord.Methods;
14
+ image: Image.Methods;
15
+ review: Review.Methods;
29
16
  /**
30
17
  * 批量获取 OKR
31
18
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/okr/batch_get
32
19
  */
33
- batchGetOkr(query?: BatchGetOkrQuery): Promise<BatchGetOkrResponse>;
34
- /**
35
- * 创建 OKR 进展记录
36
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create
37
- */
38
- createOkrProgressRecord(body: CreateOkrProgressRecordRequest, query?: CreateOkrProgressRecordQuery): Promise<CreateOkrProgressRecordResponse>;
39
- /**
40
- * 删除 OKR 进展记录
41
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/delete
42
- */
43
- deleteOkrProgressRecord(progress_id: string): Promise<void>;
44
- /**
45
- * 更新 OKR 进展记录
46
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update
47
- */
48
- updateOkrProgressRecord(progress_id: string, body: UpdateOkrProgressRecordRequest, query?: UpdateOkrProgressRecordQuery): Promise<UpdateOkrProgressRecordResponse>;
49
- /**
50
- * 获取 OKR 进展记录
51
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/get
52
- */
53
- getOkrProgressRecord(progress_id: string, query?: GetOkrProgressRecordQuery): Promise<GetOkrProgressRecordResponse>;
54
- /**
55
- * 上传进展记录图片
56
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/image/upload
57
- */
58
- uploadOkrImage(form: UploadOkrImageForm): Promise<UploadOkrImageResponse>;
59
- /**
60
- * 查询复盘信息
61
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/review/query
62
- */
63
- queryOkrReview(query?: QueryOkrReviewQuery): Promise<QueryOkrReviewResponse>;
20
+ batchGet(query?: BatchGetQuery): Promise<BatchGetResponse>;
21
+ }
22
+ interface BatchGetQuery {
23
+ /** 此次调用中使用的用户ID的类型 */
24
+ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id';
25
+ /** OKR ID 列表,最多10个 */
26
+ okr_ids: string[];
27
+ /** 请求OKR的语言版本(比如@的人名),lang=en_us/zh_cn,请求 Query中 */
28
+ lang?: string;
29
+ }
30
+ interface BatchGetResponse {
31
+ /** OKR 列表 */
32
+ okr_list?: Lark.OkrBatch[];
33
+ }
34
+ namespace Period {
35
+ interface Methods {
36
+ /**
37
+ * 创建 OKR 周期
38
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/create
39
+ */
40
+ create(body: CreateRequest): Promise<CreateResponse>;
41
+ /**
42
+ * 修改 OKR 周期状态
43
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/patch
44
+ */
45
+ patch(period_id: string, body: PatchRequest): Promise<PatchResponse>;
46
+ /**
47
+ * 获取 OKR 周期列表
48
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period/list
49
+ */
50
+ list(query?: Pagination): Paginated<Lark.Period>;
51
+ }
52
+ interface CreateRequest {
53
+ /** 周期规则 id */
54
+ period_rule_id: string;
55
+ /** 周期起始年月 */
56
+ start_month: string;
57
+ }
58
+ interface CreateResponse {
59
+ /** 周期id */
60
+ period_id?: string;
61
+ /** 周期起始年月 */
62
+ start_month?: string;
63
+ /** 周期结束年月 */
64
+ end_month?: string;
65
+ }
66
+ const enum PatchRequestStatus {
67
+ /** 正常状态 */
68
+ NormalStatus = 1,
69
+ /** 标记失效 */
70
+ MarkInvalid = 2,
71
+ /** 隐藏周期 */
72
+ HiddenPeriod = 3
73
+ }
74
+ interface PatchRequest {
75
+ /** 周期显示状态 */
76
+ status: PatchRequestStatus;
77
+ }
78
+ const enum PatchResponseStatus {
79
+ /** 正常状态 */
80
+ NormalStatus = 1,
81
+ /** 标记失效 */
82
+ MarkInvalid = 2,
83
+ /** 隐藏周期 */
84
+ HiddenPeriod = 3
85
+ }
86
+ interface PatchResponse {
87
+ /** 周期规则id */
88
+ period_id?: string;
89
+ /** 周期显示状态 */
90
+ status?: PatchResponseStatus;
91
+ }
92
+ }
93
+ namespace PeriodRule {
94
+ interface Methods {
95
+ /**
96
+ * 获取 OKR 周期规则
97
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/period_rule/list
98
+ */
99
+ list(): Promise<ListResponse>;
100
+ }
101
+ interface ListResponse {
102
+ /** 指标库列表 */
103
+ period_rules?: Lark.PeriodRule[];
104
+ }
105
+ }
106
+ namespace User {
107
+ interface Methods {
108
+ okr: Okr.Methods;
109
+ }
110
+ namespace Okr {
111
+ interface Methods {
112
+ /**
113
+ * 获取用户的 OKR 列表
114
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/user-okr/list
115
+ */
116
+ list(user_id: string, query?: ListQuery): Promise<ListResponse>;
117
+ }
118
+ interface ListQuery {
119
+ /** 此次调用中使用的用户ID的类型 */
120
+ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id';
121
+ /** 请求列表的偏移,offset>=0 */
122
+ offset: string;
123
+ /** 列表长度,0-10 */
124
+ limit: string;
125
+ /** 请求OKR的语言版本(比如@的人名),lang=en_us/zh_cn */
126
+ lang?: string;
127
+ /** period_id列表,最多10个 */
128
+ period_ids?: string[];
129
+ }
130
+ interface ListResponse {
131
+ /** OKR周期总数 */
132
+ total?: number;
133
+ /** OKR 列表 */
134
+ okr_list?: Lark.OkrBatch[];
135
+ }
136
+ }
137
+ }
138
+ namespace ProgressRecord {
139
+ interface Methods {
140
+ /**
141
+ * 创建 OKR 进展记录
142
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/create
143
+ */
144
+ create(body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
145
+ /**
146
+ * 删除 OKR 进展记录
147
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/delete
148
+ */
149
+ delete(progress_id: string): Promise<void>;
150
+ /**
151
+ * 更新 OKR 进展记录
152
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/update
153
+ */
154
+ update(progress_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>;
155
+ /**
156
+ * 获取 OKR 进展记录
157
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/progress_record/get
158
+ */
159
+ get(progress_id: string, query?: GetQuery): Promise<GetResponse>;
160
+ }
161
+ const enum CreateRequestTargetType {
162
+ /** okr的O */
163
+ Objective = 2,
164
+ /** okr的KR */
165
+ KeyResult = 3
166
+ }
167
+ interface CreateRequest {
168
+ /** 进展来源 */
169
+ source_title: string;
170
+ /** 进展来源链接 */
171
+ source_url: string;
172
+ /** 目标id,与target_type对应 */
173
+ target_id: string;
174
+ /** 目标类型 */
175
+ target_type: CreateRequestTargetType;
176
+ /** 进展详情 富文本格式 */
177
+ content: Lark.ContentBlock;
178
+ /** pc进展来源链接 */
179
+ source_url_pc?: string;
180
+ /** mobile进展来源链接 */
181
+ source_url_mobile?: string;
182
+ }
183
+ interface CreateQuery {
184
+ /** 此次调用中使用的用户ID的类型 */
185
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
186
+ }
187
+ interface CreateResponse {
188
+ /** OKR 进展ID */
189
+ progress_id?: string;
190
+ /** 进展更新时间 毫秒 */
191
+ modify_time?: string;
192
+ /** 进展 对应的 Content 详细内容 */
193
+ content?: Lark.ContentBlock;
194
+ }
195
+ interface UpdateRequest {
196
+ /** 进展详情 富文本格式 */
197
+ content: Lark.ContentBlock;
198
+ }
199
+ interface UpdateQuery {
200
+ /** 此次调用中使用的用户ID的类型 */
201
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
202
+ }
203
+ interface UpdateResponse {
204
+ /** OKR 进展ID */
205
+ progress_id?: string;
206
+ /** 进展更新时间 毫秒 */
207
+ modify_time?: string;
208
+ /** 进展 对应的 Content 详细内容 */
209
+ content?: Lark.ContentBlock;
210
+ }
211
+ interface GetQuery {
212
+ /** 此次调用中使用的用户ID的类型 */
213
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
214
+ }
215
+ interface GetResponse {
216
+ /** OKR 进展ID */
217
+ progress_id?: string;
218
+ /** 进展更新时间 毫秒 */
219
+ modify_time?: string;
220
+ /** 进展 对应的 Content 详细内容 */
221
+ content?: Lark.ContentBlock;
222
+ }
223
+ }
224
+ namespace Image {
225
+ interface Methods {
226
+ /**
227
+ * 上传进展记录图片
228
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/image/upload
229
+ */
230
+ upload(form: UploadForm): Promise<UploadResponse>;
231
+ }
232
+ const enum UploadFormTargetType {
233
+ /** okr的O */
234
+ Objective = 2,
235
+ /** okr的KR */
236
+ KeyResult = 3
237
+ }
238
+ interface UploadForm {
239
+ /** 图片 */
240
+ data: Blob;
241
+ /** 图片的目标ID */
242
+ target_id: string;
243
+ /** 图片使用的目标类型 */
244
+ target_type: UploadFormTargetType;
245
+ }
246
+ interface UploadResponse {
247
+ /** 图片token */
248
+ file_token?: string;
249
+ /** 图片下载链接 */
250
+ url?: string;
251
+ }
252
+ }
253
+ namespace Review {
254
+ interface Methods {
255
+ /**
256
+ * 查询复盘信息
257
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/okr-v1/review/query
258
+ */
259
+ query(query?: QueryQuery): Promise<QueryResponse>;
260
+ }
261
+ interface QueryQuery {
262
+ /** 此次调用中使用的用户ID的类型 */
263
+ user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id';
264
+ /** 目标用户id列表,最多5个 */
265
+ user_ids: string[];
266
+ /** period_id列表,最多5个 */
267
+ period_ids: string[];
268
+ }
269
+ interface QueryResponse {
270
+ /** OKR复盘 列表 */
271
+ review_list?: Lark.OkrReview[];
272
+ }
64
273
  }
65
- }
66
- export interface CreateOkrPeriodRequest {
67
- /** 周期规则 id */
68
- period_rule_id: string;
69
- /** 周期起始年月 */
70
- start_month: string;
71
- }
72
- export interface CreateOkrPeriodResponse {
73
- /** 周期id */
74
- period_id?: string;
75
- /** 周期起始年月 */
76
- start_month?: string;
77
- /** 周期结束年月 */
78
- end_month?: string;
79
- }
80
- export declare const enum PatchOkrPeriodRequestStatus {
81
- /** 正常状态 */
82
- NormalStatus = 1,
83
- /** 标记失效 */
84
- MarkInvalid = 2,
85
- /** 隐藏周期 */
86
- HiddenPeriod = 3
87
- }
88
- export interface PatchOkrPeriodRequest {
89
- /** 周期显示状态 */
90
- status: PatchOkrPeriodRequestStatus;
91
- }
92
- export declare const enum PatchOkrPeriodResponseStatus {
93
- /** 正常状态 */
94
- NormalStatus = 1,
95
- /** 标记失效 */
96
- MarkInvalid = 2,
97
- /** 隐藏周期 */
98
- HiddenPeriod = 3
99
- }
100
- export interface PatchOkrPeriodResponse {
101
- /** 周期规则id */
102
- period_id?: string;
103
- /** 周期显示状态 */
104
- status?: PatchOkrPeriodResponseStatus;
105
- }
106
- export interface ListOkrPeriodRuleResponse {
107
- /** 指标库列表 */
108
- period_rules?: PeriodRule[];
109
- }
110
- export interface ListOkrUserOkrQuery {
111
- /** 此次调用中使用的用户ID的类型 */
112
- user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id';
113
- /** 请求列表的偏移,offset>=0 */
114
- offset: string;
115
- /** 列表长度,0-10 */
116
- limit: string;
117
- /** 请求OKR的语言版本(比如@的人名),lang=en_us/zh_cn */
118
- lang?: string;
119
- /** period_id列表,最多10个 */
120
- period_ids?: string[];
121
- }
122
- export interface ListOkrUserOkrResponse {
123
- /** OKR周期总数 */
124
- total?: number;
125
- /** OKR 列表 */
126
- okr_list?: OkrBatch[];
127
- }
128
- export interface BatchGetOkrQuery {
129
- /** 此次调用中使用的用户ID的类型 */
130
- user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id';
131
- /** OKR ID 列表,最多10个 */
132
- okr_ids: string[];
133
- /** 请求OKR的语言版本(比如@的人名),lang=en_us/zh_cn,请求 Query中 */
134
- lang?: string;
135
- }
136
- export interface BatchGetOkrResponse {
137
- /** OKR 列表 */
138
- okr_list?: OkrBatch[];
139
- }
140
- export declare const enum CreateOkrProgressRecordRequestTargetType {
141
- /** okr的O */
142
- Objective = 2,
143
- /** okr的KR */
144
- KeyResult = 3
145
- }
146
- export interface CreateOkrProgressRecordRequest {
147
- /** 进展来源 */
148
- source_title: string;
149
- /** 进展来源链接 */
150
- source_url: string;
151
- /** 目标id,与target_type对应 */
152
- target_id: string;
153
- /** 目标类型 */
154
- target_type: CreateOkrProgressRecordRequestTargetType;
155
- /** 进展详情 富文本格式 */
156
- content: ContentBlock;
157
- /** pc进展来源链接 */
158
- source_url_pc?: string;
159
- /** mobile进展来源链接 */
160
- source_url_mobile?: string;
161
- }
162
- export interface CreateOkrProgressRecordQuery {
163
- /** 此次调用中使用的用户ID的类型 */
164
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
165
- }
166
- export interface CreateOkrProgressRecordResponse {
167
- /** OKR 进展ID */
168
- progress_id?: string;
169
- /** 进展更新时间 毫秒 */
170
- modify_time?: string;
171
- /** 进展 对应的 Content 详细内容 */
172
- content?: ContentBlock;
173
- }
174
- export interface UpdateOkrProgressRecordRequest {
175
- /** 进展详情 富文本格式 */
176
- content: ContentBlock;
177
- }
178
- export interface UpdateOkrProgressRecordQuery {
179
- /** 此次调用中使用的用户ID的类型 */
180
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
181
- }
182
- export interface UpdateOkrProgressRecordResponse {
183
- /** OKR 进展ID */
184
- progress_id?: string;
185
- /** 进展更新时间 毫秒 */
186
- modify_time?: string;
187
- /** 进展 对应的 Content 详细内容 */
188
- content?: ContentBlock;
189
- }
190
- export interface GetOkrProgressRecordQuery {
191
- /** 此次调用中使用的用户ID的类型 */
192
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
193
- }
194
- export interface GetOkrProgressRecordResponse {
195
- /** OKR 进展ID */
196
- progress_id?: string;
197
- /** 进展更新时间 毫秒 */
198
- modify_time?: string;
199
- /** 进展 对应的 Content 详细内容 */
200
- content?: ContentBlock;
201
- }
202
- export declare const enum UploadOkrImageFormTargetType {
203
- /** okr的O */
204
- Objective = 2,
205
- /** okr的KR */
206
- KeyResult = 3
207
- }
208
- export interface UploadOkrImageForm {
209
- /** 图片 */
210
- data: Blob;
211
- /** 图片的目标ID */
212
- target_id: string;
213
- /** 图片使用的目标类型 */
214
- target_type: UploadOkrImageFormTargetType;
215
- }
216
- export interface UploadOkrImageResponse {
217
- /** 图片token */
218
- file_token?: string;
219
- /** 图片下载链接 */
220
- url?: string;
221
- }
222
- export interface QueryOkrReviewQuery {
223
- /** 此次调用中使用的用户ID的类型 */
224
- user_id_type?: 'user_id' | 'union_id' | 'open_id' | 'people_admin_id';
225
- /** 目标用户id列表,最多5个 */
226
- user_ids: string[];
227
- /** period_id列表,最多5个 */
228
- period_ids: string[];
229
- }
230
- export interface QueryOkrReviewResponse {
231
- /** OKR复盘 列表 */
232
- review_list?: OkrReview[];
233
274
  }
@@ -1,17 +1,27 @@
1
1
  declare module '../internal' {
2
2
  interface Internal {
3
- /**
4
- * 识别图片中的文字
5
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/optical_char_recognition-v1/image/basic_recognize
6
- */
7
- basicRecognizeOpticalCharRecognitionImage(body: BasicRecognizeOpticalCharRecognitionImageRequest): Promise<BasicRecognizeOpticalCharRecognitionImageResponse>;
3
+ opticalCharRecognition: OpticalCharRecognition.Methods;
8
4
  }
9
5
  }
10
- export interface BasicRecognizeOpticalCharRecognitionImageRequest {
11
- /** base64 后的图片数据 */
12
- image?: string;
13
- }
14
- export interface BasicRecognizeOpticalCharRecognitionImageResponse {
15
- /** 按区域识别,返回文本列表 */
16
- text_list: string[];
6
+ export declare namespace OpticalCharRecognition {
7
+ interface Methods {
8
+ image: Image.Methods;
9
+ }
10
+ namespace Image {
11
+ interface Methods {
12
+ /**
13
+ * 识别图片中的文字
14
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/optical_char_recognition-v1/image/basic_recognize
15
+ */
16
+ basicRecognize(body: BasicRecognizeRequest): Promise<BasicRecognizeResponse>;
17
+ }
18
+ interface BasicRecognizeRequest {
19
+ /** base64 后的图片数据 */
20
+ image?: string;
21
+ }
22
+ interface BasicRecognizeResponse {
23
+ /** 按区域识别,返回文本列表 */
24
+ text_list: string[];
25
+ }
26
+ }
17
27
  }
@@ -1,53 +1,63 @@
1
- import { MaskSession } from '.';
1
+ import * as Lark from '.';
2
2
  declare module '../internal' {
3
3
  interface Internal {
4
- /**
5
- * 批量获取脱敏的用户登录信息
6
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/query
7
- */
8
- queryPassportSession(body: QueryPassportSessionRequest, query?: QueryPassportSessionQuery): Promise<QueryPassportSessionResponse>;
9
- /**
10
- * 退出登录
11
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/logout
12
- */
13
- logoutPassportSession(body: LogoutPassportSessionRequest, query?: LogoutPassportSessionQuery): Promise<void>;
4
+ passport: Passport.Methods;
14
5
  }
15
6
  }
16
- export interface QueryPassportSessionRequest {
17
- /** 用户 ID */
18
- user_ids?: string[];
19
- }
20
- export interface QueryPassportSessionQuery {
21
- /** 用户id类型 */
22
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
23
- }
24
- export interface QueryPassportSessionResponse {
25
- /** session信息 */
26
- mask_sessions?: MaskSession[];
27
- }
28
- export declare const enum LogoutPassportSessionRequestLogoutType {
29
- /** UserID */
30
- UserID = 1,
31
- /** IdpCredentialID */
32
- IdpCredentialID = 2,
33
- /** Session 标识符 */
34
- SessionUUID = 3
35
- }
36
- export interface LogoutPassportSessionRequest {
37
- /** idp 侧的唯一标识 */
38
- idp_credential_id?: string;
39
- /** 登出的方式 */
40
- logout_type: LogoutPassportSessionRequestLogoutType;
41
- /** 登出的客户端类型,默认全部登出,1-桌面端,2-网页端,3-安卓移动端,4-Apple移动端 5-服务端 6-旧版小程序端 8-其他移动端 */
42
- terminal_type?: number[];
43
- /** user_id */
44
- user_id?: string;
45
- /** 登出原因 */
46
- logout_reason?: number;
47
- /** 需要精确登出的 session 标识符 */
48
- sid?: string;
49
- }
50
- export interface LogoutPassportSessionQuery {
51
- /** user_id_type */
52
- user_id_type?: 'open_id' | 'union_id' | 'user_id';
7
+ export declare namespace Passport {
8
+ interface Methods {
9
+ session: Session.Methods;
10
+ }
11
+ namespace Session {
12
+ interface Methods {
13
+ /**
14
+ * 批量获取脱敏的用户登录信息
15
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/query
16
+ */
17
+ query(body: QueryRequest, query?: QueryQuery): Promise<QueryResponse>;
18
+ /**
19
+ * 退出登录
20
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/passport-v1/session/logout
21
+ */
22
+ logout(body: LogoutRequest, query?: LogoutQuery): Promise<void>;
23
+ }
24
+ interface QueryRequest {
25
+ /** 用户 ID */
26
+ user_ids?: string[];
27
+ }
28
+ interface QueryQuery {
29
+ /** 用户id类型 */
30
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
31
+ }
32
+ interface QueryResponse {
33
+ /** session信息 */
34
+ mask_sessions?: Lark.MaskSession[];
35
+ }
36
+ const enum LogoutRequestLogoutType {
37
+ /** UserID */
38
+ UserID = 1,
39
+ /** IdpCredentialID */
40
+ IdpCredentialID = 2,
41
+ /** Session 标识符 */
42
+ SessionUUID = 3
43
+ }
44
+ interface LogoutRequest {
45
+ /** idp 侧的唯一标识 */
46
+ idp_credential_id?: string;
47
+ /** 登出的方式 */
48
+ logout_type: LogoutRequestLogoutType;
49
+ /** 登出的客户端类型,默认全部登出,1-桌面端,2-网页端,3-安卓移动端,4-Apple移动端 5-服务端 6-旧版小程序端 8-其他移动端 */
50
+ terminal_type?: number[];
51
+ /** user_id */
52
+ user_id?: string;
53
+ /** 登出原因 */
54
+ logout_reason?: number;
55
+ /** 需要精确登出的 session 标识符 */
56
+ sid?: string;
57
+ }
58
+ interface LogoutQuery {
59
+ /** user_id_type */
60
+ user_id_type?: 'open_id' | 'union_id' | 'user_id';
61
+ }
62
+ }
53
63
  }