protocol

type EmptyResponse struct {
	*Response
}

type Event struct {
	// ID 事件ID
	ID string `json:"id"`
	// Time 事件发生的时间戳 Unix时间戳 单位为秒
	Time float64 `json:"time"`
	// Type 事件类型 meta/message/notice/request
	// 对应ActionTypeXXX
	Type string `json:"type"`
	// DetailType 事件详细类型
	DetailType string `json:"detail_type"`
	// SubType 事件子类型 详细类型的子类型
	SubType string `json:"sub_type"`
	// Self 事件发起Bot
	Self Self `json:"self"`
}

type MessageEventChannel struct {
	*Event
	// MessageID 消息ID
	MessageId string `json:"message_id"`
	// Message 消息内容 消息段列表
	Message []Segment `json:"message"`
	// AltMessage 消息内容的替代表示, 可以为空
	AltMessage string `json:"alt_message"`
	// GuildId   群组ID
	GuildId string `json:"guild_id"`
	// ChannelId 频道ID
	ChannelId string `json:"channel_id"`
	// UserId    用户ID
	UserId string `json:"user_id"`
}

type MessageEventGroup struct {
	*Event
	// MessageID 消息ID
	MessageId string `json:"message_id"`
	// Message 消息内容 消息段列表
	Message []Segment `json:"message"`
	// AltMessage 消息内容的替代表示, 可以为空
	AltMessage string `json:"alt_message"`
	// GroupId 群组ID
	GroupId string `json:"group_id"`
	// UserId 用户 ID
	UserId string `json:"user_id"`
}

type MessageEventPrivate struct {
	*Event
	// MessageID 消息ID
	MessageId string `json:"message_id"`
	// Message 消息内容 消息段列表
	Message []Segment `json:"message"`
	// AltMessage 消息内容的替代表示, 可以为空
	AltMessage string `json:"alt_message"`
	// UserId 用户 ID
	UserId string `json:"user_id"`
}

type MetaEventConnect struct {
	*Event
	// Version 机器人版本信息
	//
	// resp[get_version] OneBot实现端版本信息, 与get_version动作响应数据一致
	Version struct {
		// Impl OneBot实现端名称
		Impl string `json:"impl"`
		// Version OneBot实现端版本
		Version string `json:"version"`
		// OnebotVersion OneBot协议版本
		OnebotVersion string `json:"onebot_version"`
	} `json:"version"`
}

type MetaEventHeartbeat struct {
	*Event
	// Interval 心跳间隔
	Interval int `json:"interval"`
}

type MetaEventStatusUpdate struct {
	*Event
	// Status 机器人状态
	Status struct {
		// Good
		Good bool `json:"good"`
		// Bots
		Bots []struct {
			// Self
			Self Self `json:"self"`
			// Online
			Online bool `json:"online"`
		} `json:"bots"`
	} `json:"status"`
}

type NoticeEventChannelCreate struct {
	*Event
	// GuildId 群组ID
	GuildId string `json:"guild_id"`
	// ChannelId 频道ID
	ChannelId string `json:"channel_id"`
	// OperatorId 操作者ID
	OperatorId string `json:"operator_id"`
}

type NoticeEventChannelDelete struct {
	*Event
	// GuildId 群组ID
	GuildId string `json:"guild_id"`
	// ChannelId 频道ID
	ChannelId string `json:"channel_id"`
	// OperatorId 操作者ID
	OperatorId string `json:"operator_id"`
}

type NoticeEventChannelMemberDecrease struct {
	*Event
	// UserId 用户ID
	UserId string `json:"user_id"`
	// GuildId 群组ID
	GuildId string `json:"guild_id"`
	// ChannelId  频道ID
	ChannelId string `json:"channel_id"`
	// OperatorId 操作者ID
	OperatorId string `json:"operator_id"`
}

type NoticeEventChannelMemberIncrease struct {
	*Event
	// UserId 用户ID
	UserId string `json:"user_id"`
	// GuildId 群组ID
	GuildId string `json:"guild_id"`
	// ChannelId  频道ID
	ChannelId string `json:"channel_id"`
	// OperatorId 操作者ID
	OperatorId string `json:"operator_id"`
}

