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
use reqwest::Method;
use serde::{Deserialize, Serialize};

use super::AppRoleService;
use crate::{
    core::{
        api_req::ApiRequest,
        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
        config::Config,
        constants::AccessTokenType,
        endpoints::cloud_docs::*,
        http::Transport,
        req_option::RequestOption,
        SDKResult,
    },
    impl_executable_builder_owned,
    service::bitable::v1::app_role::{AppRole, BlockRole, TableRole},
};

/// 更新自定义角色请求
#[derive(Debug, Serialize, Default)]
pub struct UpdateAppRoleRequest {
    #[serde(skip)]
    api_request: ApiRequest,
    /// 多维表格的唯一标识符
    #[serde(skip)]
    app_token: String,
    /// 自定义角色的id
    #[serde(skip)]
    role_id: String,
    /// 角色名称
    #[serde(skip_serializing_if = "Option::is_none")]
    role_name: Option<String>,
    /// 数据表权限
    #[serde(skip_serializing_if = "Option::is_none")]
    table_roles: Option<Vec<TableRole>>,
    /// 数据表默认权限
    #[serde(skip_serializing_if = "Option::is_none")]
    block_roles: Option<Vec<BlockRole>>,
}

impl UpdateAppRoleRequest {
    pub fn builder() -> UpdateAppRoleRequestBuilder {
        UpdateAppRoleRequestBuilder::default()
    }

    pub fn new(app_token: impl ToString, role_id: impl ToString) -> Self {
        Self {
            app_token: app_token.to_string(),
            role_id: role_id.to_string(),
            ..Default::default()
        }
    }
}

#[derive(Default)]
pub struct UpdateAppRoleRequestBuilder {
    request: UpdateAppRoleRequest,
}

impl UpdateAppRoleRequestBuilder {
    /// 多维表格的唯一标识符
    pub fn app_token(mut self, app_token: impl ToString) -> Self {
        self.request.app_token = app_token.to_string();
        self
    }

    /// 自定义角色的id
    pub fn role_id(mut self, role_id: impl ToString) -> Self {
        self.request.role_id = role_id.to_string();
        self
    }

    /// 角色名称
    pub fn role_name(mut self, role_name: impl ToString) -> Self {
        self.request.role_name = Some(role_name.to_string());
        self
    }

    /// 数据表权限
    pub fn table_roles(mut self, table_roles: Vec<TableRole>) -> Self {
        self.request.table_roles = Some(table_roles);
        self
    }

    /// 数据表默认权限
    pub fn block_roles(mut self, block_roles: Vec<BlockRole>) -> Self {
        self.request.block_roles = Some(block_roles);
        self
    }

    pub fn build(mut self) -> UpdateAppRoleRequest {
        self.request.api_request.body = serde_json::to_vec(&self.request).unwrap();
        self.request
    }
}

impl_executable_builder_owned!(
    UpdateAppRoleRequestBuilder,
    AppRoleService,
    UpdateAppRoleRequest,
    BaseResponse<UpdateAppRoleResponse>,
    update
);

/// 更新自定义角色响应
#[derive(Debug, Deserialize)]
pub struct UpdateAppRoleResponse {
    /// 更新后的自定义角色信息
    pub role: AppRole,
}

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

/// 更新自定义角色
pub async fn update_app_role(
    request: UpdateAppRoleRequest,
    config: &Config,
    option: Option<RequestOption>,
) -> SDKResult<BaseResponse<UpdateAppRoleResponse>> {
    let mut api_req = request.api_request;
    api_req.http_method = Method::PUT;
    api_req.api_path = BITABLE_V1_ROLE_UPDATE
        .replace("{app_token}", &request.app_token)
        .replace("{role_id}", &request.role_id);
    api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];

    let api_resp = Transport::request(api_req, config, option).await?;
    Ok(api_resp)
}

#[cfg(test)]
#[allow(unused_variables, unused_unsafe)]
mod tests {
    use super::*;
    use serde_json;

    #[test]
    fn test_update_app_role_request_builder() {
        let request = UpdateAppRoleRequest::builder()
            .app_token("bascnmBA*****yGehy8")
            .role_id("rolxxxxxx")
            .role_name("更新后的角色名称")
            .build();

        assert_eq!(request.app_token, "bascnmBA*****yGehy8");
        assert_eq!(request.role_id, "rolxxxxxx");
        assert_eq!(request.role_name, Some("更新后的角色名称".to_string()));
    }

    #[test]
    fn test_update_app_role_request_new() {
        let request = UpdateAppRoleRequest::new("bascnmBA*****yGehy8", "rolxxxxxx");

        assert_eq!(request.app_token, "bascnmBA*****yGehy8");
        assert_eq!(request.role_id, "rolxxxxxx");
        assert_eq!(request.role_name, None);
        assert!(request.table_roles.is_none());
        assert!(request.block_roles.is_none());
    }

