@satorijs/adapter-lark 3.11.8 → 3.11.9

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.
@@ -15,6 +15,16 @@ export namespace Board {
15
15
  export namespace Whiteboard {
16
16
  export interface Methods {
17
17
  node: Node.Methods
18
+ /**
19
+ * 获取画板主题
20
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard/theme
21
+ */
22
+ theme(whiteboard_id: string): Promise<ThemeResponse>
23
+ /**
24
+ * 更新画板主题
25
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard/update_theme
26
+ */
27
+ updateTheme(whiteboard_id: string, body: UpdateThemeRequest): Promise<void>
18
28
  /**
19
29
  * 获取画板缩略图片
20
30
  * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard/download_as_image
@@ -22,8 +32,23 @@ export namespace Board {
22
32
  downloadAsImage(whiteboard_id: string): Promise<ArrayBuffer>
23
33
  }
24
34
 
35
+ export interface ThemeResponse {
36
+ /** 主题 */
37
+ theme: 'classic' | 'minimalist_gray' | 'retro' | 'vibrant_color' | 'minimalist_blue' | 'default'
38
+ }
39
+
40
+ export interface UpdateThemeRequest {
41
+ /** 主题名称 */
42
+ theme?: string
43
+ }
44
+
25
45
  export namespace Node {
26
46
  export interface Methods {
47
+ /**
48
+ * 创建节点
49
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard-node/create
50
+ */
51
+ create(whiteboard_id: string, body: CreateRequest, query?: CreateQuery): Promise<CreateResponse>
27
52
  /**
28
53
  * 获取所有节点
29
54
  * @see https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/board-v1/whiteboard-node/list
@@ -31,6 +56,25 @@ export namespace Board {
31
56
  list(whiteboard_id: string): Promise<ListResponse>
32
57
  }
33
58
 
59
+ export interface CreateRequest {
60
+ /** 子节点数据 */
61
+ nodes?: Lark.WhiteboardNode[]
62
+ }
63
+
64
+ export interface CreateQuery {
65
+ /** 操作的唯一标识,与接口返回值的 client_token 相对应,用于幂等的进行更新操作。此值为空表示将发起一次新的请求,此值非空表示幂等的进行更新操作 */
66
+ client_token?: string
67
+ /** 此次调用中使用的用户ID的类型 */
68
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
69
+ }
70
+
71
+ export interface CreateResponse {
72
+ /** 所创建的节点 id 列表 */
73
+ ids: string[]
74
+ /** 操作的唯一标识,更新请求中使用此值表示幂等的进行此次更新 */
75
+ client_token?: string
76
+ }
77
+
34
78
  export interface ListResponse {
35
79
  /** 查询结果 */
36
80
  nodes?: Lark.WhiteboardNode[]
@@ -40,10 +84,17 @@ export namespace Board {
40
84
  }
41
85
 
42
86
  Internal.define({
43
- '/board/v1/whiteboards/{whiteboard_id}/nodes': {
44
- GET: 'board.whiteboard.node.list',
87
+ '/board/v1/whiteboards/{whiteboard_id}/theme': {
88
+ GET: 'board.whiteboard.theme',
89
+ },
90
+ '/board/v1/whiteboards/{whiteboard_id}/update_theme': {
91
+ POST: 'board.whiteboard.updateTheme',
45
92
  },
46
93
  '/board/v1/whiteboards/{whiteboard_id}/download_as_image': {
47
94
  GET: { name: 'board.whiteboard.downloadAsImage', type: 'binary' },
48
95
  },
96
+ '/board/v1/whiteboards/{whiteboard_id}/nodes': {
97
+ POST: 'board.whiteboard.node.create',
98
+ GET: 'board.whiteboard.node.list',
99
+ },
49
100
  })
@@ -30,11 +30,21 @@ export namespace Calendar {
30
30
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primary
31
31
  */
32
32
  primary(query?: PrimaryQuery): Promise<PrimaryResponse>
33
+ /**
34
+ * 批量获取主日历信息
35
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/primarys
36
+ */
37
+ primarys(body: PrimarysRequest, query?: PrimarysQuery): Promise<PrimarysResponse>
33
38
  /**
34
39
  * 查询日历信息
35
40
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/get
36
41
  */
37
42
  get(calendar_id: string): Promise<GetResponse>
43
+ /**
44
+ * 批量查询日历信息
45
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/mget
46
+ */
47
+ mget(body: MgetRequest): Promise<MgetResponse>
38
48
  /**
39
49
  * 查询日历列表
40
50
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/calendar/list
@@ -100,6 +110,21 @@ export namespace Calendar {
100
110
  calendars?: Lark.UserCalendar[]
101
111
  }
102
112
 
113
+ export interface PrimarysRequest {
114
+ /** 用户ID列表 */
115
+ user_ids: string[]
116
+ }
117
+
118
+ export interface PrimarysQuery {
119
+ /** 此次调用中使用的用户ID的类型 */
120
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
121
+ }
122
+
123
+ export interface PrimarysResponse {
124
+ /** 主日历列表 */
125
+ calendars?: Lark.UserCalendar[]
126
+ }
127
+
103
128
  export interface GetResponse {
104
129
  /** 日历OpenId */
105
130
  calendar_id: string
@@ -123,6 +148,16 @@ export namespace Calendar {
123
148
  role?: 'unknown' | 'free_busy_reader' | 'reader' | 'writer' | 'owner'
124
149
  }
125
150
 
151
+ export interface MgetRequest {
152
+ /** 日历ID列表 */
153
+ calendar_ids: string[]
154
+ }
155
+
156
+ export interface MgetResponse {
157
+ /** 日历列表 */
158
+ calendars?: Lark.Calendar[]
159
+ }
160
+
126
161
  export interface ListQuery extends Pagination {
127
162
  /** 上次请求Response返回的增量同步标记,分页请求未结束时为空 */
128
163
  sync_token?: string
@@ -181,6 +216,11 @@ export namespace Calendar {
181
216
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/freebusy/list
182
217
  */
183
218
  list(body: ListRequest, query?: ListQuery): Promise<ListResponse>
219
+ /**
220
+ * 批量查询主日历日程忙闲信息
221
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/calendar-v4/freebusy/batch
222
+ */
223
+ batch(body: BatchRequest, query?: BatchQuery): Promise<BatchResponse>
184
224
  }
185
225
 
186
226
  export interface ListRequest {
@@ -207,6 +247,29 @@ export namespace Calendar {
207
247
  /** 日历上请求时间区间内的忙闲信息 */
208
248
  freebusy_list?: Lark.Freebusy[]
209
249
  }
250
+
251
+ export interface BatchRequest {
252
+ /** 获取忙闲信息的开始时间,RFC3339 date_time格式;time_min与time_max的时间区间不能超过3个月。 */
253
+ time_min: string
254
+ /** 获取忙闲信息的开始时间,RFC3339 date_time格式;time_min与time_max的时间区间不能超过3个月。 */
255
+ time_max: string
256
+ /** 用户ID列表 */
257
+ user_ids: string[]
258
+ /** 是否包含绑定的三方日历中的日程,不传默认为true,即包含。 */
259
+ include_external_calendar?: boolean
260
+ /** 是否包含标记为空闲的日程,不传默认为true,即包含空闲日程。 */
261
+ only_busy?: boolean
262
+ }
263
+
264
+ export interface BatchQuery {
265
+ /** 此次调用中使用的用户ID的类型 */
266
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
267
+ }
268
+
269
+ export interface BatchResponse {
270
+ /** 用户忙闲信息列表 */
271
+ freebusy_lists?: Lark.UserFreebusy[]
272
+ }
210
273
  }
211
274
 
212
275
  export namespace Acl {
@@ -789,9 +852,18 @@ Internal.define({
789
852
  '/calendar/v4/calendars/primary': {
790
853
  POST: 'calendar.primary',
791
854
  },
855
+ '/calendar/v4/calendars/primarys': {
856
+ POST: 'calendar.primarys',
857
+ },
858
+ '/calendar/v4/calendars/mget': {
859
+ POST: 'calendar.mget',
860
+ },
792
861
  '/calendar/v4/freebusy/list': {
793
862
  POST: 'calendar.freebusy.list',
794
863
  },
864
+ '/calendar/v4/freebusy/batch': {
865
+ POST: 'calendar.freebusy.batch',
866
+ },
795
867
  '/calendar/v4/calendars/search': {
796
868
  POST: { name: 'calendar.search', pagination: { argIndex: 1 } },
797
869
  },
@@ -21,12 +21,12 @@ export namespace Cardkit {
21
21
  */
22
22
  create(body: CreateRequest): Promise<CreateResponse>
23
23
  /**
24
- * 更新卡片配置
24
+ * 更新卡片实体配置
25
25
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/settings
26
26
  */
27
27
  settings(card_id: string, body: SettingsRequest): Promise<void>
28
28
  /**
29
- * 批量更新卡片实体
29
+ * 局部更新卡片实体
30
30
  * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/cardkit-v1/card/batch_update
31
31
  */
32
32
  batchUpdate(card_id: string, body: BatchUpdateRequest): Promise<void>