Open Lark

https://docs.rs/open-lark/0.13.0/
Admin
Open Lark is an unofficial Rust SDK for the Feishu (Lark) Open Platform, supporting custom bots,...
Tokens:580,766
Snippets:3,325
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Date Time Picker Configuration Example

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/card/components/interactive_components/date_time_picker.rs.html

Example configuration for a date time picker component, including initial values, placeholder text, and confirmation dialog settings.

```rust
"required": false, // 日期时间是否必选。默认值 false。当日期时间选择器内嵌在表单容器时，该属性可用。其它情况将报错或不生效。
          "disabled": false, // 是否禁用该日期时间选择器组件。默认值 false。
          "width": "default",  // 日期时间选择器的宽度。
          "initial_datetime": "2024-01-01 11:30", // 日期时间初始值。默认为空。
          "placeholder": {
            // 日期时间选择器组件内的占位文本。
            "tag": "plain_text",
            "content": "请选择"
          },
          "value": {
            // 回传数据
            "key_1": "value_1"
          },
          "confirm": {
            // 二次确认弹窗配置
            "title": {
              "tag": "plain_text",
              "content": "title"
            },
            "text": {
              "tag": "plain_text",
              "content": "content"
            }
          }
        });

        assert_eq!(serde_json::to_value(datetime_picker).unwrap(), json);
    }
}
```

--------------------------------

### FeishuCardTable Usage Example

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/card/components/content_components/table.rs.html

Example demonstrating how to construct a FeishuCardTable with columns and data rows.

```rust
#[test]
    fn test_table() {
        let table = FeishuCardTable::new()
            .page_zie(1)
            .row_height("middle")
            .header_style(
                FeishuCardTableHeaderStyle::new()
                    .bold(true)
                    .background_style("grey")
                    .lines(1)
                    .text_size("heading")
                    .text_align("center")
                ,
            )
            .columns(vec![
                FeishuCardTableColumn::new()
                    .name("customer_name")
                    .display_name("客户名称")
                    .data_type("text"),
                FeishuCardTableColumn::new()
                    .name("customer_scale")
                    .display_name("客户规模")
                    .data_type("options")
                    .width("90px"),
                FeishuCardTableColumn::new()
                    .name("customer_arr")
                    .display_name("ARR(万元)")
                    .data_type("number")
                    .format(
                        FeishuCardTableColumnFormat::new()
                            .precision(2)
                            .symbol("¥"),
                    )
                    .width("120px"),
                FeishuCardTableColumn::new()
                    .name("customer_year")
                    .display_name("签约年限")
                    .data_type("text"),
            ])
            .rows(json!([
                    {
                        "customer_name": "飞书消息卡片是飞书中的一种功能，它允许用户通过机器人或应用以结构化（JSON）的方式发送和接收消息。"
```

--------------------------------

### Usage example of impl_executable_builder

Source: https://docs.rs/open-lark/0.13.0/open_lark/macro.impl_executable_builder.html

Example showing how to invoke the macro to generate trait implementations for a specific request builder.

```rust
impl_executable_builder!(
    UploadMediaRequestBuilder,
    MediaService,
    UploadMediaRequest,
    BaseResponse<UploadMediaRespData>,
    upload_all
);
```

--------------------------------

### Initialize LarkClient and perform file operations

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/drive/index.html

Demonstrates how to build a LarkClient instance and provides commented-out examples for uploading files and retrieving file information.

```rust
use open_lark::prelude::*;

let client = LarkClient::builder("app_id", "app_secret")
    .with_app_type(AppType::SelfBuild)
    .build();

// 上传文件
// let upload_request = UploadAllRequest::builder()
//     .file_name("document.pdf")
//     .parent_type("folder")
//     .parent_node("folder_token")
//     .build();
// let result = client.drive.v1.files.upload_all(upload_request, None).await?;

// 获取文件信息
// let file_info = client.drive.v1.file.get(file_token, None).await?;
```

--------------------------------

### Quick Subscription Presets

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/assistant/v1/subscription/create.rs.html

Pre-configured methods for creating basic and premium subscription configurations.

```rust
pub fn basic_subscription(mut self) -> Self {
        let config = SubscriptionConfig {
            enable_notification: Some(true),
            notification_interval: Some(3600), // 1小时
            priority: Some(SubscriptionPriority::Normal),
            auto_renew: Some(false),
            tags: Some(vec!["default".to_string()]),
            custom_properties: None,
        };
        self.request.config = Some(config);
        self
    }

    /// 快速创建高级订阅
    pub fn premium_subscription(mut self) -> Self {
        let config = SubscriptionConfig {
            enable_notification: Some(true),
            notification_interval: Some(300), // 5分钟
            priority: Some(SubscriptionPriority::High),
            auto_renew: Some(true),
            tags: Some(vec!["premium".to_string(), "priority".to_string()]),
            custom_properties: None,
        };
        self.request.config = Some(config);
        self
    }
```

--------------------------------

### MultiSelectStatic Unit Test Example

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/card/components/interactive_components/multi_select_static.rs.html

Example usage of the MultiSelectStatic builder within a test case.

