open_lark/service/cloud_docs/sheets/v3/spreadsheet/
get.rs

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}
open_lark/service/cloud_docs/sheets/v3/spreadsheet/get.rs

open_lark/service/cloud_docs/sheets/v3/spreadsheet/
get.rs
