types

type BaseDataInfo struct {
	// Error code | 错误代码
	Code int `json:"code"`
	// Message | 提示信息
	Msg string `json:"msg"`
	// Data | 数据
	Data string `json:"data,omitempty"`
}

type BaseIDInfo struct {
	// ID
	Id *uint64 `json:"id,optional"`
	// Create date | 创建日期
	CreatedAt *int64 `json:"createdAt,optional"`
	// Update date | 更新日期
	UpdatedAt *int64 `json:"updatedAt,optional"`
}

type BaseListInfo struct {
	// The total number of data | 数据总数
	Total uint64 `json:"total"`
	// Data | 数据
	Data string `json:"data,omitempty"`
}

type BaseMsgResp struct {
	// Error code | 错误代码
	Code int `json:"code"`
	// Message | 提示信息
	Msg string `json:"msg"`
}

type BaseUUIDInfo struct {
	// ID
	Id *string `json:"id,optional"`
	// Create date | 创建日期
	CreatedAt *int64 `json:"createdAt,optional"`
	// Update date | 更新日期
	UpdatedAt *int64 `json:"updatedAt,optional"`
}

type CloudFileDeleteReq struct {
	// Url | 文件网址
	Url string `json:"url"`
}

type CloudFileInfo struct {
	BaseUUIDInfo
	// State | 状态
	State *bool `json:"state,optional"`
	// Name | 名称
	Name *string `json:"name,optional"`
	// Url | 网络地址
	Url *string `json:"url,optional"`
	// RelativeSrc | 相对路径
	RelativeSrc *string `json:"relativeSrc,optional"`
	// Size | 文件大小
	Size *uint64 `json:"size,optional"`
	// File type | 文件类型
	FileType *uint8 `json:"fileType,optional"`
	// User ID | 上传用户的 ID
	UserId *string `json:"userId,optional"`
	// Provider ID | 提供商的 ID
	ProviderId *uint64 `json:"providerId,optional"`
	// Tag ID | 标签 ID
	TagIds []uint64 `json:"tagIds,optional,omitempty"`
}

type CloudFileInfoResp struct {
	BaseDataInfo
	// CloudFile information | 云文件数据
	Data CloudFileInfo `json:"data"`
}

type CloudFileListInfo struct {
	BaseListInfo
	// The API list data | 云文件列表数据
	Data []CloudFileInfo `json:"data"`
}

type CloudFileListReq struct {
	PageInfo
	// Name | 文件名
	Name *string `json:"name,optional"`
	// Provider ID | 提供商 ID
	ProviderId *uint64 `json:"providerId,optional"`
	// Tag ID | 标签 ID
	TagIds []uint64 `json:"tagIds,optional"`
	// File type | 文件类型
	FileType *uint8 `json:"fileType,optional"`
	// Provider name | 提供商名称
	ProviderName *string `json:"providerName,optional"`
}

type CloudFileListResp struct {
	BaseDataInfo
	// CloudFile list data | 云文件列表数据
	Data CloudFileListInfo `json:"data"`
}

type CloudFileTagInfo struct {
	BaseIDInfo
	// Status
	Status *uint8 `json:"status,optional"`
	// Name
	Name *string `json:"name,optional"`
	// Remark
	Remark *string `json:"remark,optional"`
}

type CloudFileTagInfoResp struct {
	BaseDataInfo
	// Cloud file tag information | 云文件标签数据
	Data CloudFileTagInfo `json:"data"`
}

type CloudFileTagListInfo struct {
	BaseListInfo
	// The API list data | 云文件标签列表数据
	Data []CloudFileTagInfo `json:"data"`
}

type CloudFileTagListReq struct {
	PageInfo
	// Name
	Name *string `json:"name,optional"`
	// Remark
	Remark *string `json:"remark,optional"`
}

type CloudFileTagListResp struct {
	BaseDataInfo
	// CloudFileTag list data | 云文件标签列表数据
	Data CloudFileTagListInfo `json:"data"`
}

type FileDeleteReq struct {
	// Url | 文件网址
	Url string `json:"url"`
}

type FileInfo struct {
	BaseUUIDInfo
	// User's UUID | 用户的UUID
	UserUUID *string `json:"userUUID"`
	// File name | 文件名
	Name *string `json:"name"`
	// File type | 文件类型
	FileType *uint8 `json:"fileType"`
	// File size | 文件大小
	Size *uint64 `json:"size"`
	// File path | 文件路径
	Path *string `json:"path"`
	// File public status | 文件公开状态
	// false private true public | false 私人, true公开
	Status *uint8 `json:"status"`
	// The public URL | 公开访问的链接
	PublicPath *string `json:"publicPath"`
	// FileTags' Id | 标签 ID
	FileTagIds []uint64 `json:"tagIds,optional,omitempty"`
}

type FileListInfo struct {
	BaseListInfo
	// The file list data | 文件信息列表数据
	Data []FileInfo `json:"data"`
}

