wxwork

type AccessToken struct {
	AccessToken string    `json:"access_token"`         // 获取到的凭证，最长为512字节
	ExpiresIn   int64     `json:"expires_in,omitempty"` // 凭证的有效时间（秒），通常为2小时（7200秒）
	ExpireAt    time.Time `json:"expire_at,omitempty"`  // 过期时间，超过时重新获取
	// contains filtered or unexported fields
}

type Agent struct {
	// 企业ID
	CorpID string
	// AgentID 应用ID
	AgentID int
	// Secret 应用秘钥
	Secret string
	// AccessToken 应用登录凭证
	AccessToken *AccessToken
	// 是否开启Debug
	Debug bool

	Cache Cache
	// contains filtered or unexported fields
}

type AppChat struct {
	ChatID   string   `json:"chatid"`   // 群聊的唯一标志
	Name     string   `json:"name"`     // 群聊名称
	Owner    string   `json:"owner"`    // 群主ID
	UserList []string `json:"userlist"` // 群成员id列表
}

type AppChatMessage struct {
	// 群聊会话ID
	ChatID string `json:"chatid"`

	// 消息类型
	MsgType string `json:"msgtype,omitempty"`

	// 是否是保密消息，0表示否，1表示是，默认0
	Safe int8 `json:"safe,omitempty"`

	Text     *TextMessage     `json:"text,omitempty"`     // 文本消息
	Markdown *TextMessage     `json:"markdown,omitempty"` // markdown 消息
	Image    *MediaMessage    `json:"image,omitempty"`    // 图片消息
	Voice    *MediaMessage    `json:"voice,omitempty"`    // 语音消息
	File     *MediaMessage    `json:"file,omitempty"`     // 文件消息
	Video    *VideoMessage    `json:"video,omitempty"`    // 视频消息
	TextCard *TextCardMessage `json:"textcard,omitempty"` // 文本卡片消息
	News     *NewsMessage     `json:"news,omitempty"`     // 图文消息
	MPNews   *MPNewsMessage   `json:"mpnews,omitempty"`   // 图文消息(mpnews)
	TaskCard *TaskCardMessage `json:"taskcard,omitempty"` // 任务卡片消息
}

type Attrs struct {
	Attrs []ExternalAttr `json:"attrs"`
}

type BatchResult struct {

	// 任务状态，整型，1表示任务开始，2表示任务进行中，3表示任务已完成
	Status int `json:"status" xml:"status"`
	// 操作类型，字节串，目前分别有：1. sync_user(增量更新成员) 2. replace_user(全量覆盖成员)3. replace_party(全量覆盖部门)
	Type string `json:"type" xml:"type"`
	// 任务运行总条数
	Total int `json:"total" xml:"total"`
	// 目前运行百分比，当任务完成时为100
	Percentage int `json:"percentage" xml:"percentage"`
	// 详细的处理结果
	Result BatchResultDetail `json:"result" xml:"result"`
	// contains filtered or unexported fields
}

type BatchResultDetail struct {
	// 成员UserID。对应管理端的帐号
	UserID string `json:"userid,omitempty" xml:"userid,omitempty"`
	// 操作类型（按位或）：1 新建部门 ，2 更改部门名称， 4 移动部门， 8 修改部门排序
	Action int `json:"action,omitempty" xml:"action,omitempty"`
	// 部门ID
	PartyID int `json:"partyid,omitempty" xml:"partyid,omitempty"`
	// contains filtered or unexported fields
}

type BatchSync struct {
	// 上传的csv文件的media_id
	MediaId string `json:"media_id" xml:"media_id"`
	// 是否邀请新建的成员使用企业微信（将通过微信服务通知或短信或邮件下发邀请，每天自动下发一次，最多持续3个工作日），默认值为true。
	ToInvite bool `json:"to_invite,omitempty" xml:"to_invite,omitempty"`
	// 回调信息。如填写该项则任务完成后，通过callback推送事件给企业。具体请参考应用回调模式中的相应选项
	Callback Callback `json:"callback" xml:"callback"`
}

