@satorijs/adapter-lark 3.9.0 → 3.9.2
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/index.cjs +1091 -27
- package/lib/internal.d.ts +2 -3
- package/lib/types/acs.d.ts +19 -19
- package/lib/types/admin.d.ts +58 -32
- package/lib/types/aily.d.ts +52 -52
- package/lib/types/apaas.d.ts +96 -96
- package/lib/types/api.d.ts +14 -1
- package/lib/types/application.d.ts +153 -69
- package/lib/types/approval.d.ts +186 -154
- package/lib/types/attendance.d.ts +395 -353
- package/lib/types/auth.d.ts +18 -18
- package/lib/types/authen.d.ts +24 -24
- package/lib/types/baike.d.ts +42 -42
- package/lib/types/bitable.d.ts +276 -192
- package/lib/types/calendar.d.ts +144 -144
- package/lib/types/cardkit.d.ts +8 -8
- package/lib/types/contact.d.ts +209 -137
- package/lib/types/corehr.d.ts +761 -613
- package/lib/types/document_ai.d.ts +68 -68
- package/lib/types/docx.d.ts +103 -95
- package/lib/types/drive.d.ts +237 -229
- package/lib/types/ehr.d.ts +26 -2
- package/lib/types/helpdesk.d.ts +156 -148
- package/lib/types/hire.d.ts +954 -510
- package/lib/types/im.d.ts +446 -446
- package/lib/types/index.d.ts +72 -30
- package/lib/types/lingo.d.ts +28 -28
- package/lib/types/mail.d.ts +192 -192
- package/lib/types/minutes.d.ts +4 -4
- package/lib/types/okr.d.ts +86 -58
- package/lib/types/passport.d.ts +13 -5
- package/lib/types/payroll.d.ts +13 -5
- package/lib/types/performance.d.ts +85 -79
- package/lib/types/personal_settings.d.ts +12 -12
- package/lib/types/report.d.ts +11 -5
- package/lib/types/search.d.ts +48 -24
- package/lib/types/sheets.d.ts +64 -64
- package/lib/types/speech_to_text.d.ts +4 -4
- package/lib/types/task.d.ts +191 -185
- package/lib/types/translation.d.ts +4 -4
- package/lib/types/vc.d.ts +335 -155
- package/lib/types/wiki.d.ts +48 -48
- package/package.json +1 -1
- package/src/internal.ts +3 -4
- package/src/types/acs.ts +24 -24
- package/src/types/admin.ts +69 -39
- package/src/types/aily.ts +61 -61
- package/src/types/apaas.ts +113 -113
- package/src/types/application.ts +177 -83
- package/src/types/approval.ts +210 -174
- package/src/types/attendance.ts +466 -421
- package/src/types/auth.ts +20 -20
- package/src/types/authen.ts +28 -28
- package/src/types/baike.ts +55 -55
- package/src/types/bitable.ts +321 -235
- package/src/types/calendar.ts +167 -167
- package/src/types/cardkit.ts +10 -10
- package/src/types/contact.ts +251 -169
- package/src/types/corehr.ts +905 -736
- package/src/types/document_ai.ts +85 -85
- package/src/types/docx.ts +117 -108
- package/src/types/drive.ts +299 -290
- package/src/types/ehr.ts +28 -2
- package/src/types/helpdesk.ts +182 -173
- package/src/types/hire.ts +1081 -591
- package/src/types/im.ts +521 -521
- package/src/types/index.ts +73 -30
- package/src/types/lingo.ts +36 -36
- package/src/types/mail.ts +215 -215
- package/src/types/minutes.ts +5 -5
- package/src/types/okr.ts +98 -66
- package/src/types/passport.ts +15 -6
- package/src/types/payroll.ts +15 -6
- package/src/types/performance.ts +98 -91
- package/src/types/personal_settings.ts +15 -15
- package/src/types/report.ts +13 -6
- package/src/types/search.ts +57 -29
- package/src/types/sheets.ts +80 -80
- package/src/types/speech_to_text.ts +5 -5
- package/src/types/task.ts +238 -231
- package/src/types/translation.ts +5 -5
- package/src/types/vc.ts +386 -186
- package/src/types/wiki.ts +59 -59
- package/src/utils.ts +11 -6
- package/lib/index.cjs.map +0 -6
- package/lib/types/guild.d.ts +0 -59
- package/lib/types/message/asset.d.ts +0 -40
- package/lib/types/user.d.ts +0 -78
- package/lib/types/utils.d.ts +0 -9
package/lib/types/bitable.d.ts
CHANGED
|
@@ -41,7 +41,7 @@ declare module '../internal' {
|
|
|
41
41
|
* 列出数据表
|
|
42
42
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list
|
|
43
43
|
*/
|
|
44
|
-
listBitableAppTable(app_token: string, query?: Pagination): Promise<ListBitableAppTableResponse>;
|
|
44
|
+
listBitableAppTable(app_token: string, query?: Pagination): Promise<ListBitableAppTableResponse> & AsyncIterableIterator<AppTable>;
|
|
45
45
|
/**
|
|
46
46
|
* 删除一个数据表
|
|
47
47
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/delete
|
|
@@ -66,7 +66,7 @@ declare module '../internal' {
|
|
|
66
66
|
* 列出视图
|
|
67
67
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list
|
|
68
68
|
*/
|
|
69
|
-
listBitableAppTableView(app_token: string, table_id: string, query?: ListBitableAppTableViewQuery): Promise<ListBitableAppTableViewResponse>;
|
|
69
|
+
listBitableAppTableView(app_token: string, table_id: string, query?: ListBitableAppTableViewQuery): Promise<ListBitableAppTableViewResponse> & AsyncIterableIterator<AppTableView>;
|
|
70
70
|
/**
|
|
71
71
|
* 获取视图
|
|
72
72
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/get
|
|
@@ -91,7 +91,7 @@ declare module '../internal' {
|
|
|
91
91
|
* 查询记录
|
|
92
92
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search
|
|
93
93
|
*/
|
|
94
|
-
searchBitableAppTableRecord(app_token: string, table_id: string, body: SearchBitableAppTableRecordRequest, query?: SearchBitableAppTableRecordQuery): Promise<SearchBitableAppTableRecordResponse>;
|
|
94
|
+
searchBitableAppTableRecord(app_token: string, table_id: string, body: SearchBitableAppTableRecordRequest, query?: SearchBitableAppTableRecordQuery): Promise<SearchBitableAppTableRecordResponse> & AsyncIterableIterator<AppTableRecord>;
|
|
95
95
|
/**
|
|
96
96
|
* 删除记录
|
|
97
97
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/delete
|
|
@@ -131,7 +131,7 @@ declare module '../internal' {
|
|
|
131
131
|
* 列出字段
|
|
132
132
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/list
|
|
133
133
|
*/
|
|
134
|
-
listBitableAppTableField(app_token: string, table_id: string, query?: ListBitableAppTableFieldQuery): Promise<ListBitableAppTableFieldResponse>;
|
|
134
|
+
listBitableAppTableField(app_token: string, table_id: string, query?: ListBitableAppTableFieldQuery): Promise<ListBitableAppTableFieldResponse> & AsyncIterableIterator<AppTableFieldForList>;
|
|
135
135
|
/**
|
|
136
136
|
* 删除字段
|
|
137
137
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/delete
|
|
@@ -166,7 +166,7 @@ declare module '../internal' {
|
|
|
166
166
|
* 列出表单问题
|
|
167
167
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form-field/list
|
|
168
168
|
*/
|
|
169
|
-
listBitableAppTableFormField(app_token: string, table_id: string, form_id: string, query?: Pagination): Promise<ListBitableAppTableFormFieldResponse>;
|
|
169
|
+
listBitableAppTableFormField(app_token: string, table_id: string, form_id: string, query?: Pagination): Promise<ListBitableAppTableFormFieldResponse> & AsyncIterableIterator<AppTableFormField>;
|
|
170
170
|
/**
|
|
171
171
|
* 新增自定义角色
|
|
172
172
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/create
|
|
@@ -181,7 +181,7 @@ declare module '../internal' {
|
|
|
181
181
|
* 列出自定义角色
|
|
182
182
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/list
|
|
183
183
|
*/
|
|
184
|
-
listBitableAppRole(app_token: string, query?: Pagination): Promise<ListBitableAppRoleResponse>;
|
|
184
|
+
listBitableAppRole(app_token: string, query?: Pagination): Promise<ListBitableAppRoleResponse> & AsyncIterableIterator<AppRole>;
|
|
185
185
|
/**
|
|
186
186
|
* 删除自定义角色
|
|
187
187
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/delete
|
|
@@ -201,7 +201,7 @@ declare module '../internal' {
|
|
|
201
201
|
* 列出协作者
|
|
202
202
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/list
|
|
203
203
|
*/
|
|
204
|
-
listBitableAppRoleMember(app_token: string, role_id: string, query?: Pagination): Promise<ListBitableAppRoleMemberResponse>;
|
|
204
|
+
listBitableAppRoleMember(app_token: string, role_id: string, query?: Pagination): Promise<ListBitableAppRoleMemberResponse> & AsyncIterableIterator<AppRoleMember>;
|
|
205
205
|
/**
|
|
206
206
|
* 删除协作者
|
|
207
207
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/delete
|
|
@@ -231,7 +231,7 @@ declare module '../internal' {
|
|
|
231
231
|
* 列出记录
|
|
232
232
|
* @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/list
|
|
233
233
|
*/
|
|
234
|
-
listBitableAppTableRecord(app_token: string, table_id: string, query?: ListBitableAppTableRecordQuery): Promise<ListBitableAppTableRecordResponse>;
|
|
234
|
+
listBitableAppTableRecord(app_token: string, table_id: string, query?: ListBitableAppTableRecordQuery): Promise<ListBitableAppTableRecordResponse> & AsyncIterableIterator<AppTableRecord>;
|
|
235
235
|
}
|
|
236
236
|
}
|
|
237
237
|
export interface CreateBitableAppRequest {
|
|
@@ -242,6 +242,9 @@ export interface CreateBitableAppRequest {
|
|
|
242
242
|
/** 文档时区,说明见:https://bytedance.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf */
|
|
243
243
|
time_zone?: string;
|
|
244
244
|
}
|
|
245
|
+
export interface CreateBitableAppResponse {
|
|
246
|
+
app?: App;
|
|
247
|
+
}
|
|
245
248
|
export interface CopyBitableAppRequest {
|
|
246
249
|
/** 多维表格 App 名字 */
|
|
247
250
|
name?: string;
|
|
@@ -252,16 +255,33 @@ export interface CopyBitableAppRequest {
|
|
|
252
255
|
/** 文档时区,说明见:https://bytedance.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf */
|
|
253
256
|
time_zone?: string;
|
|
254
257
|
}
|
|
258
|
+
export interface CopyBitableAppResponse {
|
|
259
|
+
app?: App;
|
|
260
|
+
}
|
|
261
|
+
export interface GetBitableAppResponse {
|
|
262
|
+
app?: DisplayApp;
|
|
263
|
+
}
|
|
255
264
|
export interface UpdateBitableAppRequest {
|
|
256
265
|
/** 新的多维表格名字 */
|
|
257
266
|
name?: string;
|
|
258
267
|
/** 多维表格是否开启高级权限 */
|
|
259
268
|
is_advanced?: boolean;
|
|
260
269
|
}
|
|
270
|
+
export interface UpdateBitableAppResponse {
|
|
271
|
+
app?: DisplayAppV2;
|
|
272
|
+
}
|
|
261
273
|
export interface CreateBitableAppTableRequest {
|
|
262
274
|
/** 数据表 */
|
|
263
275
|
table?: ReqTable;
|
|
264
276
|
}
|
|
277
|
+
export interface CreateBitableAppTableResponse {
|
|
278
|
+
/** 数据表的唯一标识id */
|
|
279
|
+
table_id?: string;
|
|
280
|
+
/** 默认表格视图的id,该字段仅在请求参数中填写了default_view_name或fields才会返回 */
|
|
281
|
+
default_view_id?: string;
|
|
282
|
+
/** 数据表初始字段的id列表,该字段仅在请求参数中填写了fields才会返回 */
|
|
283
|
+
field_id_list?: string[];
|
|
284
|
+
}
|
|
265
285
|
export interface BatchCreateBitableAppTableRequest {
|
|
266
286
|
/** tables */
|
|
267
287
|
tables?: ReqTable[];
|
|
@@ -270,10 +290,26 @@ export interface BatchCreateBitableAppTableQuery {
|
|
|
270
290
|
/** 此次调用中使用的用户ID的类型 */
|
|
271
291
|
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
272
292
|
}
|
|
293
|
+
export interface BatchCreateBitableAppTableResponse {
|
|
294
|
+
table_ids?: string[];
|
|
295
|
+
}
|
|
273
296
|
export interface PatchBitableAppTableRequest {
|
|
274
297
|
/** 数据表的新名称 */
|
|
275
298
|
name?: string;
|
|
276
299
|
}
|
|
300
|
+
export interface PatchBitableAppTableResponse {
|
|
301
|
+
/** 数据表的名称 */
|
|
302
|
+
name?: string;
|
|
303
|
+
}
|
|
304
|
+
export interface ListBitableAppTableResponse {
|
|
305
|
+
/** 是否有下一页数据 */
|
|
306
|
+
has_more?: boolean;
|
|
307
|
+
/** 下一页分页的token */
|
|
308
|
+
page_token?: string;
|
|
309
|
+
/** 总数 */
|
|
310
|
+
total?: number;
|
|
311
|
+
items?: AppTable[];
|
|
312
|
+
}
|
|
277
313
|
export interface BatchDeleteBitableAppTableRequest {
|
|
278
314
|
/** 删除的多条tableid列表 */
|
|
279
315
|
table_ids?: string[];
|
|
@@ -284,19 +320,38 @@ export interface CreateBitableAppTableViewRequest {
|
|
|
284
320
|
/** 视图类型 */
|
|
285
321
|
view_type?: 'grid' | 'kanban' | 'gallery' | 'gantt' | 'form';
|
|
286
322
|
}
|
|
323
|
+
export interface CreateBitableAppTableViewResponse {
|
|
324
|
+
view?: AppTableView;
|
|
325
|
+
}
|
|
287
326
|
export interface PatchBitableAppTableViewRequest {
|
|
288
327
|
/** 视图名称 */
|
|
289
328
|
view_name?: string;
|
|
290
329
|
/** 视图属性 */
|
|
291
330
|
property?: AppTableViewProperty;
|
|
292
331
|
}
|
|
332
|
+
export interface PatchBitableAppTableViewResponse {
|
|
333
|
+
view?: AppTableView;
|
|
334
|
+
}
|
|
293
335
|
export interface ListBitableAppTableViewQuery extends Pagination {
|
|
294
336
|
/** 此次调用中使用的用户ID的类型 */
|
|
295
337
|
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
296
338
|
}
|
|
339
|
+
export interface ListBitableAppTableViewResponse {
|
|
340
|
+
/** 视图列表 */
|
|
341
|
+
items?: AppTableView[];
|
|
342
|
+
/** 下一页分页的token */
|
|
343
|
+
page_token?: string;
|
|
344
|
+
/** 是否有下一页数据 */
|
|
345
|
+
has_more?: boolean;
|
|
346
|
+
/** 总数 */
|
|
347
|
+
total?: number;
|
|
348
|
+
}
|
|
349
|
+
export interface GetBitableAppTableViewResponse {
|
|
350
|
+
view?: AppTableView;
|
|
351
|
+
}
|
|
297
352
|
export interface CreateBitableAppTableRecordRequest {
|
|
298
353
|
/** 记录字段 */
|
|
299
|
-
fields: unknown
|
|
354
|
+
fields: Record<string, unknown>;
|
|
300
355
|
}
|
|
301
356
|
export interface CreateBitableAppTableRecordQuery {
|
|
302
357
|
/** 此次调用中使用的用户ID的类型 */
|
|
@@ -306,9 +361,12 @@ export interface CreateBitableAppTableRecordQuery {
|
|
|
306
361
|
/** 用于控制一致性读写,默认开启检查 */
|
|
307
362
|
ignore_consistency_check?: boolean;
|
|
308
363
|
}
|
|
364
|
+
export interface CreateBitableAppTableRecordResponse {
|
|
365
|
+
record?: AppTableRecord;
|
|
366
|
+
}
|
|
309
367
|
export interface UpdateBitableAppTableRecordRequest {
|
|
310
368
|
/** 记录字段 */
|
|
311
|
-
fields: unknown
|
|
369
|
+
fields: Record<string, unknown>;
|
|
312
370
|
}
|
|
313
371
|
export interface UpdateBitableAppTableRecordQuery {
|
|
314
372
|
/** 此次调用中使用的用户ID的类型 */
|
|
@@ -316,6 +374,9 @@ export interface UpdateBitableAppTableRecordQuery {
|
|
|
316
374
|
/** 用于控制一致性读写,默认开启检查 */
|
|
317
375
|
ignore_consistency_check?: boolean;
|
|
318
376
|
}
|
|
377
|
+
export interface UpdateBitableAppTableRecordResponse {
|
|
378
|
+
record?: AppTableRecord;
|
|
379
|
+
}
|
|
319
380
|
export interface SearchBitableAppTableRecordRequest {
|
|
320
381
|
/** 视图Id,指定视图id则按照视图的筛选排序结果返回数据 */
|
|
321
382
|
view_id?: string;
|
|
@@ -332,6 +393,22 @@ export interface SearchBitableAppTableRecordQuery extends Pagination {
|
|
|
332
393
|
/** 此次调用中使用的用户ID的类型 */
|
|
333
394
|
user_id_type?: 'user_id' | 'union_id' | 'open_id';
|
|
334
395
|
}
|
|
396
|
+
export interface SearchBitableAppTableRecordResponse {
|
|
397
|
+
/** record 结果 */
|
|
398
|
+
items?: AppTableRecord[];
|
|
399
|
+
/** 是否有下一页数据 */
|
|
400
|
+
has_more?: boolean;
|
|
401
|
+
/** 下一页分页的token */
|
|
402
|
+
page_token?: string;
|
|
403
|
+
/** 总数 */
|
|
404
|
+
total?: number;
|
|
405
|
+
}
|
|
406
|
+
export interface DeleteBitableAppTableRecordResponse {
|
|
407
|
+
/** 是否成功删除 */
|
|
408
|
+
deleted?: boolean;
|
|
409
|
+
/** 删除的记录id */
|
|
410
|
+
record_id?: string;
|
|
411
|
+
}
|
|
335
412
|
export interface BatchCreateBitableAppTableRecordRequest {
|
|
336
413
|
/** 记录 */
|
|
337
414
|
records: AppTableRecord[];
|
|
@@ -344,6 +421,10 @@ export interface BatchCreateBitableAppTableRecordQuery {
|
|
|
344
421
|
/** 用于控制一致性读写,默认开启检查 */
|
|
345
422
|
ignore_consistency_check?: boolean;
|
|
346
423
|
}
|
|
424
|
+
export interface BatchCreateBitableAppTableRecordResponse {
|
|
425
|
+
/** 本次请求新增的记录列表 */
|
|
426
|
+
records?: AppTableRecord[];
|
|
427
|
+
}
|
|
347
428
|
export interface BatchUpdateBitableAppTableRecordRequest {
|
|
348
429
|
/** 记录 */
|
|
349
430
|
records: AppTableRecord[];
|
|
@@ -354,6 +435,10 @@ export interface BatchUpdateBitableAppTableRecordQuery {
|
|
|
354
435
|
/** 用于控制一致性读写,默认开启检查 */
|
|
355
436
|
ignore_consistency_check?: boolean;
|
|
356
437
|
}
|
|
438
|
+
export interface BatchUpdateBitableAppTableRecordResponse {
|
|
439
|
+
/** 更新后的记录 */
|
|
440
|
+
records?: AppTableRecord[];
|
|
441
|
+
}
|
|
357
442
|
export interface BatchGetBitableAppTableRecordRequest {
|
|
358
443
|
/** 记录 id 列表 */
|
|
359
444
|
record_ids: string[];
|
|
@@ -364,15 +449,69 @@ export interface BatchGetBitableAppTableRecordRequest {
|
|
|
364
449
|
/** 控制是否返回自动计算的字段,true 表示返回 */
|
|
365
450
|
automatic_fields?: boolean;
|
|
366
451
|
}
|
|
452
|
+
export interface BatchGetBitableAppTableRecordResponse {
|
|
453
|
+
/** 记录列表 */
|
|
454
|
+
records?: AppTableRecord[];
|
|
455
|
+
/** 禁止访问的记录列表(针对开启了高级权限的文档) */
|
|
456
|
+
forbidden_record_ids?: string[];
|
|
457
|
+
/** 不存在的记录列表 */
|
|
458
|
+
absent_record_ids?: string[];
|
|
459
|
+
}
|
|
367
460
|
export interface BatchDeleteBitableAppTableRecordRequest {
|
|
368
461
|
/** 删除的多条记录id列表 */
|
|
369
462
|
records: string[];
|
|
370
463
|
}
|
|
464
|
+
export interface BatchDeleteBitableAppTableRecordResponse {
|
|
465
|
+
/** 记录删除结果 */
|
|
466
|
+
records?: DeleteRecord[];
|
|
467
|
+
}
|
|
468
|
+
export declare const enum CreateBitableAppTableFieldRequestType {
|
|
469
|
+
/** 多行文本(默认值)、条码 */
|
|
470
|
+
Text = 1,
|
|
471
|
+
/** 数字(默认值)、进度、货币、评分 */
|
|
472
|
+
Number = 2,
|
|
473
|
+
/** 单选 */
|
|
474
|
+
SingleSelect = 3,
|
|
475
|
+
/** 多选 */
|
|
476
|
+
MultiSelect = 4,
|
|
477
|
+
/** 日期 */
|
|
478
|
+
DateTime = 5,
|
|
479
|
+
/** 复选框 */
|
|
480
|
+
Checkbox = 7,
|
|
481
|
+
/** 人员 */
|
|
482
|
+
User = 11,
|
|
483
|
+
/** 电话号码 */
|
|
484
|
+
PhoneNumber = 13,
|
|
485
|
+
/** 超链接 */
|
|
486
|
+
Url = 15,
|
|
487
|
+
/** 附件 */
|
|
488
|
+
Attachment = 17,
|
|
489
|
+
/** 单向关联 */
|
|
490
|
+
Link = 18,
|
|
491
|
+
/** 公式 */
|
|
492
|
+
Formula = 20,
|
|
493
|
+
/** 双向关联 */
|
|
494
|
+
DuplexLink = 21,
|
|
495
|
+
/** 地理位置 */
|
|
496
|
+
Location = 22,
|
|
497
|
+
/** 群组 */
|
|
498
|
+
GroupChat = 23,
|
|
499
|
+
/** 创建时间 */
|
|
500
|
+
CreatedTime = 1001,
|
|
501
|
+
/** 最后更新时间 */
|
|
502
|
+
ModifiedTime = 1002,
|
|
503
|
+
/** 创建人 */
|
|
504
|
+
CreatedUser = 1003,
|
|
505
|
+
/** 修改人 */
|
|
506
|
+
ModifiedUser = 1004,
|
|
507
|
+
/** 自动编号 */
|
|
508
|
+
AutoSerial = 1005
|
|
509
|
+
}
|
|
371
510
|
export interface CreateBitableAppTableFieldRequest {
|
|
372
511
|
/** 字段名 */
|
|
373
512
|
field_name: string;
|
|
374
513
|
/** 字段类型 */
|
|
375
|
-
type:
|
|
514
|
+
type: CreateBitableAppTableFieldRequestType;
|
|
376
515
|
/** 字段属性 */
|
|
377
516
|
property?: AppTableFieldProperty;
|
|
378
517
|
/** 字段的描述 */
|
|
@@ -384,11 +523,56 @@ export interface CreateBitableAppTableFieldQuery {
|
|
|
384
523
|
/** 格式为标准的 uuid,操作的唯一标识,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
|
|
385
524
|
client_token?: string;
|
|
386
525
|
}
|
|
526
|
+
export interface CreateBitableAppTableFieldResponse {
|
|
527
|
+
field?: AppTableField;
|
|
528
|
+
}
|
|
529
|
+
export declare const enum UpdateBitableAppTableFieldRequestType {
|
|
530
|
+
/** 多行文本(默认值)、条码 */
|
|
531
|
+
Text = 1,
|
|
532
|
+
/** 数字(默认值)、进度、货币、评分 */
|
|
533
|
+
Number = 2,
|
|
534
|
+
/** 单选 */
|
|
535
|
+
SingleSelect = 3,
|
|
536
|
+
/** 多选 */
|
|
537
|
+
MultiSelect = 4,
|
|
538
|
+
/** 日期 */
|
|
539
|
+
DateTime = 5,
|
|
540
|
+
/** 复选框 */
|
|
541
|
+
Checkbox = 7,
|
|
542
|
+
/** 人员 */
|
|
543
|
+
User = 11,
|
|
544
|
+
/** 电话号码 */
|
|
545
|
+
PhoneNumber = 13,
|
|
546
|
+
/** 超链接 */
|
|
547
|
+
Url = 15,
|
|
548
|
+
/** 附件 */
|
|
549
|
+
Attachment = 17,
|
|
550
|
+
/** 单向关联 */
|
|
551
|
+
Link = 18,
|
|
552
|
+
/** 公式 */
|
|
553
|
+
Formula = 20,
|
|
554
|
+
/** 双向关联 */
|
|
555
|
+
DuplexLink = 21,
|
|
556
|
+
/** 地理位置 */
|
|
557
|
+
Location = 22,
|
|
558
|
+
/** 群组 */
|
|
559
|
+
GroupChat = 23,
|
|
560
|
+
/** 创建时间 */
|
|
561
|
+
CreatedTime = 1001,
|
|
562
|
+
/** 最后更新时间 */
|
|
563
|
+
ModifiedTime = 1002,
|
|
564
|
+
/** 创建人 */
|
|
565
|
+
CreatedUser = 1003,
|
|
566
|
+
/** 修改人 */
|
|
567
|
+
ModifiedUser = 1004,
|
|
568
|
+
/** 自动编号 */
|
|
569
|
+
AutoSerial = 1005
|
|
570
|
+
}
|
|
387
571
|
export interface UpdateBitableAppTableFieldRequest {
|
|
388
572
|
/** 字段名 */
|
|
389
573
|
field_name: string;
|
|
390
574
|
/** 字段类型 */
|
|
391
|
-
type:
|
|
575
|
+
type: UpdateBitableAppTableFieldRequestType;
|
|
392
576
|
/** 字段属性 */
|
|
393
577
|
property?: AppTableFieldProperty;
|
|
394
578
|
/** 字段的描述 */
|
|
@@ -396,16 +580,41 @@ export interface UpdateBitableAppTableFieldRequest {
|
|
|
396
580
|
/** 字段在界面上的展示类型,例如进度字段是数字的一种展示形态 */
|
|
397
581
|
ui_type?: 'Text' | 'Email' | 'Barcode' | 'Number' | 'Progress' | 'Currency' | 'Rating' | 'SingleSelect' | 'MultiSelect' | 'DateTime' | 'Checkbox' | 'User' | 'GroupChat' | 'Phone' | 'Url' | 'Attachment' | 'SingleLink' | 'Formula' | 'DuplexLink' | 'Location' | 'CreatedTime' | 'ModifiedTime' | 'CreatedUser' | 'ModifiedUser' | 'AutoNumber';
|
|
398
582
|
}
|
|
583
|
+
export interface UpdateBitableAppTableFieldResponse {
|
|
584
|
+
field?: AppTableField;
|
|
585
|
+
}
|
|
399
586
|
export interface ListBitableAppTableFieldQuery extends Pagination {
|
|
400
587
|
/** 视图 ID */
|
|
401
588
|
view_id?: string;
|
|
402
589
|
/** 控制字段描述(多行文本格式)数据的返回格式, true 表示以数组富文本形式返回 */
|
|
403
590
|
text_field_as_array?: boolean;
|
|
404
591
|
}
|
|
592
|
+
export interface ListBitableAppTableFieldResponse {
|
|
593
|
+
/** 是否有下一页数据 */
|
|
594
|
+
has_more?: boolean;
|
|
595
|
+
/** 下一页分页的token */
|
|
596
|
+
page_token?: string;
|
|
597
|
+
/** 总数 */
|
|
598
|
+
total?: number;
|
|
599
|
+
/** 字段列表 */
|
|
600
|
+
items?: AppTableFieldForList[];
|
|
601
|
+
}
|
|
602
|
+
export interface DeleteBitableAppTableFieldResponse {
|
|
603
|
+
/** 字段唯一标识id */
|
|
604
|
+
field_id?: string;
|
|
605
|
+
/** 是否已删除 */
|
|
606
|
+
deleted?: boolean;
|
|
607
|
+
}
|
|
405
608
|
export interface CopyBitableAppDashboardRequest {
|
|
406
609
|
/** 仪表盘名称 */
|
|
407
610
|
name: string;
|
|
408
611
|
}
|
|
612
|
+
export interface CopyBitableAppDashboardResponse {
|
|
613
|
+
/** 多维表格 block_id */
|
|
614
|
+
block_id?: string;
|
|
615
|
+
/** block 名称 */
|
|
616
|
+
name?: string;
|
|
617
|
+
}
|
|
409
618
|
export interface PatchBitableAppTableFormRequest {
|
|
410
619
|
/** 表单名称 */
|
|
411
620
|
name?: string;
|
|
@@ -418,6 +627,14 @@ export interface PatchBitableAppTableFormRequest {
|
|
|
418
627
|
/** 填写次数限制一次 */
|
|
419
628
|
submit_limit_once?: boolean;
|
|
420
629
|
}
|
|
630
|
+
export interface PatchBitableAppTableFormResponse {
|
|
631
|
+
/** 表单元数据信息 */
|
|
632
|
+
form: AppTableForm;
|
|
633
|
+
}
|
|
634
|
+
export interface GetBitableAppTableFormResponse {
|
|
635
|
+
/** 表单元数据信息 */
|
|
636
|
+
form: AppTableForm;
|
|
637
|
+
}
|
|
421
638
|
export interface PatchBitableAppTableFormFieldRequest {
|
|
422
639
|
/** 上一个表单问题 ID */
|
|
423
640
|
pre_field_id?: string;
|
|
@@ -430,6 +647,20 @@ export interface PatchBitableAppTableFormFieldRequest {
|
|
|
430
647
|
/** 是否可见 */
|
|
431
648
|
visible?: boolean;
|
|
432
649
|
}
|
|
650
|
+
export interface PatchBitableAppTableFormFieldResponse {
|
|
651
|
+
/** 更新后的field值 */
|
|
652
|
+
field?: AppTableFormPatchedField;
|
|
653
|
+
}
|
|
654
|
+
export interface ListBitableAppTableFormFieldResponse {
|
|
655
|
+
/** 表单内的字段列表 */
|
|
656
|
+
items: AppTableFormField[];
|
|
657
|
+
/** 下一页分页的token */
|
|
658
|
+
page_token: string;
|
|
659
|
+
/** 是否有下一页 */
|
|
660
|
+
has_more: boolean;
|
|
661
|
+
/** 总数 */
|
|
662
|
+
total: number;
|
|
663
|
+
}
|
|
433
664
|
export interface CreateBitableAppRoleRequest {
|
|
434
665
|
/** 自定义权限的名字 */
|
|
435
666
|
role_name: string;
|
|
@@ -438,6 +669,9 @@ export interface CreateBitableAppRoleRequest {
|
|
|
438
669
|
/** block权限 */
|
|
439
670
|
block_roles?: AppRoleBlockRole[];
|
|
440
671
|
}
|
|
672
|
+
export interface CreateBitableAppRoleResponse {
|
|
673
|
+
role?: AppRole;
|
|
674
|
+
}
|
|
441
675
|
export interface UpdateBitableAppRoleRequest {
|
|
442
676
|
/** 自定义权限的名字 */
|
|
443
677
|
role_name: string;
|
|
@@ -446,6 +680,19 @@ export interface UpdateBitableAppRoleRequest {
|
|
|
446
680
|
/** block权限 */
|
|
447
681
|
block_roles?: AppRoleBlockRole[];
|
|
448
682
|
}
|
|
683
|
+
export interface UpdateBitableAppRoleResponse {
|
|
684
|
+
role?: AppRole;
|
|
685
|
+
}
|
|
686
|
+
export interface ListBitableAppRoleResponse {
|
|
687
|
+
/** 角色列表 */
|
|
688
|
+
items?: AppRole[];
|
|
689
|
+
/** 下一页分页的token */
|
|
690
|
+
page_token?: string;
|
|
691
|
+
/** 是否有下一页数据 */
|
|
692
|
+
has_more?: boolean;
|
|
693
|
+
/** 总数 */
|
|
694
|
+
total?: number;
|
|
695
|
+
}
|
|
449
696
|
export interface CreateBitableAppRoleMemberRequest {
|
|
450
697
|
/** 协作者id */
|
|
451
698
|
member_id: string;
|
|
@@ -458,6 +705,16 @@ export interface BatchCreateBitableAppRoleMemberRequest {
|
|
|
458
705
|
/** 协作者列表 */
|
|
459
706
|
member_list: AppRoleMemberId[];
|
|
460
707
|
}
|
|
708
|
+
export interface ListBitableAppRoleMemberResponse {
|
|
709
|
+
/** 协作者列表 */
|
|
710
|
+
items?: AppRoleMember[];
|
|
711
|
+
/** 是否有下一页数据 */
|
|
712
|
+
has_more?: boolean;
|
|
713
|
+
/** 下一页分页的token */
|
|
714
|
+
page_token?: string;
|
|
715
|
+
/** 总数 */
|
|
716
|
+
total?: number;
|
|
717
|
+
}
|
|
461
718
|
export interface DeleteBitableAppRoleMemberQuery {
|
|
462
719
|
/** 协作者id类型,与请求体中的member_id要对应 */
|
|
463
720
|
member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id';
|
|
@@ -466,6 +723,10 @@ export interface BatchDeleteBitableAppRoleMemberRequest {
|
|
|
466
723
|
/** 协作者列表 */
|
|
467
724
|
member_list: AppRoleMemberId[];
|
|
468
725
|
}
|
|
726
|
+
export interface ListBitableAppWorkflowResponse {
|
|
727
|
+
/** 自动化工作流信息 */
|
|
728
|
+
workflows: AppWorkflow[];
|
|
729
|
+
}
|
|
469
730
|
export interface UpdateBitableAppWorkflowRequest {
|
|
470
731
|
/** 自动化状态 */
|
|
471
732
|
status: string;
|
|
@@ -482,6 +743,9 @@ export interface GetBitableAppTableRecordQuery {
|
|
|
482
743
|
/** 控制是否返回自动计算的字段,例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`,true 表示返回 */
|
|
483
744
|
automatic_fields?: boolean;
|
|
484
745
|
}
|
|
746
|
+
export interface GetBitableAppTableRecordResponse {
|
|
747
|
+
record?: AppTableRecord;
|
|
748
|
+
}
|
|
485
749
|
export interface ListBitableAppTableRecordQuery extends Pagination {
|
|
486
750
|
/** 视图 id注意:如 filter 或 sort 有值,view_id 会被忽略。 */
|
|
487
751
|
view_id?: string;
|
|
@@ -500,186 +764,6 @@ export interface ListBitableAppTableRecordQuery extends Pagination {
|
|
|
500
764
|
/** 控制是否返回自动计算的字段,例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`,true 表示返回 */
|
|
501
765
|
automatic_fields?: boolean;
|
|
502
766
|
}
|
|
503
|
-
export interface CreateBitableAppResponse {
|
|
504
|
-
app?: App;
|
|
505
|
-
}
|
|
506
|
-
export interface CopyBitableAppResponse {
|
|
507
|
-
app?: App;
|
|
508
|
-
}
|
|
509
|
-
export interface GetBitableAppResponse {
|
|
510
|
-
app?: DisplayApp;
|
|
511
|
-
}
|
|
512
|
-
export interface UpdateBitableAppResponse {
|
|
513
|
-
app?: DisplayAppV2;
|
|
514
|
-
}
|
|
515
|
-
export interface CreateBitableAppTableResponse {
|
|
516
|
-
/** 数据表的唯一标识id */
|
|
517
|
-
table_id?: string;
|
|
518
|
-
/** 默认表格视图的id,该字段仅在请求参数中填写了default_view_name或fields才会返回 */
|
|
519
|
-
default_view_id?: string;
|
|
520
|
-
/** 数据表初始字段的id列表,该字段仅在请求参数中填写了fields才会返回 */
|
|
521
|
-
field_id_list?: string[];
|
|
522
|
-
}
|
|
523
|
-
export interface BatchCreateBitableAppTableResponse {
|
|
524
|
-
table_ids?: string[];
|
|
525
|
-
}
|
|
526
|
-
export interface PatchBitableAppTableResponse {
|
|
527
|
-
/** 数据表的名称 */
|
|
528
|
-
name?: string;
|
|
529
|
-
}
|
|
530
|
-
export interface ListBitableAppTableResponse {
|
|
531
|
-
/** 是否有下一页数据 */
|
|
532
|
-
has_more?: boolean;
|
|
533
|
-
/** 下一页分页的token */
|
|
534
|
-
page_token?: string;
|
|
535
|
-
/** 总数 */
|
|
536
|
-
total?: number;
|
|
537
|
-
items?: AppTable[];
|
|
538
|
-
}
|
|
539
|
-
export interface CreateBitableAppTableViewResponse {
|
|
540
|
-
view?: AppTableView;
|
|
541
|
-
}
|
|
542
|
-
export interface PatchBitableAppTableViewResponse {
|
|
543
|
-
view?: AppTableView;
|
|
544
|
-
}
|
|
545
|
-
export interface ListBitableAppTableViewResponse {
|
|
546
|
-
/** 视图列表 */
|
|
547
|
-
items?: AppTableView[];
|
|
548
|
-
/** 下一页分页的token */
|
|
549
|
-
page_token?: string;
|
|
550
|
-
/** 是否有下一页数据 */
|
|
551
|
-
has_more?: boolean;
|
|
552
|
-
/** 总数 */
|
|
553
|
-
total?: number;
|
|
554
|
-
}
|
|
555
|
-
export interface GetBitableAppTableViewResponse {
|
|
556
|
-
view?: AppTableView;
|
|
557
|
-
}
|
|
558
|
-
export interface CreateBitableAppTableRecordResponse {
|
|
559
|
-
record?: AppTableRecord;
|
|
560
|
-
}
|
|
561
|
-
export interface UpdateBitableAppTableRecordResponse {
|
|
562
|
-
record?: AppTableRecord;
|
|
563
|
-
}
|
|
564
|
-
export interface SearchBitableAppTableRecordResponse {
|
|
565
|
-
/** record 结果 */
|
|
566
|
-
items?: AppTableRecord[];
|
|
567
|
-
/** 是否有下一页数据 */
|
|
568
|
-
has_more?: boolean;
|
|
569
|
-
/** 下一页分页的token */
|
|
570
|
-
page_token?: string;
|
|
571
|
-
/** 总数 */
|
|
572
|
-
total?: number;
|
|
573
|
-
}
|
|
574
|
-
export interface DeleteBitableAppTableRecordResponse {
|
|
575
|
-
/** 是否成功删除 */
|
|
576
|
-
deleted?: boolean;
|
|
577
|
-
/** 删除的记录id */
|
|
578
|
-
record_id?: string;
|
|
579
|
-
}
|
|
580
|
-
export interface BatchCreateBitableAppTableRecordResponse {
|
|
581
|
-
/** 本次请求新增的记录列表 */
|
|
582
|
-
records?: AppTableRecord[];
|
|
583
|
-
}
|
|
584
|
-
export interface BatchUpdateBitableAppTableRecordResponse {
|
|
585
|
-
/** 更新后的记录 */
|
|
586
|
-
records?: AppTableRecord[];
|
|
587
|
-
}
|
|
588
|
-
export interface BatchGetBitableAppTableRecordResponse {
|
|
589
|
-
/** 记录列表 */
|
|
590
|
-
records?: AppTableRecord[];
|
|
591
|
-
/** 禁止访问的记录列表(针对开启了高级权限的文档) */
|
|
592
|
-
forbidden_record_ids?: string[];
|
|
593
|
-
/** 不存在的记录列表 */
|
|
594
|
-
absent_record_ids?: string[];
|
|
595
|
-
}
|
|
596
|
-
export interface BatchDeleteBitableAppTableRecordResponse {
|
|
597
|
-
/** 记录删除结果 */
|
|
598
|
-
records?: DeleteRecord[];
|
|
599
|
-
}
|
|
600
|
-
export interface CreateBitableAppTableFieldResponse {
|
|
601
|
-
field?: AppTableField;
|
|
602
|
-
}
|
|
603
|
-
export interface UpdateBitableAppTableFieldResponse {
|
|
604
|
-
field?: AppTableField;
|
|
605
|
-
}
|
|
606
|
-
export interface ListBitableAppTableFieldResponse {
|
|
607
|
-
/** 是否有下一页数据 */
|
|
608
|
-
has_more?: boolean;
|
|
609
|
-
/** 下一页分页的token */
|
|
610
|
-
page_token?: string;
|
|
611
|
-
/** 总数 */
|
|
612
|
-
total?: number;
|
|
613
|
-
/** 字段列表 */
|
|
614
|
-
items?: AppTableFieldForList[];
|
|
615
|
-
}
|
|
616
|
-
export interface DeleteBitableAppTableFieldResponse {
|
|
617
|
-
/** 字段唯一标识id */
|
|
618
|
-
field_id?: string;
|
|
619
|
-
/** 是否已删除 */
|
|
620
|
-
deleted?: boolean;
|
|
621
|
-
}
|
|
622
|
-
export interface CopyBitableAppDashboardResponse {
|
|
623
|
-
/** 多维表格 block_id */
|
|
624
|
-
block_id?: string;
|
|
625
|
-
/** block 名称 */
|
|
626
|
-
name?: string;
|
|
627
|
-
}
|
|
628
|
-
export interface PatchBitableAppTableFormResponse {
|
|
629
|
-
/** 表单元数据信息 */
|
|
630
|
-
form: AppTableForm;
|
|
631
|
-
}
|
|
632
|
-
export interface GetBitableAppTableFormResponse {
|
|
633
|
-
/** 表单元数据信息 */
|
|
634
|
-
form: AppTableForm;
|
|
635
|
-
}
|
|
636
|
-
export interface PatchBitableAppTableFormFieldResponse {
|
|
637
|
-
/** 更新后的field值 */
|
|
638
|
-
field?: AppTableFormPatchedField;
|
|
639
|
-
}
|
|
640
|
-
export interface ListBitableAppTableFormFieldResponse {
|
|
641
|
-
/** 表单内的字段列表 */
|
|
642
|
-
items: AppTableFormField[];
|
|
643
|
-
/** 下一页分页的token */
|
|
644
|
-
page_token: string;
|
|
645
|
-
/** 是否有下一页 */
|
|
646
|
-
has_more: boolean;
|
|
647
|
-
/** 总数 */
|
|
648
|
-
total: number;
|
|
649
|
-
}
|
|
650
|
-
export interface CreateBitableAppRoleResponse {
|
|
651
|
-
role?: AppRole;
|
|
652
|
-
}
|
|
653
|
-
export interface UpdateBitableAppRoleResponse {
|
|
654
|
-
role?: AppRole;
|
|
655
|
-
}
|
|
656
|
-
export interface ListBitableAppRoleResponse {
|
|
657
|
-
/** 角色列表 */
|
|
658
|
-
items?: AppRole[];
|
|
659
|
-
/** 下一页分页的token */
|
|
660
|
-
page_token?: string;
|
|
661
|
-
/** 是否有下一页数据 */
|
|
662
|
-
has_more?: boolean;
|
|
663
|
-
/** 总数 */
|
|
664
|
-
total?: number;
|
|
665
|
-
}
|
|
666
|
-
export interface ListBitableAppRoleMemberResponse {
|
|
667
|
-
/** 协作者列表 */
|
|
668
|
-
items?: AppRoleMember[];
|
|
669
|
-
/** 是否有下一页数据 */
|
|
670
|
-
has_more?: boolean;
|
|
671
|
-
/** 下一页分页的token */
|
|
672
|
-
page_token?: string;
|
|
673
|
-
/** 总数 */
|
|
674
|
-
total?: number;
|
|
675
|
-
}
|
|
676
|
-
export interface ListBitableAppWorkflowResponse {
|
|
677
|
-
/** 自动化工作流信息 */
|
|
678
|
-
workflows: AppWorkflow[];
|
|
679
|
-
}
|
|
680
|
-
export interface GetBitableAppTableRecordResponse {
|
|
681
|
-
record?: AppTableRecord;
|
|
682
|
-
}
|
|
683
767
|
export interface ListBitableAppTableRecordResponse {
|
|
684
768
|
/** 是否有下一页数据 */
|
|
685
769
|
has_more?: boolean;
|