@satorijs/adapter-lark 3.9.0 → 3.9.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. package/lib/index.cjs +1091 -27
  2. package/lib/internal.d.ts +2 -3
  3. package/lib/types/acs.d.ts +19 -19
  4. package/lib/types/admin.d.ts +58 -32
  5. package/lib/types/aily.d.ts +52 -52
  6. package/lib/types/apaas.d.ts +96 -96
  7. package/lib/types/api.d.ts +14 -1
  8. package/lib/types/application.d.ts +153 -69
  9. package/lib/types/approval.d.ts +186 -154
  10. package/lib/types/attendance.d.ts +395 -353
  11. package/lib/types/auth.d.ts +18 -18
  12. package/lib/types/authen.d.ts +24 -24
  13. package/lib/types/baike.d.ts +42 -42
  14. package/lib/types/bitable.d.ts +276 -192
  15. package/lib/types/calendar.d.ts +144 -144
  16. package/lib/types/cardkit.d.ts +8 -8
  17. package/lib/types/contact.d.ts +209 -137
  18. package/lib/types/corehr.d.ts +761 -613
  19. package/lib/types/document_ai.d.ts +68 -68
  20. package/lib/types/docx.d.ts +103 -95
  21. package/lib/types/drive.d.ts +237 -229
  22. package/lib/types/ehr.d.ts +26 -2
  23. package/lib/types/helpdesk.d.ts +156 -148
  24. package/lib/types/hire.d.ts +954 -510
  25. package/lib/types/im.d.ts +446 -446
  26. package/lib/types/index.d.ts +72 -30
  27. package/lib/types/lingo.d.ts +28 -28
  28. package/lib/types/mail.d.ts +192 -192
  29. package/lib/types/minutes.d.ts +4 -4
  30. package/lib/types/okr.d.ts +86 -58
  31. package/lib/types/passport.d.ts +13 -5
  32. package/lib/types/payroll.d.ts +13 -5
  33. package/lib/types/performance.d.ts +85 -79
  34. package/lib/types/personal_settings.d.ts +12 -12
  35. package/lib/types/report.d.ts +11 -5
  36. package/lib/types/search.d.ts +48 -24
  37. package/lib/types/sheets.d.ts +64 -64
  38. package/lib/types/speech_to_text.d.ts +4 -4
  39. package/lib/types/task.d.ts +191 -185
  40. package/lib/types/translation.d.ts +4 -4
  41. package/lib/types/vc.d.ts +335 -155
  42. package/lib/types/wiki.d.ts +48 -48
  43. package/package.json +1 -1
  44. package/src/internal.ts +3 -4
  45. package/src/types/acs.ts +24 -24
  46. package/src/types/admin.ts +69 -39
  47. package/src/types/aily.ts +61 -61
  48. package/src/types/apaas.ts +113 -113
  49. package/src/types/application.ts +177 -83
  50. package/src/types/approval.ts +210 -174
  51. package/src/types/attendance.ts +466 -421
  52. package/src/types/auth.ts +20 -20
  53. package/src/types/authen.ts +28 -28
  54. package/src/types/baike.ts +55 -55
  55. package/src/types/bitable.ts +321 -235
  56. package/src/types/calendar.ts +167 -167
  57. package/src/types/cardkit.ts +10 -10
  58. package/src/types/contact.ts +251 -169
  59. package/src/types/corehr.ts +905 -736
  60. package/src/types/document_ai.ts +85 -85
  61. package/src/types/docx.ts +117 -108
  62. package/src/types/drive.ts +299 -290
  63. package/src/types/ehr.ts +28 -2
  64. package/src/types/helpdesk.ts +182 -173
  65. package/src/types/hire.ts +1081 -591
  66. package/src/types/im.ts +521 -521
  67. package/src/types/index.ts +73 -30
  68. package/src/types/lingo.ts +36 -36
  69. package/src/types/mail.ts +215 -215
  70. package/src/types/minutes.ts +5 -5
  71. package/src/types/okr.ts +98 -66
  72. package/src/types/passport.ts +15 -6
  73. package/src/types/payroll.ts +15 -6
  74. package/src/types/performance.ts +98 -91
  75. package/src/types/personal_settings.ts +15 -15
  76. package/src/types/report.ts +13 -6
  77. package/src/types/search.ts +57 -29
  78. package/src/types/sheets.ts +80 -80
  79. package/src/types/speech_to_text.ts +5 -5
  80. package/src/types/task.ts +238 -231
  81. package/src/types/translation.ts +5 -5
  82. package/src/types/vc.ts +386 -186
  83. package/src/types/wiki.ts +59 -59
  84. package/src/utils.ts +11 -6
  85. package/lib/index.cjs.map +0 -6
  86. package/lib/types/guild.d.ts +0 -59
  87. package/lib/types/message/asset.d.ts +0 -40
  88. package/lib/types/user.d.ts +0 -78
  89. package/lib/types/utils.d.ts +0 -9