```rust
#[cfg(test)]
mod test {
    use serde_json::json;

    use crate::card::{
        components::{
            content_components::plain_text::PlainText,
            interactive_components::{
                multi_select_static::MultiSelectStatic, select_static::SelectStaticOption,
            },
        },
        icon::FeishuCardTextIcon,
    };

    #[test]
    fn test_select_static() {
        let select_static = MultiSelectStatic::new()
            .r#type("default")
            .name("multi_select_departments")
            .required(true)
            .disabled(false)
```

--------------------------------

### Get Spreadsheet Implementation

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/sheets/v3/spreadsheet/get.rs.html

The core method for executing the GET request to retrieve spreadsheet information.

```rust
1use reqwest::Method;
2use serde::{Deserialize, Serialize};
3
4use crate::{
5    core::{
6        api_req::ApiRequest,
7        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
8        constants::AccessTokenType,
9        http::Transport,
10        req_option::RequestOption,
11        SDKResult,
12    },
13    impl_executable_builder_owned,
14    service::sheets::v3::SpreadsheetService,
15};
16
17impl SpreadsheetService {
18    /// 获取电子表格信息
19    ///
20    /// <https://open.feishu.cn/document/ukTMukTMukTM/uUDN04SN0QjL1QDN/sheets-v3/spreadsheet/get>
21    pub async fn get(
22        &self,
23        request: GetSpreadsheetRequest,
24        option: Option<RequestOption>,
25    ) -> SDKResult<BaseResponse<GetSpreadsheetResponseData>> {
26        let mut api_req = request.api_request;
27        api_req.http_method = Method::GET;
28        api_req.api_path = format!(
29            "/open-apis/sheets/v3/spreadsheets/{}",
30            request.spreadsheet_token
31        );
32        api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];
33
34        let api_resp = Transport::request(api_req, &self.config, option).await?;
35
36        Ok(api_resp)
37    }
38}
39
40#[derive(Serialize, Deserialize, Debug, Default)]
41pub struct GetSpreadsheetRequest {
42    #[serde(skip)]
43    api_request: ApiRequest,
44    #[serde(skip)]
45    spreadsheet_token: String,
46    /// 用户 ID 类型
47    ///
48    /// 默认值：open_id
49    ///
50    /// 可选值有：
51    ///
52    /// - open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID
53    ///   不同。了解更多：如何获取 Open ID
54    /// - union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID
55    ///   是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union
56    ///   ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？
57    /// - user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID
58    ///   是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User
59    ///   ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？
60    user_id_type: Option<String>,
61}
62
63impl GetSpreadsheetRequest {
64    pub fn builder() -> GetSpreadsheetRequestBuilder {
65        GetSpreadsheetRequestBuilder::default()
66    }
67}
68
69#[derive(Default)]
70pub struct GetSpreadsheetRequestBuilder {
71    request: GetSpreadsheetRequest,
72}
73
74impl GetSpreadsheetRequestBuilder {
75    /// 用户 ID 类型
76    ///
77    /// 默认值：open_id
78    ///
79    /// 可选值有：
80    ///
81    /// - open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID
82    ///   不同。了解更多：如何获取 Open ID
83    /// - union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID
84    ///   是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union
85    ///   ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？
86    /// - user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID
87    ///   是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店用）中都保持一致。User
88    ///   ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？
89    pub fn user_id_type(mut self, user_id_type: impl ToString) -> Self {
90        self.request.user_id_type = Some(user_id_type.to_string());
91        self
92    }
93
94    /// 表格的token
95    pub fn spreadsheet_token(mut self, spreadsheet_token: impl ToString) -> Self {
96        self.request.spreadsheet_token = spreadsheet_token.to_string();
97        self
98    }
99
100    pub fn build(mut self) -> GetSpreadsheetRequest {
101        self.request.api_request.body = serde_json::to_vec(&self.request).unwrap();
102        self.request
103    }
104}
105
106// Trait implementation
107impl_executable_builder_owned!(
108    GetSpreadsheetRequestBuilder,
109    SpreadsheetService,
110    GetSpreadsheetRequest,
111    BaseResponse<GetSpreadsheetResponseData>,
112    get
113);
114
115#[derive(Debug, Deserialize)]
116pub struct GetSpreadsheetResponseData {
117    pub spreadsheet: GetSpreadsheetResponse,
118}
119
120impl ApiResponseTrait for GetSpreadsheetResponseData {
121    fn data_format() -> ResponseFormat {
122        ResponseFormat::Data
123    }
124}
125
126#[derive(Serialize, Deserialize, Debug)]
127pub struct GetSpreadsheetResponse {
128    /// 电子表格标题
129    pub title: String,
130    /// 电子表格owner
131    pub owner_id: String,
132    /// 电子表格token
133    pub token: String,
134    /// 电子表格url
135    pub url: String,
136}
```

--------------------------------

### create

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/bitable/v1/app/struct.AppService.html

Creates a new Bitable application.

```APIDOC
## create

### Description
Creates a new Bitable application.

### Method
SDK Method: `AppService::create`

### Parameters
- **request** (CreateAppRequest) - Required - The request object containing creation parameters.
- **option** (Option<RequestOption>) - Optional - Additional request options.

### Response
- **SDKResult<BaseResponse<CreateAppResponse>>** - The result of the creation operation.
```

--------------------------------

