// ==========================================================================
// GFast自动生成api操作代码。
// 生成日期：2024-03-25 16:43:56
// 生成路径: api/v1/system/document_quality_meeting.go
// 生成人：gfast
// desc:质量会议相关参数
// company:云南奇讯科技有限公司
// ==========================================================================

package system

import (
	"github.com/gogf/gf/v2/frame/g"
	commonApi "github.com/tiger1103/gfast/v3/api/v1/common"
	comModel "github.com/tiger1103/gfast/v3/internal/app/common/model"
	"github.com/tiger1103/gfast/v3/internal/app/system/model"
)

// DocumentQualityMeetingSearchReq 分页请求参数
type DocumentQualityMeetingSearchReq struct {
	g.Meta    `path:"/list" tags:"质量会议" method:"get" summary:"质量会议列表"`
	Id        string `p:"id"`                                                           //
	IdStr     string `p:"idStr"`                                                        // 模板id
	Pid       string `p:"pid"`                                                          // 父级（0代表顶级）
	Name      string `p:"name"`                                                         // 模板名称
	FilenPath string `p:"filenPath"`                                                    // 模板文件名
	Type      string `p:"type"`                                                         // 类型（1文件-2文件夹）
	Suffix    string `p:"suffix"`                                                       // 后缀
	CreateBy  string `p:"createBy"`                                                     // 创建人
	UpdateBy  string `p:"updateBy"`                                                     // 更新人
	CreatedAt string `p:"createdAt" v:"createdAt@datetime#创建时间需为YYYY-MM-DD hh:mm:ss格式"` // 创建时间
	ProjectId string `p:"projectId" v:"projectId@integer#项目id需为整数"`                     // 项目id
	commonApi.PageReq
	commonApi.Author
}

// DocumentQualityMeetingSearchRes 列表返回结果
type DocumentQualityMeetingSearchRes struct {
	g.Meta `mime:"application/json"`
	commonApi.ListRes
	List []*model.DocumentQualityMeetingListRes `json:"list"`
}

// DocumentQualityMeetingAddReq 添加操作请求参数
type DocumentQualityMeetingAddReq struct {
	g.Meta `path:"/add" tags:"质量会议" method:"post" summary:"质量会议添加"`
	commonApi.Author
	ProjectId int64            `p:"projectId" v:"required#项目ID不能为空"`
	Pid       string           `p:"pid" dc:"父级文件夹（如果需要在某个文件夹下导入，那么需要有此参数）" `
	FileType  string           `p:"fileType" dc:"1上传压缩文件夹 2上传文件" v:"between:1,2#范围值为1~2"`
	FilePath  *comModel.UpFile `p:"filePath" dc:"fileType为1上传压缩文件夹 2文件" v:"required-if:fileType,1#需要上传压缩文件夹"`
	// FileName  string           `p:"fileName" dc:"fileType为3填写文件夹名" v:"required-if:fileType,3#需要填写文件夹名称"`
}

// DocumentQualityMeetingAddRes 添加操作返回结果
type DocumentQualityMeetingAddRes struct {
	commonApi.EmptyRes
}

// DocumentQualityMeetingEditReq 修改操作请求参数
type DocumentQualityMeetingEditReq struct {
	g.Meta `path:"/edit" tags:"质量会议" method:"put" summary:"质量会议修改"`
	commonApi.Author
	Id        int64  `p:"id" v:"required#主键ID不能为空"`
	IdStr     string `p:"idStr" `
	Pid       string `p:"pid" `
	Name      string `p:"name" v:"required#模板名称不能为空"`
	FilenPath string `p:"filenPath" `
	Type      string `p:"type" `
	Suffix    string `p:"suffix" `
	CreateBy  string `p:"createBy" `
	UpdateBy  string `p:"updateBy" `
	ProjectId int64  `p:"projectId" `
}

// DocumentQualityMeetingEditRes 修改操作返回结果
type DocumentQualityMeetingEditRes struct {
	commonApi.EmptyRes
}

// DocumentQualityMeetingGetReq 获取一条数据请求
type DocumentQualityMeetingGetReq struct {
	g.Meta `path:"/get" tags:"质量会议" method:"get" summary:"获取质量会议信息"`
	commonApi.Author
	Id int64 `p:"id" v:"required#主键必须"` // 通过主键获取
}

// DocumentQualityMeetingGetRes 获取一条数据结果
type DocumentQualityMeetingGetRes struct {
	g.Meta `mime:"application/json"`
	List   []*model.SelectTabNameAndTabIdByDateRes `p:"list"`
}

// DocumentQualityMeetingDeleteReq 删除数据请求
type DocumentQualityMeetingDeleteReq struct {
	g.Meta `path:"/delete" tags:"质量会议" method:"delete" summary:"删除质量会议"`
	commonApi.Author
	Ids []int64 `p:"ids" v:"required#主键必须"` // 通过主键删除
}

