@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
package/src/types/mdm.ts CHANGED
@@ -1,57 +1,140 @@
1
+ import * as Lark from '.'
1
2
  import { Internal } from '../internal'
2
3
 
3
4
  declare module '../internal' {
4
5
  interface Internal {
5
- /**
6
- * 用户数据维度绑定
7
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/bind
8
- */
9
- bindMdmUserAuthDataRelation(body: BindMdmUserAuthDataRelationRequest, query?: BindMdmUserAuthDataRelationQuery): Promise<void>
10
- /**
11
- * 用户数据维度解绑
12
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/unbind
13
- */
14
- unbindMdmUserAuthDataRelation(body: UnbindMdmUserAuthDataRelationRequest, query?: UnbindMdmUserAuthDataRelationQuery): Promise<void>
6
+ mdm: Mdm.Methods
15
7
  }
16
8
  }
17
9
 
18
- export interface BindMdmUserAuthDataRelationRequest {
19
- /** 数据类型编码 */
20
- root_dimension_type: string
21
- /** 数据编码列表 */
22
- sub_dimension_types: string[]
23
- /** 授权人的lark id */
24
- authorized_user_ids: string[]
25
- /** uams系统中应用id */
26
- uams_app_id: string
27
- }
10
+ export namespace Mdm {
11
+ export interface Methods {
12
+ batchCountryRegion: BatchCountryRegion.Methods
13
+ countryRegion: CountryRegion.Methods
14
+ userAuthDataRelation: UserAuthDataRelation.Methods
15
+ }
28
16
 
29
- export interface BindMdmUserAuthDataRelationQuery {
30
- /** 此次调用中使用的用户ID的类型 */
31
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
32
- }
17
+ export namespace BatchCountryRegion {
18
+ export interface Methods {
19
+ /**
20
+ * 根据主数据编码批量查询国家/地区
21
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v3/batch_country_region/get
22
+ */
23
+ get(query?: GetQuery): Promise<GetResponse>
24
+ }
33
25
 
34
- export interface UnbindMdmUserAuthDataRelationRequest {
35
- /** 数据类型编码 */
36
- root_dimension_type: string
37
- /** 数据编码列表 */
38
- sub_dimension_types: string[]
39
- /** 授权人的lark id */
40
- authorized_user_ids: string[]
41
- /** uams系统中应用id */
42
- uams_app_id: string
43
- }
26
+ export interface GetQuery {
27
+ /** 需要的查询字段集 */
28
+ fields: string[]
29
+ /** 主数据编码集 */
30
+ ids: string[]
31
+ /** 语言集 */
32
+ languages: string[]
33
+ }
34
+
35
+ export interface GetResponse {
36
+ /** 国家/地区目录列表 */
37
+ data?: Lark.CountryRegion[]
38
+ }
39
+ }
40
+
41
+ export namespace CountryRegion {
42
+ export interface Methods {
43
+ /**
44
+ * 分页批量查询国家/地区
45
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v3/country_region/list
46
+ */
47
+ list(body: ListRequest, query?: ListQuery): Promise<ListResponse> & AsyncIterableIterator<Lark.CountryRegion>
48
+ }
49
+
50
+ export interface ListRequest {
51
+ /** filter */
52
+ filter?: Lark.Filter
53
+ }
54
+
55
+ export interface ListQuery {
56
+ /** 语言集 */
57
+ languages: string[]
58
+ /** 需要的查询字段集 */
59
+ fields: string[]
60
+ /** 查询页大小 */
61
+ limit?: number
62
+ /** 查询起始位置 */
63
+ offset?: number
64
+ /** 是否返回总数 */
65
+ return_count?: boolean
66
+ page_token?: string
67
+ }
44
68
 
45
- export interface UnbindMdmUserAuthDataRelationQuery {
46
- /** 此次调用中使用的用户ID的类型 */
47
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
69
+ export interface ListResponse {
70
+ /** 国家/地区目录列表 */
71
+ data?: Lark.CountryRegion[]
72
+ /** 总数 */
73
+ total?: string
74
+ /** 下一次分页参数 */
75
+ next_page_token?: string
76
+ }
77
+ }
78
+
79
+ export namespace UserAuthDataRelation {
80
+ export interface Methods {
81
+ /**
82
+ * 用户数据维度绑定
83
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/bind
84
+ */
85
+ bind(body: BindRequest, query?: BindQuery): Promise<void>
86
+ /**
87
+ * 用户数据维度解绑
88
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v1/user_auth_data_relation/unbind
89
+ */
90
+ unbind(body: UnbindRequest, query?: UnbindQuery): Promise<void>
91
+ }
92
+
93
+ export interface BindRequest {
94
+ /** 数据类型编码 */
95
+ root_dimension_type: string
96
+ /** 数据编码列表 */
97
+ sub_dimension_types: string[]
98
+ /** 授权人的lark id */
99
+ authorized_user_ids: string[]
100
+ /** uams系统中应用id */
101
+ uams_app_id: string
102
+ }
103
+
104
+ export interface BindQuery {
105
+ /** 此次调用中使用的用户ID的类型 */
106
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
107
+ }
108
+
109
+ export interface UnbindRequest {
110
+ /** 数据类型编码 */
111
+ root_dimension_type: string
112
+ /** 数据编码列表 */
113
+ sub_dimension_types: string[]
114
+ /** 授权人的lark id */
115
+ authorized_user_ids: string[]
116
+ /** uams系统中应用id */
117
+ uams_app_id: string
118
+ }
119
+
120
+ export interface UnbindQuery {
121
+ /** 此次调用中使用的用户ID的类型 */
122
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
123
+ }
124
+ }
48
125
  }
49
126
 
50
127
  Internal.define({
128
+ '/mdm/v3/batch_country_region': {
129
+ GET: 'mdm.batchCountryRegion.get',
130
+ },
131
+ '/mdm/v3/country_regions': {
132
+ GET: 'mdm.countryRegion.list',
133
+ },
51
134
  '/mdm/v1/user_auth_data_relations/bind': {
52
- POST: 'bindMdmUserAuthDataRelation',
135
+ POST: 'mdm.userAuthDataRelation.bind',
53
136
  },
54
137
  '/mdm/v1/user_auth_data_relations/unbind': {
55
- POST: 'unbindMdmUserAuthDataRelation',
138
+ POST: 'mdm.userAuthDataRelation.unbind',
56
139
  },
57
140
  })
@@ -1,46 +1,106 @@
1
- import { Minute, Statictics } from '.'
1
+ import * as Lark from '.'
2
2
  import { Internal } from '../internal'
3
3
 
4
4
  declare module '../internal' {
5
5
  interface Internal {
6
- /**
7
- * 获取妙记统计数据
8
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute-statistics/get
9
- */
10
- getMinutesMinuteStatistics(minute_token: string, query?: GetMinutesMinuteStatisticsQuery): Promise<GetMinutesMinuteStatisticsResponse>
11
- /**
12
- * 获取妙记信息
13
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute/get
14
- */
15
- getMinutesMinute(minute_token: string, query?: GetMinutesMinuteQuery): Promise<GetMinutesMinuteResponse>
6
+ minutes: Minutes.Methods
16
7
  }
17
8
  }
18
9
 
19
- export interface GetMinutesMinuteStatisticsQuery {
20
- /** 此次调用中使用的用户ID的类型 */
21
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
22
- }
10
+ export namespace Minutes {
11
+ export interface Methods {
12
+ minute: Minute.Methods
13
+ }
23
14
 
24
- export interface GetMinutesMinuteStatisticsResponse {
25
- /** 妙记浏览信息统计 */
26
- statistics?: Statictics
27
- }
15
+ export namespace Minute {
16
+ export interface Methods {
17
+ media: Media.Methods
18
+ transcript: Transcript.Methods
19
+ statistics: Statistics.Methods
20
+ /**
21
+ * 获取妙记信息
22
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute/get
23
+ */
24
+ get(minute_token: string, query?: GetQuery): Promise<GetResponse>
25
+ }
28
26
 
29
- export interface GetMinutesMinuteQuery {
30
- /** 此次调用中使用的用户ID的类型 */
31
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
32
- }
27
+ export interface GetQuery {
28
+ /** 此次调用中使用的用户ID的类型 */
29
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
30
+ }
31
+
32
+ export interface GetResponse {
33
+ /** 妙记基本信息 */
34
+ minute?: Lark.Minute
35
+ }
36
+
37
+ export namespace Media {
38
+ export interface Methods {
39
+ /**
40
+ * 下载妙记音视频文件
41
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute-media/get
42
+ */
43
+ get(minute_token: string): Promise<GetResponse>
44
+ }
45
+
46
+ export interface GetResponse {
47
+ /** 妙记音视频文件下载链接 */
48
+ download_url?: string
49
+ }
50
+ }
33
51
 
34
- export interface GetMinutesMinuteResponse {
35
- /** 妙记基本信息 */
36
- minute?: Minute
52
+ export namespace Transcript {
53
+ export interface Methods {
54
+ /**
55
+ * 导出妙记文字记录
56
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute-transcript/get
57
+ */
58
+ get(minute_token: string, query?: GetQuery): Promise<ArrayBuffer>
59
+ }
60
+
61
+ export interface GetQuery {
62
+ /** 是否包含说话人 */
63
+ need_speaker?: boolean
64
+ /** 是否包含时间戳 */
65
+ need_timestamp?: boolean
66
+ /** 导出文件格式 */
67
+ file_format?: string
68
+ }
69
+ }
70
+
71
+ export namespace Statistics {
72
+ export interface Methods {
73
+ /**
74
+ * 获取妙记统计数据
75
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/minutes-v1/minute-statistics/get
76
+ */
77
+ get(minute_token: string, query?: GetQuery): Promise<GetResponse>
78
+ }
79
+
80
+ export interface GetQuery {
81
+ /** 此次调用中使用的用户ID的类型 */
82
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
83
+ }
84
+
85
+ export interface GetResponse {
86
+ /** 妙记浏览信息统计 */
87
+ statistics?: Lark.Statictics
88
+ }
89
+ }
90
+ }
37
91
  }
38
92
 
39
93
  Internal.define({
94
+ '/minutes/v1/minutes/{minute_token}/media': {
95
+ GET: 'minutes.minute.media.get',
96
+ },
97
+ '/minutes/v1/minutes/{minute_token}/transcript': {
98
+ GET: { name: 'minutes.minute.transcript.get', type: 'binary' },
99
+ },
40
100
  '/minutes/v1/minutes/{minute_token}/statistics': {
41
- GET: 'getMinutesMinuteStatistics',
101
+ GET: 'minutes.minute.statistics.get',
42
102
  },
43
103
  '/minutes/v1/minutes/{minute_token}': {
44
- GET: 'getMinutesMinute',
104
+ GET: 'minutes.minute.get',
45
105
  },
46
106
  })
@@ -1,28 +1,40 @@
1
- import { Post } from '.'
1
+ import * as Lark from '.'
2
2
  import { Internal } from '../internal'
3
3
 
4
4
  declare module '../internal' {
5
5
  interface Internal {
6
- /**
7
- * 查询帖子信息
8
- * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/moments-v1/post/get
9
- */
10
- getMomentsPost(post_id: string, query?: GetMomentsPostQuery): Promise<GetMomentsPostResponse>
6
+ moments: Moments.Methods
11
7
  }
12
8
  }
13
9
 
14
- export interface GetMomentsPostQuery {
15
- /** 此次调用中使用的用户ID的类型 */
16
- user_id_type?: 'user_id' | 'union_id' | 'open_id'
17
- }
10
+ export namespace Moments {
11
+ export interface Methods {
12
+ post: Post.Methods
13
+ }
14
+
15
+ export namespace Post {
16
+ export interface Methods {
17
+ /**
18
+ * 查询帖子信息
19
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/moments-v1/post/get
20
+ */
21
+ get(post_id: string, query?: GetQuery): Promise<GetResponse>
22
+ }
18
23
 
19
- export interface GetMomentsPostResponse {
20
- /** 帖子实体 */
21
- post?: Post
24
+ export interface GetQuery {
25
+ /** 此次调用中使用的用户ID的类型 */
26
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
27
+ }
28
+
29
+ export interface GetResponse {
30
+ /** 帖子实体 */
31
+ post?: Lark.Post
32
+ }
33
+ }
22
34
  }
23
35
 
24
36
  Internal.define({
25
37
  '/moments/v1/posts/{post_id}': {
26
- GET: 'getMomentsPost',
38
+ GET: 'moments.post.get',
27
39
  },
28
40
  })