type NoticeEventChannelMessageDelete struct {
	*Event
	// GuildId 群组ID
	GuildId string `json:"guild_id"`
	// ChannelId  频道ID
	ChannelId string `json:"channel_id"`
	// MessageId 消息ID
	MessageId string `json:"message_id"`
	// UserId 用户ID
	UserId string `json:"user_id"`
	// OperatorId 操作者ID
	OperatorId string `json:"operator_id"`
}

type NoticeEventFriendDecrease struct {
	*Event
	// UserId 用户ID
	UserId string `json:"user_id"`
}

type NoticeEventFriendIncrease struct {
	*Event
	// UserId 用户ID
	UserId string `json:"user_id"`
}

type NoticeEventGroupMemberDecrease struct {
	*Event
	// UserId 用户ID
	UserId string `json:"user_id"`
	// GroupId 群组ID
	GroupId string `json:"group_id"`
	// OperatorId 操作者ID
	OperatorId string `json:"operator_id"`
}

type NoticeEventGroupMemberIncrease struct {
	*Event
	// UserId 用户ID
	UserId string `json:"user_id"`
	// GroupId 群组ID
	GroupId string `json:"group_id"`
	// OperatorId 操作者ID
	OperatorId string `json:"operator_id"`
}

type NoticeEventGroupMessageDelete struct {
	*Event
	// MessageId 消息ID
	MessageId string `json:"message_id"`
	// UserId 用户ID
	UserId string `json:"user_id"`
	// OperatorId 群组ID
	OperatorId string `json:"operator_id"`
}

type NoticeEventGuildMemberDecrease struct {
	*Event
	// UserId 用户ID
	UserId string `json:"user_id"`
	// GuildId 群组ID
	GuildId string `json:"guild_id"`
	// OperatorId 操作者ID
	OperatorId string `json:"operator_id"`
}

type NoticeEventGuildMemberIncrease struct {
	*Event
	// UserId 用户ID
	UserId string `json:"user_id"`
	// GuildId 群组ID
	GuildId string `json:"guild_id"`
	// OperatorId 操作者ID
	OperatorId string `json:"operator_id"`
}

type NoticeEventMessageDelete struct {
	*Event
	// MessageID 消息ID
	MessageId string `json:"message_id"`
	// UserId 用户ID
	UserId string `json:"user_id"`
}

type OneBotConfig struct {
	// PlatForm 平台
	PlatForm string `json:"platform"`
	// Implementation 实现
	Implementation string `json:"implementation"`
	// Version 版本
	Version string `json:"version"`
	// HeartBeat 心跳
	HeartBeat struct {
		// Enable 是否启用
		Enable bool `json:"enable"`
		// Interval 心跳间隔
		Interval int `json:"interval"`
	}
}

type RawRequestType struct {
	// *Request 请求头
	*Request
	// Param 各种参数
	Param map[string]any `json:"params"`
}

type Request struct {
	// Action 动作名称
	Action string `json:"action"`
	// Echo 原样返回
	Echo string `json:"echo"`
	// Self 事件发起Bot
	Self Self `json:"self"`
	// ConnectionUUID 内部使用: 判断发出请求的连接UUID 用于返回时寻找连接
	ConnectionUUID string
	// contains filtered or unexported fields
}

type RequestDeleteMessage struct {
	*Request
	// MessageId 唯一的消息 ID
	MessageId string `json:"message_id"`
	// contains filtered or unexported fields
}

type RequestGetChannelInfo struct {
	*Request
	// GuildId 群组 ID
	GuildId string `json:"guild_id"`
	// ChannelId 频道 ID
	ChannelId string `json:"channel_id"`
	// contains filtered or unexported fields
}

type RequestGetChannelList struct {
	*Request
	// GuildId 群组 ID
	GuildId string `json:"guild_id"`
	// JoinedOnly 只获取机器人账号已加入的频道列表
	JoinedOnly bool `json:"joined_only"`
	// contains filtered or unexported fields
}