### Get Subscription API Request

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/assistant/v1/subscription/get.rs.html

Asynchronous function to perform a GET request for subscription status.

```rust
/// 获取订阅状态
pub async fn get_subscription(
    request: GetSubscriptionRequest,
    config: &Config,
    option: Option<RequestOption>,
) -> SDKResult<BaseResponse<GetSubscriptionResponse>> {
    let mut api_req = request.api_request;
    api_req.http_method = Method::GET;

    api_req.api_path = format!(
        "/open-apis/assistant/v1/file/{}/{}/subscription",
        request.file_type, request.file_token
    );

    api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];

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

--------------------------------

### Initialize Cloud Docs Service and Perform Operations

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/index.html

Demonstrates how to initialize the LarkClient and access various cloud document services like Drive, Wiki, Docx, Sheets, and Bitable.

```rust
use open_lark::prelude::*;

let client = LarkClient::builder("app_id", "app_secret")
    .with_app_type(AppType::SelfBuild)
    .build();

// 获取云文档服务
let cloud_docs = &client.cloud_docs;

// 云空间操作
// let file_request = CreateFileRequest::builder()
//     .name("项目计划书.docx")
//     .parent_token("folder_123")
//     .file_type("docx")
//     .build();
// let file = cloud_docs.drive.v1.file.create(file_request, None).await?;

// 创建知识库
// let wiki_request = CreateWikiRequest::builder()
//     .name("产品知识库")
//     .description("产品相关文档和资料")
//     .build();
// let wiki = cloud_docs.wiki.v2.space.create(wiki_request, None).await?;

// 操作文档
// let docx_request = CreateDocumentRequest::builder()
//     .title("会议纪要")
//     .folder_token("folder_456")
//     .build();
// let document = cloud_docs.docx.v1.document.create(docx_request, None).await?;

// 操作电子表格
// let sheets_request = CreateSpreadsheetRequest::builder()
//     .title("销售数据")
//     .folder_token("folder_789")
//     .build();
// let spreadsheet = cloud_docs.sheets.v3.spreadsheet.create(sheets_request, None).await?;

// 操作多维表格
// let bitable_request = CreateBitableRequest::builder()
//     .name("项目管理表")
//     .folder_token("folder_abc")
//     .build();
// let bitable = cloud_docs.bitable.v1.app.create(bitable_request, None).await?;
```

--------------------------------

### Creating a Simple FeishuCard

Source: https://docs.rs/open-lark/0.13.0/open_lark/card/struct.FeishuCard.html

Demonstrates how to initialize a new FeishuCard with configuration and localized headers.

```rust
use open_lark::card::{FeishuCard, FeishuCardConfig};
use open_lark::card::components::content_components::title::FeishuCardTitle;
use open_lark::card::components::content_components::title::Title;
use open_lark::card::components::CardElement;

// 创建简单卡片
let card = FeishuCard::new()
    .config(
        FeishuCardConfig::new()
            .enable_forward(true)
            .update_multi(false)
    )
    .header("zh_cn",
        FeishuCardTitle::new()
            .title(Title::new("欢迎使用飞书卡片"))
    )?
    .elements("zh_cn", vec![
        // 添加卡片元素
    ])?;
```

--------------------------------

### Get Comment Response and Execution Function

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/comments/get.rs.html

Defines the response structure and the asynchronous function to execute the get comment request.

```rust
144/// 获取全文评论响应
145#[derive(Debug, Deserialize)]
146pub struct GetCommentResponse {
147    /// 评论信息
148    pub comment: Comment,
149}
150
151impl ApiResponseTrait for GetCommentResponse {
152    fn data_format() -> ResponseFormat {
153        ResponseFormat::Data
154    }
155}
156
157/// 获取全文评论
158pub async fn get_comment(
159    request: GetCommentRequest,
160    config: &Config,
161    option: Option<RequestOption>,
162) -> SDKResult<BaseResponse<GetCommentResponse>> {
163    let mut api_req = request.api_request;
164    api_req.http_method = Method::GET;
165    api_req.api_path = format!(
166        "/open-apis/comment/v1/comments/{}?file_type={}&file_token={}",
167        request.comment_id, request.file_type, request.file_token
168    );
169
170    // 添加用户ID类型查询参数
171    if let Some(user_id_type) = request.user_id_type {
172        api_req.api_path = format!("{}&user_id_type={}", api_req.api_path, user_id_type);
173    }
```

--------------------------------

### Initialize LarkClient

Source: https://docs.rs/open-lark/0.13.0/index.html

Demonstrates how to instantiate a LarkClient using the builder pattern with app credentials and configuration options.

```rust
use open_lark::prelude::*;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // 创建客户端
    let client = LarkClient::builder("your_app_id", "your_app_secret")
        .with_app_type(AppType::SelfBuild)
        .with_enable_token_cache(true)
        .build();

    println!("飞书开放平台 Rust SDK 初始化成功");
    Ok(())
}
```

--------------------------------

### Get Bitable View Implementation

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/bitable/v1/app_table_view/get.rs.html

The core service method for retrieving view details, utilizing the Transport layer to execute the GET request.

```rust
1use reqwest::Method;
2use serde::Deserialize;
3
4use crate::{
5    core::{
6        api_req::ApiRequest,
7        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
8        constants::AccessTokenType,
9        http::Transport,
10        req_option::RequestOption,
11        SDKResult,
12    },
13    impl_executable_builder_owned,
14};
15
16use super::AppTableViewService;
17
18impl AppTableViewService {
19    /// 获取视图
20    pub async fn get(
21        &self,
22        request: GetViewRequest,
23        option: Option<RequestOption>,
24    ) -> SDKResult<BaseResponse<GetViewResponse>> {
25        let mut api_req = request.api_request;
26        api_req.http_method = Method::GET;
27        api_req.api_path = format!(
28            "/open-apis/bitable/v1/apps/{}/tables/{}/views/{}",
29            request.app_token, request.table_id, request.view_id
30        );
31        api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];
32
33        let api_resp = Transport::request(api_req, &self.config, option).await?;
34        Ok(api_resp)
35    }
36}
```

--------------------------------

### Initialize LarkClient and Invoke Services

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/index.html

Demonstrates how to instantiate the LarkClient using credentials and perform service calls. Ensure the appropriate request objects are prepared before invoking specific API methods.

```rust
use open_lark::prelude::*;