type Cache interface {
	Set(key string, value []byte) error
	Get(key string) []byte
	Remove(key string) error
}

type Callback struct {
	// 企业应用接收企业微信推送请求的访问协议和地址，支持http或https协议
	URL string `json:"url,omitempty" xml:"url,omitempty"`
	// 用于生成签名
	Token string `json:"token" xml:"token"`
	// 用于消息体的加密，是AES密钥的Base64编码
	EncodingAESKey string `json:"encodingaeskey" xml:"encodingaeskey"`
}

type CallbackData struct {
	AgentId string `json:"agentId"`
	Content string `json:"content"`
	Ldap    string `json:"ldap"`
}

type Caller interface {
	Success() bool
	Error() error
}

type Department struct {
	// 部门id，32位整型，指定时必须大于1。若不填该参数，将自动生成id
	ID int `json:"id,omitempty" xml:"Id"`
	// 部门名称。长度限制为1~32个字符，字符不能包括\:?”<>｜
	Name string `json:"name,omitempty" xml:"Name"`
	// 英文名称，需要在管理后台开启多语言支持才能生效。长度限制为1~32个字符，字符不能包括\:?”<>｜
	NameEn string `json:"name_en,omitempty"`
	// 父部门id，32位整型
	ParentID int `json:"parentid,omitempty" xml:"ParentID"`
	// 在父部门中的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
	Order int `json:"order,omitempty" xml:"order"`
	// 子部门
	Department []Department `json:"department,omitempty"`
}

type ExternalAttr struct {
	// 属性类型: 0-文本 1-网页 2-小程序
	Type int `json:"type,omitempty"`

	// 属性名称： 需要先确保在管理端有创建该属性，否则会忽略
	Name string `json:"name,omitempty"`

	// 文本类型的属性  type为0时必填
	Text TextAttr `json:"text,omitempty"`

	// 网页类型的属性，url和title字段要么同时为空表示清除该属性，要么同时不为空	type为1时必填
	Web WebAttr `json:"web,omitempty"`

	// 小程序类型的属性，appid和title字段要么同时为空表示清除改属性，要么同时不为空	type为2时必填
	Miniprogram MiniprogramAttr `json:"miniprogram,omitempty"`
}

type ExternalProfile struct {

	// 企业对外简称，需从已认证的企业简称中选填。可在“我的企业”页中查看企业简称认证状态。
	CorpName string `json:"external_corp_name,omitempty"`

	// 属性列表，目前支持文本、网页、小程序三种类型
	ExternalAttr ExternalAttr `json:"external_attr,omitempty"`
}

type MPNewsArticle struct {
	Title            string `json:"title,omitempty"`              // 图文标题
	ThumbMediaId     string `json:"thumb_media_id,omitempty"`     // 缩略图素材ID
	Author           string `json:"author,omitempty"`             // 作者
	ContentSourceUrl string `json:"content_source_url,omitempty"` // 页面链接
	Content          string `json:"content,omitempty"`            // 消息内容
	Digest           string `json:"digest,omitempty"`             // 消息描述
}

type MPNewsMessage struct {
	Articles []MPNewsArticle `json:"articles,omitempty"` // 图文消息内容，支持1-8条图文
}

type Media struct {
	Type      string `json:"type,omitempty"`       // 文件类型,image、voice、video、file
	MediaId   string `json:"media_id,omitempty"`   // 唯一标识，3天内有效
	CreatedAt string `json:"created_at,omitempty"` // 上传时间戳
	// contains filtered or unexported fields
}

type MediaMessage struct {
	MediaId string `json:"media_id,omitempty"`
}

