open-lark 0.14.0

Enterprise-grade Lark/Feishu Open API SDK with comprehensive Chinese documentation and advanced error handling
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
use reqwest::Method;
use serde::{Deserialize, Serialize};

use crate::{
    core::{
        api_req::ApiRequest,
        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
        config::Config,
        constants::AccessTokenType,
        endpoints::workplace::*,
        http::Transport,
        query_params::QueryParams,
        req_option::RequestOption,
        standard_response::StandardResponse,
        trait_system::Service,
        SDKResult,
    },
    service::workplace::models::{
        CustomWorkplaceAccessData, CustomWorkplaceWidgetAccessData, PageResponse,
        WorkplaceAccessData,
    },
};

/// 工作台访问数据服务
pub struct WorkplaceAccessDataService {
    pub config: Config,
}

impl WorkplaceAccessDataService {
    /// 创建工作台访问数据服务实例
    pub fn new(config: Config) -> Self {
        Self { config }
    }

    /// 获取工作台访问数据
    ///
    /// 获取工作台的访问数据统计信息,支持按时间范围、用户、部门等维度查询。
    ///
    /// # Arguments
    ///
    /// * `request` - 访问数据查询请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回工作台访问数据列表
    pub async fn search(
        &self,
        request: AccessDataSearchRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<AccessDataSearchResponse> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: WORKPLACE_ACCESS_DATA_SEARCH.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        // 添加查询参数
        if let Some(page_token) = request.page_token {
            api_req
                .query_params
                .insert(QueryParams::PAGE_TOKEN, page_token);
        }

        if let Some(page_size) = request.page_size {
            api_req
                .query_params
                .insert(QueryParams::PAGE_SIZE, page_size.to_string());
        }

        if let Some(start_time) = request.start_time {
            api_req
                .query_params
                .insert(QueryParams::START_TIME, start_time.to_string());
        }

        if let Some(end_time) = request.end_time {
            api_req
                .query_params
                .insert(QueryParams::END_TIME, end_time.to_string());
        }

        if let Some(user_id) = request.user_id {
            api_req.query_params.insert(QueryParams::USER_ID, user_id);
        }

        if let Some(department_id) = request.department_id {
            api_req
                .query_params
                .insert(QueryParams::DEPARTMENT_ID, department_id);
        }

        if let Some(access_type) = request.access_type {
            api_req
                .query_params
                .insert(QueryParams::ACCESS_TYPE, access_type);
        }

        let api_resp: BaseResponse<AccessDataSearchResponse> =
            Transport::request(api_req, &self.config, option).await?;
        api_resp.into_result()
    }

    /// 获取定制工作台访问数据
    ///
    /// 获取定制工作台的访问数据统计信息。
    ///
    /// # Arguments
    ///
    /// * `request` - 定制工作台访问数据查询请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回定制工作台访问数据列表
    pub async fn search_custom(
        &self,
        request: CustomAccessDataSearchRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<CustomAccessDataSearchResponse> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: WORKPLACE_CUSTOM_ACCESS_DATA_SEARCH.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        // 添加查询参数
        if let Some(page_token) = request.page_token {
            api_req
                .query_params
                .insert(QueryParams::PAGE_TOKEN, page_token);
        }

        if let Some(page_size) = request.page_size {
            api_req
                .query_params
                .insert(QueryParams::PAGE_SIZE, page_size.to_string());
        }

        if let Some(start_time) = request.start_time {
            api_req
                .query_params
                .insert(QueryParams::START_TIME, start_time.to_string());
        }

        if let Some(end_time) = request.end_time {
            api_req
                .query_params
                .insert(QueryParams::END_TIME, end_time.to_string());
        }

        if let Some(user_id) = request.user_id {
            api_req.query_params.insert(QueryParams::USER_ID, user_id);
        }

        if let Some(custom_workplace_id) = request.custom_workplace_id {
            api_req
                .query_params
                .insert(QueryParams::CUSTOM_WORKPLACE_ID, custom_workplace_id);
        }

        let api_resp: BaseResponse<CustomAccessDataSearchResponse> =
            Transport::request(api_req, &self.config, option).await?;
        api_resp.into_result()
    }

