@satorijs/adapter-lark 3.9.1 → 3.9.3

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 (82) hide show
  1. package/lib/index.cjs +1078 -14
  2. package/lib/types/acs.d.ts +19 -19
  3. package/lib/types/admin.d.ts +58 -32
  4. package/lib/types/aily.d.ts +52 -52
  5. package/lib/types/apaas.d.ts +96 -96
  6. package/lib/types/application.d.ts +151 -67
  7. package/lib/types/approval.d.ts +182 -150
  8. package/lib/types/attendance.d.ts +395 -353
  9. package/lib/types/auth.d.ts +18 -18
  10. package/lib/types/authen.d.ts +24 -24
  11. package/lib/types/baike.d.ts +42 -42
  12. package/lib/types/bitable.d.ts +268 -184
  13. package/lib/types/calendar.d.ts +144 -144
  14. package/lib/types/cardkit.d.ts +8 -8
  15. package/lib/types/contact.d.ts +209 -137
  16. package/lib/types/corehr.d.ts +760 -620
  17. package/lib/types/document_ai.d.ts +68 -68
  18. package/lib/types/docx.d.ts +103 -95
  19. package/lib/types/drive.d.ts +236 -236
  20. package/lib/types/ehr.d.ts +26 -2
  21. package/lib/types/helpdesk.d.ts +155 -155
  22. package/lib/types/hire.d.ts +954 -510
  23. package/lib/types/im.d.ts +446 -446
  24. package/lib/types/index.d.ts +72 -30
  25. package/lib/types/lingo.d.ts +28 -28
  26. package/lib/types/mail.d.ts +192 -192
  27. package/lib/types/minutes.d.ts +4 -4
  28. package/lib/types/okr.d.ts +86 -58
  29. package/lib/types/passport.d.ts +13 -5
  30. package/lib/types/payroll.d.ts +13 -5
  31. package/lib/types/performance.d.ts +85 -79
  32. package/lib/types/personal_settings.d.ts +12 -12
  33. package/lib/types/report.d.ts +11 -5
  34. package/lib/types/search.d.ts +48 -24
  35. package/lib/types/sheets.d.ts +64 -64
  36. package/lib/types/speech_to_text.d.ts +4 -4
  37. package/lib/types/task.d.ts +191 -185
  38. package/lib/types/translation.d.ts +4 -4
  39. package/lib/types/vc.d.ts +335 -155
  40. package/lib/types/wiki.d.ts +48 -48
  41. package/package.json +1 -1
  42. package/src/internal.ts +1 -1
  43. package/src/types/acs.ts +24 -24
  44. package/src/types/admin.ts +69 -39
  45. package/src/types/aily.ts +61 -61
  46. package/src/types/apaas.ts +113 -113
  47. package/src/types/application.ts +173 -79
  48. package/src/types/approval.ts +202 -166
  49. package/src/types/attendance.ts +466 -421
  50. package/src/types/auth.ts +20 -20
  51. package/src/types/authen.ts +28 -28
  52. package/src/types/baike.ts +55 -55
  53. package/src/types/bitable.ts +305 -219
  54. package/src/types/calendar.ts +167 -167
  55. package/src/types/cardkit.ts +10 -10
  56. package/src/types/contact.ts +251 -169
  57. package/src/types/corehr.ts +903 -743
  58. package/src/types/document_ai.ts +85 -85
  59. package/src/types/docx.ts +117 -108
  60. package/src/types/drive.ts +298 -298
  61. package/src/types/ehr.ts +28 -2
  62. package/src/types/helpdesk.ts +181 -181
  63. package/src/types/hire.ts +1081 -591
  64. package/src/types/im.ts +521 -521
  65. package/src/types/index.ts +73 -30
  66. package/src/types/lingo.ts +36 -36
  67. package/src/types/mail.ts +215 -215
  68. package/src/types/minutes.ts +5 -5
  69. package/src/types/okr.ts +98 -66
  70. package/src/types/passport.ts +15 -6
  71. package/src/types/payroll.ts +15 -6
  72. package/src/types/performance.ts +98 -91
  73. package/src/types/personal_settings.ts +15 -15
  74. package/src/types/report.ts +13 -6
  75. package/src/types/search.ts +57 -29
  76. package/src/types/sheets.ts +80 -80
  77. package/src/types/speech_to_text.ts +5 -5
  78. package/src/types/task.ts +238 -231
  79. package/src/types/translation.ts +5 -5
  80. package/src/types/vc.ts +386 -186
  81. package/src/types/wiki.ts +59 -59
  82. package/src/utils.ts +12 -7
