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

// RollbackApprovalInstance 从当前审批任务, 退回到已审批的一个或多个任务节点。退回后, 已审批节点重新生成审批任务。
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/approval-v4/instance/specified_rollback
// new doc: https://open.feishu.cn/document/server-docs/approval-v4/task/specified_rollback
func (r *ApprovalService) RollbackApprovalInstance(ctx context.Context, request *RollbackApprovalInstanceReq, options ...MethodOptionFunc) (*RollbackApprovalInstanceResp, *Response, error) {
	if r.cli.mock.mockApprovalRollbackApprovalInstance != nil {
		r.cli.Log(ctx, LogLevelDebug, "[lark] Approval#RollbackApprovalInstance mock enable")
		return r.cli.mock.mockApprovalRollbackApprovalInstance(ctx, request, options...)
	}

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

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

// MockApprovalRollbackApprovalInstance mock ApprovalRollbackApprovalInstance method
func (r *Mock) MockApprovalRollbackApprovalInstance(f func(ctx context.Context, request *RollbackApprovalInstanceReq, options ...MethodOptionFunc) (*RollbackApprovalInstanceResp, *Response, error)) {
	r.mockApprovalRollbackApprovalInstance = f
}

// UnMockApprovalRollbackApprovalInstance un-mock ApprovalRollbackApprovalInstance method
func (r *Mock) UnMockApprovalRollbackApprovalInstance() {
	r.mockApprovalRollbackApprovalInstance = nil
}

// RollbackApprovalInstanceReq ...
type RollbackApprovalInstanceReq 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
	UserID         string   `json:"user_id,omitempty"`           // 当前审批任务的审批人的用户 ID, 从实例详情中的 task_list 字段获取, 且相应任务的状态必须为 PENDING, 示例值: "893g4c45"
	TaskID         string   `json:"task_id,omitempty"`           // 当前需要回退的审批任务的任务 ID, 从实例详情中的 task_list 字段获取, 且相应任务的状态必须为 PENDING, 示例值: "7026591166355210260"
	Reason         *string  `json:"reason,omitempty"`            // 退回原因, 示例值: "申请事项填写不具体, 请重新填写"
	Extra          *string  `json:"extra,omitempty"`             // 扩展字段, 示例值: "暂不填写"
	TaskDefKeyList []string `json:"task_def_key_list,omitempty"` // 需要退回到的任务 node_key。node_key 从实例详情中 timeline 字段获取, 且相应任务的状态必须为 PASS, 示例值: ["START", "APPROVAL_27997_285502", "APPROVAL_462205_2734554"], 长度范围: `1` ～ `100`
}

// RollbackApprovalInstanceResp ...
type RollbackApprovalInstanceResp struct {
}

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