    /// 获取定制工作台小组件访问数据
    ///
    /// 获取定制工作台小组件的访问数据统计信息。
    ///
    /// # Arguments
    ///
    /// * `request` - 定制工作台小组件访问数据查询请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回定制工作台小组件访问数据列表
    pub async fn search_custom_widget(
        &self,
        request: CustomWidgetAccessDataSearchRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<CustomWidgetAccessDataSearchResponse> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: WORKPLACE_WIDGET_ACCESS_DATA_SEARCH.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        // 添加查询参数
        if let Some(page_token) = request.page_token {
            api_req
                .query_params
                .insert(QueryParams::PAGE_TOKEN, page_token);
        }

        if let Some(page_size) = request.page_size {
            api_req
                .query_params
                .insert(QueryParams::PAGE_SIZE, page_size.to_string());
        }

        if let Some(start_time) = request.start_time {
            api_req
                .query_params
                .insert(QueryParams::START_TIME, start_time.to_string());
        }

        if let Some(end_time) = request.end_time {
            api_req
                .query_params
                .insert(QueryParams::END_TIME, end_time.to_string());
        }

        if let Some(user_id) = request.user_id {
            api_req.query_params.insert(QueryParams::USER_ID, user_id);
        }

        if let Some(custom_workplace_id) = request.custom_workplace_id {
            api_req
                .query_params
                .insert(QueryParams::CUSTOM_WORKPLACE_ID, custom_workplace_id);
        }

        if let Some(widget_id) = request.widget_id {
            api_req
                .query_params
                .insert(QueryParams::WIDGET_ID, widget_id);
        }

        let api_resp: BaseResponse<CustomWidgetAccessDataSearchResponse> =
            Transport::request(api_req, &self.config, option).await?;
        api_resp.into_result()
    }
}

impl Service for WorkplaceAccessDataService {
    fn config(&self) -> &Config {
        &self.config
    }

    fn service_name() -> &'static str {
        "workplace_access_data"
    }

    fn service_version() -> &'static str {
        "v1"
    }
}

/// 工作台访问数据查询请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct AccessDataSearchRequest {
    /// 页码标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 每页数量
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
    /// 开始时间戳
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start_time: Option<i64>,
    /// 结束时间戳
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end_time: Option<i64>,
    /// 用户ID筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
    /// 部门ID筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub department_id: Option<String>,
    /// 访问类型筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub access_type: Option<String>,
}

impl AccessDataSearchRequest {
    /// 创建Builder实例
    pub fn builder() -> AccessDataSearchRequestBuilder {
        AccessDataSearchRequestBuilder::default()
    }
}

/// 工作台访问数据查询请求Builder
#[derive(Default)]
pub struct AccessDataSearchRequestBuilder {
    inner: AccessDataSearchRequest,
}

impl AccessDataSearchRequestBuilder {
    /// 设置页面令牌
    pub fn page_token(mut self, token: impl Into<String>) -> Self {
        self.inner.page_token = Some(token.into());
        self
    }

    /// 设置页面大小
    pub fn page_size(mut self, size: i32) -> Self {
        self.inner.page_size = Some(size);
        self
    }

    /// 设置开始时间戳
    pub fn start_time(mut self, timestamp: i64) -> Self {
        self.inner.start_time = Some(timestamp);
        self
    }

    /// 设置结束时间戳  
    pub fn end_time(mut self, timestamp: i64) -> Self {
        self.inner.end_time = Some(timestamp);
        self
    }

    /// 设置时间范围(复合方法)
    pub fn time_range(mut self, start_time: i64, end_time: i64) -> Self {
        self.inner.start_time = Some(start_time);
        self.inner.end_time = Some(end_time);
        self
    }

    /// 设置分页参数(复合方法)
    pub fn pagination(mut self, page_token: Option<String>, page_size: Option<i32>) -> Self {
        self.inner.page_token = page_token;
        self.inner.page_size = page_size;
        self
    }

    /// 设置用户ID筛选
    pub fn user_filter(mut self, user_id: impl Into<String>) -> Self {
        self.inner.user_id = Some(user_id.into());
        self
    }

    /// 设置部门ID筛选
    pub fn department_filter(mut self, department_id: impl Into<String>) -> Self {
        self.inner.department_id = Some(department_id.into());
        self
    }

    /// 设置访问类型筛选
    pub fn access_type_filter(mut self, access_type: impl Into<String>) -> Self {
        self.inner.access_type = Some(access_type.into());
        self
    }