type Message struct {
	// 接收成员ID列表，“|”分隔,max:1000,全部成员:"@all"
	ToUser string `json:"touser,omitempty"`

	// 接收部门ID列表，“|”分隔,max:100
	ToParty string `json:"toparty,omitempty"`

	// 接收标签ID列表，“|”分隔,max:100
	ToTag string `json:"totag,omitempty"`

	// 消息类型
	MsgType string `json:"msgtype,omitempty"`

	// 企业应用ID
	AgentID int `json:"agentid,omitempty"`

	// 是否是保密消息，0表示否，1表示是，默认0
	Safe int8 `json:"safe,omitempty"`

	// 是否开启id转译，0表示否，1表示是，默认0
	EnableIdTrans int8 `json:"enable_id_trans,omitempty"`

	// 是否开启重复消息检查，0表示否，1表示是，默认0
	EnableDuplicateCheck int8 `json:"enable_duplicate_check,omitempty"`

	// 是否重复消息检查的时间间隔，默认1800s，最大不超过4小时
	DuplicateCheckInterval int64 `json:"duplicate_check_interval,omitempty"`

	Text        *TextMessage              `json:"text,omitempty"`               // 文本消息
	Markdown    *TextMessage              `json:"markdown,omitempty"`           // markdown 消息
	Image       *MediaMessage             `json:"image,omitempty"`              // 图片消息
	Voice       *MediaMessage             `json:"voice,omitempty"`              // 语音消息
	File        *MediaMessage             `json:"file,omitempty"`               // 文件消息
	Video       *VideoMessage             `json:"video,omitempty"`              // 视频消息
	TextCard    *TextCardMessage          `json:"textcard,omitempty"`           // 文本卡片消息
	News        *NewsMessage              `json:"news,omitempty"`               // 图文消息
	MPNews      *MPNewsMessage            `json:"mpnews,omitempty"`             // 图文消息(mpnews)
	MiniProgram *MiniprogramNoticeMessage `json:"miniprogram_notice,omitempty"` // 小程序消息
	TaskCard    *TaskCardMessage          `json:"taskcard,omitempty"`           // 任务卡片消息
}

type MiniprogramAttr struct {
	// 小程序appid，必须是有在本企业安装授权的小程序，否则会被忽略
	Appid int `json:"appid,omitempty"`

	// 小程序的展示标题,长度限制12个UTF8字符
	Title string `json:"title,omitempty"`

	// 小程序的页面路径
	Pagepath string `json:"pagepath,omitempty"`
}

type MiniprogramNoticeMessage struct {
	Appid             string            `json:"appid,omitempty"`               // 小程序appid,必须是与当前小程序应用关联的小程序
	Page              string            `json:"page,omitempty"`                // 点击消息卡片后的小程序页面，仅限本小程序内的页面
	Title             string            `json:"title,omitempty"`               // 消息标题
	Description       string            `json:"description,omitempty"`         // 消息描述
	EmphasisFirstItem bool              `json:"emphasis_first_item,omitempty"` // 是否放大第一个content_item
	ContentItem       map[string]string `json:"content_item,omitempty"`        // 消息内容键值对，最多允许10个item
}

type NewsArticle struct {
	Title       string `json:"title,omitempty"`       // 图文标题
	Description string `json:"description,omitempty"` // 图文描述
	Url         string `json:"url,omitempty"`         // 跳转链接
	PicUrl      string `json:"picurl,omitempty"`      // 图片链接
}

type NewsMessage struct {
	Articles []NewsArticle `json:"articles,omitempty"` // 图文消息内容，支持1-8条图文
}

type RecvEvent struct {
	Event    string `xml:"Event"`    // 事件类型
	EventKey string `xml:"EventKey"` // 事件KEY值

	// 上报地理位置事件
	Latitude  string `xml:"Latitude"`  // 地理位置纬度
	Longitude string `xml:"Longitude"` // 地理位置经度
	Precision string `xml:"Precision"` // 地理位置精度

	// 异步任务完成事件推送
	JobID   string `xml:"JobId"`   // 异步任务id
	JobType string `xml:"JobType"` // 操作类型
	ErrCode int    `xml:"ErrCode"`
	ErrMsg  string `xml:"ErrMsg"`

	// 通讯录变更事件
	ChangeType string `xml:"ChangeType"`
}

