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

// GetCoreHRJobFamily 根据 ID 查询单个序列。
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/corehr-v1/job_family/get
// new doc: https://open.feishu.cn/document/server-docs/corehr-v1/job-management/job_family/get
func (r *CoreHRService) GetCoreHRJobFamily(ctx context.Context, request *GetCoreHRJobFamilyReq, options ...MethodOptionFunc) (*GetCoreHRJobFamilyResp, *Response, error) {
	if r.cli.mock.mockCoreHRGetCoreHRJobFamily != nil {
		r.cli.Log(ctx, LogLevelDebug, "[lark] CoreHR#GetCoreHRJobFamily mock enable")
		return r.cli.mock.mockCoreHRGetCoreHRJobFamily(ctx, request, options...)
	}

	req := &RawRequestReq{
		Scope:                 "CoreHR",
		API:                   "GetCoreHRJobFamily",
		Method:                "GET",
		URL:                   r.cli.openBaseURL + "/open-apis/corehr/v1/job_families/:job_family_id",
		Body:                  request,
		MethodOption:          newMethodOption(options),
		NeedTenantAccessToken: true,
	}
	resp := new(getCoreHRJobFamilyResp)

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

// MockCoreHRGetCoreHRJobFamily mock CoreHRGetCoreHRJobFamily method
func (r *Mock) MockCoreHRGetCoreHRJobFamily(f func(ctx context.Context, request *GetCoreHRJobFamilyReq, options ...MethodOptionFunc) (*GetCoreHRJobFamilyResp, *Response, error)) {
	r.mockCoreHRGetCoreHRJobFamily = f
}

// UnMockCoreHRGetCoreHRJobFamily un-mock CoreHRGetCoreHRJobFamily method
func (r *Mock) UnMockCoreHRGetCoreHRJobFamily() {
	r.mockCoreHRGetCoreHRJobFamily = nil
}

// GetCoreHRJobFamilyReq ...
type GetCoreHRJobFamilyReq struct {
	JobFamilyID string `path:"job_family_id" json:"-"` // 序列 ID, 示例值: "1554548"
}

// GetCoreHRJobFamilyResp ...
type GetCoreHRJobFamilyResp struct {
	JobFamily *GetCoreHRJobFamilyRespJobFamily `json:"job_family,omitempty"` // 序列信息
}

// GetCoreHRJobFamilyRespJobFamily ...
type GetCoreHRJobFamilyRespJobFamily struct {
	ID             string                                        `json:"id,omitempty"`              // 序列 ID
	Name           []*GetCoreHRJobFamilyRespJobFamilyName        `json:"name,omitempty"`            // 名称
	Active         bool                                          `json:"active,omitempty"`          // 是否启用
	ParentID       string                                        `json:"parent_id,omitempty"`       // 上级序列 ID, 枚举值及详细信息可通过[批量查询序列]接口查询获得
	EffectiveTime  string                                        `json:"effective_time,omitempty"`  // 生效时间
	ExpirationTime string                                        `json:"expiration_time,omitempty"` // 失效时间
	Code           string                                        `json:"code,omitempty"`            // 编码
	CustomFields   []*GetCoreHRJobFamilyRespJobFamilyCustomField `json:"custom_fields,omitempty"`   // 自定义字段
}

// GetCoreHRJobFamilyRespJobFamilyCustomField ...
type GetCoreHRJobFamilyRespJobFamilyCustomField struct {
	FieldName string `json:"field_name,omitempty"` // 字段名
	Value     string `json:"value,omitempty"`      // 字段值, 是json转义后的字符串, 根据元数据定义不同, 字段格式不同(如123, 123.23, "true", [\"id1\", \"id2\"], "2006-01-02 15:04:05")
}

// GetCoreHRJobFamilyRespJobFamilyName ...
type GetCoreHRJobFamilyRespJobFamilyName struct {
	Lang  string `json:"lang,omitempty"`  // 名称信息的语言
	Value string `json:"value,omitempty"` // 名称信息的内容
}

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