@@ -106,11 +106,23 @@ export interface CreateSearchAppQuery extends Pagination {
106
106
  /** 此次调用中使用的用户ID的类型 */
107
107
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
108
108
  }
109
+ export declare const enum CreateSearchDataSourceRequestState {
110
+ /** 已上线 */
111
+ Online = 0,
112
+ /** 未上线 */
113
+ Offline = 1
114
+ }
115
+ export declare const enum CreateSearchDataSourceRequestConnectType {
116
+ /** 调用搜索请求时,使用的是飞书搜索接口 */
117
+ Default = 0,
118
+ /** 调用搜索请求时,使用的是自定义回调函数的Uri */
119
+ Callback = 1
120
+ }
109
121
  export interface CreateSearchDataSourceRequest {
110
122
  /** data_source的展示名称 */
111
123
  name: string;
112
124
  /** 数据源状态,0-已上线,1-未上线 */
113
- state?: 0 | 1;
125
+ state?: CreateSearchDataSourceRequestState;
114
126
  /** 对于数据源的描述 */
115
127
  description?: string;
116
128
  /** 数据源在 search tab 上的展示图标路径 */
@@ -128,17 +140,27 @@ export interface CreateSearchDataSourceRequest {
128
140
  /** datasource对应的开放平台应用id */
129
141
  app_id?: string;
130
142
  /** 搜索请求的接入方式 */
131
- connect_type?: 0 | 1;
143
+ connect_type?: CreateSearchDataSourceRequestConnectType;
132
144
  /** 根据连接器类型不同所需要提供的相关参数 */
133
145
  connector_param?: ConnectorParam;
134
146
  /** 是否使用问答服务 */
135
147
  enable_answer?: boolean;
136
148
  }
149
+ export interface CreateSearchDataSourceResponse {
150
+ /** 数据源实例 */
151
+ data_source?: DataSource;
152
+ }
153
+ export declare const enum PatchSearchDataSourceRequestState {
154
+ /** 已上线 */
155
+ Online = 0,
156
+ /** 未上线 */
157
+ Offline = 1
158
+ }
137
159
  export interface PatchSearchDataSourceRequest {
138
160
  /** 数据源的展示名称 */
139
161
  name?: string;
140
162
  /** 数据源状态,0-已上线,1-未上线 */
141
- state?: 0 | 1;
163
+ state?: PatchSearchDataSourceRequestState;
142
164
  /** 对于数据源的描述 */
143
165
  description?: string;
144
166
  /** 数据源在 search tab 上的展示图标路径 */
@@ -152,9 +174,23 @@ export interface PatchSearchDataSourceRequest {
152
174
  /** 是否使用问答服务 */
153
175
  enable_answer?: boolean;
154
176
  }
177
+ export interface PatchSearchDataSourceResponse {
178
+ /** 数据源 */
179
+ data_source?: DataSource;
180
+ }
181
+ export interface GetSearchDataSourceResponse {
182
+ /** 数据源实例 */
183
+ data_source?: DataSource;
184
+ }
185
+ export declare const enum ListSearchDataSourceQueryView {
186
+ /** 全量数据 */
187
+ FULL = 0,
188
+ /** 摘要数据 */
189
+ BASIC = 1
190
+ }
155
191
  export interface ListSearchDataSourceQuery extends Pagination {
156
192
  /** 回包数据格式,0-全量数据;1-摘要数据。**注**:摘要数据仅包含"id","name","state"。 */
157
- view?: 0 | 1;
193
+ view?: ListSearchDataSourceQueryView;
158
194
  }
159
195
  export interface CreateSearchDataSourceItemRequest {
160
196
  /** item 在 datasource 中的唯一标识,只接受英文字母、数字和下划线 */
@@ -168,6 +204,10 @@ export interface CreateSearchDataSourceItemRequest {
168
204
  /** 非结构化数据,如文档文本 */
169
205
  content?: ItemContent;
170
206
  }
207
+ export interface GetSearchDataSourceItemResponse {
208
+ /** 数据项实例 */
209
+ item: Item;
210
+ }
171
211
  export interface CreateSearchSchemaRequest {
172
212
  /** 数据范式的属性定义 */
173
213
  properties: SchemaProperty[];
@@ -180,32 +220,16 @@ export interface CreateSearchSchemaQuery {
180
220
  /** 是否只用来校验合法性 */
181
221
  validate_only?: boolean;
182
222
  }
223
+ export interface CreateSearchSchemaResponse {
224
+ /** 数据范式实例 */
225
+ schema?: Schema;
226
+ }
183
227
  export interface PatchSearchSchemaRequest {
184
228
  /** 数据展示相关配置 */
185
229
  display?: SchemaDisplay;
186
230
  /** 数据范式的属性定义 */
187
231
  properties?: PatchSchemaProperty[];
188
232
  }
189
- export interface CreateSearchDataSourceResponse {
190
- /** 数据源实例 */
191
- data_source?: DataSource;
192
- }
193
- export interface PatchSearchDataSourceResponse {
194
- /** 数据源 */
195
- data_source?: DataSource;
196
- }
197
- export interface GetSearchDataSourceResponse {
198
- /** 数据源实例 */
199
- data_source?: DataSource;
200
- }
201
- export interface GetSearchDataSourceItemResponse {
202
- /** 数据项实例 */
203
- item: Item;
204
- }
205
- export interface CreateSearchSchemaResponse {
206
- /** 数据范式实例 */
207
- schema?: Schema;
208
- }
209
233
  export interface PatchSearchSchemaResponse {
210
234
  /** 数据范式实例 */
211
235
  schema?: Schema;
@@ -144,6 +144,10 @@ export interface CreateSheetsSpreadsheetRequest {
144
144
  /** 文件夹token */
145
145
  folder_token?: string;
146
146
  }
147
+ export interface CreateSheetsSpreadsheetResponse {
148
+ /** 表格信息 */
149
+ spreadsheet?: Spreadsheet;
150
+ }
147
151
  export interface PatchSheetsSpreadsheetRequest {
148
152
  /** 表格标题 */
149
153
  title?: string;
@@ -152,6 +156,18 @@ export interface GetSheetsSpreadsheetQuery {
152
156
  /** 此次调用中使用的用户ID的类型 */
153
157
  user_id_type?: 'user_id' | 'union_id' | 'open_id';
154
158
  }
159
+ export interface GetSheetsSpreadsheetResponse {
160
+ /** 表格 */
161
+ spreadsheet?: GetSpreadsheet;
162
+ }
163
+ export interface QuerySheetsSpreadsheetSheetResponse {
164
+ /** 工作表信息 */
165
+ sheets?: Sheet[];
166
+ }
167
+ export interface GetSheetsSpreadsheetSheetResponse {
168
+ /** 工作表 */
169
+ sheet?: Sheet;
170
+ }
155
171
  export interface MoveDimensionSheetsSpreadsheetSheetRequest {
156
172
  /** 移动源位置参数 */
157
173
  source?: Dimension;
@@ -164,6 +180,10 @@ export interface FindSheetsSpreadsheetSheetRequest {
164
180
  /** 查找的字符串 */
165
181
  find: string;
166
182
  }
183
+ export interface FindSheetsSpreadsheetSheetResponse {
184
+ /** 查找返回符合条件的信息 */
185
+ find_result?: FindReplaceResult;
186
+ }
167
187
  export interface ReplaceSheetsSpreadsheetSheetRequest {
168
188
  /** 查找条件 */
169
189
  find_condition: FindCondition;
@@ -172,6 +192,10 @@ export interface ReplaceSheetsSpreadsheetSheetRequest {
172
192
  /** 替换的字符串 */
173
193
  replacement: string;
174
194
  }
195
+ export interface ReplaceSheetsSpreadsheetSheetResponse {
196
+ /** 符合查找条件并替换的单元格信息 */
197
+ replace_result?: FindReplaceResult;
198
+ }
175
199
  export interface CreateSheetsSpreadsheetSheetFilterRequest {
176
200
  /** 筛选应用范围 */
177
201
  range: string;
@@ -186,6 +210,10 @@ export interface UpdateSheetsSpreadsheetSheetFilterRequest {
186
210
  /** 筛选条件 */
187
211
  condition: Condition;
188
212
  }
213
+ export interface GetSheetsSpreadsheetSheetFilterResponse {
214
+ /** 筛选信息 */
215
+ sheet_filter_info?: SheetFilterInfo;
216
+ }
189
217
  export interface CreateSheetsSpreadsheetSheetFilterViewRequest {
190
218
  /** 筛选视图 id */
191
219
  filter_view_id?: string;
@@ -194,12 +222,28 @@ export interface CreateSheetsSpreadsheetSheetFilterViewRequest {
194
222
  /** 筛选视图的筛选范围 */
195
223
  range?: string;
196
224
  }
225
+ export interface CreateSheetsSpreadsheetSheetFilterViewResponse {
226
+ /** 创建的筛选视图的 id 、name、range */
227
+ filter_view?: FilterView;
228
+ }
197
229
  export interface PatchSheetsSpreadsheetSheetFilterViewRequest {
198
230
  /** 筛选视图名字 */
199
231
  filter_view_name?: string;
200
232
  /** 筛选视图的筛选范围 */
201
233
  range?: string;
202
234
  }
235
+ export interface PatchSheetsSpreadsheetSheetFilterViewResponse {
236
+ /** 更新后的筛选视图的 id 、name、range */
237
+ filter_view?: FilterView;
238
+ }
239
+ export interface QuerySheetsSpreadsheetSheetFilterViewResponse {
240
+ /** 子表的所有筛选视图信息,id、name、range */
241
+ items?: FilterView[];
242
+ }
243
+ export interface GetSheetsSpreadsheetSheetFilterViewResponse {
244
+ /** 筛选视图信息,包括 id、name、range */
245
+ filter_view?: FilterView;
246
+ }
203
247
  export interface CreateSheetsSpreadsheetSheetFilterViewConditionRequest {
204
248
  /** 设置筛选条件的列,使用字母号 */
205
249
  condition_id?: string;
@@ -210,6 +254,10 @@ export interface CreateSheetsSpreadsheetSheetFilterViewConditionRequest {
210
254
  /** 筛选参数 */
211
255
  expected?: string[];
212
256
  }
257
+ export interface CreateSheetsSpreadsheetSheetFilterViewConditionResponse {
258
+ /** 创建的筛选条件 */
259
+ condition?: FilterViewCondition;
260
+ }
213
261
  export interface UpdateSheetsSpreadsheetSheetFilterViewConditionRequest {
214
262
  /** 筛选类型 */
215
263
  filter_type?: string;
@@ -218,6 +266,18 @@ export interface UpdateSheetsSpreadsheetSheetFilterViewConditionRequest {
218
266
  /** 筛选参数 */
219
267
  expected?: string[];
220
268
  }
269
+ export interface UpdateSheetsSpreadsheetSheetFilterViewConditionResponse {
270
+ /** 更新后的筛选条件 */
271
+ condition?: FilterViewCondition;
272
+ }
273
+ export interface QuerySheetsSpreadsheetSheetFilterViewConditionResponse {
274
+ /** 筛选视图设置的所有筛选条件 */
275
+ items?: FilterViewCondition[];
276
+ }
277
+ export interface GetSheetsSpreadsheetSheetFilterViewConditionResponse {
278
+ /** 筛选的条件 */
279
+ condition?: FilterViewCondition;
280
+ }
221
281
  export interface CreateSheetsSpreadsheetSheetFloatImageRequest {
222
282
  /** 浮动图片 id */
223
283
  float_image_id?: string;
@@ -234,6 +294,10 @@ export interface CreateSheetsSpreadsheetSheetFloatImageRequest {
234
294
  /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移,大于等于0且小于所在单元格的高度 */
235
295
  offset_y?: number;
236
296
  }
297
+ export interface CreateSheetsSpreadsheetSheetFloatImageResponse {
298
+ /** 浮动图片 */
299
+ float_image?: FloatImage;
300
+ }
237
301
  export interface PatchSheetsSpreadsheetSheetFloatImageRequest {
238
302
  /** 浮动图片 token,需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */
239
303
  float_image_token?: string;
@@ -248,70 +312,6 @@ export interface PatchSheetsSpreadsheetSheetFloatImageRequest {
248
312
  /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移,大于等于0且小于所在单元格的高度 */
249
313
  offset_y?: number;
250
314
  }
251
- export interface CreateSheetsSpreadsheetResponse {
252
- /** 表格信息 */
253
- spreadsheet?: Spreadsheet;
254
- }
255
- export interface GetSheetsSpreadsheetResponse {
256
- /** 表格 */
257
- spreadsheet?: GetSpreadsheet;
258
- }
259
- export interface QuerySheetsSpreadsheetSheetResponse {
260
- /** 工作表信息 */
261
- sheets?: Sheet[];
262
- }
263
- export interface GetSheetsSpreadsheetSheetResponse {
264
- /** 工作表 */
265
- sheet?: Sheet;
266
- }
267
- export interface FindSheetsSpreadsheetSheetResponse {
268
- /** 查找返回符合条件的信息 */
269
- find_result?: FindReplaceResult;
270
- }
271
- export interface ReplaceSheetsSpreadsheetSheetResponse {
272
- /** 符合查找条件并替换的单元格信息 */
273
- replace_result?: FindReplaceResult;
274
- }
275
- export interface GetSheetsSpreadsheetSheetFilterResponse {
276
- /** 筛选信息 */
277
- sheet_filter_info?: SheetFilterInfo;
278
- }
279
- export interface CreateSheetsSpreadsheetSheetFilterViewResponse {
280
- /** 创建的筛选视图的 id 、name、range */
281
- filter_view?: FilterView;
282
- }
283
- export interface PatchSheetsSpreadsheetSheetFilterViewResponse {
284
- /** 更新后的筛选视图的 id 、name、range */
285
- filter_view?: FilterView;
286
- }
287
- export interface QuerySheetsSpreadsheetSheetFilterViewResponse {
288
- /** 子表的所有筛选视图信息,id、name、range */
289
- items?: FilterView[];
290
- }
291
- export interface GetSheetsSpreadsheetSheetFilterViewResponse {
292
- /** 筛选视图信息,包括 id、name、range */
293
- filter_view?: FilterView;
294
- }
295
- export interface CreateSheetsSpreadsheetSheetFilterViewConditionResponse {
296
- /** 创建的筛选条件 */
297
- condition?: FilterViewCondition;
298
- }
299
- export interface UpdateSheetsSpreadsheetSheetFilterViewConditionResponse {
300
- /** 更新后的筛选条件 */
301
- condition?: FilterViewCondition;
302
- }
303
- export interface QuerySheetsSpreadsheetSheetFilterViewConditionResponse {
304
- /** 筛选视图设置的所有筛选条件 */
305
- items?: FilterViewCondition[];
306
- }
307
- export interface GetSheetsSpreadsheetSheetFilterViewConditionResponse {
308
- /** 筛选的条件 */
309
- condition?: FilterViewCondition;
310
- }
311
- export interface CreateSheetsSpreadsheetSheetFloatImageResponse {
312
- /** 浮动图片 */
313
- float_image?: FloatImage;
314
- }
315
315
  export interface PatchSheetsSpreadsheetSheetFloatImageResponse {
316
316
  /** 浮动图片 */
317
317
  float_image?: FloatImage;
@@ -19,16 +19,16 @@ export interface FileRecognizeSpeechToTextSpeechRequest {
19
19
  /** 配置属性 */
20
20
  config: FileConfig;
21
21
  }
22
+ export interface FileRecognizeSpeechToTextSpeechResponse {
23
+ /** 语音识别后的文本信息 */
24
+ recognition_text: string;
25
+ }
22
26
  export interface StreamRecognizeSpeechToTextSpeechRequest {
23
27
  /** 语音资源 */
24
28
  speech: Speech;
25
29
  /** 配置属性 */
26
30
  config: StreamConfig;
27
31
  }
28
- export interface FileRecognizeSpeechToTextSpeechResponse {
29
- /** 语音识别后的文本信息 */
30
- recognition_text: string;
31
- }
32
32
  export interface StreamRecognizeSpeechToTextSpeechResponse {
33
33
  /** 16 位 String 随机串作为同一数据流的标识 */
34
34
  stream_id: string;