// 创建客户端
let client = LarkClient::builder("app_id", "app_secret")
    .with_app_type(AppType::SelfBuild)
    .build();

// 服务调用示例（需要相应的请求对象）
// let message = client.im.v1.message.create(message_request, None).await?;
// let document = client.cloud_docs.drive.v1.file.create_file(file_request, None).await?;
// let employee = client.contact.v3.user.get(user_request, None).await?;
```

--------------------------------

### Initialize Lark Search Service

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/search/index.html

Demonstrates how to initialize the Lark client and access the search service module.

```rust
use open_lark::prelude::*;

let client = LarkClient::builder("app_id", "app_secret")
    .with_app_type(AppType::SelfBuild)
    .build();

// 获取搜索服务
let search = &client.search;

// 创建数据源（v2版本）
// let data_source_request = CreateDataSourceRequest::builder()
//     .name("企业知识库")
//     .description("包含公司所有技术文档")
//     .build();
// let data_source = search.v2.data_source.create(data_source_request, None).await?;

// 执行搜索
// let search_request = SearchRequest::builder()
//     .query("飞书API")
//     .data_source_id("ds_123")
//     .build();
// let results = search.v2.suite_search.search(search_request, None).await?;
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/im/v1/file/struct.FileService.html

Downloads a file from the service.

```APIDOC
## pub async fn get(&self, file_key: &str, option: Option<RequestOption>) -> SDKResult<GetFileResponse>

### Description
Downloads a file using the provided file key.

### Parameters
- **file_key** (&str) - Required - The unique key identifying the file.
- **option** (Option<RequestOption>) - Optional - Additional request options.
```

--------------------------------

### Initialize LarkClient and Access Contact Service

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/contact/index.html

Demonstrates how to build a LarkClient instance and access the contact service module to interact with v3 APIs.

```rust
use open_lark::prelude::*;

let client = LarkClient::builder("app_id", "app_secret")
    .with_app_type(AppType::SelfBuild)
    .build();

// 获取通讯录服务
let contact = &client.contact;

// 使用v3版本API
// let users = contact.v3.user.list(request, None).await?;
// let departments = contact.v3.department.list(request, None).await?;
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/sheets/v3/struct.SpreadsheetService.html

Retrieves spreadsheet information.

```APIDOC
## get

### Description
Retrieves the metadata and basic information of a spreadsheet.

### Signature
`pub async fn get(&self, request: GetSpreadsheetRequest, option: Option<RequestOption>) -> SDKResult<BaseResponse<GetSpreadsheetResponseData>>`
```

--------------------------------

### Initialize LarkClient and Authentication Requests

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/authentication/index.html

Demonstrates how to initialize the LarkClient and outlines the structure for requesting App and User access tokens.

```rust
use open_lark::prelude::*;

let client = LarkClient::builder("app_id", "app_secret")
    .with_app_type(AppType::SelfBuild)
    .build();

// 认证服务通过核心配置处理，无需直接访问

// 获取App Access Token
// let app_token_request = GetAppAccessTokenRequest::builder()
//     .app_id("app_id")
//     .app_secret("app_secret")
//     .build();
// let token = auth.v1.app_access_token.get(app_token_request, None).await?;

