@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,326 +1,361 @@
1
- import { Condition, Dimension, FilterView, FilterViewCondition, FindCondition, FindReplaceResult, FloatImage, GetSpreadsheet, Sheet, SheetFilterInfo, Spreadsheet } from '.';
1
+ import * as Lark from '.';
2
2
  declare module '../internal' {
3
3
  interface Internal {
4
- /**
5
- * 创建电子表格
6
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/create
7
- */
8
- createSheetsSpreadsheet(body: CreateSheetsSpreadsheetRequest): Promise<CreateSheetsSpreadsheetResponse>;
9
- /**
10
- * 修改电子表格属性
11
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/patch
12
- */
13
- patchSheetsSpreadsheet(spreadsheet_token: string, body: PatchSheetsSpreadsheetRequest): Promise<void>;
14
- /**
15
- * 获取电子表格信息
16
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/get
17
- */
18
- getSheetsSpreadsheet(spreadsheet_token: string, query?: GetSheetsSpreadsheetQuery): Promise<GetSheetsSpreadsheetResponse>;
19
- /**
20
- * 获取工作表
21
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query
22
- */
23
- querySheetsSpreadsheetSheet(spreadsheet_token: string): Promise<QuerySheetsSpreadsheetSheetResponse>;
24
- /**
25
- * 查询工作表
26
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/get
27
- */
28
- getSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string): Promise<GetSheetsSpreadsheetSheetResponse>;
29
- /**
30
- * 移动行列
31
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/move_dimension
32
- */
33
- moveDimensionSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string, body: MoveDimensionSheetsSpreadsheetSheetRequest): Promise<void>;
34
- /**
35
- * 查找单元格
36
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/find
37
- */
38
- findSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string, body: FindSheetsSpreadsheetSheetRequest): Promise<FindSheetsSpreadsheetSheetResponse>;
39
- /**
40
- * 替换单元格
41
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/replace
42
- */
43
- replaceSheetsSpreadsheetSheet(spreadsheet_token: string, sheet_id: string, body: ReplaceSheetsSpreadsheetSheetRequest): Promise<ReplaceSheetsSpreadsheetSheetResponse>;
44
- /**
45
- * 创建筛选
46
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/create
47
- */
48
- createSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string, body: CreateSheetsSpreadsheetSheetFilterRequest): Promise<void>;
49
- /**
50
- * 更新筛选
51
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/update
52
- */
53
- updateSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string, body: UpdateSheetsSpreadsheetSheetFilterRequest): Promise<void>;
54
- /**
55
- * 获取筛选
56
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/get
57
- */
58
- getSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string): Promise<GetSheetsSpreadsheetSheetFilterResponse>;
59
- /**
60
- * 删除筛选
61
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/delete
62
- */
63
- deleteSheetsSpreadsheetSheetFilter(spreadsheet_token: string, sheet_id: string): Promise<void>;
64
- /**
65
- * 创建筛选视图
66
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/create
67
- */
68
- createSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, body: CreateSheetsSpreadsheetSheetFilterViewRequest): Promise<CreateSheetsSpreadsheetSheetFilterViewResponse>;
69
- /**
70
- * 更新筛选视图
71
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/patch
72
- */
73
- patchSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, filter_view_id: string, body: PatchSheetsSpreadsheetSheetFilterViewRequest): Promise<PatchSheetsSpreadsheetSheetFilterViewResponse>;
74
- /**
75
- * 查询筛选视图
76
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/query
77
- */
78
- querySheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string): Promise<QuerySheetsSpreadsheetSheetFilterViewResponse>;
79
- /**
80
- * 获取筛选视图
81
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/get
82
- */
83
- getSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise<GetSheetsSpreadsheetSheetFilterViewResponse>;
84
- /**
85
- * 删除筛选视图
86
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/delete
87
- */
88
- deleteSheetsSpreadsheetSheetFilterView(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise<void>;
89
- /**
90
- * 创建筛选条件
91
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/create
92
- */
93
- createSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, body: CreateSheetsSpreadsheetSheetFilterViewConditionRequest): Promise<CreateSheetsSpreadsheetSheetFilterViewConditionResponse>;
94
- /**
95
- * 更新筛选条件
96
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/update
97
- */
98
- updateSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string, body: UpdateSheetsSpreadsheetSheetFilterViewConditionRequest): Promise<UpdateSheetsSpreadsheetSheetFilterViewConditionResponse>;
99
- /**
100
- * 查询筛选条件
101
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/query
102
- */
103
- querySheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise<QuerySheetsSpreadsheetSheetFilterViewConditionResponse>;
104
- /**
105
- * 获取筛选条件
106
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/get
107
- */
108
- getSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string): Promise<GetSheetsSpreadsheetSheetFilterViewConditionResponse>;
109
- /**
110
- * 删除筛选条件
111
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/delete
112
- */
113
- deleteSheetsSpreadsheetSheetFilterViewCondition(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string): Promise<void>;
114
- /**
115
- * 创建浮动图片
116
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/create
117
- */
118
- createSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, body: CreateSheetsSpreadsheetSheetFloatImageRequest): Promise<CreateSheetsSpreadsheetSheetFloatImageResponse>;
119
- /**
120
- * 更新浮动图片
121
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/patch
122
- */
123
- patchSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, float_image_id: string, body: PatchSheetsSpreadsheetSheetFloatImageRequest): Promise<PatchSheetsSpreadsheetSheetFloatImageResponse>;
124
- /**
125
- * 获取浮动图片
126
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/get
127
- */
128
- getSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, float_image_id: string): Promise<GetSheetsSpreadsheetSheetFloatImageResponse>;
129
- /**
130
- * 查询浮动图片
131
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/query
132
- */
133
- querySheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string): Promise<QuerySheetsSpreadsheetSheetFloatImageResponse>;
134
- /**
135
- * 删除浮动图片
136
- * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/delete
137
- */
138
- deleteSheetsSpreadsheetSheetFloatImage(spreadsheet_token: string, sheet_id: string, float_image_id: string): Promise<void>;
4
+ sheets: Sheets.Methods;
139
5
  }
