openlark-docs 0.16.0

飞书开放平台云文档服务模块 - 文档、表格、知识库API (202 APIs, 100% 覆盖,不含旧版本)
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
/// CCM Sheet V2 数据读写模型
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// 读取单个范围请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ReadSingleRangeParams {
    /// 范围参数,如 "Sheet1!A1:C10"
    #[serde(rename = "value_range")]
    pub value_range: String,
    /// 是否返回格式化值
    #[serde(rename = "value_render_option")]
    pub value_render_option: Option<String>,
    /// 日期格式化
    #[serde(rename = "date_render_option")]
    pub date_render_option: Option<String>,
}

/// 读取单个范围响应
#[derive(Debug, Clone, Serialize, Default)]
pub struct ReadSingleRangeResponse {
    /// 范围数据
    pub data: Option<RangeData>,
}

impl<'de> Deserialize<'de> for ReadSingleRangeResponse {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let raw = Value::deserialize(deserializer)?;

        // 兼容两种形状:
        // 1) { data: { ... } }
        // 2) { spreadsheetToken, revision, valueRange: { ... } }
        if let Some(inner) = raw.get("data") {
            let data: RangeData =
                serde_json::from_value(inner.clone()).map_err(serde::de::Error::custom)?;
            return Ok(Self { data: Some(data) });
        }

        let spreadsheet_token = raw
            .get("spreadsheet_token")
            .or_else(|| raw.get("spreadsheetToken"))
            .and_then(Value::as_str)
            .unwrap_or_default()
            .to_string();

        if let Some(value_range_obj) = raw.get("valueRange").or_else(|| raw.get("value_range")) {
            let value_range = value_range_obj
                .get("range")
                .and_then(Value::as_str)
                .unwrap_or_default()
                .to_string();
            let major_dimension = value_range_obj
                .get("majorDimension")
                .or_else(|| value_range_obj.get("major_dimension"))
                .and_then(Value::as_str)
                .unwrap_or("ROWS")
                .to_string();
            let values = value_range_obj
                .get("values")
                .and_then(Value::as_array)
                .map(|rows| {
                    rows.iter()
                        .map(|row| row.as_array().cloned().unwrap_or_default())
                        .collect::<Vec<Vec<Value>>>()
                })
                .unwrap_or_default();

            return Ok(Self {
                data: Some(RangeData {
                    spreadsheet_token,
                    value_range,
                    major_dimension,
                    values,
                }),
            });
        }

        Ok(Self { data: None })
    }
}

/// 范围数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RangeData {
    /// 电子表格token
    #[serde(rename = "spreadsheet_token")]
    pub spreadsheet_token: String,
    /// 范围信息
    #[serde(rename = "value_range")]
    pub value_range: String,
    /// 主要维度
    #[serde(rename = "major_dimension")]
    pub major_dimension: String,
    /// 行数据
    pub values: Vec<Vec<serde_json::Value>>,
}

/// 读取多个范围请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ReadMultipleRangesParams {
    /// 范围列表
    pub ranges: Vec<String>,
    /// 是否返回格式化值
    #[serde(rename = "value_render_option")]
    pub value_render_option: Option<String>,
    /// 日期格式化
    #[serde(rename = "date_render_option")]
    pub date_render_option: Option<String>,
}

/// 读取多个范围响应
#[derive(Debug, Clone, Serialize, Default)]
pub struct ReadMultipleRangesResponse {
    /// 范围数据列表
    pub data: Option<MultipleRangeData>,
}

impl<'de> Deserialize<'de> for ReadMultipleRangesResponse {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let raw = Value::deserialize(deserializer)?;

        // 兼容两种形状:
        // 1) { data: { ... } }
        // 2) { spreadsheetToken, valueRanges: [...] }
        if let Some(inner) = raw.get("data") {
            let data: MultipleRangeData =
                serde_json::from_value(inner.clone()).map_err(serde::de::Error::custom)?;
            return Ok(Self { data: Some(data) });
        }

        let spreadsheet_token = raw
            .get("spreadsheet_token")
            .or_else(|| raw.get("spreadsheetToken"))
            .and_then(Value::as_str)
            .unwrap_or_default()
            .to_string();