    /// 构建请求对象
    pub fn build(self) -> AccessDataSearchRequest {
        self.inner
    }
}

/// 工作台访问数据查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct AccessDataSearchResponse {
    /// 工作台访问数据列表
    #[serde(flatten)]
    pub access_data: PageResponse<WorkplaceAccessData>,
}

impl ApiResponseTrait for AccessDataSearchResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 定制工作台访问数据查询请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CustomAccessDataSearchRequest {
    /// 页码标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 每页数量
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
    /// 开始时间戳
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start_time: Option<i64>,
    /// 结束时间戳
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end_time: Option<i64>,
    /// 用户ID筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
    /// 定制工作台ID筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom_workplace_id: Option<String>,
}

/// 定制工作台访问数据查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct CustomAccessDataSearchResponse {
    /// 定制工作台访问数据列表
    #[serde(flatten)]
    pub access_data: PageResponse<CustomWorkplaceAccessData>,
}

impl ApiResponseTrait for CustomAccessDataSearchResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 定制工作台小组件访问数据查询请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct CustomWidgetAccessDataSearchRequest {
    /// 页码标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 每页数量
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
    /// 开始时间戳
    #[serde(skip_serializing_if = "Option::is_none")]
    pub start_time: Option<i64>,
    /// 结束时间戳
    #[serde(skip_serializing_if = "Option::is_none")]
    pub end_time: Option<i64>,
    /// 用户ID筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
    /// 定制工作台ID筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom_workplace_id: Option<String>,
    /// 小组件ID筛选
    #[serde(skip_serializing_if = "Option::is_none")]
    pub widget_id: Option<String>,
}

impl CustomWidgetAccessDataSearchRequest {
    /// 创建Builder实例
    pub fn builder() -> CustomWidgetAccessDataSearchRequestBuilder {
        CustomWidgetAccessDataSearchRequestBuilder::default()
    }
}

/// 定制工作台小组件访问数据查询请求Builder
#[derive(Default)]
pub struct CustomWidgetAccessDataSearchRequestBuilder {
    inner: CustomWidgetAccessDataSearchRequest,
}

impl CustomWidgetAccessDataSearchRequestBuilder {
    /// 设置页面令牌
    pub fn page_token(mut self, token: impl Into<String>) -> Self {
        self.inner.page_token = Some(token.into());
        self
    }

    /// 设置页面大小
    pub fn page_size(mut self, size: i32) -> Self {
        self.inner.page_size = Some(size);
        self
    }

    /// 设置开始时间戳
    pub fn start_time(mut self, timestamp: i64) -> Self {
        self.inner.start_time = Some(timestamp);
        self
    }

    /// 设置结束时间戳  
    pub fn end_time(mut self, timestamp: i64) -> Self {
        self.inner.end_time = Some(timestamp);
        self
    }

    /// 设置时间范围(复合方法)
    pub fn time_range(mut self, start_time: i64, end_time: i64) -> Self {
        self.inner.start_time = Some(start_time);
        self.inner.end_time = Some(end_time);
        self
    }

    /// 设置分页参数(复合方法)
    pub fn pagination(mut self, page_token: Option<String>, page_size: Option<i32>) -> Self {
        self.inner.page_token = page_token;
        self.inner.page_size = page_size;
        self
    }

    /// 设置用户ID筛选
    pub fn user_filter(mut self, user_id: impl Into<String>) -> Self {
        self.inner.user_id = Some(user_id.into());
        self
    }

    /// 设置定制工作台ID筛选
    pub fn custom_workplace_filter(mut self, custom_workplace_id: impl Into<String>) -> Self {
        self.inner.custom_workplace_id = Some(custom_workplace_id.into());
        self
    }

    /// 设置小组件ID筛选
    pub fn widget_filter(mut self, widget_id: impl Into<String>) -> Self {
        self.inner.widget_id = Some(widget_id.into());
        self
    }

    /// 构建请求对象
    pub fn build(self) -> CustomWidgetAccessDataSearchRequest {
        self.inner
    }
}

/// 定制工作台小组件访问数据查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct CustomWidgetAccessDataSearchResponse {
    /// 定制工作台小组件访问数据列表
    #[serde(flatten)]
    pub access_data: PageResponse<CustomWorkplaceWidgetAccessData>,
}

impl ApiResponseTrait for CustomWidgetAccessDataSearchResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}