140
6
  }
141
- export interface CreateSheetsSpreadsheetRequest {
142
- /** 表格标题 */
143
- title?: string;
144
- /** 文件夹token */
145
- folder_token?: string;
146
- }
147
- export interface CreateSheetsSpreadsheetResponse {
148
- /** 表格信息 */
149
- spreadsheet?: Spreadsheet;
150
- }
151
- export interface PatchSheetsSpreadsheetRequest {
152
- /** 表格标题 */
153
- title?: string;
154
- }
155
- export interface GetSheetsSpreadsheetQuery {
156
- /** 此次调用中使用的用户ID的类型 */
157
- user_id_type?: 'user_id' | 'union_id' | 'open_id';
158
- }
159
- export interface GetSheetsSpreadsheetResponse {
160
- /** 表格 */
161
- spreadsheet?: GetSpreadsheet;
162
- }
163
- export interface QuerySheetsSpreadsheetSheetResponse {
164
- /** 工作表信息 */
165
- sheets?: Sheet[];
166
- }
167
- export interface GetSheetsSpreadsheetSheetResponse {
168
- /** 工作表 */
169
- sheet?: Sheet;
170
- }
171
- export interface MoveDimensionSheetsSpreadsheetSheetRequest {
172
- /** 移动源位置参数 */
173
- source?: Dimension;
174
- /** 移动的目标位置行或者列号 */
175
- destination_index?: number;
176
- }
177
- export interface FindSheetsSpreadsheetSheetRequest {
178
- /** 查找条件 */
179
- find_condition: FindCondition;
180
- /** 查找的字符串 */
181
- find: string;
182
- }
183
- export interface FindSheetsSpreadsheetSheetResponse {
184
- /** 查找返回符合条件的信息 */
185
- find_result?: FindReplaceResult;
186
- }
187
- export interface ReplaceSheetsSpreadsheetSheetRequest {
188
- /** 查找条件 */
189
- find_condition: FindCondition;
190
- /** 查找的字符串 */
191
- find: string;
192
- /** 替换的字符串 */
193
- replacement: string;
194
- }
195
- export interface ReplaceSheetsSpreadsheetSheetResponse {
196
- /** 符合查找条件并替换的单元格信息 */
197
- replace_result?: FindReplaceResult;
198
- }
199
- export interface CreateSheetsSpreadsheetSheetFilterRequest {
200
- /** 筛选应用范围 */
201
- range: string;
202
- /** 设置筛选条件的列 */
203
- col: string;
204
- /** 筛选的条件 */
205
- condition: Condition;
206
- }
207
- export interface UpdateSheetsSpreadsheetSheetFilterRequest {
208
- /** 更新筛选条件的列 */
209
- col: string;
210
- /** 筛选条件 */
211
- condition: Condition;
212
- }
213
- export interface GetSheetsSpreadsheetSheetFilterResponse {
214
- /** 筛选信息 */
215
- sheet_filter_info?: SheetFilterInfo;
216
- }
217
- export interface CreateSheetsSpreadsheetSheetFilterViewRequest {
218
- /** 筛选视图 id */
219
- filter_view_id?: string;
220
- /** 筛选视图名字 */
221
- filter_view_name?: string;
222
- /** 筛选视图的筛选范围 */
223
- range?: string;
224
- }
225
- export interface CreateSheetsSpreadsheetSheetFilterViewResponse {
226
- /** 创建的筛选视图的 id 、name、range */
227
- filter_view?: FilterView;
228
- }
229
- export interface PatchSheetsSpreadsheetSheetFilterViewRequest {
230
- /** 筛选视图名字 */
231
- filter_view_name?: string;
232
- /** 筛选视图的筛选范围 */
233
- range?: string;
234
- }
235
- export interface PatchSheetsSpreadsheetSheetFilterViewResponse {
236
- /** 更新后的筛选视图的 id 、name、range */
237
- filter_view?: FilterView;
238
- }
239
- export interface QuerySheetsSpreadsheetSheetFilterViewResponse {
240
- /** 子表的所有筛选视图信息,id、name、range */
241
- items?: FilterView[];
242
- }
243
- export interface GetSheetsSpreadsheetSheetFilterViewResponse {
244
- /** 筛选视图信息,包括 id、name、range */
245
- filter_view?: FilterView;
246
- }
247
- export interface CreateSheetsSpreadsheetSheetFilterViewConditionRequest {
248
- /** 设置筛选条件的列,使用字母号 */
249
- condition_id?: string;
250
- /** 筛选类型 */
251
- filter_type?: string;
252
- /** 比较类型 */
253
- compare_type?: string;
254
- /** 筛选参数 */
255
- expected?: string[];
256
- }
257
- export interface CreateSheetsSpreadsheetSheetFilterViewConditionResponse {
258
- /** 创建的筛选条件 */
259
- condition?: FilterViewCondition;
260
- }
261
- export interface UpdateSheetsSpreadsheetSheetFilterViewConditionRequest {
262
- /** 筛选类型 */
263
- filter_type?: string;
264
- /** 比较类型 */
265
- compare_type?: string;
266
- /** 筛选参数 */
267
- expected?: string[];
268
- }
269
- export interface UpdateSheetsSpreadsheetSheetFilterViewConditionResponse {
270
- /** 更新后的筛选条件 */
271
- condition?: FilterViewCondition;
272
- }
273
- export interface QuerySheetsSpreadsheetSheetFilterViewConditionResponse {
274
- /** 筛选视图设置的所有筛选条件 */
275
- items?: FilterViewCondition[];
276
- }
277
- export interface GetSheetsSpreadsheetSheetFilterViewConditionResponse {
278
- /** 筛选的条件 */
279
- condition?: FilterViewCondition;
280
- }
281
- export interface CreateSheetsSpreadsheetSheetFloatImageRequest {
282
- /** 浮动图片 id */
283
- float_image_id?: string;
284
- /** 浮动图片 token,需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */
285
- float_image_token?: string;
286
- /** 浮动图片的左上角单元格定位,只支持一个单元格 */
287
- range?: string;
288
- /** 浮动图片的宽度,大于等于 20px */
289
- width?: number;
290
- /** 浮动图片的高度,大于等于 20px */
291
- height?: number;
292
- /** 浮动图片左上角所在位置相对于所在单元格左上角的横向偏移,大于等于0且小于所在单元格的宽度 */
293
- offset_x?: number;
294
- /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移,大于等于0且小于所在单元格的高度 */
295
- offset_y?: number;
296
- }
297
- export interface CreateSheetsSpreadsheetSheetFloatImageResponse {
298
- /** 浮动图片 */
299
- float_image?: FloatImage;
300
- }
301
- export interface PatchSheetsSpreadsheetSheetFloatImageRequest {
302
- /** 浮动图片 token,需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */
303
- float_image_token?: string;
304
- /** 浮动图片的左上角单元格定位,只支持一个单元格 */
305
- range?: string;
306
- /** 浮动图片的宽度,大于等于 20px */
307
- width?: number;
308
- /** 浮动图片的高度,大于等于 20px */
309
- height?: number;
310
- /** 浮动图片左上角所在位置相对于所在单元格左上角的横向偏移,大于等于0且小于所在单元格的宽度 */
311
- offset_x?: number;
312
- /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移,大于等于0且小于所在单元格的高度 */
313
- offset_y?: number;
314
- }
315
- export interface PatchSheetsSpreadsheetSheetFloatImageResponse {
316
- /** 浮动图片 */
317
- float_image?: FloatImage;
318
- }
319
- export interface GetSheetsSpreadsheetSheetFloatImageResponse {
320
- /** 浮动图片 */
321
- float_image?: FloatImage;
322
- }
323
- export interface QuerySheetsSpreadsheetSheetFloatImageResponse {
324
- /** 子表的所有浮动图片信息 */
325
- items?: FloatImage[];
7
+ export declare namespace Sheets {
8
+ interface Methods {
9
+ spreadsheet: Spreadsheet.Methods;
10
+ }
11
+ namespace Spreadsheet {
12
+ interface Methods {
13
+ sheet: Sheet.Methods;
14
+ /**
15
+ * 创建电子表格
16
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/create
17
+ */
18
+ create(body: CreateRequest): Promise<CreateResponse>;
19
+ /**
20
+ * 修改电子表格属性
21
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/patch
22
+ */
23
+ patch(spreadsheet_token: string, body: PatchRequest): Promise<void>;
24
+ /**
25
+ * 获取电子表格信息
26
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/get
27
+ */
28
+ get(spreadsheet_token: string, query?: GetQuery): Promise<GetResponse>;
29
+ }
30
+ interface CreateRequest {
31
+ /** 表格标题 */
32
+ title?: string;
33
+ /** 文件夹token */
34
+ folder_token?: string;
35
+ }
36
+ interface CreateResponse {
37
+ /** 表格信息 */
38
+ spreadsheet?: Lark.Spreadsheet;
39
+ }
40
+ interface PatchRequest {
41
+ /** 表格标题 */
42
+ title?: string;
43
+ }
44
+ interface GetQuery {
45
+ /** 此次调用中使用的用户ID的类型 */
46
+ user_id_type?: 'user_id' | 'union_id' | 'open_id';
47
+ }
48
+ interface GetResponse {
49
+ /** 表格 */
50
+ spreadsheet?: Lark.GetSpreadsheet;
51
+ }
52
+ namespace Sheet {
53
+ interface Methods {
54
+ filter: Filter.Methods;
55
+ filterView: FilterView.Methods;
56
+ floatImage: FloatImage.Methods;
57
+ /**
58
+ * 获取工作表
59
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/query
60
+ */
61
+ query(spreadsheet_token: string): Promise<QueryResponse>;
62
+ /**
63
+ * 查询工作表
64
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/get
65
+ */
66
+ get(spreadsheet_token: string, sheet_id: string): Promise<GetResponse>;
67
+ /**
68
+ * 移动行列
69
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/move_dimension
70
+ */
71
+ moveDimension(spreadsheet_token: string, sheet_id: string, body: MoveDimensionRequest): Promise<void>;
72
+ /**
73
+ * 查找单元格
74
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/find
75
+ */
76
+ find(spreadsheet_token: string, sheet_id: string, body: FindRequest): Promise<FindResponse>;
77
+ /**
78
+ * 替换单元格
79
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet/replace
80
+ */
81
+ replace(spreadsheet_token: string, sheet_id: string, body: ReplaceRequest): Promise<ReplaceResponse>;
82
+ }
83
+ interface QueryResponse {
84
+ /** 工作表信息 */
85
+ sheets?: Lark.Sheet[];
86
+ }
87
+ interface GetResponse {
88
+ /** 工作表 */
89
+ sheet?: Lark.Sheet;
90
+ }
91
+ interface MoveDimensionRequest {
92
+ /** 移动源位置参数 */
93
+ source?: Lark.Dimension;
94
+ /** 移动的目标位置行或者列号 */
95
+ destination_index?: number;
96
+ }
97
+ interface FindRequest {
98
+ /** 查找条件 */
99
+ find_condition: Lark.FindCondition;
100
+ /** 查找的字符串 */
101
+ find: string;
102
+ }
103
+ interface FindResponse {
104
+ /** 查找返回符合条件的信息 */
105
+ find_result?: Lark.FindReplaceResult;
106
+ }
107
+ interface ReplaceRequest {
108
+ /** 查找条件 */
109
+ find_condition: Lark.FindCondition;
110
+ /** 查找的字符串 */
111
+ find: string;
112
+ /** 替换的字符串 */
113
+ replacement: string;
114
+ }
115
+ interface ReplaceResponse {
116
+ /** 符合查找条件并替换的单元格信息 */
117
+ replace_result?: Lark.FindReplaceResult;
118
+ }
119
+ namespace Filter {
120
+ interface Methods {
121
+ /**
122
+ * 创建筛选
123
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/create
124
+ */
125
+ create(spreadsheet_token: string, sheet_id: string, body: CreateRequest): Promise<void>;
126
+ /**
127
+ * 更新筛选
128
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/update
129
+ */
130
+ update(spreadsheet_token: string, sheet_id: string, body: UpdateRequest): Promise<void>;
131
+ /**
132
+ * 获取筛选
133
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/get
134
+ */
135
+ get(spreadsheet_token: string, sheet_id: string): Promise<GetResponse>;
136
+ /**
137
+ * 删除筛选
138
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter/delete
139
+ */
140
+ delete(spreadsheet_token: string, sheet_id: string): Promise<void>;
141
+ }
142
+ interface CreateRequest {
143
+ /** 筛选应用范围 */
144
+ range: string;
145
+ /** 设置筛选条件的列 */
146
+ col: string;
147
+ /** 筛选的条件 */
148
+ condition: Lark.Condition;
149
+ }
150
+ interface UpdateRequest {
151
+ /** 更新筛选条件的列 */
152
+ col: string;
153
+ /** 筛选条件 */
154
+ condition: Lark.Condition;
155
+ }
156
+ interface GetResponse {
157
+ /** 筛选信息 */
158
+ sheet_filter_info?: Lark.SheetFilterInfo;
159
+ }
160
+ }
161
+ namespace FilterView {
162
+ interface Methods {
163
+ condition: Condition.Methods;
164
+ /**
165
+ * 创建筛选视图
166
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/create
167
+ */
168
+ create(spreadsheet_token: string, sheet_id: string, body: CreateRequest): Promise<CreateResponse>;
169
+ /**
170
+ * 更新筛选视图
171
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/patch
172
+ */
173
+ patch(spreadsheet_token: string, sheet_id: string, filter_view_id: string, body: PatchRequest): Promise<PatchResponse>;
174
+ /**
175
+ * 查询筛选视图
176
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/query
177
+ */
178
+ query(spreadsheet_token: string, sheet_id: string): Promise<QueryResponse>;
179
+ /**
180
+ * 获取筛选视图
181
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/get
182
+ */
183
+ get(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise<GetResponse>;
184
+ /**
185
+ * 删除筛选视图
186
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view/delete
187
+ */
188
+ delete(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise<void>;
189
+ }
190
+ interface CreateRequest {
191
+ /** 筛选视图 id */
192
+ filter_view_id?: string;
193
+ /** 筛选视图名字 */
194
+ filter_view_name?: string;
195
+ /** 筛选视图的筛选范围 */
196
+ range?: string;
197
+ }
198
+ interface CreateResponse {
199
+ /** 创建的筛选视图的 id 、name、range */
200
+ filter_view?: Lark.FilterView;
201
+ }
202
+ interface PatchRequest {
203
+ /** 筛选视图名字 */
204
+ filter_view_name?: string;
205
+ /** 筛选视图的筛选范围 */
206
+ range?: string;
207
+ }
208
+ interface PatchResponse {
209
+ /** 更新后的筛选视图的 id 、name、range */
210
+ filter_view?: Lark.FilterView;
211
+ }
212
+ interface QueryResponse {
213
+ /** 子表的所有筛选视图信息,id、name、range */
214
+ items?: Lark.FilterView[];
215
+ }
216
+ interface GetResponse {
217
+ /** 筛选视图信息,包括 id、name、range */
218
+ filter_view?: Lark.FilterView;
219
+ }
220
+ namespace Condition {
221
+ interface Methods {
222
+ /**
223
+ * 创建筛选条件
224
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/create
225
+ */
226
+ create(spreadsheet_token: string, sheet_id: string, filter_view_id: string, body: CreateRequest): Promise<CreateResponse>;
227
+ /**
228
+ * 更新筛选条件
229
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/update
230
+ */
231
+ update(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string, body: UpdateRequest): Promise<UpdateResponse>;
232
+ /**
233
+ * 查询筛选条件
234
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/query
235
+ */
236
+ query(spreadsheet_token: string, sheet_id: string, filter_view_id: string): Promise<QueryResponse>;
237
+ /**
238
+ * 获取筛选条件
239
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/get
240
+ */
241
+ get(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string): Promise<GetResponse>;
242
+ /**
243
+ * 删除筛选条件
244
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-filter_view-condition/delete
245
+ */
246
+ delete(spreadsheet_token: string, sheet_id: string, filter_view_id: string, condition_id: string): Promise<void>;
247
+ }
248
+ interface CreateRequest {
249
+ /** 设置筛选条件的列,使用字母号 */
250
+ condition_id?: string;
251
+ /** 筛选类型 */
252
+ filter_type?: string;
253
+ /** 比较类型 */
254
+ compare_type?: string;
255
+ /** 筛选参数 */
256
+ expected?: string[];
257
+ }
258
+ interface CreateResponse {
259
+ /** 创建的筛选条件 */
260
+ condition?: Lark.FilterViewCondition;
261
+ }
262
+ interface UpdateRequest {
263
+ /** 筛选类型 */
264
+ filter_type?: string;
265
+ /** 比较类型 */
266
+ compare_type?: string;
267
+ /** 筛选参数 */
268
+ expected?: string[];
269
+ }
270
+ interface UpdateResponse {
271
+ /** 更新后的筛选条件 */
272
+ condition?: Lark.FilterViewCondition;
273
+ }
274
+ interface QueryResponse {
275
+ /** 筛选视图设置的所有筛选条件 */
276
+ items?: Lark.FilterViewCondition[];
277
+ }
278
+ interface GetResponse {
279
+ /** 筛选的条件 */
280
+ condition?: Lark.FilterViewCondition;
281
+ }
282
+ }
283
+ }
284
+ namespace FloatImage {
285
+ interface Methods {
286
+ /**
287
+ * 创建浮动图片
288
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/create
289
+ */
290
+ create(spreadsheet_token: string, sheet_id: string, body: CreateRequest): Promise<CreateResponse>;
291
+ /**
292
+ * 更新浮动图片
293
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/patch
294
+ */
295
+ patch(spreadsheet_token: string, sheet_id: string, float_image_id: string, body: PatchRequest): Promise<PatchResponse>;
296
+ /**
297
+ * 获取浮动图片
298
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/get
299
+ */
300
+ get(spreadsheet_token: string, sheet_id: string, float_image_id: string): Promise<GetResponse>;
301
+ /**
302
+ * 查询浮动图片
303
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/query
304
+ */
305
+ query(spreadsheet_token: string, sheet_id: string): Promise<QueryResponse>;
306
+ /**
307
+ * 删除浮动图片
308
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet-sheet-float_image/delete
309
+ */
310
+ delete(spreadsheet_token: string, sheet_id: string, float_image_id: string): Promise<void>;
311
+ }
312
+ interface CreateRequest {
313
+ /** 浮动图片 id */
314
+ float_image_id?: string;
315
+ /** 浮动图片 token,需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */
316
+ float_image_token?: string;
317
+ /** 浮动图片的左上角单元格定位,只支持一个单元格 */
318
+ range?: string;
319
+ /** 浮动图片的宽度,大于等于 20px */
320
+ width?: number;
321
+ /** 浮动图片的高度,大于等于 20px */
322
+ height?: number;
323
+ /** 浮动图片左上角所在位置相对于所在单元格左上角的横向偏移,大于等于0且小于所在单元格的宽度 */
324
+ offset_x?: number;
325
+ /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移,大于等于0且小于所在单元格的高度 */
326
+ offset_y?: number;
327
+ }
328
+ interface CreateResponse {
329
+ /** 浮动图片 */
330
+ float_image?: Lark.FloatImage;
331
+ }
332
+ interface PatchRequest {
333
+ /** 浮动图片 token,需要先上传图片到表格获得此 token 之后再进行浮动图片的操作 */
334
+ float_image_token?: string;
335
+ /** 浮动图片的左上角单元格定位,只支持一个单元格 */
336
+ range?: string;
337
+ /** 浮动图片的宽度,大于等于 20px */
338
+ width?: number;
339
+ /** 浮动图片的高度,大于等于 20px */
340
+ height?: number;
341
+ /** 浮动图片左上角所在位置相对于所在单元格左上角的横向偏移,大于等于0且小于所在单元格的宽度 */
342
+ offset_x?: number;
343
+ /** 浮动图片左上角所在位置相对于所在单元格左上角的纵向偏移,大于等于0且小于所在单元格的高度 */
344
+ offset_y?: number;
345
+ }
346
+ interface PatchResponse {
347
+ /** 浮动图片 */
348
+ float_image?: Lark.FloatImage;
349
+ }
350
+ interface GetResponse {
351
+ /** 浮动图片 */
352
+ float_image?: Lark.FloatImage;
353
+ }
354
+ interface QueryResponse {
355
+ /** 子表的所有浮动图片信息 */
356
+ items?: Lark.FloatImage[];
357
+ }
358
+ }
359
+ }
360
+ }
326
361
  }