// 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"
)

// GetEHREmployeeList 根据员工飞书用户 ID / 员工状态 / 雇员类型等搜索条件, 批量获取员工花名册字段信息。字段包括「系统标准字段 / system_fields」和「自定义字段 / custom_fields」。
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/ehr/ehr-v1/employee/list
// new doc: https://open.feishu.cn/document/server-docs/ehr-v1/list
func (r *EHRService) GetEHREmployeeList(ctx context.Context, request *GetEHREmployeeListReq, options ...MethodOptionFunc) (*GetEHREmployeeListResp, *Response, error) {
	if r.cli.mock.mockEHRGetEHREmployeeList != nil {
		r.cli.Log(ctx, LogLevelDebug, "[lark] EHR#GetEHREmployeeList mock enable")
		return r.cli.mock.mockEHRGetEHREmployeeList(ctx, request, options...)
	}

	req := &RawRequestReq{
		Scope:                 "EHR",
		API:                   "GetEHREmployeeList",
		Method:                "GET",
		URL:                   r.cli.openBaseURL + "/open-apis/ehr/v1/employees",
		Body:                  request,
		MethodOption:          newMethodOption(options),
		NeedTenantAccessToken: true,
	}
	resp := new(getEHREmployeeListResp)

	response, err := r.cli.RawRequest(ctx, req, resp)
	return resp.Data, response, err
}

// MockEHRGetEHREmployeeList mock EHRGetEHREmployeeList method
func (r *Mock) MockEHRGetEHREmployeeList(f func(ctx context.Context, request *GetEHREmployeeListReq, options ...MethodOptionFunc) (*GetEHREmployeeListResp, *Response, error)) {
	r.mockEHRGetEHREmployeeList = f
}

// UnMockEHRGetEHREmployeeList un-mock EHRGetEHREmployeeList method
func (r *Mock) UnMockEHRGetEHREmployeeList() {
	r.mockEHRGetEHREmployeeList = nil
}

// GetEHREmployeeListReq ...
type GetEHREmployeeListReq struct {
	View       *string  `query:"view" json:"-"`         // 返回数据类型, 不传值默认为 basic, 示例值: basic, 可选值有: basic: 概览, 只返回 id、name 等基本信息, full: 明细, 返回系统标准字段和自定义字段集合
	Status     []int64  `query:"status" json:"-"`       // 员工状态, 不传代表查询所有员工状态, 实际在职 = 2&4, 可同时查询多个状态的记录, 如 status=2&status=4, 示例值: 2, 可选值有: 1: 待入职, 2: 在职, 3: 已取消入职, 4: 待离职, 5: 已离职
	Type       []int64  `query:"type" json:"-"`         // 人员类型, 不传代表查询所有人员类型, 同时可使用自定义员工类型的 int 值进行查询, 可通过下方接口获取到该租户的自定义员工类型的名称, 参见 [获取人员类型](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list), 示例值: 1, 可选值有: 1: 全职, 2: 实习, 3: 顾问, 4: 外包, 5: 劳务
	StartTime  *string  `query:"start_time" json:"-"`   // 查询开始时间（创建时间 >= 此时间）, 示例值: 1608690517811
	EndTime    *string  `query:"end_time" json:"-"`     // 查询结束时间（创建时间 <= 此时间）, 示例值: 1608690517811
	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
	UserIDs    []string `query:"user_ids" json:"-"`     // user_id、open_id 或 union_id, 默认为 open_id, 如果传入的值不是 open_id, 需要一并传入 user_id_type 参数, 可一次查询多个 id 的用户, 例如: user_ids=ou_8ebd4f35d7101ffdeb4771d7c8ec517e&user_ids=ou_7abc4f35d7101ffdeb4771dabcde, [用户相关的 ID 概念](https://open.feishu.cn/document/home/user-identity-introduction/introduction), 示例值: ou_8ebd4f35d7101ffdeb4771d7c8ec517e, 最大长度: `100`
	PageToken  *string  `query:"page_token" json:"-"`   // 分页标记, 第一次请求不填, 表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token, 下次遍历可采用该 page_token 获取查询结果, 示例值: 10
	PageSize   *int64   `query:"page_size" json:"-"`    // 分页大小, 取值范围 1~100, 默认 10, 示例值: 10, 取值范围: `1` ～ `100`
}

