@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,775 +1,835 @@
1
- import { App, AppDashboard, AppRole, AppRoleBlockRole, AppRoleMember, AppRoleMemberId, AppRoleTableRole, AppTable, AppTableField, AppTableFieldDescription, AppTableFieldForList, AppTableFieldProperty, AppTableForm, AppTableFormField, AppTableFormPatchedField, AppTableRecord, AppTableView, AppTableViewProperty, AppWorkflow, DeleteRecord, DisplayApp, DisplayAppV2, FilterInfo, ReqTable, Sort } from '.';
2
- import { Pagination } from '../internal';
1
+ import * as Lark from '.';
2
+ import { Paginated, Pagination } from '../internal';
3
3
  declare module '../internal' {
4
4
  interface Internal {
5
- /**
6
- * 创建多维表格
7
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/create
8
- */
9
- createBitableApp(body: CreateBitableAppRequest): Promise<CreateBitableAppResponse>;
10
- /**
11
- * 复制多维表格
12
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/copy
13
- */
14
- copyBitableApp(app_token: string, body: CopyBitableAppRequest): Promise<CopyBitableAppResponse>;
15
- /**
16
- * 获取多维表格元数据
17
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/get
18
- */
19
- getBitableApp(app_token: string): Promise<GetBitableAppResponse>;
20
- /**
21
- * 更新多维表格元数据
22
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/update
23
- */
24
- updateBitableApp(app_token: string, body: UpdateBitableAppRequest): Promise<UpdateBitableAppResponse>;
25
- /**
26
- * 新增一个数据表
27
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/create
28
- */
29
- createBitableAppTable(app_token: string, body: CreateBitableAppTableRequest): Promise<CreateBitableAppTableResponse>;
30
- /**
31
- * 新增多个数据表
32
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_create
33
- */
34
- batchCreateBitableAppTable(app_token: string, body: BatchCreateBitableAppTableRequest, query?: BatchCreateBitableAppTableQuery): Promise<BatchCreateBitableAppTableResponse>;
35
- /**
36
- * 更新数据表
37
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/patch
38
- */
39
- patchBitableAppTable(app_token: string, table_id: string, body: PatchBitableAppTableRequest): Promise<PatchBitableAppTableResponse>;
40
- /**
41
- * 列出数据表
42
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list
43
- */
44
- listBitableAppTable(app_token: string, query?: Pagination): Promise<ListBitableAppTableResponse> & AsyncIterableIterator<AppTable>;
45
- /**
46
- * 删除一个数据表
47
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/delete
48
- */
49
- deleteBitableAppTable(app_token: string, table_id: string): Promise<void>;
50
- /**
51
- * 删除多个数据表
52
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_delete
53
- */
54
- batchDeleteBitableAppTable(app_token: string, body: BatchDeleteBitableAppTableRequest): Promise<void>;
55
- /**
56
- * 新增视图
57
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/create
58
- */
59
- createBitableAppTableView(app_token: string, table_id: string, body: CreateBitableAppTableViewRequest): Promise<CreateBitableAppTableViewResponse>;
60
- /**
61
- * 更新视图
62
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/patch
63
- */
64
- patchBitableAppTableView(app_token: string, table_id: string, view_id: string, body: PatchBitableAppTableViewRequest): Promise<PatchBitableAppTableViewResponse>;
65
- /**
66
- * 列出视图
67
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list
68
- */
69
- listBitableAppTableView(app_token: string, table_id: string, query?: ListBitableAppTableViewQuery): Promise<ListBitableAppTableViewResponse> & AsyncIterableIterator<AppTableView>;
70
- /**
71
- * 获取视图
72
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/get
73
- */
74
- getBitableAppTableView(app_token: string, table_id: string, view_id: string): Promise<GetBitableAppTableViewResponse>;
75
- /**
76
- * 删除视图
77
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/delete
78
- */
79
- deleteBitableAppTableView(app_token: string, table_id: string, view_id: string): Promise<void>;
80
- /**
81
- * 新增记录
82
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/create
83
- */
84
- createBitableAppTableRecord(app_token: string, table_id: string, body: CreateBitableAppTableRecordRequest, query?: CreateBitableAppTableRecordQuery): Promise<CreateBitableAppTableRecordResponse>;
85
- /**
86
- * 更新记录
87
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/update
88
- */
89
- updateBitableAppTableRecord(app_token: string, table_id: string, record_id: string, body: UpdateBitableAppTableRecordRequest, query?: UpdateBitableAppTableRecordQuery): Promise<UpdateBitableAppTableRecordResponse>;
90
- /**
91
- * 查询记录
92
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search
93
- */
94
- searchBitableAppTableRecord(app_token: string, table_id: string, body: SearchBitableAppTableRecordRequest, query?: SearchBitableAppTableRecordQuery): Promise<SearchBitableAppTableRecordResponse> & AsyncIterableIterator<AppTableRecord>;
95
- /**
96
- * 删除记录
97
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/delete
98
- */
99
- deleteBitableAppTableRecord(app_token: string, table_id: string, record_id: string): Promise<DeleteBitableAppTableRecordResponse>;
100
- /**
101
- * 新增多条记录
102
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_create
103
- */
104
- batchCreateBitableAppTableRecord(app_token: string, table_id: string, body: BatchCreateBitableAppTableRecordRequest, query?: BatchCreateBitableAppTableRecordQuery): Promise<BatchCreateBitableAppTableRecordResponse>;
105
- /**
106
- * 更新多条记录
107
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_update
108
- */
109
- batchUpdateBitableAppTableRecord(app_token: string, table_id: string, body: BatchUpdateBitableAppTableRecordRequest, query?: BatchUpdateBitableAppTableRecordQuery): Promise<BatchUpdateBitableAppTableRecordResponse>;
110
- /**
111
- * 批量获取记录
112
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_get
113
- */
114
- batchGetBitableAppTableRecord(app_token: string, table_id: string, body: BatchGetBitableAppTableRecordRequest): Promise<BatchGetBitableAppTableRecordResponse>;
115
- /**
116
- * 删除多条记录
117
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_delete
118
- */
119
- batchDeleteBitableAppTableRecord(app_token: string, table_id: string, body: BatchDeleteBitableAppTableRecordRequest): Promise<BatchDeleteBitableAppTableRecordResponse>;
120
- /**
121
- * 新增字段
122
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/create
123
- */
124
- createBitableAppTableField(app_token: string, table_id: string, body: CreateBitableAppTableFieldRequest, query?: CreateBitableAppTableFieldQuery): Promise<CreateBitableAppTableFieldResponse>;
125
- /**
126
- * 更新字段
127
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/update
128
- */
129
- updateBitableAppTableField(app_token: string, table_id: string, field_id: string, body: UpdateBitableAppTableFieldRequest): Promise<UpdateBitableAppTableFieldResponse>;
130
- /**
131
- * 列出字段
132
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/list
133
- */
134
- listBitableAppTableField(app_token: string, table_id: string, query?: ListBitableAppTableFieldQuery): Promise<ListBitableAppTableFieldResponse> & AsyncIterableIterator<AppTableFieldForList>;
135
- /**
136
- * 删除字段
137
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/delete
138
- */
139
- deleteBitableAppTableField(app_token: string, table_id: string, field_id: string): Promise<DeleteBitableAppTableFieldResponse>;
140
- /**
141
- * 复制仪表盘
142
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/copy
143
- */
144
- copyBitableAppDashboard(app_token: string, block_id: string, body: CopyBitableAppDashboardRequest): Promise<CopyBitableAppDashboardResponse>;
145
- /**
146
- * 列出仪表盘
147
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/list
148
- */
149
- listBitableAppDashboard(app_token: string, query?: Pagination): Paginated<AppDashboard, 'dashboards'>;
150
- /**
151
- * 更新表单元数据
152
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/patch
153
- */
154
- patchBitableAppTableForm(app_token: string, table_id: string, form_id: string, body: PatchBitableAppTableFormRequest): Promise<PatchBitableAppTableFormResponse>;
155
- /**
156
- * 获取表单元数据
157
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/get
158
- */
159
- getBitableAppTableForm(app_token: string, table_id: string, form_id: string): Promise<GetBitableAppTableFormResponse>;
160
- /**
161
- * 更新表单问题
162
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form-field/patch
163
- */
164
- patchBitableAppTableFormField(app_token: string, table_id: string, form_id: string, field_id: string, body: PatchBitableAppTableFormFieldRequest): Promise<PatchBitableAppTableFormFieldResponse>;
165
- /**
166
- * 列出表单问题
167
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form-field/list
168
- */
169
- listBitableAppTableFormField(app_token: string, table_id: string, form_id: string, query?: Pagination): Promise<ListBitableAppTableFormFieldResponse> & AsyncIterableIterator<AppTableFormField>;
170
- /**
171
- * 新增自定义角色
172
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/create
173
- */
174
- createBitableAppRole(app_token: string, body: CreateBitableAppRoleRequest): Promise<CreateBitableAppRoleResponse>;
175
- /**
176
- * 更新自定义角色
177
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/update
178
- */
179
- updateBitableAppRole(app_token: string, role_id: string, body: UpdateBitableAppRoleRequest): Promise<UpdateBitableAppRoleResponse>;
180
- /**
181
- * 列出自定义角色
182
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/list
183
- */
184
- listBitableAppRole(app_token: string, query?: Pagination): Promise<ListBitableAppRoleResponse> & AsyncIterableIterator<AppRole>;
185
- /**
186
- * 删除自定义角色
187
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/delete
188
- */
189
- deleteBitableAppRole(app_token: string, role_id: string): Promise<void>;
190
- /**
191
- * 新增协作者
192
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/create
193
- */
194
- createBitableAppRoleMember(app_token: string, role_id: string, body: CreateBitableAppRoleMemberRequest, query?: CreateBitableAppRoleMemberQuery): Promise<void>;
195
- /**
196
- * 批量新增协作者
197
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_create
198
- */
199
- batchCreateBitableAppRoleMember(app_token: string, role_id: string, body: BatchCreateBitableAppRoleMemberRequest): Promise<void>;
200
- /**
201
- * 列出协作者
202
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/list
203
- */
204
- listBitableAppRoleMember(app_token: string, role_id: string, query?: Pagination): Promise<ListBitableAppRoleMemberResponse> & AsyncIterableIterator<AppRoleMember>;
205
- /**
206
- * 删除协作者
207
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/delete
208
- */
209
- deleteBitableAppRoleMember(app_token: string, role_id: string, member_id: string, query?: DeleteBitableAppRoleMemberQuery): Promise<void>;
210
- /**
211
- * 批量删除协作者
212
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_delete
213
- */
214
- batchDeleteBitableAppRoleMember(app_token: string, role_id: string, body: BatchDeleteBitableAppRoleMemberRequest): Promise<void>;
215
- /**
216
- * 列出自动化流程
217
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-workflow/list
218
- */
219
- listBitableAppWorkflow(app_token: string, query?: Pagination): Promise<ListBitableAppWorkflowResponse>;
220
- /**
221
- * 更新自动化流程状态
222
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-workflow/update
223
- */
224
- updateBitableAppWorkflow(app_token: string, workflow_id: string, body: UpdateBitableAppWorkflowRequest): Promise<void>;
225
- /**
226
- * 检索记录
227
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/get
228
- */
229
- getBitableAppTableRecord(app_token: string, table_id: string, record_id: string, query?: GetBitableAppTableRecordQuery): Promise<GetBitableAppTableRecordResponse>;
230
- /**
231
- * 列出记录
232
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/list
233
- */
234
- listBitableAppTableRecord(app_token: string, table_id: string, query?: ListBitableAppTableRecordQuery): Promise<ListBitableAppTableRecordResponse> & AsyncIterableIterator<AppTableRecord>;
5
+ bitable: Bitable.Methods;
235
6
  }
236
7
  }
