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

// SearchApprovalInstance 该接口通过不同条件查询审批系统中符合条件的审批实例列表。
//
// 如需了解审批实例各状态的说明, 以及审批实例状态变更事件, 可参见[审批实例状态变更](https://open.feishu.cn/document/ukTMukTMukTM/uIDO24iM4YjLygjN/event/common-event/approval-instance-event)。
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/query
// new doc: https://open.feishu.cn/document/server-docs/approval-v4/approval-search/query-2
func (r *ApprovalService) SearchApprovalInstance(ctx context.Context, request *SearchApprovalInstanceReq, options ...MethodOptionFunc) (*SearchApprovalInstanceResp, *Response, error) {
	if r.cli.mock.mockApprovalSearchApprovalInstance != nil {
		r.cli.Log(ctx, LogLevelDebug, "[lark] Approval#SearchApprovalInstance mock enable")
		return r.cli.mock.mockApprovalSearchApprovalInstance(ctx, request, options...)
	}

	req := &RawRequestReq{
		Scope:                 "Approval",
		API:                   "SearchApprovalInstance",
		Method:                "POST",
		URL:                   r.cli.openBaseURL + "/open-apis/approval/v4/instances/query",
		Body:                  request,
		MethodOption:          newMethodOption(options),
		NeedTenantAccessToken: true,
	}
	resp := new(searchApprovalInstanceResp)

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

// MockApprovalSearchApprovalInstance mock ApprovalSearchApprovalInstance method
func (r *Mock) MockApprovalSearchApprovalInstance(f func(ctx context.Context, request *SearchApprovalInstanceReq, options ...MethodOptionFunc) (*SearchApprovalInstanceResp, *Response, error)) {
	r.mockApprovalSearchApprovalInstance = f
}

// UnMockApprovalSearchApprovalInstance un-mock ApprovalSearchApprovalInstance method
func (r *Mock) UnMockApprovalSearchApprovalInstance() {
	r.mockApprovalSearchApprovalInstance = nil
}

// SearchApprovalInstanceReq ...
type SearchApprovalInstanceReq struct {
	PageSize              *int64  `query:"page_size" json:"-"`                // 分页大小, 示例值: 10, 默认值: `10`, 取值范围: `5` ～ `200`
	PageToken             *string `query:"page_token" json:"-"`               // 分页标记, 第一次请求不填, 表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token, 下次遍历可采用该 page_token 获取查询结果, 示例值: nF1ZXJ5VGhlbkZldGNoCgAAAAAA6PZwFmUzSldvTC1yU
	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
	UserID                *string `json:"user_id,omitempty"`                  // 根据user_id_type填写用户 id, 示例值: "lwiu098wj"
	ApprovalCode          *string `json:"approval_code,omitempty"`            // 审批定义 code, 示例值: "EB828003-9FFE-4B3F-AA50-2E199E2ED942"
	InstanceCode          *string `json:"instance_code,omitempty"`            // 审批实例 code, 示例值: "EB828003-9FFE-4B3F-AA50-2E199E2ED943"
	InstanceExternalID    *string `json:"instance_external_id,omitempty"`     // 审批实例第三方 id 注: 和 approval_code 取并集, 示例值: "EB828003-9FFE-4B3F-AA50-2E199E2ED976"
	GroupExternalID       *string `json:"group_external_id,omitempty"`        // 审批定义分组第三方 id 注: 和 instance_code 取并集, 示例值: "1234567"
	InstanceTitle         *string `json:"instance_title,omitempty"`           // 审批实例标题（只有第三方审批有）, 示例值: "test"
	InstanceStatus        *string `json:"instance_status,omitempty"`          // 审批实例状态, 注: 若不设置, 查询全部状态 若不在集合中, 报错, 示例值: "PENDING", 可选值有: PENDING: 审批中, RECALL: 撤回, REJECT: 拒绝, DELETED: 已删除, APPROVED: 通过, ALL: 所有状态
	InstanceStartTimeFrom *string `json:"instance_start_time_from,omitempty"` // 实例查询开始时间（unix毫秒时间戳）, 示例值: "1547654251506"
	InstanceStartTimeTo   *string `json:"instance_start_time_to,omitempty"`   // 实例查询结束时间 (unix毫秒时间戳), 示例值: "1547654251506"
	Locale                *string `json:"locale,omitempty"`                   // 地区, 示例值: "zh-CN", 可选值有: zh-CN: 中文, en-US: 英文, ja-JP: 日文
}

// SearchApprovalInstanceResp ...
type SearchApprovalInstanceResp struct {
	Count        int64                                 `json:"count,omitempty"`         // 查询返回条数
	InstanceList []*SearchApprovalInstanceRespInstance `json:"instance_list,omitempty"` // 审批实例列表
	PageToken    string                                `json:"page_token,omitempty"`    // 分页标记, 当 has_more 为 true 时, 会同时返回新的 page_token, 否则不返回 page_token
	HasMore      bool                                  `json:"has_more,omitempty"`      // 是否还有更多项
}

// SearchApprovalInstanceRespInstance ...
type SearchApprovalInstanceRespInstance struct {
	Approval *SearchApprovalInstanceRespInstanceApproval `json:"approval,omitempty"` // 审批定义
	Group    *SearchApprovalInstanceRespInstanceGroup    `json:"group,omitempty"`    // 审批定义分组
	Instance *SearchApprovalInstanceRespInstanceInstance `json:"instance,omitempty"` // 审批实例信息
}

// SearchApprovalInstanceRespInstanceApproval ...
type SearchApprovalInstanceRespInstanceApproval struct {
	Code       string                                              `json:"code,omitempty"`        // 审批定义 code
	Name       string                                              `json:"name,omitempty"`        // 审批定义名称
	IsExternal bool                                                `json:"is_external,omitempty"` // 是否为第三方审批
	External   *SearchApprovalInstanceRespInstanceApprovalExternal `json:"external,omitempty"`    // 第三方审批信息
	ApprovalID string                                              `json:"approval_id,omitempty"` // 审批定义Id
	Icon       string                                              `json:"icon,omitempty"`        // 审批定义图标信息
}

// SearchApprovalInstanceRespInstanceApprovalExternal ...
type SearchApprovalInstanceRespInstanceApprovalExternal struct {
	BatchCcRead bool `json:"batch_cc_read,omitempty"` // 是否支持批量读
}

// SearchApprovalInstanceRespInstanceGroup ...
type SearchApprovalInstanceRespInstanceGroup struct {
	ExternalID string `json:"external_id,omitempty"` // 审批定义分组外部 id
	Name       string `json:"name,omitempty"`        // 审批定义分组名称
}

// SearchApprovalInstanceRespInstanceInstance ...
type SearchApprovalInstanceRespInstanceInstance struct {
	Code       string                                          `json:"code,omitempty"`        // 审批实例 code
	ExternalID string                                          `json:"external_id,omitempty"` // 审批实例外部 id
	UserID     string                                          `json:"user_id,omitempty"`     // 审批实例发起人 id
	StartTime  string                                          `json:"start_time,omitempty"`  // 审批实例开始时间
	EndTime    string                                          `json:"end_time,omitempty"`    // 审批实例结束时间
	Status     string                                          `json:"status,omitempty"`      // 审批实例状态, 可选值有: rejected: 拒绝, pending: 审批中, canceled: 撤回, deleted: 已删除, approved: 通过
	Title      string                                          `json:"title,omitempty"`       // 审批实例名称（只有第三方审批有）
	Extra      string                                          `json:"extra,omitempty"`       // 审批实例扩展字段, string型json
	SerialID   string                                          `json:"serial_id,omitempty"`   // 审批流水号
	Link       *SearchApprovalInstanceRespInstanceInstanceLink `json:"link,omitempty"`        // 审批实例链接（只有第三方审批有）
}

// SearchApprovalInstanceRespInstanceInstanceLink ...
type SearchApprovalInstanceRespInstanceInstanceLink struct {
	PcLink     string `json:"pc_link,omitempty"`     // 审批实例 pc 端链接
	MobileLink string `json:"mobile_link,omitempty"` // 审批实例移动端链接
}

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