// GetEHREmployeeListResp ...
type GetEHREmployeeListResp struct {
	Items     []*GetEHREmployeeListRespItem `json:"items,omitempty"`      // 员工列表
	PageToken string                        `json:"page_token,omitempty"` // 分页标记, 当 has_more 为 true 时, 会同时返回新的 page_token, 否则不返回 page_token
	HasMore   bool                          `json:"has_more,omitempty"`   // 是否还有更多项
}

// GetEHREmployeeListRespItem ...
type GetEHREmployeeListRespItem struct {
	UserID       string                                   `json:"user_id,omitempty"`       // 员工的用户 ID, user_id_type 为 user_id 时返回 user_id；, user_id_type 为 open_id 时返回 open_id；, user_id_type 为 union_id 时返回 union_id；, 「待入职」和「已取消入职」的员工, 此字段值为 null
	SystemFields *GetEHREmployeeListRespItemSystemFields  `json:"system_fields,omitempty"` // 系统字段
	CustomFields []*GetEHREmployeeListRespItemCustomField `json:"custom_fields,omitempty"` // 自定义字段
}

// GetEHREmployeeListRespItemCustomField ...
type GetEHREmployeeListRespItemCustomField struct {
	Key   string `json:"key,omitempty"`   // 自定义字段key
	Label string `json:"label,omitempty"` // 自定义字段名称
	Type  string `json:"type,omitempty"`  // 自定义字段类型, 可选值有: text: 文本类型, date: 日期类型, 如 2020-01-01, option: 枚举类型, file: 附件类型
	Value string `json:"value,omitempty"` // 根据 type 不同, 结构不同, 不同 type 对应的数据结构在 type 的枚举值中有描述
}