type RecvMessage struct {
	ToUsername   string `xml:"ToUserName"`   // 企业微信CorpID
	FromUsername string `xml:"FromUserName"` // 成员UserID
	CreateTime   int64  `xml:"CreateTime"`   // 消息创建时间（整型）
	MsgType      string `xml:"MsgType"`      // 消息类型
	AgentID      int    `xml:"AgentId"`      // 企业应用的id，整型
	MsgID        int64  `xml:"MsgId"`        // 消息id，64位整型

	Content string `xml:"Content"` // 文本消息

	// 多媒体消息
	MediaID      string `xml:"MediaId"`      // 媒体文件id
	PicURL       string `xml:"PicUrl"`       // 图片链接
	Format       string `xml:"Format"`       // 语音格式
	ThumbMediaID string `xml:"ThumbMediaId"` // 视频缩略图的媒体id

	// 位置消息
	LocationX float64 `xml:"Location_X"` // 地理位置纬度
	LocationY float64 `xml:"Location_Y"` // 地理位置经度
	Scale     int     `xml:"Scale"`      // 地图缩放大小
	Label     string  `xml:"Label"`      // 地理位置信息

	// 链接消息
	Title       string `xml:"Title"`       // 标题
	Description string `xml:"Description"` // 链接描述
	Url         string `xml:"Url"`         // 链接跳转的url

	RecvEvent
}

type ReplyMessage struct {
	ToUserName   string
	FromUserName string
	CreateTime   int64
	MsgType      string

	// 文本消息
	Content string

	// 多媒体消息
	MediaId     string
	Title       string
	Description string

	ArticleCount int
	Url          string
	PicUrl       string
}

type RespMessage struct {
	InvalidUser  string `json:"invaliduser"`
	InvalidParty string `json:"invalidparty"`
	InvalidTag   string `json:"invalidtag"`
	// contains filtered or unexported fields
}

type Tag struct {
	TagID     int      `json:"tagid"`               // 标签id
	TagName   string   `json:"tagname"`             // 标签名称
	UserList  []string `json:"userlist,omitempty"`  // 标签成员ID列表
	PartyList []int    `json:"partylist,omitempty"` // 标签部门ID列表
}

type TaskCardBtn struct {
	Key         string `json:"key,omitempty"`          // 按钮key值
	Name        string `json:"name,omitempty"`         // 按钮名称
	ReplaceName string `json:"replace_name,omitempty"` // 点击按钮后显示的名称
	Color       string `json:"color,omitempty"`        // 按钮字体颜色
	IsBold      bool   `json:"is_bold,omitempty"`      // 按钮字体是否加粗
}

type TaskCardMessage struct {
	Title       string        `json:"title,omitempty"`       // 消息标题
	Description string        `json:"description,omitempty"` // 消息描述
	Url         string        `json:"url,omitempty"`         // 跳转链接
	TaskId      string        `json:"task_id,omitempty"`     // 任务id
	Btn         []TaskCardBtn `json:"btn,omitempty"`         // 按钮列表，按钮个数为为1~2个
}

type TextAttr struct {
	// 文本属性内容,长度限制12个UTF8字符
	Value string `json:"value,omitempty"`
}

type TextCardMessage struct {
	Title       string `json:"title,omitempty"`       // 消息标题
	Description string `json:"description,omitempty"` // 消息描述
	Url         string `json:"url,omitempty"`         // 消息跳转链接
	BtnTxt      string `json:"btntxt,omitempty"`      // 按钮文字, 默认为“详情”
}

type TextMessage struct {
	Content string `json:"content,omitempty"` // 消息内容，最长不超过2048个字节
}

