@satorijs/adapter-lark 3.10.6 → 3.11.0

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