// 获取用户访问令牌
// let user_token_request = GetUserAccessTokenRequest::builder()
//     .grant_type("authorization_code")
//     .code("authorization_code")
//     .build();
// let user_token = auth.v1.user_access_token.get(user_token_request, None).await?;
```

--------------------------------

### Get Filter View Condition Implementation

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/sheets/v3/spreadsheet_sheet_filter_view_condition/get.rs.html

The get_condition method performs a GET request to retrieve filter view condition details. It requires a spreadsheet token, sheet ID, filter view ID, and condition ID.

```rust
1use reqwest::Method;
2use serde::{Deserialize, Serialize};
3
4use crate::{
5    core::{
6        api_req::ApiRequest,
7        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
8        constants::AccessTokenType,
9        http::Transport,
10        req_option::RequestOption,
11        SDKResult,
12    },
13    service::sheets::v3::SpreadsheetSheetFilterViewService,
14};
15
16use super::query::FilterConditionInfo;
17
18impl SpreadsheetSheetFilterViewService {
19    /// 获取筛选条件
20    pub async fn get_condition(
21        &self,
22        request: GetFilterViewConditionRequest,
23        option: Option<RequestOption>,
24    ) -> SDKResult<BaseResponse<GetFilterViewConditionResponseData>> {
25        let mut api_req = request.api_request;
26        api_req.http_method = Method::GET;
27        api_req.api_path = format!(
28            "/open-apis/sheets/v3/spreadsheets/{}/sheets/{}/filter_views/{}/conditions/{}",
29            request.spreadsheet_token,
30            request.sheet_id,
31            request.filter_view_id,
32            request.condition_id
33        );
34        api_req.supported_access_token_types = vec![AccessTokenType::Tenant, AccessTokenType::User];
35
36        let api_resp = Transport::request(api_req, &self.config, option).await?;
37
38        Ok(api_resp)
39    }
40}
41
42/// 获取筛选条件请求
43#[derive(Default, Debug, Serialize, Deserialize)]
44pub struct GetFilterViewConditionRequest {
45    #[serde(skip)]
46    api_request: ApiRequest,
47    /// spreadsheet 的 token
48    spreadsheet_token: String,
49    /// sheet 的 id
50    sheet_id: String,
51    /// 筛选视图 ID
52    filter_view_id: String,
53    /// 筛选条件 ID
54    condition_id: String,
55}
56
57impl GetFilterViewConditionRequest {
58    pub fn builder() -> GetFilterViewConditionRequestBuilder {
59        GetFilterViewConditionRequestBuilder::default()
60    }
61}
62
63#[derive(Default)]
64pub struct GetFilterViewConditionRequestBuilder {
65    request: GetFilterViewConditionRequest,
66}
67
68impl GetFilterViewConditionRequestBuilder {
69    pub fn spreadsheet_token(mut self, spreadsheet_token: impl ToString) -> Self {
70        self.request.spreadsheet_token = spreadsheet_token.to_string();
71        self
72    }
73
74    pub fn sheet_id(mut self, sheet_id: impl ToString) -> Self {
75        self.request.sheet_id = sheet_id.to_string();
76        self
77    }
78
79    pub fn filter_view_id(mut self, filter_view_id: impl ToString) -> Self {
80        self.request.filter_view_id = filter_view_id.to_string();
81        self
82    }
83
84    pub fn condition_id(mut self, condition_id: impl ToString) -> Self {
85        self.request.condition_id = condition_id.to_string();
86        self
87    }
88
89    pub fn build(mut self) -> GetFilterViewConditionRequest {
90        self.request.api_request.body = serde_json::to_vec(&self.request).unwrap();
91        self.request
92    }
93}
94
95/// 获取筛选条件响应体最外层
96#[derive(Deserialize, Debug)]
97pub struct GetFilterViewConditionResponseData {
98    /// 筛选条件信息
99    #[serde(flatten)]
100    pub condition_info: FilterConditionInfo,
101}
102
103impl ApiResponseTrait for GetFilterViewConditionResponseData {
104    fn data_format() -> ResponseFormat {
105        ResponseFormat::Data
106    }
107}
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/contact/v3/unit/struct.UnitService.html

Retrieves information for a specific unit.

```APIDOC
## pub async fn get(&self, unit_id: &str) -> SDKResult<GetUnitResponse>

### Description
Fetches the details of a specific unit by its ID.

### Parameters
- **unit_id** (&str) - Required - The unique identifier of the unit.
```

--------------------------------

### CustomBot::new

Source: https://docs.rs/open-lark/0.13.0/open_lark/custom_bot/struct.CustomBot.html

Initializes a new instance of the CustomBot client.

```APIDOC
## pub fn new(webhook_url: &'a str, secret: Option<&'a str>) -> Self

### Description
Creates a new CustomBot instance using the provided webhook URL and an optional secret for signature verification.

### Parameters
- **webhook_url** (&str) - Required - The webhook URL of the custom bot.
- **secret** (Option<&str>) - Optional - The secret key for the bot, if configured.
```

--------------------------------

### Importing and Using the Prelude

Source: https://docs.rs/open-lark/0.13.0/open_lark/prelude/index.html

Use the prelude to quickly access the LarkClient, message builders, and other core SDK components.

```rust
use open_lark::prelude::*;

// 创建客户端
let client = LarkClient::builder("app_id", "app_secret")
    .with_app_type(AppType::SelfBuild)
    .build();

// 创建消息
let message = CreateMessageRequestBody::builder()
    .receive_id("user_id")
    .msg_type("text")
    .content("{\"text\":\"Hello, World!\"}")
    .build();
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/contact/v3/job_level/struct.JobLevelService.html

Retrieves a single job level.

```APIDOC
## pub async fn get(&self, job_level_id: &str) -> SDKResult<GetJobLevelResponse>

### Description
Fetches the details of a specific job level by its ID.

### Parameters
- **job_level_id** (&str) - Required - The unique identifier of the job level.

### Returns
- **SDKResult<GetJobLevelResponse>** - The retrieved job level information.
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/contact/v3/job_family/struct.JobFamilyService.html

