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

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