type User struct {
	// 成员UserID。对应管理端的帐号，企业内必须唯一。不区分大小写，长度为1~64个字节。只能由数字、字母和“_-@.”四种字符组成，且第一个字符必须是数字或字母。
	UserID string `json:"userid,omitempty" xml:"UserID"`

	// 成员名称。长度为1~64个utf8字符
	Name string `json:"name,omitempty" xml:"Name"`

	// 成员别名。长度1~32个utf8字符
	Alias string `json:"alias,omitempty" xml:"Alias"`

	// 手机号码。企业内必须唯一，mobile/email二者不能同时为空
	Mobile string `json:"mobile,omitempty" xml:"Mobile"`

	// 成员所属部门id列表,不超过20个
	Department []int `json:"department,omitempty" xml:"Department"`

	// 部门内的排序值，默认为0，成员次序以创建时间从小到大排列。数量必须和department一致，数值越大排序越前面。有效的值范围是[0, 2^32)
	Order []int `json:"order,omitempty" xml:"Order"`

	// 职务信息。长度为0~128个字符
	Position string `json:"position,omitempty" xml:"Position"`

	// 性别。1表示男性，2表示女性
	Gender string `json:"gender,omitempty" xml:"Gender"`

	// 邮箱。长度6~64个字节，且为有效的email格式。企业内必须唯一，mobile/email二者不能同时为空
	Email string `json:"email,omitempty" xml:"Email"`

	// 座机。32字节以内，由纯数字或’-‘号组成。
	Telephone string `json:"telephone,omitempty" xml:"Telephone"`

	// 个数必须和department一致，表示在所在的部门内是否为上级。1表示为上级，0表示非上级。在审批等应用里可以用来标识上级审批人
	IsLeaderInDept []int `json:"is_leader_in_dept,omitempty" xml:"IsLeaderInDept"`

	// 成员头像的mediaid，通过素材管理接口上传图片获得的mediaid
	AvatarMediaID string `json:"avatar_mediaid,omitempty"`

	// 启用/禁用成员。1表示启用成员，0表示禁用成员
	Enable int8 `json:"enable,omitempty"`

	// 自定义字段。自定义字段需要先在WEB管理端添加，见扩展属性添加方法，否则忽略未知属性的赋值。与对外属性一致，不过只支持type=0的文本和type=1的网页类型，详细描述查看对外属性
	ExtAttr Attrs `json:"extattr,omitempty" xml:"ExtAttr"`

	// 是否邀请该成员使用企业微信（将通过微信服务通知或短信或邮件下发邀请，每天自动下发一次，最多持续3个工作日），默认值为true。
	ToInvite bool `json:"to_invite,omitempty"`

	// 成员对外属性
	ExternalProfile ExternalProfile `json:"external_profile,omitempty"`

	// 对外职务，如果设置了该值，则以此作为对外展示的职务，否则以position来展示。长度12个汉字内
	ExternalPosition string `json:"external_position,omitempty"`

	Address     string `json:"address,omitempty" xml:"Address"` // 地址。
	Avatar      string `json:"avatar,omitempty" xml:"Avatar"`   // 头像url。 第三方仅通讯录应用可获取
	ThumbAvatar string `json:"thumb_avatar,omitempty"`          // 头像缩略图url。第三方仅通讯录应用可获取
	QrCode      string `json:"qr_code,omitempty"`               // 员工二维码
	Status      int8   `json:"status,omitempty" xml:"status"`   // 激活状态: 1=已激活，2=已禁用，4=未激活。
}

type VideoMessage struct {
	Title       string `json:"title,omitempty"`       // 视频标题
	Description string `json:"description,omitempty"` // 视频介绍
	MediaMessage
}

type WebAttr struct {
	// 网页的url,必须包含http或者https头
	Url string `json:"url,omitempty"`

	// 网页的展示标题,长度限制12个UTF8字符
	Title string `json:"title,omitempty"`
}