Retrieves a single job family.

```APIDOC
## get

### Description
Retrieves the details of a specific job family by its ID.

### Signature
`pub async fn get(&self, job_family_id: &str) -> SDKResult<GetJobFamilyResponse>`
```

--------------------------------

### Create AuthenService Instance

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/authentication/struct.AuthenService.html

Constructor for initializing the authentication service with the required client configuration.

```rust
pub fn new(config: Arc<Config>) -> Self
```

--------------------------------

### View Data Type Initialization

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/bitable/v1/app_table_view/create.rs.html

Shows how to initialize different types of Bitable views including grid, kanban, gallery, and gantt.

```rust
#[test]
    fn test_view_data_types() {
        let grid_view = ViewData::grid_view("表格视图");
        assert_eq!(grid_view.view_type, Some("grid".to_string()));

        let kanban_view = ViewData::kanban_view("看板视图");
        assert_eq!(kanban_view.view_type, Some("kanban".to_string()));

        let gallery_view = ViewData::gallery_view("画册视图");
        assert_eq!(gallery_view.view_type, Some("gallery".to_string()));

        let gantt_view = ViewData::gantt_view("甘特视图");
        assert_eq!(gantt_view.view_type, Some("gantt".to_string()));
    }
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/contact/v3/department/struct.DepartmentService.html

Retrieves information for a single department.

```APIDOC
## pub async fn get(&self, department_id: &str, _req: &GetDepartmentRequest) -> SDKResult<GetDepartmentResponse>

### Description
Retrieves information for a single department.

### Parameters
- **department_id** (&str) - Required - The ID of the department to retrieve.
- **_req** (&GetDepartmentRequest) - Required - The request object.
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/wiki/v2/task/struct.TaskService.html

Retrieves the result of a specific task.

```APIDOC
## pub async fn get(&self, request: GetTaskRequest, option: Option<RequestOption>) -> SDKResult<GetTaskResponse>

### Description
Retrieves the result of a specific task.

### Parameters
- **request** (GetTaskRequest) - Required - The request object containing the task identifier.
- **option** (Option<RequestOption>) - Optional - Additional request options.

### Returns
- **SDKResult<GetTaskResponse>** - The result of the operation containing the task response or an error.
```

--------------------------------

### pub async fn move_docs_to_wiki

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/wiki/v2/task/fn.move_docs_to_wiki.html

Moves cloud space documents to a wiki space.

```APIDOC
## move_docs_to_wiki

### Description
移动云空间文档至知识空间 (Moves cloud space documents to a wiki space).

### Signature
`pub async fn move_docs_to_wiki(request: MoveDocsToWikiRequest, config: &Config, option: Option<RequestOption>) -> SDKResult<BaseResponse<MoveDocsToWikiResponse>>`

### Parameters
- **request** (MoveDocsToWikiRequest) - The request object containing details for the move operation.
- **config** (&Config) - Configuration settings for the SDK client.
- **option** (Option<RequestOption>) - Optional request options.

### Returns
- **SDKResult<BaseResponse<MoveDocsToWikiResponse>>** - A result containing the response object or an error.
```

--------------------------------

### Create File Shortcut Request Model

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/drive/v1/file.rs.html

Initial structure for creating a file shortcut.

```rust
/// 创建文件快捷方式请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CreateFileShortcutRequest {
    /// 原文件token
    pub refer_entity: ReferEntity,
    /// 快捷方式名称
    pub name: String,
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/sheets/v3/struct.SpreadsheetSheetService.html

Retrieve information about a specific sheet.

```APIDOC
## pub async fn get(&self, request: GetSpreadsheetSheetRequest, option: Option<RequestOption>) -> SDKResult<BaseResponse<GetSpreadsheetSheetResponse>>

### Description
Retrieves sheet information including ID, title, index position, and visibility status using the spreadsheet token and sheet ID.

### Parameters
- **request** (GetSpreadsheetSheetRequest) - Required - The request object containing spreadsheet token and sheet ID.
- **option** (Option<RequestOption>) - Optional - Request configuration options.
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/docx/v1/document_block/struct.DocumentBlockService.html

Retrieves the content of a specific block.

```APIDOC
## get

### Description
Retrieves the detailed content of a specific block.

### Method
SDK Method

### Parameters
- **document_id** (String) - Required - The ID of the document.
- **block_id** (String) - Required - The ID of the block.
- **option** (Option<RequestOption>) - Optional - Request configuration options.
```

--------------------------------

### Service Initialization

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/bitable/v1/app_table_view/struct.AppTableViewService.html

Constructor for creating a new instance of the service.

```rust
pub fn new(config: Config) -> Self
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/docx/v1/document/struct.DocumentService.html

Retrieves basic information about a document.

```APIDOC
## get

### Description
Retrieves basic information about a document.

### Method
SDK Method

### Parameters
- **document_id** (impl Into<String>) - Required
- **option** (Option<RequestOption>) - Optional

### Response
- **SDKResult<BaseResponse<GetDocumentRespData>>** - Returns the document information.
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/bitable/v1/app_table_view/struct.AppTableViewService.html

Retrieves details of a specific view.