    #[test]
    fn test_update_app_role_request_default() {
        let request = UpdateAppRoleRequest::default();

        assert_eq!(request.app_token, "");
        assert_eq!(request.role_id, "");
        assert_eq!(request.role_name, None);
        assert!(request.table_roles.is_none());
        assert!(request.block_roles.is_none());
    }

    #[test]
    fn test_update_app_role_request_builder_default() {
        let builder = UpdateAppRoleRequestBuilder::default();
        let request = builder.build();

        assert_eq!(request.app_token, "");
        assert_eq!(request.role_id, "");
        assert_eq!(request.role_name, None);
        assert!(request.table_roles.is_none());
        assert!(request.block_roles.is_none());
    }

    #[test]
    fn test_update_app_role_request_builder_chaining() {
        let request = UpdateAppRoleRequest::builder()
            .app_token("app1")
            .role_id("role1")
            .role_name("name1")
            .app_token("app2")
            .role_id("role2")
            .role_name("name2")
            .build();

        assert_eq!(request.app_token, "app2");
        assert_eq!(request.role_id, "role2");
        assert_eq!(request.role_name, Some("name2".to_string()));
    }

    #[test]
    fn test_update_app_role_request_debug() {
        let request = UpdateAppRoleRequest::new("test_app", "test_role");
        let debug_str = format!("{:?}", request);

        assert!(debug_str.contains("UpdateAppRoleRequest"));
        assert!(debug_str.contains("test_app"));
        assert!(debug_str.contains("test_role"));
    }

    #[test]
    fn test_update_app_role_request_serialization() {
        let request = UpdateAppRoleRequest::new("app_token_123", "role_456");
        let serialized = serde_json::to_string(&request).unwrap();

        // Skip字段不应该出现在序列化结果中
        assert!(!serialized.contains("app_token"));
        assert!(!serialized.contains("role_id"));
        assert!(!serialized.contains("api_request"));
        assert_eq!(serialized, "{}");
    }

    #[test]
    fn test_update_app_role_request_with_role_name() {
        let request = UpdateAppRoleRequest::builder()
            .app_token("test_app")
            .role_id("test_role")
            .role_name("新角色名称")
            .build();

        assert_eq!(request.app_token, "test_app");
        assert_eq!(request.role_id, "test_role");
        assert_eq!(request.role_name, Some("新角色名称".to_string()));
        assert!(request.table_roles.is_none());
        assert!(request.block_roles.is_none());
    }

    #[test]
    fn test_update_app_role_request_with_table_roles() {
        let table_roles = vec![]; // Empty vector for now since we need the actual TableRole definition
        let request = UpdateAppRoleRequest::builder()
            .app_token("test_app")
            .role_id("test_role")
            .table_roles(table_roles.clone())
            .build();

        assert_eq!(request.app_token, "test_app");
        assert_eq!(request.role_id, "test_role");
        assert_eq!(request.role_name, None);
        assert!(request.table_roles.is_some());
        assert!(request.block_roles.is_none());
    }

    #[test]
    fn test_update_app_role_request_with_block_roles() {
        let block_roles = vec![]; // Empty vector for now since we need the actual BlockRole definition
        let request = UpdateAppRoleRequest::builder()
            .app_token("test_app")
            .role_id("test_role")
            .block_roles(block_roles.clone())
            .build();

        assert_eq!(request.app_token, "test_app");
        assert_eq!(request.role_id, "test_role");
        assert_eq!(request.role_name, None);
        assert!(request.table_roles.is_none());
        assert!(request.block_roles.is_some());
    }

    #[test]
    fn test_update_app_role_request_with_all_fields() {
        let table_roles = vec![];
        let block_roles = vec![];
        let request = UpdateAppRoleRequest::builder()
            .app_token("full_app")
            .role_id("full_role")
            .role_name("完整角色")
            .table_roles(table_roles.clone())
            .block_roles(block_roles.clone())
            .build();

        assert_eq!(request.app_token, "full_app");
        assert_eq!(request.role_id, "full_role");
        assert_eq!(request.role_name, Some("完整角色".to_string()));
        assert!(request.table_roles.is_some());
        assert!(request.block_roles.is_some());
    }

    #[test]
    fn test_update_app_role_request_with_empty_values() {
        let request = UpdateAppRoleRequest::new("", "");

        assert_eq!(request.app_token, "");
        assert_eq!(request.role_id, "");
        assert_eq!(request.role_name, None);
    }

    #[test]
    fn test_update_app_role_request_with_unicode() {
        let request = UpdateAppRoleRequest::new("应用令牌_123", "角色_456");

        assert_eq!(request.app_token, "应用令牌_123");
        assert_eq!(request.role_id, "角色_456");
    }

