-
-
Notifications
You must be signed in to change notification settings - Fork 71
/
Copy pathapi_hire_employee_get.go
99 lines (88 loc) · 7.67 KB
/
api_hire_employee_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
// 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"
)
// GetHireEmployee 通过员工 ID 获取入职信息。
//
// doc: https://open.feishu.cn/document/ukTMukTMukTM/uMzM1YjLzMTN24yMzUjN/hire-v1/employee/get
// new doc: https://open.feishu.cn/document/server-docs/hire-v1/candidate-management/delivery-process-management/onboard/get
func (r *HireService) GetHireEmployee(ctx context.Context, request *GetHireEmployeeReq, options ...MethodOptionFunc) (*GetHireEmployeeResp, *Response, error) {
if r.cli.mock.mockHireGetHireEmployee != nil {
r.cli.Log(ctx, LogLevelDebug, "[lark] Hire#GetHireEmployee mock enable")
return r.cli.mock.mockHireGetHireEmployee(ctx, request, options...)
}
req := &RawRequestReq{
Scope: "Hire",
API: "GetHireEmployee",
Method: "GET",
URL: r.cli.openBaseURL + "/open-apis/hire/v1/employees/:employee_id",
Body: request,
MethodOption: newMethodOption(options),
NeedTenantAccessToken: true,
}
resp := new(getHireEmployeeResp)
response, err := r.cli.RawRequest(ctx, req, resp)
return resp.Data, response, err
}
// MockHireGetHireEmployee mock HireGetHireEmployee method
func (r *Mock) MockHireGetHireEmployee(f func(ctx context.Context, request *GetHireEmployeeReq, options ...MethodOptionFunc) (*GetHireEmployeeResp, *Response, error)) {
r.mockHireGetHireEmployee = f
}
// UnMockHireGetHireEmployee un-mock HireGetHireEmployee method
func (r *Mock) UnMockHireGetHireEmployee() {
r.mockHireGetHireEmployee = nil
}
// GetHireEmployeeReq ...
type GetHireEmployeeReq struct {
EmployeeID string `path:"employee_id" json:"-"` // 员工ID, 示例值: "123"
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
DepartmentIDType *DepartmentIDType `query:"department_id_type" json:"-"` // 此次调用中使用的部门 ID 的类型, 示例值: department_id, 可选值有: open_department_id: 以 open_department_id 来标识部门, department_id: 以 department_id 来标识部门, people_admin_department_id: 以 people_admin_department_id 来标识部门, 默认值: `people_admin_department_id`
JobLevelIDType *IDType `query:"job_level_id_type" json:"-"` // 此次调用中使用的「职级 ID」的类型, 示例值: 6942778198054125570, 可选值有: people_admin_job_level_id: 「人力系统管理后台」适用的职级 ID。人力系统管理后台逐步下线中, 建议不继续使用此 ID。, job_level_id: 「飞书管理后台」适用的职级 ID, 通过[「获取租户职级列表」](https://open.feishu.cn/document/server-docs/contact-v3/job_level/list)接口获取, 默认值: `people_admin_job_level_id`
JobFamilyIDType *IDType `query:"job_family_id_type" json:"-"` // 此次调用中使用的「序列 ID」的类型, 示例值: 6942778198054125571, 可选值有: people_admin_job_category_id: 「人力系统管理后台」适用的序列 ID。人力系统管理后台逐步下线中, 建议不继续使用此 ID。, job_family_id: 「飞书管理后台」适用的序列 ID, 通过[「获取租户序列列表」](https://open.feishu.cn/document/server-docs/contact-v3/job_family/list)接口获取, 默认值: `people_admin_job_category_id`
EmployeeTypeIDType *IDType `query:"employee_type_id_type" json:"-"` // 此次调用中使用的「人员类型 ID」的类型, 示例值: 1, 可选值有: people_admin_employee_type_id: 「人力系统管理后台」适用的人员类型 ID。人力系统管理后台逐步下线中, 建议不继续使用此 ID。, employee_type_enum_id: 「飞书管理后台」适用的人员类型 ID, 通过[「查询人员类型」](https://open.feishu.cn/document/server-docs/contact-v3/employee_type_enum/list)接口获取, 默认值: `people_admin_employee_type_id`
}
// GetHireEmployeeResp ...
type GetHireEmployeeResp struct {
Employee *GetHireEmployeeRespEmployee `json:"employee,omitempty"` // 员工信息
}
// GetHireEmployeeRespEmployee ...
type GetHireEmployeeRespEmployee struct {
ID string `json:"id,omitempty"` // 员工ID
ApplicationID string `json:"application_id,omitempty"` // 投递ID
OnboardStatus int64 `json:"onboard_status,omitempty"` // 入职状态, 可选值有: 1: 已入职, 2: 已离职
ConversionStatus int64 `json:"conversion_status,omitempty"` // 转正状态, 可选值有: 1: 未转正, 2: 已转正
OnboardTime int64 `json:"onboard_time,omitempty"` // 实际入职时间
ExpectedConversionTime int64 `json:"expected_conversion_time,omitempty"` // 预期转正时间
ActualConversionTime int64 `json:"actual_conversion_time,omitempty"` // 实际转正时间
OverboardTime int64 `json:"overboard_time,omitempty"` // 离职时间
OverboardNote string `json:"overboard_note,omitempty"` // 离职原因
OnboardCityCode string `json:"onboard_city_code,omitempty"` // 办公地点
Department string `json:"department,omitempty"` // 入职部门
Leader string `json:"leader,omitempty"` // 直属上级
Sequence string `json:"sequence,omitempty"` // 序列
Level string `json:"level,omitempty"` // 职级
EmployeeType EmployeeType `json:"employee_type,omitempty"` // 员工类型
}
// getHireEmployeeResp ...
type getHireEmployeeResp struct {
Code int64 `json:"code,omitempty"` // 错误码, 非 0 表示失败
Msg string `json:"msg,omitempty"` // 错误描述
Data *GetHireEmployeeResp `json:"data,omitempty"`
Error *ErrorDetail `json:"error,omitempty"`
}