type RequestGetChannelMemberInfo struct {
	*Request
	// GuildId 群组 ID
	GuildId string `json:"guild_id"`
	// ChannelId 频道 ID
	ChannelId string `json:"channel_id"`
	// UserId 用户 ID
	UserId string `json:"user_id"`
	// contains filtered or unexported fields
}

type RequestGetChannelMemberList struct {
	*Request
	// GuildId 群组 ID
	GuildId string `json:"guild_id"`
	// ChannelId 频道 ID
	ChannelId string `json:"channel_id"`
	// contains filtered or unexported fields
}

type RequestGetFile struct {
	*Request
	// FileId 文件 ID
	FileId string `json:"file_id"`
	// Type 获取文件的方式，可以为 url、path、data 或扩展的方式
	Type string `json:"type"`
	// contains filtered or unexported fields
}

type RequestGetFileFragmented struct {
	*Request
	// Stage 上传阶段，必须为 prepare 传输阶段，必须为 transfer
	Stage string `json:"stage"`
	// FileID 文件 ID
	FileID string `json:"file_id"`
	// Offset 本次传输的文件偏移，单位：字节
	Offset int64 `json:"offset"`
	// Size 本次传输的文件大小，单位：字节
	Size int64 `json:"size"`
	// contains filtered or unexported fields
}

type RequestGetFriendList struct {
	*Request
	// contains filtered or unexported fields
}

type RequestGetGroupInfo struct {
	*Request
	// GroupId 	群 ID
	GroupId string `json:"group_id"`
	// contains filtered or unexported fields
}

type RequestGetGroupList struct {
	*Request
	// contains filtered or unexported fields
}

type RequestGetGroupMemberInfo struct {
	*Request
	// GroupId 	群 ID
	GroupId string `json:"group_id"`
	// UserId 	用户 ID
	UserId string `json:"user_id"`
	// contains filtered or unexported fields
}

type RequestGetGroupMemberList struct {
	*Request
	// GroupId 	群 ID
	GroupId string `json:"group_id"`
	// contains filtered or unexported fields
}

type RequestGetGuildInfo struct {
	*Request
	// GuildIf 群组 ID
	GuildId string `json:"guild_id"`
	// contains filtered or unexported fields
}

type RequestGetGuildList struct {
	*Request
	// contains filtered or unexported fields
}

type RequestGetGuildMemberInfo struct {
	*Request
	// GuildId 群组 ID
	GuildId string `json:"guild_id"`
	// UserId 用户 ID
	UserId string `json:"user_id"`
	// contains filtered or unexported fields
}

type RequestGetGuildMemberList struct {
	*Request
	// GuildId 群组 ID
	GuildId string `json:"guild_id"`
	// contains filtered or unexported fields
}

type RequestGetLatestEvents struct {
	*Request
	// Limit 获取的事件数量上限，0 表示不限制
	Limit int64 `json:"limit"`
	// Timeout 没有事件时最多等待的秒数，0 表示使用短轮询，不等待
	Timeout int64 `json:"timeout"`
	// contains filtered or unexported fields
}

type RequestGetSelfInfo struct {
	*Request
	// contains filtered or unexported fields
}

type RequestGetStatus struct {
	*Request
	// contains filtered or unexported fields
}

type RequestGetSupportedActions struct {
	*Request
	// contains filtered or unexported fields
}

type RequestGetUserInfo struct {
	*Request
	// UserId 用户 ID，可以是好友，也可以是陌生人
	UserId string `json:"user_id"`
	// contains filtered or unexported fields
}

type RequestGetVersion struct {
	*Request
	// contains filtered or unexported fields
}

type RequestInterface interface {
	// Do 执行动作
	// e 返回的Response 需要符合Response的类型
	Do() (e any)
	// New 返回一个新的RequestInterface
	New() any
}

type RequestLeaveChannel struct {
	*Request
	// GuildId 群组 ID
	GuildId string `json:"guild_id"`
	// ChannelId 频道 ID
	ChannelId string `json:"channel_id"`
	// contains filtered or unexported fields
}

type RequestLeaveGroup struct {
	*Request
	// GroupId 群 ID
	GroupId string `json:"group_id"`
	// contains filtered or unexported fields
}