237
- export interface CreateBitableAppRequest {
238
- /** 多维表格App名字 */
239
- name?: string;
240
- /** 多维表格App归属文件夹 */
241
- folder_token?: string;
242
- /** 文档时区,说明见:https://bytedance.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf */
243
- time_zone?: string;
244
- }
245
- export interface CreateBitableAppResponse {
246
- app?: App;
247
- }
248
- export interface CopyBitableAppRequest {
249
- /** 多维表格 App 名字 */
250
- name?: string;
251
- /** 多维表格 App 归属文件夹 */
252
- folder_token?: string;
253
- /** 不复制文档内容,只复制文档结构 */
254
- without_content?: boolean;
255
- /** 文档时区,说明见:https://bytedance.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf */
256
- time_zone?: string;
257
- }
258
- export interface CopyBitableAppResponse {
259
- app?: App;
260
- }
261
- export interface GetBitableAppResponse {
262
- app?: DisplayApp;
263
- }
264
- export interface UpdateBitableAppRequest {
265
- /** 新的多维表格名字 */
266
- name?: string;
267
- /** 多维表格是否开启高级权限 */
268
- is_advanced?: boolean;
269
- }
270
- export interface UpdateBitableAppResponse {
271
- app?: DisplayAppV2;
272
- }
273
- export interface CreateBitableAppTableRequest {
274
- /** 数据表 */
275
- table?: ReqTable;
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
- }
285
- export interface BatchCreateBitableAppTableRequest {
286
- /** tables */
287
- tables?: ReqTable[];
288
- }
289
- export interface BatchCreateBitableAppTableQuery {
290
- /** 此次调用中使用的用户ID的类型 */
291
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
292
- }
293
- export interface BatchCreateBitableAppTableResponse {
294
- table_ids?: string[];
295
- }
296
- export interface PatchBitableAppTableRequest {
297
- /** 数据表的新名称 */
298
- name?: string;
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
- }
313
- export interface BatchDeleteBitableAppTableRequest {
314
- /** 删除的多条tableid列表 */
315
- table_ids?: string[];
316
- }
317
- export interface CreateBitableAppTableViewRequest {
318
- /** 视图名字 */
319
- view_name: string;
320
- /** 视图类型 */
321
- view_type?: 'grid' | 'kanban' | 'gallery' | 'gantt' | 'form';
322
- }
323
- export interface CreateBitableAppTableViewResponse {
324
- view?: AppTableView;
325
- }
326
- export interface PatchBitableAppTableViewRequest {
327
- /** 视图名称 */
328
- view_name?: string;
329
- /** 视图属性 */
330
- property?: AppTableViewProperty;
331
- }
332
- export interface PatchBitableAppTableViewResponse {
333
- view?: AppTableView;
334
- }
335
- export interface ListBitableAppTableViewQuery extends Pagination {
336
- /** 此次调用中使用的用户ID的类型 */
337
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
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
- }
352
- export interface CreateBitableAppTableRecordRequest {
353
- /** 记录字段 */
354
- fields: Record<string, unknown>;
355
- }
356
- export interface CreateBitableAppTableRecordQuery {
357
- /** 此次调用中使用的用户ID的类型 */
358
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
359
- /** 格式为标准的 uuid,操作的唯一标识,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
360
- client_token?: string;
361
- /** 用于控制一致性读写,默认开启检查 */
362
- ignore_consistency_check?: boolean;
363
- }
364
- export interface CreateBitableAppTableRecordResponse {
365
- record?: AppTableRecord;
366
- }
367
- export interface UpdateBitableAppTableRecordRequest {
368
- /** 记录字段 */
369
- fields: Record<string, unknown>;
370
- }
371
- export interface UpdateBitableAppTableRecordQuery {
372
- /** 此次调用中使用的用户ID的类型 */
373
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
374
- /** 用于控制一致性读写,默认开启检查 */
375
- ignore_consistency_check?: boolean;
376
- }
377
- export interface UpdateBitableAppTableRecordResponse {
378
- record?: AppTableRecord;
379
- }
380
- export interface SearchBitableAppTableRecordRequest {
381
- /** 视图Id,指定视图id则按照视图的筛选排序结果返回数据 */
382
- view_id?: string;
383
- /** 指定要返回的字段 */
384
- field_names?: string[];
385
- /** 排序条件 */
386
- sort?: Sort[];
387
- /** 筛选条件 */
388
- filter?: FilterInfo;
389
- /** 控制是否返回自动计算的字段, true 表示返回 */
390
- automatic_fields?: boolean;
391
- }
392
- export interface SearchBitableAppTableRecordQuery extends Pagination {
393
- /** 此次调用中使用的用户ID的类型 */
394
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
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
- }
412
- export interface BatchCreateBitableAppTableRecordRequest {
413
- /** 记录 */
414
- records: AppTableRecord[];
415
- }
416
- export interface BatchCreateBitableAppTableRecordQuery {
417
- /** 此次调用中使用的用户ID的类型 */
418
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
419
- /** 格式为标准的 uuid,操作的唯一标识,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
420
- client_token?: string;
421
- /** 用于控制一致性读写,默认开启检查 */
422
- ignore_consistency_check?: boolean;
423
- }
424
- export interface BatchCreateBitableAppTableRecordResponse {
425
- /** 本次请求新增的记录列表 */
426
- records?: AppTableRecord[];
427
- }
428
- export interface BatchUpdateBitableAppTableRecordRequest {
429
- /** 记录 */
430
- records: AppTableRecord[];
431
- }
432
- export interface BatchUpdateBitableAppTableRecordQuery {
433
- /** 此次调用中使用的用户ID的类型 */
434
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
435
- /** 用于控制一致性读写,默认开启检查 */
436
- ignore_consistency_check?: boolean;
437
- }
438
- export interface BatchUpdateBitableAppTableRecordResponse {
439
- /** 更新后的记录 */
440
- records?: AppTableRecord[];
441
- }
442
- export interface BatchGetBitableAppTableRecordRequest {
443
- /** 记录 id 列表 */
444
- record_ids: string[];
445
- /** 此次调用中使用的用户 id 的类型 */
446
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
447
- /** 控制是否返回记录的分享链接,true 表示返回分享链接 */
448
- with_shared_url?: boolean;
449
- /** 控制是否返回自动计算的字段,true 表示返回 */
450
- automatic_fields?: boolean;
451
- }
452
- export interface BatchGetBitableAppTableRecordResponse {
453
- /** 记录列表 */
454
- records?: AppTableRecord[];
455
- /** 禁止访问的记录列表(针对开启了高级权限的文档) */
456
- forbidden_record_ids?: string[];
457
- /** 不存在的记录列表 */
458
- absent_record_ids?: string[];
459
- }
460
- export interface BatchDeleteBitableAppTableRecordRequest {
461
- /** 删除的多条记录id列表 */
462
- records: string[];
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
- }
510
- export interface CreateBitableAppTableFieldRequest {
511
- /** 字段名 */
512
- field_name: string;
513
- /** 字段类型 */
514
- type: CreateBitableAppTableFieldRequestType;
515
- /** 字段属性 */
516
- property?: AppTableFieldProperty;
517
- /** 字段的描述 */
518
- description?: AppTableFieldDescription;
519
- /** 字段在界面上的展示类型,例如进度字段是数字的一种展示形态 */
520
- 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';
521
- }
522
- export interface CreateBitableAppTableFieldQuery {
523
- /** 格式为标准的 uuid,操作的唯一标识,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
524
- client_token?: string;
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
- }
571
- export interface UpdateBitableAppTableFieldRequest {
572
- /** 字段名 */
573
- field_name: string;
574
- /** 字段类型 */
575
- type: UpdateBitableAppTableFieldRequestType;
576
- /** 字段属性 */
577
- property?: AppTableFieldProperty;
578
- /** 字段的描述 */
579
- description?: AppTableFieldDescription;
580
- /** 字段在界面上的展示类型,例如进度字段是数字的一种展示形态 */
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';
582
- }
583
- export interface UpdateBitableAppTableFieldResponse {
584
- field?: AppTableField;
585
- }
586
- export interface ListBitableAppTableFieldQuery extends Pagination {
587
- /** 视图 ID */
588
- view_id?: string;
589
- /** 控制字段描述(多行文本格式)数据的返回格式, true 表示以数组富文本形式返回 */
590
- text_field_as_array?: boolean;
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
- }
608
- export interface CopyBitableAppDashboardRequest {
609
- /** 仪表盘名称 */
610
- name: string;
611
- }
612
- export interface CopyBitableAppDashboardResponse {
613
- /** 多维表格 block_id */
614
- block_id?: string;
615
- /** block 名称 */
616
- name?: string;
617
- }
618
- export interface PatchBitableAppTableFormRequest {
619
- /** 表单名称 */
620
- name?: string;
621
- /** 表单描述 */
622
- description?: string;
623
- /** 是否开启共享 */
624
- shared?: boolean;
625
- /** 分享范围限制 */
626
- shared_limit?: 'off' | 'tenant_editable' | 'anyone_editable';
627
- /** 填写次数限制一次 */
628
- submit_limit_once?: boolean;
629
- }
630
- export interface PatchBitableAppTableFormResponse {
631
- /** 表单元数据信息 */
632
- form: AppTableForm;
633
- }
634
- export interface GetBitableAppTableFormResponse {
635
- /** 表单元数据信息 */
636
- form: AppTableForm;
637
- }
638
- export interface PatchBitableAppTableFormFieldRequest {
639
- /** 上一个表单问题 ID */
640
- pre_field_id?: string;
641
- /** 表单问题 */
642
- title?: string;
643
- /** 问题描述 */
644
- description?: string;
645
- /** 是否必填 */
646
- required?: boolean;
647
- /** 是否可见 */
648
- visible?: boolean;
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
- }
664
- export interface CreateBitableAppRoleRequest {
665
- /** 自定义权限的名字 */
666
- role_name: string;
667
- /** 数据表权限 */
668
- table_roles: AppRoleTableRole[];
669
- /** block权限 */
670
- block_roles?: AppRoleBlockRole[];
671
- }
672
- export interface CreateBitableAppRoleResponse {
673
- role?: AppRole;
674
- }
675
- export interface UpdateBitableAppRoleRequest {
676
- /** 自定义权限的名字 */
677
- role_name: string;
678
- /** 数据表权限 */
679
- table_roles: AppRoleTableRole[];
680
- /** block权限 */
681
- block_roles?: AppRoleBlockRole[];
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
- }
696
- export interface CreateBitableAppRoleMemberRequest {
697
- /** 协作者id */
698
- member_id: string;
699
- }
700
- export interface CreateBitableAppRoleMemberQuery {
701
- /** 协作者id类型,与请求体中的member_id要对应 */
702
- member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id';
703
- }
704
- export interface BatchCreateBitableAppRoleMemberRequest {
705
- /** 协作者列表 */
706
- member_list: AppRoleMemberId[];
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
- }
718
- export interface DeleteBitableAppRoleMemberQuery {
719
- /** 协作者id类型,与请求体中的member_id要对应 */
720
- member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id';
721
- }
722
- export interface BatchDeleteBitableAppRoleMemberRequest {
723
- /** 协作者列表 */
724
- member_list: AppRoleMemberId[];
725
- }
726
- export interface ListBitableAppWorkflowResponse {
727
- /** 自动化工作流信息 */
728
- workflows: AppWorkflow[];
729
- }
730
- export interface UpdateBitableAppWorkflowRequest {
731
- /** 自动化状态 */
732
- status: string;
733
- }
734
- export interface GetBitableAppTableRecordQuery {
735
- /** 控制多行文本字段数据的返回格式, true 表示以数组形式返回 */
736
- text_field_as_array?: boolean;
737
- /** 此次调用中使用的用户ID的类型 */
738
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
739
- /** 控制公式、查找引用是否显示完整的原样返回结果 */
740
- display_formula_ref?: boolean;
741
- /** 控制是否返回该记录的链接 */
742
- with_shared_url?: boolean;
743
- /** 控制是否返回自动计算的字段,例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`,true 表示返回 */
744
- automatic_fields?: boolean;
745
- }
746
- export interface GetBitableAppTableRecordResponse {
747
- record?: AppTableRecord;
748
- }
749
- export interface ListBitableAppTableRecordQuery extends Pagination {
750
- /** 视图 id注意:如 filter 或 sort 有值,view_id 会被忽略。 */
751
- view_id?: string;
752
- /** 筛选参数注意:1.筛选记录的表达式不超过2000个字符。2.不支持对“人员”以及“关联字段”的属性进行过滤筛选,如人员的 OpenID。3.仅支持字段在页面展示字符值进行筛选。详细请参考[记录筛选开发指南](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/filter) */
753
- filter?: string;
754
- /** 排序参数注意:1.表达式需要不超过1000字符。2.不支持对带“公式”和“关联字段”的表的使用。3.使用引号将字段名称和顺序逆序连接起来。 */
755
- sort?: string;
756
- /** 字段名称 */
757
- field_names?: string;
758
- /** 控制多行文本字段数据的返回格式,true 表示以数组形式返回。注意:1.多行文本中如果有超链接部分,则会返回链接的 URL。2.目前可以返回多行文本中 URL 类型为多维表格链接、飞书 doc、飞书 sheet的URL类型以及@人员的数据结构。 */
759
- text_field_as_array?: boolean;
760
- /** 此次调用中使用的用户ID的类型 */
761
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
762
- /** 控制公式、查找引用是否显示完整的原样返回结果 */
763
- display_formula_ref?: boolean;
764
- /** 控制是否返回自动计算的字段,例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`,true 表示返回 */
765
- automatic_fields?: boolean;
766
- }
767
- export interface ListBitableAppTableRecordResponse {
768
- /** 是否有下一页数据 */
769
- has_more?: boolean;
770
- /** 下一页分页的token */
771
- page_token?: string;
772
- /** 总数 */
773
- total?: number;
774
- items?: AppTableRecord[];
8
+ export declare namespace Bitable {
9
+ interface Methods {
10
+ app: App.Methods;
11
+ }
12
+ namespace App {
13
+ interface Methods {
14
+ table: Table.Methods;
15
+ dashboard: Dashboard.Methods;
16
+ role: Role.Methods;
17
+ workflow: Workflow.Methods;
18
+ /**
19
+ * 创建多维表格
20
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/create
21
+ */
22
+ create(body: CreateRequest): Promise<CreateResponse>;
23
+ /**
24
+ * 复制多维表格
25
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/copy
26
+ */
27
+ copy(app_token: string, body: CopyRequest): Promise<CopyResponse>;
28
+ /**
29
+ * 获取多维表格元数据
30
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/get
31
+ */
32
+ get(app_token: string): Promise<GetResponse>;
33
+ /**
34
+ * 更新多维表格元数据
35
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/update
36
+ */
37
+ update(app_token: string, body: UpdateRequest): Promise<UpdateResponse>;
38
+ }
39
+ interface CreateRequest {
40
+ /** 多维表格App名字 */
41
+ name?: string;
42
+ /** 多维表格App归属文件夹 */
43
+ folder_token?: string;
44
+ /** 文档时区,说明见:https://bytedance.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf */
45
+ time_zone?: string;
46
+ }
47
+ interface CreateResponse {
48
+ app?: Lark.App;
49
+ }
50
+ interface CopyRequest {
51
+ /** 多维表格 App 名字 */
52
+ name?: string;
53
+ /** 多维表格 App 归属文件夹 */
54
+ folder_token?: string;
55
+ /** 不复制文档内容,只复制文档结构 */
56
+ without_content?: boolean;
57
+ /** 文档时区,说明见:https://bytedance.feishu.cn/docx/YKRndTM7VoyDqpxqqeEcd67MnEf */
58
+ time_zone?: string;
59
+ }
60
+ interface CopyResponse {
61
+ app?: Lark.App;
62
+ }
63
+ interface GetResponse {
64
+ app?: Lark.DisplayApp;
65
+ }
66
+ interface UpdateRequest {
67
+ /** 新的多维表格名字 */
68
+ name?: string;
69
+ /** 多维表格是否开启高级权限 */
70
+ is_advanced?: boolean;
71
+ }
72
+ interface UpdateResponse {
73
+ app?: Lark.DisplayAppV2;
74
+ }
75
+ namespace Table {
76
+ interface Methods {
77
+ view: View.Methods;
78
+ record: Record.Methods;
79
+ field: Field.Methods;
80
+ form: Form.Methods;
81
+ /**
82
+ * 新增一个数据表
83
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/create
84
+ */
85
+ create(app_token: string, body: CreateRequest): Promise<CreateResponse>;
86
+ /**
87
+ * 新增多个数据表
88
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_create
89
+ */
90
+ batchCreate(app_token: string, body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>;
91
+ /**
92
+ * 更新数据表
93
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/patch
94
+ */
95
+ patch(app_token: string, table_id: string, body: PatchRequest): Promise<PatchResponse>;
96
+ /**
97
+ * 列出数据表
98
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/list
99
+ */
100
+ list(app_token: string, query?: Pagination): Promise<ListResponse> & AsyncIterableIterator<Lark.AppTable>;
101
+ /**
102
+ * 删除一个数据表
103
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/delete
104
+ */
105
+ delete(app_token: string, table_id: string): Promise<void>;
106
+ /**
107
+ * 删除多个数据表
108
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table/batch_delete
109
+ */
110
+ batchDelete(app_token: string, body: BatchDeleteRequest): Promise<void>;
111
+ }
112
+ interface CreateRequest {
113
+ /** 数据表 */
114
+ table?: Lark.ReqTable;
115
+ }
116
+ interface CreateResponse {
117
+ /** 数据表的唯一标识id */
118
+ table_id?: string;
119
+ /** 默认表格视图的id,该字段仅在请求参数中填写了default_view_name或fields才会返回 */
120
+ default_view_id?: string;
121
+ /** 数据表初始字段的id列表,该字段仅在请求参数中填写了fields才会返回 */
122
+ field_id_list?: string[];
123
+ }
124
+ interface BatchCreateRequest {
125
+ /** tables */
126
+ tables?: Lark.ReqTable[];
127
+ }
128
+ interface BatchCreateQuery {
129
+ /** 此次调用中使用的用户ID的类型 */
130
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
131
+ }
132
+ interface BatchCreateResponse {
133
+ table_ids?: string[];
134
+ }
135
+ interface PatchRequest {
136
+ /** 数据表的新名称 */
137
+ name?: string;
138
+ }
139
+ interface PatchResponse {
140
+ /** 数据表的名称 */
141
+ name?: string;
142
+ }
143
+ interface ListResponse {
144
+ /** 是否有下一页数据 */
145
+ has_more?: boolean;
146
+ /** 下一页分页的token */
147
+ page_token?: string;
148
+ /** 总数 */
149
+ total?: number;
150
+ items?: Lark.AppTable[];
151
+ }
152
+ interface BatchDeleteRequest {
153
+ /** 删除的多条tableid列表 */
154
+ table_ids?: string[];
155
+ }
156
+ namespace View {
157
+ interface Methods {
158
+ /**
159
+ * 新增视图
160
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/create
161
+ */
162
+ create(app_token: string, table_id: string, body: CreateRequest): Promise<CreateResponse>;
163
+ /**
164
+ * 更新视图
165
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/patch
166
+ */
167
+ patch(app_token: string, table_id: string, view_id: string, body: PatchRequest): Promise<PatchResponse>;
168
+ /**
169
+ * 列出视图
170
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/list
171
+ */
172
+ list(app_token: string, table_id: string, query?: ListQuery): Promise<ListResponse> & AsyncIterableIterator<Lark.AppTableView>;
173
+ /**
174
+ * 获取视图
175
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/get
176
+ */
177
+ get(app_token: string, table_id: string, view_id: string): Promise<GetResponse>;
178
+ /**
179
+ * 删除视图
180
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-view/delete
181
+ */
182
+ delete(app_token: string, table_id: string, view_id: string): Promise<void>;
183
+ }
184
+ interface CreateRequest {
185
+ /** 视图名字 */
186
+ view_name: string;
187
+ /** 视图类型 */
188
+ view_type?: 'grid' | 'kanban' | 'gallery' | 'gantt' | 'form';
189
+ }
190
+ interface CreateResponse {
191
+ view?: Lark.AppTableView;
192
+ }
193
+ interface PatchRequest {
194
+ /** 视图名称 */
195
+ view_name?: string;
196
+ /** 视图属性 */
197
+ property?: Lark.AppTableViewProperty;
198
+ }
199
+ interface PatchResponse {
200
+ view?: Lark.AppTableView;
201
+ }
202
+ interface ListQuery extends Pagination {
203
+ /** 此次调用中使用的用户ID的类型 */
204
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
205
+ }
206
+ interface ListResponse {
207
+ /** 视图列表 */
208
+ items?: Lark.AppTableView[];
209
+ /** 下一页分页的token */
210
+ page_token?: string;
211
+ /** 是否有下一页数据 */
212
+ has_more?: boolean;
213
+ /** 总数 */
214
+ total?: number;
215
+ }
216
+ interface GetResponse {
217
+ view?: Lark.AppTableView;
218
+ }
219
+ }
220
+ namespace Record {
221
+ interface Methods {
222
+ /**
223
+ * 新增记录
224
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/create
225
+ */
226
+ create(app_token: string, table_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
227
+ /**
228
+ * 更新记录
229
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/update
230
+ */
231
+ update(app_token: string, table_id: string, record_id: string, body: UpdateRequest, query?: UpdateQuery): Promise<UpdateResponse>;
232
+ /**
233
+ * 查询记录
234
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/search
235
+ */
236
+ search(app_token: string, table_id: string, body: SearchRequest, query?: SearchQuery): Promise<SearchResponse> & AsyncIterableIterator<Lark.AppTableRecord>;
237
+ /**
238
+ * 删除记录
239
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/delete
240
+ */
241
+ delete(app_token: string, table_id: string, record_id: string): Promise<DeleteResponse>;
242
+ /**
243
+ * 新增多条记录
244
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_create
245
+ */
246
+ batchCreate(app_token: string, table_id: string, body: BatchCreateRequest, query?: BatchCreateQuery): Promise<BatchCreateResponse>;
247
+ /**
248
+ * 更新多条记录
249
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_update
250
+ */
251
+ batchUpdate(app_token: string, table_id: string, body: BatchUpdateRequest, query?: BatchUpdateQuery): Promise<BatchUpdateResponse>;
252
+ /**
253
+ * 批量获取记录
254
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_get
255
+ */
256
+ batchGet(app_token: string, table_id: string, body: BatchGetRequest): Promise<BatchGetResponse>;
257
+ /**
258
+ * 删除多条记录
259
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/batch_delete
260
+ */
261
+ batchDelete(app_token: string, table_id: string, body: BatchDeleteRequest): Promise<BatchDeleteResponse>;
262
+ /**
263
+ * 检索记录
264
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/get
265
+ */
266
+ get(app_token: string, table_id: string, record_id: string, query?: GetQuery): Promise<GetResponse>;
267
+ /**
268
+ * 列出记录
269
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-record/list
270
+ */
271
+ list(app_token: string, table_id: string, query?: ListQuery): Promise<ListResponse> & AsyncIterableIterator<Lark.AppTableRecord>;
272
+ }
273
+ interface CreateRequest {
274
+ /** 记录字段 */
275
+ fields: Record<string, unknown>;
276
+ }
277
+ interface CreateQuery {
278
+ /** 此次调用中使用的用户ID的类型 */
279
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
280
+ /** 格式为标准的 uuid,操作的唯一标识,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
281
+ client_token?: string;
282
+ /** 用于控制一致性读写,默认开启检查 */
283
+ ignore_consistency_check?: boolean;
284
+ }
285
+ interface CreateResponse {
286
+ record?: Lark.AppTableRecord;
287
+ }
288
+ interface UpdateRequest {
289
+ /** 记录字段 */
290
+ fields: Record<string, unknown>;
291
+ }
292
+ interface UpdateQuery {
293
+ /** 此次调用中使用的用户ID的类型 */
294
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
295
+ /** 用于控制一致性读写,默认开启检查 */
296
+ ignore_consistency_check?: boolean;
297
+ }
298
+ interface UpdateResponse {
299
+ record?: Lark.AppTableRecord;
300
+ }
301
+ interface SearchRequest {
302
+ /** 视图Id,指定视图id则按照视图的筛选排序结果返回数据 */
303
+ view_id?: string;
304
+ /** 指定要返回的字段 */
305
+ field_names?: string[];
306
+ /** 排序条件 */
307
+ sort?: Lark.Sort[];
308
+ /** 筛选条件 */
309
+ filter?: Lark.FilterInfo;
310
+ /** 控制是否返回自动计算的字段, true 表示返回 */
311
+ automatic_fields?: boolean;
312
+ }
313
+ interface SearchQuery extends Pagination {
314
+ /** 此次调用中使用的用户ID的类型 */
315
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
316
+ }
317
+ interface SearchResponse {
318
+ /** record 结果 */
319
+ items?: Lark.AppTableRecord[];
320
+ /** 是否有下一页数据 */
321
+ has_more?: boolean;
322
+ /** 下一页分页的token */
323
+ page_token?: string;
324
+ /** 总数 */
325
+ total?: number;
326
+ }
327
+ interface DeleteResponse {
328
+ /** 是否成功删除 */
329
+ deleted?: boolean;
330
+ /** 删除的记录id */
331
+ record_id?: string;
332
+ }
333
+ interface BatchCreateRequest {
334
+ /** 记录 */
335
+ records: Lark.AppTableRecord[];
336
+ }
337
+ interface BatchCreateQuery {
338
+ /** 此次调用中使用的用户ID的类型 */
339
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
340
+ /** 格式为标准的 uuid,操作的唯一标识,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
341
+ client_token?: string;
342
+ /** 用于控制一致性读写,默认开启检查 */
343
+ ignore_consistency_check?: boolean;
344
+ }
345
+ interface BatchCreateResponse {
346
+ /** 本次请求新增的记录列表 */
347
+ records?: Lark.AppTableRecord[];
348
+ }
349
+ interface BatchUpdateRequest {
350
+ /** 记录 */
351
+ records: Lark.AppTableRecord[];
352
+ }
353
+ interface BatchUpdateQuery {
354
+ /** 此次调用中使用的用户ID的类型 */
355
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
356
+ /** 用于控制一致性读写,默认开启检查 */
357
+ ignore_consistency_check?: boolean;
358
+ }
359
+ interface BatchUpdateResponse {
360
+ /** 更新后的记录 */
361
+ records?: Lark.AppTableRecord[];
362
+ }
363
+ interface BatchGetRequest {
364
+ /** 记录 id 列表 */
365
+ record_ids: string[];
366
+ /** 此次调用中使用的用户 id 的类型 */
367
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
368
+ /** 控制是否返回记录的分享链接,true 表示返回分享链接 */
369
+ with_shared_url?: boolean;
370
+ /** 控制是否返回自动计算的字段,true 表示返回 */
371
+ automatic_fields?: boolean;
372
+ }
373
+ interface BatchGetResponse {
374
+ /** 记录列表 */
375
+ records?: Lark.AppTableRecord[];
376
+ /** 禁止访问的记录列表(针对开启了高级权限的文档) */
377
+ forbidden_record_ids?: string[];
378
+ /** 不存在的记录列表 */
379
+ absent_record_ids?: string[];
380
+ }
381
+ interface BatchDeleteRequest {
382
+ /** 删除的多条记录id列表 */
383
+ records: string[];
384
+ }
385
+ interface BatchDeleteResponse {
386
+ /** 记录删除结果 */
387
+ records?: Lark.DeleteRecord[];
388
+ }
389
+ interface GetQuery {
390
+ /** 控制多行文本字段数据的返回格式, true 表示以数组形式返回 */
391
+ text_field_as_array?: boolean;
392
+ /** 此次调用中使用的用户ID的类型 */
393
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
394
+ /** 控制公式、查找引用是否显示完整的原样返回结果 */
395
+ display_formula_ref?: boolean;
396
+ /** 控制是否返回该记录的链接 */
397
+ with_shared_url?: boolean;
398
+ /** 控制是否返回自动计算的字段,例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`,true 表示返回 */
399
+ automatic_fields?: boolean;
400
+ }
401
+ interface GetResponse {
402
+ record?: Lark.AppTableRecord;
403
+ }
404
+ interface ListQuery extends Pagination {
405
+ /** 视图 id注意:如 filter 或 sort 有值,view_id 会被忽略。 */
406
+ view_id?: string;
407
+ /** 筛选参数注意:1.筛选记录的表达式不超过2000个字符。2.不支持对“人员”以及“关联字段”的属性进行过滤筛选,如人员的 OpenID。3.仅支持字段在页面展示字符值进行筛选。详细请参考[记录筛选开发指南](/ssl:ttdoc/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/filter) */
408
+ filter?: string;
409
+ /** 排序参数注意:1.表达式需要不超过1000字符。2.不支持对带“公式”和“关联字段”的表的使用。3.使用引号将字段名称和顺序逆序连接起来。 */
410
+ sort?: string;
411
+ /** 字段名称 */
412
+ field_names?: string;
413
+ /** 控制多行文本字段数据的返回格式,true 表示以数组形式返回。注意:1.多行文本中如果有超链接部分,则会返回链接的 URL。2.目前可以返回多行文本中 URL 类型为多维表格链接、飞书 doc、飞书 sheet的URL类型以及@人员的数据结构。 */
414
+ text_field_as_array?: boolean;
415
+ /** 此次调用中使用的用户ID的类型 */
416
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
417
+ /** 控制公式、查找引用是否显示完整的原样返回结果 */
418
+ display_formula_ref?: boolean;
419
+ /** 控制是否返回自动计算的字段,例如 `created_by`/`created_time`/`last_modified_by`/`last_modified_time`,true 表示返回 */
420
+ automatic_fields?: boolean;
421
+ }
422
+ interface ListResponse {
423
+ /** 是否有下一页数据 */
424
+ has_more?: boolean;
425
+ /** 下一页分页的token */
426
+ page_token?: string;
427
+ /** 总数 */
428
+ total?: number;
429
+ items?: Lark.AppTableRecord[];
430
+ }
431
+ }
432
+ namespace Field {
433
+ interface Methods {
434
+ /**
435
+ * 新增字段
436
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/create
437
+ */
438
+ create(app_token: string, table_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>;
439
+ /**
440
+ * 更新字段
441
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/update
442
+ */
443
+ update(app_token: string, table_id: string, field_id: string, body: UpdateRequest): Promise<UpdateResponse>;
444
+ /**
445
+ * 列出字段
446
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/list
447
+ */
448
+ list(app_token: string, table_id: string, query?: ListQuery): Promise<ListResponse> & AsyncIterableIterator<Lark.AppTableFieldForList>;
449
+ /**
450
+ * 删除字段
451
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-field/delete
452
+ */
453
+ delete(app_token: string, table_id: string, field_id: string): Promise<DeleteResponse>;
454
+ }
455
+ const enum CreateRequestType {
456
+ /** 多行文本(默认值)、条码 */
457
+ Text = 1,
458
+ /** 数字(默认值)、进度、货币、评分 */
459
+ Number = 2,
460
+ /** 单选 */
461
+ SingleSelect = 3,
462
+ /** 多选 */
463
+ MultiSelect = 4,
464
+ /** 日期 */
465
+ DateTime = 5,
466
+ /** 复选框 */
467
+ Checkbox = 7,
468
+ /** 人员 */
469
+ User = 11,
470
+ /** 电话号码 */
471
+ PhoneNumber = 13,
472
+ /** 超链接 */
473
+ Url = 15,
474
+ /** 附件 */
475
+ Attachment = 17,
476
+ /** 单向关联 */
477
+ Link = 18,
478
+ /** 公式 */
479
+ Formula = 20,
480
+ /** 双向关联 */
481
+ DuplexLink = 21,
482
+ /** 地理位置 */
483
+ Location = 22,
484
+ /** 群组 */
485
+ GroupChat = 23,
486
+ /** 创建时间 */
487
+ CreatedTime = 1001,
488
+ /** 最后更新时间 */
489
+ ModifiedTime = 1002,
490
+ /** 创建人 */
491
+ CreatedUser = 1003,
492
+ /** 修改人 */
493
+ ModifiedUser = 1004,
494
+ /** 自动编号 */
495
+ AutoSerial = 1005
496
+ }
497
+ interface CreateRequest {
498
+ /** 字段名 */
499
+ field_name: string;
500
+ /** 字段类型 */
501
+ type: CreateRequestType;
502
+ /** 字段属性 */
503
+ property?: Lark.AppTableFieldProperty;
504
+ /** 字段的描述 */
505
+ description?: Lark.AppTableFieldDescription;
506
+ /** 字段在界面上的展示类型,例如进度字段是数字的一种展示形态 */
507
+ 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';
508
+ }
509
+ interface CreateQuery {
510
+ /** 格式为标准的 uuid,操作的唯一标识,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作。 */
511
+ client_token?: string;
512
+ }
513
+ interface CreateResponse {
514
+ field?: Lark.AppTableField;
515
+ }
516
+ const enum UpdateRequestType {
517
+ /** 多行文本(默认值)、条码 */
518
+ Text = 1,
519
+ /** 数字(默认值)、进度、货币、评分 */
520
+ Number = 2,
521
+ /** 单选 */
522
+ SingleSelect = 3,
523
+ /** 多选 */
524
+ MultiSelect = 4,
525
+ /** 日期 */
526
+ DateTime = 5,
527
+ /** 复选框 */
528
+ Checkbox = 7,
529
+ /** 人员 */
530
+ User = 11,
531
+ /** 电话号码 */
532
+ PhoneNumber = 13,
533
+ /** 超链接 */
534
+ Url = 15,
535
+ /** 附件 */
536
+ Attachment = 17,
537
+ /** 单向关联 */
538
+ Link = 18,
539
+ /** 公式 */
540
+ Formula = 20,
541
+ /** 双向关联 */
542
+ DuplexLink = 21,
543
+ /** 地理位置 */
544
+ Location = 22,
545
+ /** 群组 */
546
+ GroupChat = 23,
547
+ /** 创建时间 */
548
+ CreatedTime = 1001,
549
+ /** 最后更新时间 */
550
+ ModifiedTime = 1002,
551
+ /** 创建人 */
552
+ CreatedUser = 1003,
553
+ /** 修改人 */
554
+ ModifiedUser = 1004,
555
+ /** 自动编号 */
556
+ AutoSerial = 1005
557
+ }
558
+ interface UpdateRequest {
559
+ /** 字段名 */
560
+ field_name: string;
561
+ /** 字段类型 */
562
+ type: UpdateRequestType;
563
+ /** 字段属性 */
564
+ property?: Lark.AppTableFieldProperty;
565
+ /** 字段的描述 */
566
+ description?: Lark.AppTableFieldDescription;
567
+ /** 字段在界面上的展示类型,例如进度字段是数字的一种展示形态 */
568
+ 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';
569
+ }
570
+ interface UpdateResponse {
571
+ field?: Lark.AppTableField;
572
+ }
573
+ interface ListQuery extends Pagination {
574
+ /** 视图 ID */
575
+ view_id?: string;
576
+ /** 控制字段描述(多行文本格式)数据的返回格式, true 表示以数组富文本形式返回 */
577
+ text_field_as_array?: boolean;
578
+ }
579
+ interface ListResponse {
580
+ /** 是否有下一页数据 */
581
+ has_more?: boolean;
582
+ /** 下一页分页的token */
583
+ page_token?: string;
584
+ /** 总数 */
585
+ total?: number;
586
+ /** 字段列表 */
587
+ items?: Lark.AppTableFieldForList[];
588
+ }
589
+ interface DeleteResponse {
590
+ /** 字段唯一标识id */
591
+ field_id?: string;
592
+ /** 是否已删除 */
593
+ deleted?: boolean;
594
+ }
595
+ }
596
+ namespace Form {
597
+ interface Methods {
598
+ field: Field.Methods;
599
+ /**
600
+ * 更新表单元数据
601
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/patch
602
+ */
603
+ patch(app_token: string, table_id: string, form_id: string, body: PatchRequest): Promise<PatchResponse>;
604
+ /**
605
+ * 获取表单元数据
606
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form/get
607
+ */
608
+ get(app_token: string, table_id: string, form_id: string): Promise<GetResponse>;
609
+ }
610
+ interface PatchRequest {
611
+ /** 表单名称 */
612
+ name?: string;
613
+ /** 表单描述 */
614
+ description?: string;
615
+ /** 是否开启共享 */
616
+ shared?: boolean;
617
+ /** 分享范围限制 */
618
+ shared_limit?: 'off' | 'tenant_editable' | 'anyone_editable';
619
+ /** 填写次数限制一次 */
620
+ submit_limit_once?: boolean;
621
+ }
622
+ interface PatchResponse {
623
+ /** 表单元数据信息 */
624
+ form: Lark.AppTableForm;
625
+ }
626
+ interface GetResponse {
627
+ /** 表单元数据信息 */
628
+ form: Lark.AppTableForm;
629
+ }
630
+ namespace Field {
631
+ interface Methods {
632
+ /**
633
+ * 更新表单问题
634
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form-field/patch
635
+ */
636
+ patch(app_token: string, table_id: string, form_id: string, field_id: string, body: PatchRequest): Promise<PatchResponse>;
637
+ /**
638
+ * 列出表单问题
639
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-table-form-field/list
640
+ */
641
+ list(app_token: string, table_id: string, form_id: string, query?: Pagination): Promise<ListResponse> & AsyncIterableIterator<Lark.AppTableFormField>;
642
+ }
643
+ interface PatchRequest {
644
+ /** 上一个表单问题 ID */
645
+ pre_field_id?: string;
646
+ /** 表单问题 */
647
+ title?: string;
648
+ /** 问题描述 */
649
+ description?: string;
650
+ /** 是否必填 */
651
+ required?: boolean;
652
+ /** 是否可见 */
653
+ visible?: boolean;
654
+ }
655
+ interface PatchResponse {
656
+ /** 更新后的field值 */
657
+ field?: Lark.AppTableFormPatchedField;
658
+ }
659
+ interface ListResponse {
660
+ /** 表单内的字段列表 */
661
+ items: Lark.AppTableFormField[];
662
+ /** 下一页分页的token */
663
+ page_token: string;
664
+ /** 是否有下一页 */
665
+ has_more: boolean;
666
+ /** 总数 */
667
+ total: number;
668
+ }
669
+ }
670
+ }
671
+ }
672
+ namespace Dashboard {
673
+ interface Methods {
674
+ /**
675
+ * 复制仪表盘
676
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/copy
677
+ */
678
+ copy(app_token: string, block_id: string, body: CopyRequest): Promise<CopyResponse>;
679
+ /**
680
+ * 列出仪表盘
681
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-dashboard/list
682
+ */
683
+ list(app_token: string, query?: Pagination): Paginated<Lark.AppDashboard, 'dashboards'>;
684
+ }
685
+ interface CopyRequest {
686
+ /** 仪表盘名称 */
687
+ name: string;
688
+ }
689
+ interface CopyResponse {
690
+ /** 多维表格 block_id */
691
+ block_id?: string;
692
+ /** block 名称 */
693
+ name?: string;
694
+ }
695
+ }
696
+ namespace Role {
697
+ interface Methods {
698
+ member: Member.Methods;
699
+ /**
700
+ * 删除自定义角色
701
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/delete
702
+ */
703
+ delete(app_token: string, role_id: string): Promise<void>;
704
+ /**
705
+ * 新增自定义角色
706
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/create
707
+ */
708
+ create(app_token: string, body: CreateRequest): Promise<CreateResponse>;
709
+ /**
710
+ * 列出自定义角色
711
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/list
712
+ */
713
+ list(app_token: string, query?: Pagination): Promise<ListResponse> & AsyncIterableIterator<Lark.AppRole>;
714
+ /**
715
+ * 更新自定义角色
716
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role/update
717
+ */
718
+ update(app_token: string, role_id: string, body: UpdateRequest): Promise<UpdateResponse>;
719
+ }
720
+ interface CreateRequest {
721
+ /** 自定义权限的名字 */
722
+ role_name: string;
723
+ /** 数据表权限 */
724
+ table_roles: Lark.AppRoleTableRole[];
725
+ /** block权限 */
726
+ block_roles?: Lark.AppRoleBlockRole[];
727
+ }
728
+ interface CreateResponse {
729
+ role?: Lark.AppRole;
730
+ }
731
+ interface ListResponse {
732
+ /** 角色列表 */
733
+ items?: Lark.AppRole[];
734
+ /** 下一页分页的token */
735
+ page_token?: string;
736
+ /** 是否有下一页数据 */
737
+ has_more?: boolean;
738
+ /** 总数 */
739
+ total?: number;
740
+ }
741
+ interface UpdateRequest {
742
+ /** 自定义权限的名字 */
743
+ role_name: string;
744
+ /** 数据表权限 */
745
+ table_roles: Lark.AppRoleTableRole[];
746
+ /** block权限 */
747
+ block_roles?: Lark.AppRoleBlockRole[];
748
+ }
749
+ interface UpdateResponse {
750
+ role?: Lark.AppRole;
751
+ }
752
+ namespace Member {
753
+ interface Methods {
754
+ /**
755
+ * 新增协作者
756
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/create
757
+ */
758
+ create(app_token: string, role_id: string, body: CreateRequest, query?: CreateQuery): Promise<void>;
759
+ /**
760
+ * 批量新增协作者
761
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_create
762
+ */
763
+ batchCreate(app_token: string, role_id: string, body: BatchCreateRequest): Promise<void>;
764
+ /**
765
+ * 列出协作者
766
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/list
767
+ */
768
+ list(app_token: string, role_id: string, query?: Pagination): Promise<ListResponse> & AsyncIterableIterator<Lark.AppRoleMember>;
769
+ /**
770
+ * 删除协作者
771
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/delete
772
+ */
773
+ delete(app_token: string, role_id: string, member_id: string, query?: DeleteQuery): Promise<void>;
774
+ /**
775
+ * 批量删除协作者
776
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-role-member/batch_delete
777
+ */
778
+ batchDelete(app_token: string, role_id: string, body: BatchDeleteRequest): Promise<void>;
779
+ }
780
+ interface CreateRequest {
781
+ /** 协作者id */
782
+ member_id: string;
783
+ }
784
+ interface CreateQuery {
785
+ /** 协作者id类型,与请求体中的member_id要对应 */
786
+ member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id';
787
+ }
788
+ interface BatchCreateRequest {
789
+ /** 协作者列表 */
790
+ member_list: Lark.AppRoleMemberId[];
791
+ }
792
+ interface ListResponse {
793
+ /** 协作者列表 */
794
+ items?: Lark.AppRoleMember[];
795
+ /** 是否有下一页数据 */
796
+ has_more?: boolean;
797
+ /** 下一页分页的token */
798
+ page_token?: string;
799
+ /** 总数 */
800
+ total?: number;
801
+ }
802
+ interface DeleteQuery {
803
+ /** 协作者id类型,与请求体中的member_id要对应 */
804
+ member_id_type?: 'open_id' | 'union_id' | 'user_id' | 'chat_id' | 'department_id' | 'open_department_id';
805
+ }
806
+ interface BatchDeleteRequest {
807
+ /** 协作者列表 */
808
+ member_list: Lark.AppRoleMemberId[];
809
+ }
810
+ }
811
+ }
812
+ namespace Workflow {
813
+ interface Methods {
814
+ /**
815
+ * 列出自动化流程
816
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-workflow/list
817
+ */
818
+ list(app_token: string, query?: Pagination): Promise<ListResponse>;
819
+ /**
820
+ * 更新自动化流程状态
821
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app-workflow/update
822
+ */
823
+ update(app_token: string, workflow_id: string, body: UpdateRequest): Promise<void>;
824
+ }
825
+ interface ListResponse {
826
+ /** 自动化工作流信息 */
827
+ workflows: Lark.AppWorkflow[];
828
+ }
829
+ interface UpdateRequest {
830
+ /** 自动化状态 */
831
+ status: string;
832
+ }
833
+ }
834
+ }
775
835
  }