type FileListReq struct {
	PageInfo
	// File type | 文件类型
	// max length : 10
	FileType *uint8 `json:"fileType,optional" validate:"omitempty,max=10"`
	// File name | 文件名
	// max length : 50
	FileName *string `json:"fileName,optional" validate:"omitempty,max=50"`
	// Create date period | 创建日期时间段
	Period []string `json:"period,optional"`
	// FileTags' Id | 标签 ID
	FileTagIds []uint64 `json:"tagIds,optional"`
	// Status | 状态
	Status *uint8 `json:"status,optional"`
}

type FileListResp struct {
	BaseDataInfo
	// The file list data | 文件信息列表数据
	Data FileListInfo `json:"data"`
}

type FileTagInfo struct {
	BaseIDInfo
	// Status
	Status *uint8 `json:"status,optional"`
	// Name
	Name *string `json:"name,optional"`
	// Remark
	Remark *string `json:"remark,optional"`
}

type FileTagInfoResp struct {
	BaseDataInfo
	// FileTag information | 文件标签数据
	Data FileTagInfo `json:"data"`
}

type FileTagListInfo struct {
	BaseListInfo
	// The API list data | 文件标签列表数据
	Data []FileTagInfo `json:"data"`
}

type FileTagListReq struct {
	PageInfo
	// Name
	Name *string `json:"name,optional"`
	// Remark
	Remark *string `json:"remark,optional"`
}

type FileTagListResp struct {
	BaseDataInfo
	// FileTag list data | 文件标签列表数据
	Data FileTagListInfo `json:"data"`
}

type IDPathReq struct {
	// ID
	// Required: true
	Id uint64 `path:"id"`
}

type IDReq struct {
	// ID
	// Required: true
	Id uint64 `json:"id" validate:"number"`
}

type IDsReq struct {
	// IDs
	// Required: true
	Ids []uint64 `json:"ids"`
}

type PageInfo struct {
	// Page number | 第几页
	// required : true
	// min : 0
	Page uint64 `json:"page" validate:"required,number,gt=0"`
	// Page size | 单页数据行数
	// required : true
	// max : 100000
	PageSize uint64 `json:"pageSize" validate:"required,number,lt=100000"`
}

type StatusCodeReq struct {
	// ID
	Id string `json:"id"`
	// Status code | 状态码
	Status uint64 `json:"status" validate:"number"`
}

type StorageProviderInfo struct {
	BaseIDInfo
	// State | 状态
	State *bool `json:"state,optional"`
	// Name | 云服务提供商名称
	Name *string `json:"name,optional"`
	// Bucket | 存储桶
	Bucket *string `json:"bucket,optional"`
	// Secret Id
	SecretId *string `json:"secretId,optional"`
	// Secret Key
	SecretKey *string `json:"secretKey,optional"`
	// Secret Key
	Endpoint *string `json:"endpoint,optional"`
	// folder | folder
	Folder *string `json:"folder,optional"`
	// Region | 地区
	Region *string `json:"region,optional"`
	// Whether is Default | 是否为默认
	IsDefault *bool `json:"isDefault,optional"`
	// Does it use CDN | 是否使用 CDN
	UseCdn *bool `json:"useCdn,optional"`
	// CDN URL | CDN 地址
	CdnUrl *string `json:"cdnUrl,optional"`
}

type StorageProviderInfoResp struct {
	BaseDataInfo
	// StorageProvider information | 服务提供商数据
	Data StorageProviderInfo `json:"data"`
}

type StorageProviderListInfo struct {
	BaseListInfo
	// The API list data | 服务提供商列表数据
	Data []StorageProviderInfo `json:"data"`
}

type StorageProviderListReq struct {
	PageInfo
	// Name | 名称
	Name *string `json:"name,optional"`
}

type StorageProviderListResp struct {
	BaseDataInfo
	// StorageProvider list data | 服务提供商列表数据
	Data StorageProviderListInfo `json:"data"`
}

type UUIDPathReq struct {
	// ID
	// Required: true
	Id string `path:"id"`
}

type UUIDReq struct {
	// ID
	// Required: true
	// Max length: 36
	Id string `json:"id" validate:"len=36"`
}

type UUIDsReq struct {
	// Ids
	// Required: true
	Ids []string `json:"ids"`
}

type UpdateFileReq struct {
	// ID
	// Required : true
	ID string `json:"id"`
	// File name | 文件名
	// Required : true
	Name *string `json:"name,optional" validate:"max=50"`
	// File tag | 文件标签
	FileTagIds []uint64 `json:"tagIds,optional"`
}

type UploadInfo struct {
	// File name | 文件名称
	Name string `json:"name"`
	// File path | 文件路径
	Url string `json:"url"`
}

type UploadResp struct {
	BaseDataInfo
	// The  data when upload finished | 上传完成数据
	Data UploadInfo `json:"data"`
}