        let value_ranges = raw
            .get("value_ranges")
            .or_else(|| raw.get("valueRanges"))
            .and_then(Value::as_array)
            .map(|ranges| {
                ranges
                    .iter()
                    .map(|range| RangeData {
                        spreadsheet_token: spreadsheet_token.clone(),
                        value_range: range
                            .get("range")
                            .and_then(Value::as_str)
                            .unwrap_or_default()
                            .to_string(),
                        major_dimension: range
                            .get("major_dimension")
                            .or_else(|| range.get("majorDimension"))
                            .and_then(Value::as_str)
                            .unwrap_or("ROWS")
                            .to_string(),
                        values: range
                            .get("values")
                            .and_then(Value::as_array)
                            .map(|rows| {
                                rows.iter()
                                    .map(|row| row.as_array().cloned().unwrap_or_default())
                                    .collect::<Vec<Vec<Value>>>()
                            })
                            .unwrap_or_default(),
                    })
                    .collect::<Vec<RangeData>>()
            })
            .unwrap_or_default();

        if value_ranges.is_empty() {
            return Ok(Self { data: None });
        }

        Ok(Self {
            data: Some(MultipleRangeData {
                spreadsheet_token,
                value_ranges,
            }),
        })
    }
}

/// 多个范围数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct MultipleRangeData {
    /// 电子表格token
    #[serde(rename = "spreadsheet_token")]
    pub spreadsheet_token: String,
    /// 范围数据列表
    #[serde(rename = "value_ranges")]
    pub value_ranges: Vec<RangeData>,
}

/// 写入单个范围请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WriteSingleRangeParams {
    /// 范围参数,如 "Sheet1!A1:C10"
    #[serde(rename = "range")]
    pub range: String,
    /// 主要维度
    #[serde(rename = "major_dimension")]
    pub major_dimension: Option<String>,
    /// 行数据
    pub values: Vec<Vec<serde_json::Value>>,
}

/// 写入单个范围响应
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct WriteSingleRangeResponse {
    /// 更新结果
    pub data: Option<UpdateRangeResult>,
}

/// 更新范围结果
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UpdateRangeResult {
    /// 电子表格token
    #[serde(rename = "spreadsheet_token")]
    pub spreadsheet_token: String,
    /// 更新的范围
    #[serde(rename = "updated_range")]
    pub updated_range: String,
    /// 更新的行数
    #[serde(rename = "updated_rows")]
    pub updated_rows: i32,
    /// 更新的列数
    #[serde(rename = "updated_columns")]
    pub updated_columns: i32,
    /// 更新的单元格数
    #[serde(rename = "updated_cells")]
    pub updated_cells: i32,
}

/// 批量写入范围请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BatchWriteRangesParams {
    /// 写入数据
    pub data: Vec<BatchWriteData>,
    /// 是否包含格式
    #[serde(rename = "include_style")]
    pub include_style: Option<bool>,
}

/// 批量写入数据
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BatchWriteData {
    /// 数据范围
    #[serde(rename = "data_range")]
    pub data_range: String,
    /// 主要维度
    #[serde(rename = "major_dimension")]
    pub major_dimension: String,
    /// 行数据
    pub values: Vec<Vec<serde_json::Value>>,
}

/// 批量写入范围响应
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BatchWriteRangesResponse {
    /// 批量更新结果
    pub data: Option<BatchUpdateResult>,
}

/// 批量更新结果
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BatchUpdateResult {
    /// 电子表格token
    #[serde(rename = "spreadsheet_token")]
    pub spreadsheet_token: String,
    /// 更新结果列表
    #[serde(rename = "updated_ranges")]
    pub updated_ranges: Vec<UpdateRangeResult>,
    /// 总更新行数
    #[serde(rename = "total_updated_rows")]
    pub total_updated_rows: i32,
    /// 总更新列数
    #[serde(rename = "total_updated_columns")]
    pub total_updated_columns: i32,
    /// 总更新单元格数
    #[serde(rename = "total_updated_cells")]
    pub total_updated_cells: i32,
    /// 是否包含格式
    #[serde(rename = "total_updated_styles")]
    pub total_updated_styles: i32,
}