// GetEHREmployeeListRespItemSystemFields ...
type GetEHREmployeeListRespItemSystemFields struct {
	Name                    string                                                 `json:"name,omitempty"`                      // 中文姓名
	EnName                  string                                                 `json:"en_name,omitempty"`                   // 英文姓名
	Email                   string                                                 `json:"email,omitempty"`                     // 邮箱
	Mobile                  string                                                 `json:"mobile,omitempty"`                    // 手机号码
	DepartmentID            string                                                 `json:"department_id,omitempty"`             // 部门的飞书 open_department_id
	Manager                 *GetEHREmployeeListRespItemSystemFieldsManager         `json:"manager,omitempty"`                   // 上级
	Job                     *GetEHREmployeeListRespItemSystemFieldsJob             `json:"job,omitempty"`                       // 职位
	JobLevel                *GetEHREmployeeListRespItemSystemFieldsJobLevel        `json:"job_level,omitempty"`                 // 职级
	WorkLocation            *GetEHREmployeeListRespItemSystemFieldsWorkLocation    `json:"work_location,omitempty"`             // 工作地点
	Gender                  int64                                                  `json:"gender,omitempty"`                    // 性别, 可选值有: 1: 男, 2: 女
	Birthday                string                                                 `json:"birthday,omitempty"`                  // 出生日期
	NativeRegion            *GetEHREmployeeListRespItemSystemFieldsNativeRegion    `json:"native_region,omitempty"`             // 籍贯
	Ethnicity               int64                                                  `json:"ethnicity,omitempty"`                 // 民族, 可选值有: 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: 其他
	MaritalStatus           int64                                                  `json:"marital_status,omitempty"`            // 婚姻状况, 可选值有: 1: 未婚, 2: 已婚, 3: 离异, 4: 其他
	PoliticalStatus         int64                                                  `json:"political_status,omitempty"`          // 政治面貌, 可选值有: 1: 中共党员, 2: 中国农工民主党, 3: 中国国民党革命委员会, 4: 中国民主促进会会员, 5: 中国民主同盟成员, 6: 中国民主建国会, 7: 中国致公党党员, 8: 九三学社社员, 9: 共青团员, 10: 其它党派成员, 11: 民主人士, 12: 群众, 13: 台湾民主自治同盟盟员
	EnteredWorkforceDate    string                                                 `json:"entered_workforce_date,omitempty"`    // 参加工作日期
	IDType                  int64                                                  `json:"id_type,omitempty"`                   // 证件类型, 可选值有: 1: 居民身份证, 2: 港澳居民来往内地通行证, 3: 台湾居民来往大陆通行证, 4: 护照, 5: 其他
	IDNumber                string                                                 `json:"id_number,omitempty"`                 // 证件号
	HukouType               int64                                                  `json:"hukou_type,omitempty"`                // 户口类型, 可选值有: 1: 本市城镇, 2: 外埠城镇, 3: 本市农村, 4: 外埠农村
	HukouLocation           string                                                 `json:"hukou_location,omitempty"`            // 户口所在地
	BankAccountNumber       string                                                 `json:"bank_account_number,omitempty"`       // 银行卡号
	BankName                string                                                 `json:"bank_name,omitempty"`                 // 开户行
	SocialSecurityAccount   string                                                 `json:"social_security_account,omitempty"`   // 社保账号
	ProvidentFundAccount    string                                                 `json:"provident_fund_account,omitempty"`    // 公积金账号
	EmployeeNo              string                                                 `json:"employee_no,omitempty"`               // 工号
	EmployeeType            int64                                                  `json:"employee_type,omitempty"`             // 人员类型, 同时可读取到自定义员工类型的 int 值, 可通过下方接口获取到该租户的自定义员工类型的名称, 参见 [获取人员类型](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list), 可选值有: 1: 正式, 2: 实习, 3: 顾问, 4: 外包, 5: 劳务
	Status                  int64                                                  `json:"status,omitempty"`                    // 员工状态, 可选值有: 1: 待入职, 2: 在职, 3: 已取消入职, 4: 待离职, 5: 已离职
	HireDate                string                                                 `json:"hire_date,omitempty"`                 // 入职日期
	ProbationMonths         float64                                                `json:"probation_months,omitempty"`          // 试用期（月）
	ConversionDate          string                                                 `json:"conversion_date,omitempty"`           // 转正日期
	Application             int64                                                  `json:"application,omitempty"`               // 转正申请, 可选值有: 1: 未申请, 2: 审批中, 3: 被驳回, 4: 已通过
	ApplicationStatus       int64                                                  `json:"application_status,omitempty"`        // 转正状态, 可选值有: 1: 无需转正, 2: 待转正, 3: 已转正
	LastDay                 string                                                 `json:"last_day,omitempty"`                  // 离职日期
	DepartureType           int64                                                  `json:"departure_type,omitempty"`            // 离职类型, 可选值有: 1: 主动, 2: 被动, 3: 其他
	DepartureReason         int64                                                  `json:"departure_reason,omitempty"`          // 离职原因, 可选值有: 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: 其他（其他）
	DepartureNotes          string                                                 `json:"departure_notes,omitempty"`           // 离职备注
	ContractCompany         *GetEHREmployeeListRespItemSystemFieldsContractCompany `json:"contract_company,omitempty"`          // 合同公司
	ContractType            int64                                                  `json:"contract_type,omitempty"`             // 合同类型, 可选值有: 1: 固定期限劳动合同, 2: 无固定期限劳动合同, 3: 实习协议, 4: 外包协议, 5: 劳务派遣合同, 6: 返聘协议, 7: 其他
	ContractStartDate       string                                                 `json:"contract_start_date,omitempty"`       // 合同开始日期
	ContractExpirationDate  string                                                 `json:"contract_expiration_date,omitempty"`  // 合同到期日期
	ContractSignTimes       int64                                                  `json:"contract_sign_times,omitempty"`       // 劳动合同签订次数
	PersonalEmail           string                                                 `json:"personal_email,omitempty"`            // 个人邮箱
	FamilyAddress           string                                                 `json:"family_address,omitempty"`            // 家庭地址
	PrimaryEmergencyContact *EHREmergencyContact                                   `json:"primary_emergency_contact,omitempty"` // 主要紧急联系人
	EmergencyContact        []*EHREmergencyContact                                 `json:"emergency_contact,omitempty"`         // 紧急联系人
	HighestLevelOfEdu       *EHREducation                                          `json:"highest_level_of_edu,omitempty"`      // 最高学历
	Education               []*EHREducation                                        `json:"education,omitempty"`                 // 教育经历
	FormerWorkExp           *EHRWorkExperience                                     `json:"former_work_exp,omitempty"`           // 前工作经历
	WorkExp                 []*EHRWorkExperience                                   `json:"work_exp,omitempty"`                  // 工作经历
	IDPhotoPoSide           []*EHRAttachment                                       `json:"id_photo_po_side,omitempty"`          // 身份证照片（人像面）
	IDPhotoEmSide           []*EHRAttachment                                       `json:"id_photo_em_side,omitempty"`          // 身份证照片（国徽面）
	IDPhoto                 []*EHRAttachment                                       `json:"id_photo,omitempty"`                  // 证件照
	DiplomaPhoto            []*EHRAttachment                                       `json:"diploma_photo,omitempty"`             // 学位证书
	GraduationCert          []*EHRAttachment                                       `json:"graduation_cert,omitempty"`           // 毕业证书
	CertOfMerit             []*EHRAttachment                                       `json:"cert_of_merit,omitempty"`             // 奖励证明
	OffboardingFile         []*EHRAttachment                                       `json:"offboarding_file,omitempty"`          // 离职证明
	CancelOnboardingReason  int64                                                  `json:"cancel_onboarding_reason,omitempty"`  // 取消入职原因, 可选值有: 1: 个人原因, 2: 原单位留任, 3: 接受其他 Offer, 4: 其他
	CancelOnboardingNotes   string                                                 `json:"cancel_onboarding_notes,omitempty"`   // 取消入职备注
	EmployeeFormStatus      int64                                                  `json:"employee_form_status,omitempty"`      // 入职登记表状态, 可选值有: 1: 未发送, 2: 待提交, 3: 已提交
	CreateTime              int64                                                  `json:"create_time,omitempty"`               // 创建时间
	UpdateTime              int64                                                  `json:"update_time,omitempty"`               // 更新时间
}