type RequestLeaveGuild struct {
	*Request
	// GuildId 群组 ID
	GuildId string `json:"guild_id"`
	// contains filtered or unexported fields
}

type RequestSendMessage struct {
	*Request
	// DetailType 发送的类型，可以为 private、group、channel 或扩展的类型，和消息事件的 detail_type 字段对应
	DetailType string `json:"detail_type"`
	// UserId 用户 ID，当 detail_type 为 private 时必须传入
	UserId string `json:"user_id"`
	// GroupId	群 ID，当 detail_type 为 group 时必须传入
	GroupId string `json:"group_id"`
	// GuildId Guild 群组 ID，当 detail_type 为 channel 时必须传入
	GuildId string `json:"guild_id"`
	// ChannelId 频道 ID，当 detail_type 为 channel 时必须传入
	ChannelId string `json:"channel_id"`
	// Message 消息段列表 消息内容
	Message []Segment `json:"message"`
	// contains filtered or unexported fields
}

type RequestSetChannelName struct {
	*Request
	// GuildId 群组 ID
	GuildId string `json:"guild_id"`
	// ChannelId 频道 ID
	ChannelId string `json:"channel_id"`
	// ChannelName 新频道名称
	ChannelName string `json:"channel_name"`
	// contains filtered or unexported fields
}

type RequestSetGroupName struct {
	*Request
	// GroupId 群 ID
	GroupId string `json:"group_id"`
	// GroupName 新群名称
	GroupName string `json:"group_name"`
	// contains filtered or unexported fields
}

type RequestSetGuildName struct {
	*Request
	// GuildId 群组 ID
	GuildId string `json:"guild_id"`
	// GuildName 新群组名称
	GuildName string `json:"guild_name"`
	// contains filtered or unexported fields
}

type RequestUploadFile struct {
	*Request
	// Name 文件名，如 foo.jpg
	Name string `json:"name"`
	// Url 文件 URL，当 type 为 url 时必须返回，应用端必须能以 HTTP(S) 协议从此 URL 下载文件
	Url string `json:"url"`
	// Headers	下载 URL 时需要添加的 HTTP 请求头，可选返回
	Headers map[string]string `json:"headers"`
	// Path 文件路径，当 type 为 path 时必须返回，应用端必须能从此路径访问文件
	Path string `json:"path"`
	// Data 文件数据，当 type 为 data 时必须返回
	Data []byte `json:"data"`
	// Sha256 文件数据（原始二进制）的 SHA256 校验和，全小写，可选返回
	Sha256 string `json:"sha256"`
	// Type 	上传文件的方式，可以为 url、path、data 或扩展的方式
	Type string `json:"type"`
	// contains filtered or unexported fields
}

type RequestUploadFileFragmented struct {
	*Request
	// Stage 上传阶段，必须为 prepare 传输阶段，必须为 transfer
	Stage string `json:"stage"`
	// Name 文件名，如 foo.jpg
	Name string `json:"name"`
	// TotalSize 文件总大小，单位为字节
	TotalSize int64 `json:"total_size"`
	// FileID 准备阶段返回的文件 ID
	FileID string `json:"file_id"`
	// Offset 	本次传输的文件偏移，单位：字节
	Offset int64 `json:"offset"`
	// Data 本次传输的文件数据
	Data []byte `json:"data"`
	// Sha256 本次传输的文件数据（原始二进制）的 SHA256 校验和，全小写
	Sha256 string `json:"sha256"`
	// contains filtered or unexported fields
}

type Response struct {
	// Status 响应状态
	// 必须为 StatusOk 或 StatusFailed
	Status string `json:"status"`
	// RetCode 返回码 对应上文的 ResponseCodeXXX
	Retcode int `json:"retcode"`
	// Message 错误信息，当动作执行失败时，建议在此填写人类可读的错误信息，当执行成功时，应为空字符串
	Message string `json:"message"`
	// Echo 应原样返回动作请求中的 echo 字段值
	Echo string `json:"echo"`
	// contains filtered or unexported fields
}

type ResponseDeleteMessage struct {
	*Response
}