/// 追加数据请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AppendValuesParams {
    /// 追加范围
    #[serde(rename = "range")]
    pub range: String,
    /// 主要维度
    #[serde(rename = "major_dimension")]
    pub major_dimension: Option<String>,
    /// 追加的行数据
    pub values: Vec<Vec<serde_json::Value>>,
}

/// 追加数据响应
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AppendValuesResponse {
    /// 追加结果
    pub data: Option<AppendResult>,
}

/// 追加结果
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AppendResult {
    /// 电子表格token
    #[serde(rename = "spreadsheet_token")]
    pub spreadsheet_token: String,
    /// 更新的范围
    #[serde(rename = "updated_range")]
    pub updated_range: String,
    /// 更新的行数
    #[serde(rename = "updated_rows")]
    pub updated_rows: i32,
    /// 更新的列数
    #[serde(rename = "updated_columns")]
    pub updated_columns: i32,
    /// 更新的单元格数
    #[serde(rename = "updated_cells")]
    pub updated_cells: i32,
}

/// 插入数据请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct InsertValuesParams {
    /// 插入范围
    #[serde(rename = "range")]
    pub range: String,
    /// 主要维度
    #[serde(rename = "major_dimension")]
    pub major_dimension: Option<String>,
    /// 插入的行数据
    pub values: Vec<Vec<serde_json::Value>>,
}

/// 插入数据响应
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct InsertValuesResponse {
    /// 插入结果
    pub data: Option<InsertResult>,
}

/// 插入结果
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct InsertResult {
    /// 电子表格token
    #[serde(rename = "spreadsheet_token")]
    pub spreadsheet_token: String,
    /// 更新的范围
    #[serde(rename = "updated_range")]
    pub updated_range: String,
    /// 更新的行数
    #[serde(rename = "updated_rows")]
    pub updated_rows: i32,
    /// 更新的列数
    #[serde(rename = "updated_columns")]
    pub updated_columns: i32,
    /// 更新的单元格数
    #[serde(rename = "updated_cells")]
    pub updated_cells: i32,
}

/// 写入图片请求参数
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ValuesImageParams {
    /// 范围参数,如 "Sheet1!A1:C10"
    #[serde(rename = "range")]
    pub range: String,
    /// 主要维度
    #[serde(rename = "major_dimension")]
    pub major_dimension: Option<String>,
    /// 图片数据
    pub values: Vec<ImageValue>,
}

/// 图片值
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ImageValue {
    /// 图片数据
    #[serde(rename = "image_key")]
    pub image_key: String,
    /// 替代文本
    #[serde(rename = "alternative_text")]
    pub alternative_text: Option<String>,
}

/// 写入图片响应
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ValuesImageResponse {
    /// 图片写入结果
    pub data: Option<ImageResult>,
}

/// 图片写入结果
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ImageResult {
    /// 电子表格token
    #[serde(rename = "spreadsheet_token")]
    pub spreadsheet_token: String,
    /// 更新的范围
    #[serde(rename = "updated_range")]
    pub updated_range: String,
    /// 更新的行数
    #[serde(rename = "updated_rows")]
    pub updated_rows: i32,
    /// 更新的列数
    #[serde(rename = "updated_columns")]
    pub updated_columns: i32,
    /// 更新的单元格数
    #[serde(rename = "updated_cells")]
    pub updated_cells: i32,
}

#[cfg(test)]
mod tests {

    use serde_json;

    #[test]
    fn test_serialization_roundtrip() {
        // 基础序列化测试
        let json = r#"{"test": "value"}"#;
        assert!(serde_json::from_str::<serde_json::Value>(json).is_ok());
    }

    #[test]
    fn test_deserialization_from_json() {
        // 基础反序列化测试
        let json = r#"{"field": "data"}"#;
        let value: serde_json::Value = serde_json::from_str(json).expect("JSON 反序列化失败");
        assert_eq!(value["field"], "data");
    }
}