```APIDOC
## pub async fn get(&self, request: GetViewRequest, option: Option<RequestOption>) -> SDKResult<BaseResponse<GetViewResponse>>

### Description
Fetches the configuration and details of a specific view.

### Parameters
- **request** (GetViewRequest) - Required - The request object containing view identification details.
- **option** (Option<RequestOption>) - Optional - Additional request configuration options.
```

--------------------------------

### Quick Creation Methods

Source: https://docs.rs/open-lark/0.13.0/open_lark/core/retry_middleware/struct.RetryStrategyBuilder.html

Static methods for quickly creating common retry strategies.

```APIDOC
## pub fn linear(max_attempts: u32, delay: Duration) -> RetryStrategy
Creates a linear retry strategy with a fixed delay.

## pub fn exponential(max_attempts: u32, base_delay: Duration, max_delay: Duration) -> RetryStrategy
Creates an exponential backoff retry strategy.
```

--------------------------------

### Subscription Configuration Helper Methods

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/assistant/v1/subscription/create.rs.html

Methods for retrieving and calculating subscription configuration details like notification intervals and priority.

```rust
impl SubscriptionConfig {
    /// 是否启用了实时通知
    pub fn has_notification(&self) -> bool {
        self.enable_notification.unwrap_or(false)
    }

    /// 获取通知频率（秒）
    pub fn get_notification_interval(&self) -> i32 {
        self.notification_interval.unwrap_or(3600)
    }

    /// 获取通知频率（分钟）
    pub fn get_notification_interval_minutes(&self) -> f64 {
        self.get_notification_interval() as f64 / 60.0
    }

    /// 获取通知频率（小时）
    pub fn get_notification_interval_hours(&self) -> f64 {
        self.get_notification_interval() as f64 / 3600.0
    }

    /// 是否为高频通知（小于1小时）
    pub fn is_high_frequency(&self) -> bool {
        self.get_notification_interval() < 3600
    }

    /// 获取优先级
    pub fn get_priority(&self) -> SubscriptionPriority {
        self.priority
            .clone()
            .unwrap_or(SubscriptionPriority::Normal)
    }

    /// 是否启用自动续费
    pub fn has_auto_renew(&self) -> bool {
        self.auto_renew.unwrap_or(false)
    }

    /// 获取标签列表
    pub fn get_tags(&self) -> Vec<String> {
        self.tags.clone().unwrap_or_default()
    }

    /// 是否包含指定标签
    pub fn has_tag(&self, tag: &str) -> bool {
        self.get_tags().contains(&tag.to_string())
    }

    /// 获取配置摘要
    pub fn summary(&self) -> String {
        let mut parts = Vec::new();

        parts.push(format!("优先级: {}", self.get_priority().description()));

        if self.has_notification() {
            let interval = self.get_notification_interval_hours();
            if interval < 1.0 {
                parts.push(format!("通知: 每{:.0}分钟", interval * 60.0));
            } else {
                parts.push(format!("通知: 每{interval:.1}小时"));
            }
        } else {
            parts.push("通知: 已禁用".to_string());
        }

        if self.has_auto_renew() {
            parts.push("自动续费: 是".to_string());
        }

        let tags = self.get_tags();
        if !tags.is_empty() {
            parts.push(format!("标签: {}", tags.join(", ")));
        }

        parts.join(" | ")
    }
}
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/bitable/v1/struct.FormService.html

Retrieves the metadata for a specific form.

```APIDOC
## get

### Description
Retrieves the metadata for a form.

### Signature
`pub async fn get(&self, request: GetFormRequest, option: Option<RequestOption>) -> SDKResult<BaseResponse<GetFormResponse>>`
```

--------------------------------

### get

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/bitable/v1/app/struct.AppService.html

Retrieves metadata for a Bitable application.

```APIDOC
## get

### Description
Retrieves metadata for a Bitable application.

### Method
SDK Method: `AppService::get`

### Parameters
- **request** (GetAppRequest) - Required - The request object containing the application identifier.
- **option** (Option<RequestOption>) - Optional - Additional request options.

### Response
- **SDKResult<BaseResponse<GetAppResponse>>** - The application metadata.
```

--------------------------------

### Initialize ListViewsRequest

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/bitable/v1/app_table_view/list.rs.html

Demonstrates creating a new request instance with required app_token and table_id parameters.

```rust
#[test]
    fn test_list_views_request_new() {
        let request = ListViewsRequest::new("bascnmBA*****yGehy8", "tblsRc9GRRXKqhvW");
        assert_eq!(request.app_token, "bascnmBA*****yGehy8");
        assert_eq!(request.table_id, "tblsRc9GRRXKqhvW");
        assert_eq!(request.page_size, None);
        assert_eq!(request.page_token, None);
    }
```

--------------------------------

### Initialize Lark Client and Sheets Operations

Source: https://docs.rs/open-lark/0.13.0/open_lark/service/cloud_docs/sheets/index.html

Demonstrates how to initialize the Lark client and provides commented examples for creating spreadsheets and writing data using the V3 API.

```rust
use open_lark::prelude::*;

let client = LarkClient::builder("app_id", "app_secret")
    .with_app_type(AppType::SelfBuild)
    .build();