type ResponseGetChannelInfo struct {
	*Response
	// ChannelId 频道 ID
	ChannelId string `json:"channel_id"`
	// ChannelName 频道名称
	ChannelName string `json:"channel_name"`
}

type ResponseGetChannelList struct {
	*Response
	// Channels 频道列表
	Channels []struct {
		// ChannelId 频道 ID
		ChannelId string `json:"channel_id"`
		// ChannelName 频道名称
		ChannelName string `json:"channel_name"`
	}
}

type ResponseGetChannelMemberInfo struct {
	*Response
	// UserId 用户 ID
	UserId string `json:"user_id"`
	// UserName 用户名称/姓名/昵称
	UserName string `json:"user_name"`
	// UserDisplayName 	用户设置的群组内显示名称或账号显示名称，若无则为空字符串
	UserDisplayName string `json:"user_displayname"`
}

type ResponseGetChannelMemberList struct {
	*Response
	// Members 频道成员列表
	Members []struct {
		// UserId 用户 ID
		UserId string `json:"user_id"`
		// UserName 用户名称/姓名/昵称
		UserName string `json:"user_name"`
		// UserDisplayName 	用户设置的群组内显示名称或账号显示名称，若无则为空字符串
		UserDisplayName string `json:"user_displayname"`
	}
}

type ResponseGetFile struct {
	*Response
	// Name 文件名，如 foo.jpg
	Name string `json:"name"`
	// Url 文件 URL，当 type 为 url 时必须返回，应用端必须能以 HTTP(S) 协议从此 URL 下载文件
	Url string `json:"url"`
	// Headers	下载 URL 时需要添加的 HTTP 请求头，可选返回
	Headers map[string]string `json:"headers"`
	// Path 文件路径，当 type 为 path 时必须返回，应用端必须能从此路径访问文件
	Path string `json:"path"`
	// Data 文件数据，当 type 为 data 时必须返回
	Data []byte `json:"data"`
	// Sha256 文件数据（原始二进制）的 SHA256 校验和，全小写，可选返回
	Sha256 string `json:"sha256"`
}

type ResponseGetFileFragmented struct {
	*Response
	// Name 文件名，如 foo.jpg
	Name string `json:"name"`
	// TotalSize 文件完整大小，单位：字节
	TotalSize int `json:"total_size"`
	// Sha256 文件数据（原始二进制）的 SHA256 校验和，全小写
	Sha256 string `json:"sha256"`
	// Data 本次传输的文件数据
	Data []byte `json:"data"`
}

type ResponseGetFriendList struct {
	*Response
	// Friends 好友列表
	Friends []struct {
		// UserId 用户 ID
		UserId string `json:"user_id"`
		// UserName 用户名称/姓名/昵称
		UserName string `json:"user_name"`
		// UserDisplayName 用户设置的显示名称，若无则为空字符串
		UserDisplayName string `json:"user_displayname"`
		// UserRemark 机器人账号对该用户的备注名称，若无则为空字符串
		UserRemark string `json:"user_remark"`
	}
}

type ResponseGetGroupInfo struct {
	*Response
	// GroupId 群号
	GroupId string `json:"group_id"`
	// GroupName 群名称
	GroupName string `json:"group_name"`
}

type ResponseGetGroupList struct {
	*Response
	Groups []struct {
		// GroupId 群号
		GroupId string `json:"group_id"`
		// GroupName 群名称
		GroupName string `json:"group_name"`
	}
}

type ResponseGetGroupMemberInfo struct {
	*Response
	// UserId 用户 ID
	UserId string `json:"user_id"`
	// UserName 用户名称/姓名/昵称
	UserName string `json:"user_name"`
	// UserDisplayName 用户设置的群内显示名称或账号显示名称，若无则为空字符串
	UserDisplayName string `json:"user_displayname"`
}

type ResponseGetGroupMemberList struct {
	*Response
	// Members 群成员列表
	Members []struct {
		// UserId 用户 ID
		UserId string `json:"user_id"`
		// UserName 用户名称/姓名/昵称
		UserName string `json:"user_name"`
		// UserDisplayName 用户设置的群内显示名称或账号显示名称，若无则为空字符串
		UserDisplayName string `json:"user_displayname"`
	}
}