// GetEHREmployeeListRespItemSystemFieldsContractCompany ...
type GetEHREmployeeListRespItemSystemFieldsContractCompany struct {
	ID   int64  `json:"id,omitempty"`   // 公司 ID
	Name string `json:"name,omitempty"` // 公司名称
}

// GetEHREmployeeListRespItemSystemFieldsJob ...
type GetEHREmployeeListRespItemSystemFieldsJob struct {
	ID   int64  `json:"id,omitempty"`   // 职位 ID
	Name string `json:"name,omitempty"` // 职位名称
}

// GetEHREmployeeListRespItemSystemFieldsJobLevel ...
type GetEHREmployeeListRespItemSystemFieldsJobLevel struct {
	ID   int64  `json:"id,omitempty"`   // 职级 ID
	Name string `json:"name,omitempty"` // 职级名称
}

// GetEHREmployeeListRespItemSystemFieldsManager ...
type GetEHREmployeeListRespItemSystemFieldsManager struct {
	UserID string `json:"user_id,omitempty"` // 上级的用户 ID（user_id）
	Name   string `json:"name,omitempty"`    // 中文名
	EnName string `json:"en_name,omitempty"` // 英文名
}

// GetEHREmployeeListRespItemSystemFieldsNativeRegion ...
type GetEHREmployeeListRespItemSystemFieldsNativeRegion struct {
	IsoCode string `json:"iso_code,omitempty"` // ISO 编码
	Name    string `json:"name,omitempty"`     // 名称
}

// GetEHREmployeeListRespItemSystemFieldsWorkLocation ...
type GetEHREmployeeListRespItemSystemFieldsWorkLocation struct {
	ID   int64  `json:"id,omitempty"`   // 工作地点 ID
	Name string `json:"name,omitempty"` // 工作地点名称
}

// getEHREmployeeListResp ...
type getEHREmployeeListResp struct {
	Code  int64                   `json:"code,omitempty"` // 错误码, 非 0 表示失败
	Msg   string                  `json:"msg,omitempty"`  // 错误描述
	Data  *GetEHREmployeeListResp `json:"data,omitempty"`
	Error *ErrorDetail            `json:"error,omitempty"`
}
