schema

type Address struct {
	AddressPure
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type AddressPure struct {
	Id           string  `json:"id"`            // 地址ID
	Name         string  `json:"name"`          // 收货人
	Phone        string  `json:"phone"`         // 收货人手机号
	ProvinceCode string  `json:"province_code"` // 省份代码
	CityCode     string  `json:"city_code"`     // 城市代码
	AreaCode     string  `json:"area_code"`     // 区域代码
	StreetCode   string  `json:"street_code"`   // 街道/乡镇代码
	Address      string  `json:"address"`       // 详细的地址
	IsDefault    bool    `json:"is_default"`    // 是否是默认地址
	Note         *string `json:"note"`          // 备注，例如 `家`/`公司`/`学校`
}

type AdminProfile struct {
	AdminProfilePure
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type AdminProfilePure struct {
	Id        string            `json:"id"`        // 用户ID
	Username  string            `json:"username"`  // 用户名, 用于登陆
	Name      string            `json:"name"`      // 管理员名
	Accession []string          `json:"accession"` // 管理员所拥有的权限
	IsSuper   bool              `json:"is_super"`  // 是否是超级管理员, 超级管理员全站应该只有一个
	Status    model.AdminStatus `json:"status"`    // 状态
}

type AdminProfileWithToken struct {
	AdminProfile
	Token string `json:"token"`
}

type Banner struct {
	BannerPure
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type BannerPure struct {
	Id          string               `json:"id"`           // 地址ID
	Image       string               `json:"image"`        // 图片 URL
	Href        string               `json:"href"`         // 点击图片跳转 URL
	Platform    model.BannerPlatform `json:"platform"`     // 平台
	Description *string              `json:"description"`  // 描述
	Priority    *string              `json:"priority"`     // 优先级，用于排序
	Identifier  *string              `json:"identifier"`   // APP 跳转标识符
	FallbackUrl *string              `json:"fallback_url"` // APP 跳转标识符的备选方案
}

type Config struct {
	Fields    interface{} `json:"fields"`
	CreatedAt string      `json:"created_at"`
	UpdatedAt string      `json:"updated_at"`
}

type FileResponse struct {
	Hash         string `json:"hash"`          // 文件 hash
	Filename     string `json:"filename"`      // 存储在服务端的文件名
	Origin       string `json:"origin"`        // 上传文件的原始名
	Size         int64  `json:"size"`          // 文件大小
	RawPath      string `json:"raw_path"`      // 纯文本的文件路径, 需要拼接上域名
	DownloadPath string `json:"download_path"` // 下载的文件路径, 需要拼接上域名
}

type Help struct {
	HelpPure
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type HelpPure struct {
	Id       string           `json:"id"`        // 帮助文章ID
	Title    string           `json:"title"`     // 帮助文章标题
	Content  string           `json:"content"`   // 帮助文章内容
	Tags     []string         `json:"tags"`      // 帮助文章的标签
	Status   model.HelpStatus `json:"status"`    // 帮助文章状态
	Type     model.HelpType   `json:"type"`      // 帮助文章的类型
	ParentId *string          `json:"parent_id"` // 父级 ID，如果有的话
}

type Invite struct {
	InvitePure
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type InvitePure struct {
	Id            string `json:"id"`
	Inviter       string `json:"inviter"`        // 邀请人
	Invitee       string `json:"invitee"`        // 受邀请人, 只有唯一的一个
	Status        int32  `json:"status"`         // 受邀请人的激活状态
	RewardSettled bool   `json:"reward_settled"` // 是否已发放奖励, 包括邀请人和收邀请人的奖励
}

type LogLogin struct {
	LogLoginPure
	User      ProfilePublic `json:"user"`
	CreatedAt string        `json:"created_at"`
	UpdatedAt string        `json:"updated_at"`
}

type LogLoginPure struct {
	Id      string `json:"id"`
	Uid     string `json:"uid"`
	Type    int    `json:"type"`
	Command int    `json:"command"`
	LastIp  string `json:"last_ip"`
	Client  string `json:"client"`
}

type Menu struct {
	MenuPure
	Children  []Menu `json:"children"` // 子菜单
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type MenuPure struct {
	Id        string   `json:"id"`
	ParentId  string   `json:"parent_id"` // 该菜单的父级 ID
	Name      string   `json:"name"`      // 菜单名
	Url       string   `json:"url"`       // 菜单链接的 URL 地址
	Icon      string   `json:"icon"`      // 菜单的图标
	Accession []string `json:"accession"` // 该菜单所需要的权限
	Sort      int      `json:"sort"`      // 菜单排序, 越大的越靠前
}

type MenuTreeItem struct {
	Menu
	Children []*MenuTreeItem
}

type Message struct {
	MessagePure
	ReadAt    *string `json:"read_at"`    // 用户读取的时间
	CreatedAt string  `json:"created_at"` // 创建时间
	UpdatedAt string  `json:"updated_at"` // 更新时间
}

type MessageAdmin struct {
	MessagePureAdmin
	ReadAt    *string `json:"read_at"`    // 用户读取的时间
	CreatedAt string  `json:"created_at"` // 创建时间
	UpdatedAt string  `json:"updated_at"` // 更新时间
}

type MessagePure struct {
	Id      string  `json:"id"`      // 消息ID
	Title   string  `json:"title"`   // 消息标题
	Content string  `json:"content"` // 消息内容
	Read    bool    `json:"read"`    // 用户是否已读
	Note    *string `json:"note"`    // 备注
}

type MessagePureAdmin struct {
	Id      string  `json:"id"`      // 消息ID
	Uid     string  `json:"uid"`     // 用户 UID
	Title   string  `json:"title"`   // 消息标题
	Content string  `json:"content"` // 消息内容
	Read    bool    `json:"read"`    // 用户是否已读
	Note    *string `json:"note"`    // 备注
}

type MessageStatus struct {
	Unread int64 `json:"unread"` // 未读数量
}

type Meta struct {
	Limit    int     `json:"limit"`              // 当前请求获取多少条数据， 默认 10
	Page     int     `json:"page"`               // 当前第几页，默认 0 开始
	Total    int64   `json:"total"`              // 数据总量
	Num      int     `json:"num"`                // 当前返回的数据流
	Sort     string  `json:"sort"`               // 排序
	Platform *string `json:"platform,omitempty"` // 平台
}

type Name struct {
	Field       string `json:"field"`       // 字段名称
	Description string `json:"description"` // 配置描述
}

type News struct {
	NewsPure
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type NewsPure struct {
	Id      string           `json:"id"`
	Author  string           `json:"author"`
	Title   string           `json:"title"`
	Content string           `json:"content"`
	Type    model.NewsType   `json:"type"`
	Tags    []string         `json:"tags"`
	Status  model.NewsStatus `json:"status"`
}

type Notification struct {
	NotificationPure
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type NotificationAdmin struct {
	NotificationPureAdmin
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type NotificationPure struct {
	Id      string  `json:"id"`
	Title   string  `json:"title"`
	Content string  `json:"content"`
	Read    bool    `json:"read"`    // 用户是否已读
	ReadAt  string  `json:"read_at"` // 用户读取的时间
	Note    *string `json:"note"`
}

type NotificationPureAdmin struct {
	Id      string  `json:"id"`
	Author  string  `json:"author"`
	Title   string  `json:"title"`
	Content string  `json:"content"`
	Note    *string `json:"note"`
}

type Order string

type Profile struct {
	ProfilePure
	PayPassword bool               `json:"pay_password"` // 是否已设置交易密码
	Wechat      *WechatBindingInfo `json:"wechat"`       // 绑定的微信帐号信息，没有是为 null
	CreatedAt   string             `json:"created_at"`
	UpdatedAt   string             `json:"updated_at"`
}

type ProfilePublic struct {
	Id       string  `json:"id"`
	Username string  `json:"username"`
	Nickname *string `json:"nickname"`
	Avatar   string  `json:"avatar"`
}

type ProfilePure struct {
	Id                      string   `json:"id"`
	Username                string   `json:"username"`
	Nickname                *string  `json:"nickname"`
	Email                   *string  `json:"email"`
	Phone                   *string  `json:"phone"`
	Status                  int32    `json:"status"`
	Gender                  int      `json:"gender"`
	Avatar                  string   `json:"avatar"`
	Role                    []string `json:"role"`
	Level                   int32    `json:"level"`
	InviteCode              string   `json:"invite_code"`
	UsernameRenameRemaining int      `json:"username_rename_remaining"`
}

type ProfileWithToken struct {
	Profile
	Token string `json:"token"`
}

type Query struct {
	Limit    int     `json:"limit" url:"limit" validate:"omitempty,number,gte=1" comment:"每页数量"`
	Page     int     `json:"page" url:"page" validate:"omitempty,number,gte=0" comment:"页数"`
	Sort     string  `json:"sort" url:"sort" validate:"omitempty,max=255" comment:"排序"`
	Platform *string `json:"platform" url:"platform" validate:"omitempty,max=16" comment:"平台"`
	Total    *int    `json:"total" url:"total" validate:"omitempty" comment:"总数"` // 客户端应该不传过来，定义在这里只是允许接收这个参数
	Num      *int    `json:"num" url:"num" validate:"omitempty" comment:"当前页数"`   // 客户端应该不传过来，定义在这里只是允许接收这个参数
}

type Report struct {
	ReportPure
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type ReportPure struct {
	Id          string             `json:"id"`
	Uid         string             `json:"uid"`
	Title       string             `json:"title"`
	Content     string             `json:"content"`
	Type        model.ReportType   `json:"type"`
	Status      model.ReportStatus `json:"status"`
	Screenshots []string           `json:"screenshots"`
	Locked      bool               `json:"locked"`
}

type Response struct {
	Message string      `json:"message"`        // 附带的消息，接口请求错误时，一般都会有错误信息
	Data    interface{} `json:"data"`           // 接口附带的数据
	Status  int         `json:"status"`         // 状态码，非 1 状态码则为错误
	Meta    *Meta       `json:"meta,omitempty"` // 数据列表多了一个 Meta 字段
}

type Role struct {
	RolePure
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type RolePure struct {
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Accession   []string `json:"accession"`
	BuildIn     bool     `json:"build_in"`
	Note        *string  `json:"note"`
}

type Sort struct {
	Field string `json:"field"` // 排序的字段
	Order Order  `json:"order"` // 字段的排序方向
}

type TransferLog struct {
	TransferLogPure
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type TransferLogPure struct {
	Id       string               `json:"id"`       // 转账ID
	Currency string               `json:"currency"` // 币种
	From     string               `json:"from"`     // 谁转的
	To       string               `json:"to"`       // 转给谁
	Amount   string               `json:"amount"`   // 转账数量
	Status   model.TransferStatus `json:"status"`   // 转账状态
	Note     *string              `json:"string"`   // 转账备注
}

type Wallet struct {
	WalletPure
	CreatedAt string `json:"created_at"`
	UpdatedAt string `json:"updated_at"`
}

type WalletPure struct {
	Id       string `json:"id"`       // 用户ID
	Currency string `json:"currency"` // 币种
	Balance  string `json:"balance"`  // 可用余额
	Frozen   string `json:"frozen"`   // 冻结余额
}

type WechatBindingInfo struct {
	Nickname  string `json:"nickname"`   // 用户昵称
	AvatarUrl string `json:"avatar_url"` // 用户头像
	Gender    int    `json:"gender"`     // 性别
	Country   string `json:"country"`    // 国家
	Province  string `json:"province"`   // 省份
	City      string `json:"city"`       // 城市
	Language  string `json:"language"`   // 语言
}