type ResponseGetGuildInfo struct {
	*Response
	// GuildId 群组 ID
	GuildId string `json:"guild_id"`
	// GuildName 群组名称
	GuildName string `json:"guild_name"`
}

type ResponseGetGuildList struct {
	*Response
	// Guilds 群组列表
	Guilds []struct {
		// GuildId 群组 ID
		GuildId string `json:"guild_id"`
		// GuildName 群组名称
		GuildName string `json:"guild_name"`
	}
}

type ResponseGetGuildMemberInfo struct {
	*Response
	// UserId 用户 ID
	UserId string `json:"user_id"`
	// UserName 用户名称/姓名/昵称
	UserName string `json:"user_name"`
	// UserDisplayName 	用户设置的群组内显示名称或账号显示名称，若无则为空字符串
	UserDisplayName string `json:"user_displayname"`
}

type ResponseGetGuildMemberList struct {
	*Response
	// Members 群组成员列表
	Members []struct {
		// UserId 用户 ID
		UserId string `json:"user_id"`
		// UserName 用户名称/姓名/昵称
		UserName string `json:"user_name"`
		// UserDisplayName 	用户设置的群组内显示名称或账号显示名称，若无则为空字符串
		UserDisplayName string `json:"user_displayname"`
	}
}

type ResponseGetLatestEvents struct {
	*Response
	// Events 事件列表
	Events []any
}

type ResponseGetSelfInfo struct {
	*Response
	// UserId 机器人用户 ID
	UserId string `json:"user_id"`
	// Nickname 机器人名称/姓名/昵称
	UserName string `json:"user_name"`
	// UserDisPlayName 机器人账号设置的显示名称，若无则为空字符串
	UserDisplayName string `json:"user_displayname"`
}

type ResponseGetStatus struct {
	*Response

	Good bool `json:"good"`
	Bots []struct {
		Self   Self `json:"self"`
		Online bool `json:"online"`
		Extra  map[string]any
	} `json:"bots"`
}

type ResponseGetSupportedActions struct {
	*Response
	// Actions 动作列表
	Actions []string
}

type ResponseGetUserInfo struct {
	*Response
	// UserId 用户 ID
	UserId string `json:"user_id"`
	// UserName 用户名称/姓名/昵称
	UserName string `json:"user_name"`
	// UserDisplayName 用户设置的显示名称，若无则为空字符串
	UserDisplayName string `json:"user_displayname"`
	// UserRemark 机器人账号对该用户的备注名称，若无则为空字符串
	UserRemark string `json:"user_remark"`
}

type ResponseGetVersion struct {
	*Response
	// Impl OneBot 实现名称，格式见 术语表
	Impl string `json:"impl"`
	// Version OneBot 实现的版本号
	Version string `json:"version"`
	// OneBotVersion OneBot 实现的 OneBot 标准版本号
	OnebotVersion string `json:"onebot_version"`
}

type ResponseLeaveChannel struct {
	*Response
}

type ResponseLeaveGroup struct {
	*Response
}

type ResponseLeaveGuild struct {
	*Response
}

type ResponseSendMessage struct {
	*Response
	// MessageId 消息 ID
	MessageId string `json:"message_id"`
	// Time 消息成功发出的时间（Unix 时间戳），单位：秒
	Time float64 `json:"time"`
}

type ResponseSetChannelName struct {
	*Response
}

type ResponseSetGroupName struct {
	*Response
}

type ResponseSetGuildName struct {
	*Response
}

type ResponseUploadFile struct {
	*Response
	// FileId 文件 ID
	FileId string `json:"file_id"`
}

type ResponseUploadFileFragmented struct {
	*Response
	// FileId 文件 ID，仅传输阶段使用
	FileId string `json:"file_id"`
}

type Segment struct {
	// Type 消息段类型
	Type string `json:"type"`
	// Data 消息段数据
	Data map[string]interface{} `json:"data"`
}

type Self struct {
	// PlatForm 平台
	PlatForm string `json:"platform"`
	// UserId 用户ID
	UserId string `json:"user_id"`
}