// DocumentQualityMeetingDeleteRes 删除数据返回
type DocumentQualityMeetingDeleteRes struct {
	commonApi.EmptyRes
}

// DocumentQualityNewFolderDataReq 新建文件夹
type DocumentQualityNewFolderDataReq struct {
	g.Meta `path:"/qualityNewFolderData" tags:"质量会议" method:"post" summary:"新建文件夹"`
	commonApi.Author
	ProjectId int64  `p:"projectId" v:"required#项目ID不能为空"`
	Pid       string `p:"pid" dc:"父级文件夹（如果需要在某个文件夹下导入，那么需要有此参数）" `
	// FileType  string           `p:"fileType" dc:"1上传压缩文件夹 2上传文件 3新建文件夹" v:"between:1,3#范围值为1~3"`
	FilePath *comModel.UpFile `p:"filePath" dc:"fileType为1上传压缩文件夹 2文件" v:"required-if:fileType,1#需要上传压缩文件夹"`
	FileName string           `p:"fileName" dc:"fileType为3填写文件夹名" v:"required-if:fileType,3#需要填写文件夹名称"`
}

// DocumentQualityNewFolderDataRes 新建文件夹
type DocumentQualityNewFolderDataRes struct {
	commonApi.EmptyRes
}

// DocumentQualityDataUniFileDownloadReq 单文件下载
type DocumentQualityDataUniFileDownloadReq struct {
	g.Meta       `path:"/qualityDataUniFileDownload" tags:"质量会议" method:"get" summary:"单文件下载"`
	RelativePath string `p:"relativePath" dc:"相对路径" v:"required#相对路径不能为空"`
	Type         string `p:"type" dc:"1文件下载 2文件夹下载" v:"required#相对路径不能为空"`

	commonApi.Author
}

// DocumentQualityDataUniFileDownloadRes 单文件下载
type DocumentQualityDataUniFileDownloadRes struct {
	commonApi.EmptyRes
	Path string `p:"path" dc:"文件夹压缩包下载路径"`
}

// DocumentQualityTreeStructureReq 树形结构
type DocumentQualityTreeStructureReq struct {
	g.Meta    `path:"/qualityTreeStructure" tags:"质量会议" method:"get" summary:"树形结构"`
	ProjectId string `p:"projectId" v:"projectId@integer#项目id需为整数"` // 项目id
	Pid       string `p:"pid"`                                      // 父级（0代表顶级）
	// Name      string `p:"name"`                                     //模板名称
	// Suffix    string `p:"suffix"`                                   //后缀
	commonApi.Author
}

// DocumentQualityTreeStructureRes 树形结构
type DocumentQualityTreeStructureRes struct {
	g.Meta `mime:"application/json"`
	List   []*model.DocumentQualityMeetingListRes `json:"list"`
}

// DocumentQualitySelectByPidReq 获取pid
type DocumentQualitySelectByPidReq struct {
	g.Meta    `path:"/qualitySelectByPid" tags:"质量会议" method:"get" summary:"获取pid"`
	ProjectId string `p:"projectId" v:"projectId@integer#项目id需为整数"`
	PathName  string `p:"pathName" dc:"路径地址（例子：/xxxx/xxxx）" v:"required#路径地址不能为空"`
	commonApi.Author
}

// DocumentQualitySelectByPidRes 获取pid
type DocumentQualitySelectByPidRes struct {
	g.Meta `mime:"application/json"`
	Pid    string `p:"pid" dc:"pid"`
}

// DocumentQualityDataRecyclingStationReq 回收站
type DocumentQualityDataRecyclingStationReq struct {
	g.Meta `path:"/qualityDataRecyclingStation" tags:"质量会议" method:"put" summary:"回收站恢复及删除（删除已被注释）"`
	commonApi.Author
	Ids []int64 `p:"ids" v:"required#主键ID不能为空"`
	// Type string  `p:"type" dc:"1恢复 2删除" v:"between:1,1#范围值为1"`
	Type string `p:"type" dc:"1恢复" `
}

// DocumentQualityDataRecyclingStationRes 回收站
type DocumentQualityDataRecyclingStationRes struct {
	commonApi.EmptyRes
}

// DocumentQualityRecycleBinListReq 不分页请求参数
type DocumentQualityRecycleBinListReq struct {
	g.Meta    `path:"/qualityRecycleBinList" tags:"质量会议" method:"get" summary:"回收站数据加载"`
	ProjectId int64  `p:"projectId" v:"required#项目ID不能为空"`
	Type      string `p:"type" dc:"1未删除的全部 2删除的全部 3全部（删除+未删除）" v:"between:1,3#范围值为1~3"`
	commonApi.Author
}

// DocumentQualityRecycleBinListRes 不分页请求参数
type DocumentQualityRecycleBinListRes struct {
	g.Meta `mime:"application/json"`
	List   []*model.DocumentQualityMeetingInfoRes `json:"list"`
}