@@ -745,7 +745,18 @@ export interface AilyMessage {
745
745
  status?: AilyMessageStatus
746
746
  }
747
747
 
748
- export type AilyMessageContentType = 'MDX' | 'TEXT' | 'CLIP' | 'SmartCard' | 'JSON'
748
+ export const enum AilyMessageContentType {
749
+ /** MDX */
750
+ ContentTypeMDX = 'MDX',
751
+ /** TEXT */
752
+ ContentTypeText = 'TEXT',
753
+ /** GUI 卡片 */
754
+ ContentTypeClip = 'CLIP',
755
+ /** SmartCard */
756
+ ContentTypeSmartCard = 'SmartCard',
757
+ /** JSON */
758
+ ContentTypeJSON = 'JSON',
759
+ }
749
760
 
750
761
  export interface AilyMessageFile {
751
762
  /** 文件 ID */
@@ -769,7 +780,12 @@ export interface AilyMessageFilePreview {
769
780
  expired_at?: string
770
781
  }
771
782
 
772
- export type AilyMessageStatus = 'IN_PROGRESS' | 'COMPLETED'
783
+ export const enum AilyMessageStatus {
784
+ /** 生成中 */
785
+ MessageStatusInProgress = 'IN_PROGRESS',
786
+ /** 已完成 */
787
+ MessageStatusCompleted = 'COMPLETED',
788
+ }
773
789
 
774
790
  export interface AilySender {
775
791
  /** 实体 ID */
@@ -782,7 +798,12 @@ export interface AilySender {
782
798
  aily_id?: string
783
799
  }
784
800
 
785
- export type AilySenderType = 'USER' | 'ASSISTANT'
801
+ export const enum AilySenderType {
802
+ /** 用户 */
803
+ SenderTypeUser = 'USER',
804
+ /** 应用 */
805
+ SenderTypeAssistant = 'ASSISTANT',
806
+ }
786
807
 
787
808
  export interface AilySession {
788
809
  /** 会话 ID */
@@ -1486,7 +1507,7 @@ export interface AppRoleTableRole {
1486
1507
  /** 记录筛选条件,在table_perm为1或2时有意义,用于指定可编辑或可阅读某些记录 */
1487
1508
  rec_rule?: AppRoleTableRoleRecRule
1488
1509
  /** 字段权限,仅在table_perm为2时有意义,设置字段可编辑或可阅读 */
1489
- field_perm?: unknown
1510
+ field_perm?: Record<string, number>
1490
1511
  /** 新增记录权限,仅在table_perm为2时有意义,用于设置记录是否可以新增 */
1491
1512
  allow_add_record?: boolean
1492
1513
  /** 删除记录权限,仅在table_perm为2时有意义,用于设置记录是否可以删除 */
@@ -1902,17 +1923,17 @@ export interface AppTableFormPatchedField {
1902
1923
 
1903
1924
  export interface AppTableRecord {
1904
1925
  /** 记录字段 */
1905
- fields: unknown
1926
+ fields: Record<string, unknown>
1906
1927
  /** 记录Id */
1907
1928
  record_id?: string
1908
1929
  /** 创建人 */
1909
1930
  created_by?: Person
1910
1931
  /** 创建时间 */
1911
- created_time?: unknown
1932
+ created_time?: number
1912
1933
  /** 修改人 */
1913
1934
  last_modified_by?: Person
1914
1935
  /** 最近更新时间 */
1915
- last_modified_time?: unknown
1936
+ last_modified_time?: number
1916
1937
  /** 记录分享链接(批量获取记录接口将返回该字段) */
1917
1938
  shared_url?: string
1918
1939
  /** 记录链接(检索记录接口将返回该字段) */
@@ -4277,7 +4298,7 @@ export interface Contract {
4277
4298
  }
4278
4299
 
4279
4300
  export interface ContractCompany {
4280
- id?: unknown
4301
+ id?: number
4281
4302
  name?: string
4282
4303
  }
4283
4304
 
@@ -4693,9 +4714,9 @@ export interface DataAsset {
4693
4714
  /** 数据知识ID */
4694
4715
  data_asset_id?: string
4695
4716
  /** 数据知识标题 */
4696
- label?: unknown
4717
+ label?: Record<string, string>
4697
4718
  /** 数据知识描述 */
4698
- description?: unknown
4719
+ description?: Record<string, string>
4699
4720
  /** 数据资源类型 */
4700
4721
  data_source_type?: 'excel' | 'pdf' | 'pptx' | 'txt' | 'docx' | 'mysql' | 'postgresql' | 'larkbase' | 'salesforce' | 'fenxiangxiaoke' | 'qianchuan' | 'clickhouse' | 'databricks' | 'servicedesk' | 'larkbiz_wiki' | 'larkbiz_doc' | 'larkbiz_docs' | 'larkbiz_docx' | 'larkbiz_pdf' | 'larkbiz_word' | 'larkbiz_pptx' | 'larkbiz_sheets' | 'larkbiz_base' | 'larkbiz_personalfolder' | 'larkbiz_sharedfolder' | 'object'
4701
4722
  /** 数据连接状态 */
@@ -4720,9 +4741,9 @@ export interface DataAssetItem {
4720
4741
  /** 数据知识项标识 */
4721
4742
  api_name?: string
4722
4743
  /** 数据知识项标题 */
4723
- label?: unknown
4744
+ label?: Record<string, string>
4724
4745
  /** 数据知识项描述 */
4725
- description?: unknown
4746
+ description?: Record<string, string>
4726
4747
  /** 数据知识资源 */
4727
4748
  resources?: DataAssetResource[]
4728
4749
  }
@@ -5426,7 +5447,9 @@ export interface EducationInfo {
5426
5447
  custom_fields?: ObjectFieldData[]
5427
5448
  }
5428
5449
 
5429
- export type EeKunlunCommonI18nI18nText = unknown
5450
+ export type EeKunlunCommonI18nI18nText = Record<EeKunlunCommonI18nLanguageCode, string>
5451
+
5452
+ export type EeKunlunCommonI18nLanguageCode = string
5430
5453
 
5431
5454
  export interface Email {
5432
5455
  /** 邮箱地址 */
@@ -7268,7 +7291,12 @@ export interface IdEntity {
7268
7291
  value?: string
7269
7292
  }
7270
7293
 
7271
- export type IdentityProvider = 'AILY' | 'FEISHU'
7294
+ export const enum IdentityProvider {
7295
+ /** Aily 账号体系 */
7296
+ IdentityProviderAily = 'AILY',
7297
+ /** 飞书账号体系 */
7298
+ IdentityProviderFeishu = 'FEISHU',
7299
+ }
7272
7300
 
7273
7301
  export interface IdInfo {
7274
7302
  /** 传入的 ID */
@@ -8088,7 +8116,7 @@ export interface JiraIssue {
8088
8116
  }
8089
8117
 
8090
8118
  export interface Job {
8091
- id?: unknown
8119
+ id?: number
8092
8120
  name?: string
8093
8121
  }
8094
8122
 
@@ -11105,7 +11133,7 @@ export interface OpenAppFeedCardButton {
11105
11133
  /** 按钮类型 */
11106
11134
  button_type?: 'default' | 'primary' | 'success'
11107
11135
  /** action 字典 */
11108
- action_map?: unknown
11136
+ action_map?: Record<string, string>
11109
11137
  }
11110
11138
 
11111
11139
  export interface OpenAppFeedCardButtons {
@@ -14199,7 +14227,22 @@ export interface RunError {
14199
14227
  message: string
14200
14228
  }
14201
14229
 
14202
- export type RunStatus = 'QUEUED' | 'IN_PROGRESS' | 'REQUIRES_MESSAGE' | 'CANCELLED' | 'COMPLETED' | 'FAILED' | 'EXPIRED'
14230
+ export const enum RunStatus {
14231
+ /** 排队中 */
14232
+ RunStatusQueued = 'QUEUED',
14233
+ /** 执行中 */
14234
+ RunStatusInProgress = 'IN_PROGRESS',
14235
+ /** 等待补充消息输入 */
14236
+ RunStatusRequiresMessage = 'REQUIRES_MESSAGE',
14237
+ /** 已取消 */
14238
+ RunStatusCancelled = 'CANCELLED',
14239
+ /** 已完成 */
14240
+ RunStatusCompleted = 'COMPLETED',
14241
+ /** 已失败 */
14242
+ RunStatusFailed = 'FAILED',
14243
+ /** 已过期 */
14244
+ RunStatusExpired = 'EXPIRED',
14245
+ }
14203
14246
 
14204
14247
  export interface Schema {
14205
14248
  /** UI项名称 TODO文档 */
@@ -14963,9 +15006,9 @@ export interface SystemFields {
14963
15006
  /** 入职登记表状态 */
14964
15007
  employee_form_status?: 1 | 2 | 3
14965
15008
  /** 创建时间 */
14966
- create_time?: unknown
15009
+ create_time?: number
14967
15010
  /** 更新时间 */
14968
- update_time?: unknown
15011
+ update_time?: number
14969
15012
  }
14970
15013
 
14971
15014
  export interface SystemStatus {
@@ -16052,11 +16095,11 @@ export interface Ticket {
16052
16095
  /** ticket score */
16053
16096
  score?: number
16054
16097
  /** the time when the ticket is created */
16055
- created_at?: unknown
16098
+ created_at?: number
16056
16099
  /** the time when the ticket is updated */
16057
- updated_at?: unknown
16100
+ updated_at?: number
16058
16101
  /** the time when the ticket is closed */
16059
- closed_at?: unknown
16102
+ closed_at?: number
16060
16103
  /** 不满意原因 */
16061
16104
  dissatisfaction_reason?: I18n
16062
16105
  /** agents of this ticket */
@@ -16074,19 +16117,19 @@ export interface Ticket {
16074
16117
  /** 客服服务时长,客服最后一次回复时间距离客服进入时间间隔,单位秒 */
16075
16118
  agent_service_duration?: number
16076
16119
  /** 客服首次回复时间距离客服进入时间的间隔,单位秒 */
16077
- agent_first_response_duration?: unknown
16120
+ agent_first_response_duration?: number
16078
16121
  /** 机器人服务时间:客服进入时间距离工单创建时间的间隔,单位秒 */
16079
- bot_service_duration?: unknown
16122
+ bot_service_duration?: number
16080
16123
  /** 客服解决时长,关单时间距离客服进入时间的间隔,单位秒 */
16081
- agent_resolution_time?: unknown
16124
+ agent_resolution_time?: number
16082
16125
  /** 工单实际处理时间:从客服进入到关单,单位秒 */
16083
- actual_processing_time?: unknown
16126
+ actual_processing_time?: number
16084
16127
  /** 客服进入时间,单位毫秒 */
16085
- agent_entry_time?: unknown
16128
+ agent_entry_time?: number
16086
16129
  /** 客服首次回复时间,单位毫秒 */
16087
- agent_first_response_time?: unknown
16130
+ agent_first_response_time?: number
16088
16131
  /** 客服最后回复时间,单位毫秒 */
16089
- agent_last_response_time?: unknown
16132
+ agent_last_response_time?: number
16090
16133
  /** 主责客服 */
16091
16134
  agent_owner?: TicketUser
16092
16135
  }
@@ -17722,7 +17765,7 @@ export interface WorkingHoursType {
17722
17765
  }
17723
17766
 
17724
17767
  export interface WorkLocation {
17725
- id?: unknown
17768
+ id?: number
17726
17769
  name?: string
17727
17770
  }
17728
17771
 
@@ -102,6 +102,10 @@ export interface CreateLingoDraftQuery {
102
102
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
103
103
  }
104
104
 
105
+ export interface CreateLingoDraftResponse {
106
+ draft?: Draft
107
+ }
108
+
105
109
  export interface UpdateLingoDraftRequest {
106
110
  /** 实体词 Id */
107
111
  id?: string
@@ -124,6 +128,10 @@ export interface UpdateLingoDraftQuery {
124
128
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
125
129
  }
126
130
 
131
+ export interface UpdateLingoDraftResponse {
132
+ draft?: Draft
133
+ }
134
+
127
135
  export interface CreateLingoEntityRequest {
128
136
  /** 词条名 */
129
137
  main_keys: Term[]
@@ -148,6 +156,10 @@ export interface CreateLingoEntityQuery {
148
156
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
149
157
  }
150
158
 
159
+ export interface CreateLingoEntityResponse {
160
+ entity?: Entity
161
+ }
162
+
151
163
  export interface UpdateLingoEntityRequest {
152
164
  /** 词条名 */
153
165
  main_keys: Term[]
@@ -170,6 +182,10 @@ export interface UpdateLingoEntityQuery {
170
182
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
171
183
  }
172
184
 
185
+ export interface UpdateLingoEntityResponse {
186
+ entity?: Entity
187
+ }
188
+
173
189
  export interface DeleteLingoEntityQuery {
174
190
  /** 数据提供方(使用时需要将路径中的词条 ID 固定为:enterprise_0,且提供 provider 和 outer_id) */
175
191
  provider?: string
@@ -186,6 +202,11 @@ export interface GetLingoEntityQuery {
186
202
  user_id_type?: 'user_id' | 'union_id' | 'open_id'
187
203
  }
188
204
 
205
+ export interface GetLingoEntityResponse {
206
+ /** 实体词 */
207
+ entity?: Entity
208
+ }
209
+
189
210
  export interface ListLingoEntityQuery extends Pagination {
190
211
  /** 数据提供方【可用来过滤数据】 */
191
212
  provider?: string
@@ -205,6 +226,11 @@ export interface MatchLingoEntityQuery {
205
226
  repo_id?: string
206
227
  }
207
228
 
229
+ export interface MatchLingoEntityResponse {
230
+ /** 匹配结果 */
231
+ results?: MatchInfo[]
232
+ }
233
+
208
234
  export interface SearchLingoEntityRequest {
209
235
  /** 搜索关键词 */
210
236
  query?: string
@@ -228,11 +254,21 @@ export interface HighlightLingoEntityRequest {
228
254
  text: string
229
255
  }
230
256
 
257
+ export interface HighlightLingoEntityResponse {
258
+ /** 返回识别到的实体词信息 */
259
+ phrases?: Phrase[]
260
+ }
261
+
231
262
  export interface ListLingoClassificationQuery extends Pagination {
232
263
  /** 词库ID */
233
264
  repo_id?: string
234
265
  }
235
266
 
267
+ export interface ListLingoRepoResponse {
268
+ /** 词库列表 */
269
+ items?: Repo[]
270
+ }
271
+
236
272
  export interface UploadLingoFileForm {
237
273
  /** 文件名称,当前仅支持上传图片且图片格式为以下六种:icon、bmp、gif、png、jpeg、webp */
238
274
  name: string
@@ -240,42 +276,6 @@ export interface UploadLingoFileForm {
240
276
  file: Blob
241
277
  }
242
278
 
243
- export interface CreateLingoDraftResponse {
244
- draft?: Draft
245
- }
246
-
247
- export interface UpdateLingoDraftResponse {
248
- draft?: Draft
249
- }
250
-
251
- export interface CreateLingoEntityResponse {
252
- entity?: Entity
253
- }
254
-
255
- export interface UpdateLingoEntityResponse {
256
- entity?: Entity
257
- }
258
-
259
- export interface GetLingoEntityResponse {
260
- /** 实体词 */
261
- entity?: Entity
262
- }
263
-
264
- export interface MatchLingoEntityResponse {
265
- /** 匹配结果 */
266
- results?: MatchInfo[]
267
- }
268
-
269
- export interface HighlightLingoEntityResponse {
270
- /** 返回识别到的实体词信息 */
271
- phrases?: Phrase[]
272
- }
273
-
274
- export interface ListLingoRepoResponse {
275
- /** 词库列表 */
276
- items?: Repo[]
277
- }
278
-
279
279
  export interface UploadLingoFileResponse {
280
280
  /** 文件 token */
281
281
  file_token?: string