// V3 版本 - 创建电子表格
// let create_request = CreateSpreadsheetRequest::builder()
//     .title("销售数据统计")
//     .folder_token("folder_token")
//     .build();
// let spreadsheet = client.sheets.v3.spreadsheet.create(create_request, None).await?;

// V3 版本 - 写入数据
// let write_request = WriteDataToMultipleRangesRequest::builder()
//     .spreadsheet_token("spreadsheet_token")
//     .value_ranges(vec![...])
//     .build();
// client.sheets.v3.data_operation.write_data_to_multiple_ranges(write_request, None).await?;
```

--------------------------------

### GET /open-apis/im/v1/images/:image_key

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/im/v1/image/mod.rs.html

Downloads an image by its key.

```APIDOC
## GET /open-apis/im/v1/images/:image_key

### Description
Retrieves an image from the server using its unique image key.

### Method
GET

### Endpoint
/open-apis/im/v1/images/{image_key}

### Parameters
#### Path Parameters
- **image_key** (string) - Required - The unique identifier of the image to download.

### Response
#### Success Response (200)
- **data** (Vec<u8>) - The raw binary data of the image.
```

--------------------------------

### Initialize ApiRequest Instances

Source: https://docs.rs/open-lark/0.13.0/open_lark/core/api_req/struct.ApiRequest.html

Examples of initializing ApiRequest for standard JSON requests and multipart file uploads.

```rust
// 普通JSON请求
let mut api_req = ApiRequest {
    http_method: Method::POST,
    api_path: "/open-apis/drive/v1/files".to_string(),
    body: serde_json::to_vec(&request_data).unwrap(),
    ..Default::default()
};

// 文件上传请求（multipart）
let mut api_req = ApiRequest {
    http_method: Method::POST,
    api_path: "/open-apis/drive/v1/files/upload".to_string(),
    body: serde_json::to_vec(&metadata).unwrap(),  // JSON元数据
    file: file_bytes,  // 文件内容
    ..Default::default()
};
```

--------------------------------

### GET /open-apis/contact/v3/job_levels

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/contact/v3/job_level.rs.html

Lists all job levels for the tenant.

```APIDOC
## GET /open-apis/contact/v3/job_levels

### Description
Retrieves a list of all job levels.

### Method
GET

### Endpoint
/open-apis/contact/v3/job_levels
```

--------------------------------

### Initialize LarkClient and Send Message

Source: https://docs.rs/open-lark/0.13.0/open_lark/client/struct.LarkClient.html

Demonstrates how to initialize a LarkClient for a self-built application and prepare a message request.

```rust
use open_lark::prelude::*;

// 创建自建应用客户端
let client = LarkClient::builder("your_app_id", "your_app_secret")
    .with_app_type(AppType::SelfBuild)
    .with_enable_token_cache(true)
    .build();

// 发送文本消息
let message = CreateMessageRequestBody::builder()
    .receive_id("ou_xxx")
    .msg_type("text")
    .content("{\"text\":\"Hello from Rust!\"}")
    .build();

let request = CreateMessageRequest::builder()
    .receive_id_type("open_id")
    .request_body(message)
    .build();

// let result = client.im.message.create(request, None).await?;
```

--------------------------------

### GET /open-apis/contact/v3/job_families

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/contact/v3/job_family.rs.html

Lists all job families for the tenant.

```APIDOC
## GET /open-apis/contact/v3/job_families

### Description
Retrieves a list of all job families associated with the tenant.

### Method
GET

### Endpoint
/open-apis/contact/v3/job_families
```

--------------------------------

### GET /open-apis/contact/v3/employee_type_enums

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/contact/v3/employee_type_enum.rs.html

Lists all employee type enumerations.

```APIDOC
## GET /open-apis/contact/v3/employee_type_enums

### Description
Lists all employee type enumerations.

### Method
GET

### Endpoint
/open-apis/contact/v3/employee_type_enums
```

--------------------------------

### Validate Cloud Docs Permission Settings

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/permission/public_v1/get.rs.html

Demonstrates the initialization of permission settings and the subsequent validation of access and security flags.

```rust
            link_share_setting: "tenant_editable".to_string(),
            password_switch: true,
            allow_copy: true,
            allow_comment: true,
            allow_save_copy: false,
            access_setting: None,
            watermark_setting: None,
        };

        assert!(settings.is_link_share_enabled());
        assert!(settings.is_tenant_accessible());
        assert!(!settings.is_anyone_accessible());
        assert!(settings.is_editable());
        assert!(!settings.is_readonly());
        assert!(settings.has_password_protection());
        assert_eq!(settings.share_level_description(), "组织内可编辑");
        assert_eq!(settings.security_level(), "较安全");
    }
}
```

--------------------------------

### Create Import Task

Source: https://docs.rs/open-lark/0.13.0/src/open_lark/service/cloud_docs/drive/v1/file.rs.html

Initiates a document import task.

```rust
pub async fn create_import_task(
        &self,
        request: CreateImportTaskRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<CreateImportTaskRespData>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: "/open-apis/drive/v1/import_tasks".to_string(),
            supported_access_token_types: vec![AccessTokenType::User, AccessTokenType::Tenant],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        let api_resp = Transport::request(api_req, &self.config, option).await?;
        Ok(api_resp)
    }
```
Tokens:
Raw