// ==========================================================================
// GFast自动生成api操作代码。
// 生成日期：2023-09-01 17:36:18
// 生成路径: api/v1/test/test_contact_info.go
// 生成人：yqq
// desc:业主方联系人关联相关参数
// company:云南奇讯科技有限公司
// ==========================================================================

package test

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

// TestContactInfoSearchReq 分页请求参数
type TestContactInfoSearchReq struct {
	g.Meta       `path:"/list" tags:"业主方联系人关联" method:"get" summary:"业主方联系人关联列表"`
	Id           string `p:"id"`                                 //
	OwenerId     string `p:"owenerId" v:"owenerId@integer#需为整数"` //
	ContactName  string `p:"contactName"`                        //
	ContactPost  string `p:"contactPost"`                        //
	ContactPhone string `p:"contactPhone"`                       //
	commonApi.PageReq
	commonApi.Author
}

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

// TestContactInfoAddReq 添加操作请求参数
type TestContactInfoAddReq struct {
	g.Meta `path:"/add" tags:"业主方联系人关联" method:"post" summary:"业主方联系人关联添加"`
	commonApi.Author
	WxOrPc       string `p:"wxOrPc" dc:"参数为1表示pc添加 否则为小程序添加"`
	Creator      string `p:"creator" v:"phone"`
	OwenerId     uint   `p:"owenerId" `
	ContactName  string `p:"contactName" v:"required#不能为空"`
	ContactPost  string `p:"contactPost" `
	ContactPhone string `p:"contactPhone" `
}

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

// TestContactInfoEditReq 修改操作请求参数
type TestContactInfoEditReq struct {
	g.Meta `path:"/edit" tags:"业主方联系人关联" method:"put" summary:"业主方联系人关联修改"`
	commonApi.Author
	Creator      string `p:"creator" v:"phone" dc:"小程序需要传递当前用户的电话"`
	WxOrPc       string `p:"wxOrPc" dc:"参数为1表示pc添加 否则为小程序添加"`
	Id           uint   `p:"id" v:"required#主键ID不能为空"`
	OwenerId     uint   `p:"owenerId" `
	ContactName  string `p:"contactName" v:"required#不能为空"`
	ContactPost  string `p:"contactPost" `
	ContactPhone string `p:"contactPhone" `
}

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

// TestContactInfoGetReq 获取一条数据请求
type TestContactInfoGetReq struct {
	g.Meta `path:"/get" tags:"业主方联系人关联" method:"get" summary:"获取业主方联系人关联信息"`
	commonApi.Author
	Id uint `p:"id" v:"required#主键必须"` //通过主键获取
}

// TestContactInfoGetRes 获取一条数据结果
type TestContactInfoGetRes struct {
	g.Meta `mime:"application/json"`
	*model.TestContactInfoInfoRes
}

// TestContactInfoDeleteReq 删除数据请求
type TestContactInfoDeleteReq struct {
	g.Meta `path:"/delete" tags:"业主方联系人关联" method:"delete" summary:"删除业主方联系人关联"`
	commonApi.Author
	Ids []uint `p:"ids" v:"required#主键必须"` //通过主键删除
}

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