-
-
Notifications
You must be signed in to change notification settings - Fork 71
/
Copy pathapi_drive_file_meta_get.go
104 lines (91 loc) · 6.49 KB
/
api_drive_file_meta_get.go
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
// Code generated by lark_sdk_gen. DO NOT EDIT.
/**
* Copyright 2022 chyroc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package lark
import (
"context"
)
// GetDriveFileMeta 该接口用于根据文件 token 获取其元数据, 包括标题、所有者、创建时间、密级、访问链接等数据。
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/meta/batch_query
// new doc: https://open.feishu.cn/document/server-docs/docs/drive-v1/file/batch_query
func (r *DriveService) GetDriveFileMeta(ctx context.Context, request *GetDriveFileMetaReq, options ...MethodOptionFunc) (*GetDriveFileMetaResp, *Response, error) {
if r.cli.mock.mockDriveGetDriveFileMeta != nil {
r.cli.Log(ctx, LogLevelDebug, "[lark] Drive#GetDriveFileMeta mock enable")
return r.cli.mock.mockDriveGetDriveFileMeta(ctx, request, options...)
}
req := &RawRequestReq{
Scope: "Drive",
API: "GetDriveFileMeta",
Method: "POST",
URL: r.cli.openBaseURL + "/open-apis/drive/v1/metas/batch_query",
Body: request,
MethodOption: newMethodOption(options),
NeedTenantAccessToken: true,
NeedUserAccessToken: true,
}
resp := new(getDriveFileMetaResp)
response, err := r.cli.RawRequest(ctx, req, resp)
return resp.Data, response, err
}
// MockDriveGetDriveFileMeta mock DriveGetDriveFileMeta method
func (r *Mock) MockDriveGetDriveFileMeta(f func(ctx context.Context, request *GetDriveFileMetaReq, options ...MethodOptionFunc) (*GetDriveFileMetaResp, *Response, error)) {
r.mockDriveGetDriveFileMeta = f
}
// UnMockDriveGetDriveFileMeta un-mock DriveGetDriveFileMeta method
func (r *Mock) UnMockDriveGetDriveFileMeta() {
r.mockDriveGetDriveFileMeta = nil
}
// GetDriveFileMetaReq ...
type GetDriveFileMetaReq struct {
UserIDType *IDType `query:"user_id_type" json:"-"` // 用户 ID 类型, 示例值: open_id, 可选值有: open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多: 如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid), union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的, 在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID, 应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多: 如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id), user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内, 一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多: 如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id), 默认值: `open_id`, 当值为 `user_id`, 字段权限要求: 获取用户 user ID
RequestDocs []*GetDriveFileMetaReqRequestDocs `json:"request_docs,omitempty"` // 请求的文件的 token 和类型。一次请求中不可超过 200 个, 长度范围: `1` ～ `200`
WithURL *bool `json:"with_url,omitempty"` // 是否获取文件的访问链接, 示例值: false
}
// GetDriveFileMetaReqRequestDocs ...
type GetDriveFileMetaReqRequestDocs struct {
DocToken string `json:"doc_token,omitempty"` // 文件的 token, 获取方式见[文件概述](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/drive-v1/file/file-overview), 示例值: "doccnfYZzTlvXqZIGTdAHKabcef"
DocType string `json:"doc_type,omitempty"` // 文件的类型, 示例值: "doc", 可选值有: doc: 飞书文档, sheet: 飞书电子表格, bitable: 飞书多维表格, mindnote: 飞书思维笔记, file: 飞书文件, wiki: 飞书知识库, docx: 飞书新版文档, folder: 飞书文件夹, synced_block: 文档同步块（灰度中）
}
// GetDriveFileMetaResp ...
type GetDriveFileMetaResp struct {
Metas []*GetDriveFileMetaRespMeta `json:"metas,omitempty"` // 文件的元数据列表
FailedList []*GetDriveFileMetaRespFailed `json:"failed_list,omitempty"` // 获取元数据失败的文档 token 列表
}
// GetDriveFileMetaRespFailed ...
type GetDriveFileMetaRespFailed struct {
Token string `json:"token,omitempty"` // 获取元数据失败的文档token
Code int64 `json:"code,omitempty"` // 获取元数据失败的错误码, 可选值有: 970002: 文档类型不支持, 970003: 当前应用或用户没有获取该文件元数据的权限, 970005: 文件 token 和 doc_type 不匹配或该文件不存在
}
// GetDriveFileMetaRespMeta ...
type GetDriveFileMetaRespMeta struct {
DocToken string `json:"doc_token,omitempty"` // 文件的 token
DocType string `json:"doc_type,omitempty"` // 文件的类型
Title string `json:"title,omitempty"` // 标题
OwnerID string `json:"owner_id,omitempty"` // 文件的所有者
CreateTime string `json:"create_time,omitempty"` // 创建时间。UNIX 时间戳, 单位为秒
LatestModifyUser string `json:"latest_modify_user,omitempty"` // 最后编辑者
LatestModifyTime string `json:"latest_modify_time,omitempty"` // 最后编辑时间。UNIX 时间戳, 单位为秒
URL string `json:"url,omitempty"` // 文档访问链接
SecLabelName string `json:"sec_label_name,omitempty"` // 文档密级标签名称, 字段权限要求: 获取文档密级标签名称
}
// getDriveFileMetaResp ...
type getDriveFileMetaResp struct {
Code int64 `json:"code,omitempty"` // 错误码, 非 0 表示失败
Msg string `json:"msg,omitempty"` // 错误描述
Data *GetDriveFileMetaResp `json:"data,omitempty"`
Error *ErrorDetail `json:"error,omitempty"`
}