    #[test]
    fn test_update_app_role_request_with_string_types() {
        let owned_app_token = String::from("owned_app");
        let owned_role_id = String::from("owned_role");
        let request1 = UpdateAppRoleRequest::new(owned_app_token, owned_role_id);

        assert_eq!(request1.app_token, "owned_app");
        assert_eq!(request1.role_id, "owned_role");

        let request2 = UpdateAppRoleRequest::builder()
            .app_token(String::from("builder_app"))
            .role_id(String::from("builder_role"))
            .role_name(String::from("builder_name"))
            .build();

        assert_eq!(request2.app_token, "builder_app");
        assert_eq!(request2.role_id, "builder_role");
        assert_eq!(request2.role_name, Some("builder_name".to_string()));
    }

    #[test]
    fn test_update_app_role_request_with_long_values() {
        let long_token = "a".repeat(1000);
        let long_role = "b".repeat(500);
        let long_name = "c".repeat(200);
        let request = UpdateAppRoleRequest::builder()
            .app_token(&long_token)
            .role_id(&long_role)
            .role_name(&long_name)
            .build();

        assert_eq!(request.app_token, long_token);
        assert_eq!(request.role_id, long_role);
        assert_eq!(request.role_name, Some(long_name));
    }

    #[test]
    fn test_update_app_role_request_with_special_characters() {
        let special_app = "app-token_123.test";
        let special_role = "role@domain#test";
        let special_name = "角色名称!@#$%^&*()";
        let request = UpdateAppRoleRequest::builder()
            .app_token(special_app)
            .role_id(special_role)
            .role_name(special_name)
            .build();

        assert_eq!(request.app_token, special_app);
        assert_eq!(request.role_id, special_role);
        assert_eq!(request.role_name, Some(special_name.to_string()));
    }

    #[test]
    fn test_update_app_role_request_builder_partial() {
        let request1 = UpdateAppRoleRequest::builder()
            .app_token("only_app")
            .build();

        assert_eq!(request1.app_token, "only_app");
        assert_eq!(request1.role_id, "");
        assert!(request1.role_name.is_none());

        let request2 = UpdateAppRoleRequest::builder().role_id("only_role").build();

        assert_eq!(request2.app_token, "");
        assert_eq!(request2.role_id, "only_role");
        assert!(request2.role_name.is_none());

        let request3 = UpdateAppRoleRequest::builder()
            .role_name("only_name")
            .build();

        assert_eq!(request3.app_token, "");
        assert_eq!(request3.role_id, "");
        assert_eq!(request3.role_name, Some("only_name".to_string()));
    }

    #[test]
    fn test_update_app_role_request_serialization_with_role_name() {
        let request = UpdateAppRoleRequest::builder()
            .app_token("app123")
            .role_id("role456")
            .role_name("测试角色")
            .build();
        let serialized = serde_json::to_string(&request).unwrap();

        // role_name should appear in serialization
        assert!(serialized.contains("role_name"));
        assert!(serialized.contains("测试角色"));
        // Skip fields should not appear
        assert!(!serialized.contains("app_token"));
        assert!(!serialized.contains("role_id"));
        assert!(!serialized.contains("api_request"));
    }

    #[test]
    fn test_update_app_role_request_serialization_with_optional_fields() {
        let table_roles = vec![];
        let block_roles = vec![];
        let request = UpdateAppRoleRequest::builder()
            .app_token("app123")
            .role_id("role456")
            .role_name("测试角色")
            .table_roles(table_roles)
            .block_roles(block_roles)
            .build();
        let serialized = serde_json::to_string(&request).unwrap();

        // Optional fields should appear in serialization
        assert!(serialized.contains("role_name"));
        assert!(serialized.contains("table_roles"));
        assert!(serialized.contains("block_roles"));
        assert!(serialized.contains("测试角色"));
    }

    #[test]
    fn test_update_app_role_response_data_format() {
        let format = UpdateAppRoleResponse::data_format();
        assert!(matches!(format, ResponseFormat::Data));
    }

    #[test]
    fn test_memory_efficiency() {
        let request = UpdateAppRoleRequest::new("test", "test");
        let size = std::mem::size_of_val(&request);

        assert!(size > 0);
        assert!(size < 1024);
    }

    #[test]
    fn test_update_app_role_request_builder_method_returns() {
        let builder = UpdateAppRoleRequest::builder().app_token("测试链式");

        // 确保builder方法返回正确的类型
        let _chained = builder.role_id("role").role_name("name");
    }

    #[test]
    fn test_update_app_role_request_build_with_body() {
        let request = UpdateAppRoleRequest::builder()
            .app_token("test_app")
            .role_id("test_role")
            .role_name("测试角色")
            .build();

        // build() method should set the body in api_request
        assert!(!request.api_request.body.is_empty());
    }
}