You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

266 lines
6.7 KiB
TOML

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

[service]
name = "WProject"
desc = "项目服务"
[[method]]
name = "Select"
desc = "项目选择列表"
[method.req]
field = [
"int64 company_id//企业id",
"bool show_user //是否值显示员工可展示,如果否,表示返回企业内所有项目",
"int64 user_id //员工id",
]
[method.res]
field = ["repeated One list //列表数据"]
[[method.res.message]]
name = "One"
field = [
"int64 id //项目id",
"string hash_id //对外项目id",
"string title //项目名称",
"int32 scene //项目应用场景(1-app,2-web)",
"string logo_url //项目logo地址",
"int32 is_test //是否测试项目(0-否,1-是)",
]
[[method]]
name = "List"
desc = "项目列表"
[method.req]
field = [
"int64 company_id//企业id",
"int32 page //当前页",
"int32 per_page //每页条数",
"bool show_user //是否值显示员工可展示,如果否,表示返回企业内所有项目",
"int64 user_id //员工id",
]
[method.res]
field = ["repeated One list //列表数据", "int64 total //列表总数"]
[[method.res.message]]
name = "One"
field = [
"int64 id //项目id",
"string hash_id //对外项目id",
"string title //项目名称",
"string domain //域名前缀",
"int64 created_time //创建时间时间戳",
"repeated UserRelate user_relate //关联的员工",
"int32 scene //项目应用场景(1-app,2-web)",
"string logo_url //项目logo地址",
]
[[method.res.message]]
name = "UserRelate"
field = [
"int64 user_id //员工id",
"string hash_id //对外员工id",
"string show_name //员工显示的名称",
]
[[method]]
name = "Show"
desc = "项目详情"
[method.req]
field = ["int64 id //项目id", "string hash_id //对外项目id"]
[method.res]
field = [
"int64 id //项目id",
"string hash_id //对外项目id",
"string title //项目名称",
"string domain //域名前缀",
"int64 company_id //企业id",
"string notify_token //项目回调token",
"string encrypt_str //数据加密字符串",
"int32 scene //项目应用场景(1-app,2-web)",
"string third_secret //第三方开放平台密钥",
"int32 fission_cert_type //活动用户认证方式(0-不认证,1-加密认证)",
"string third_url //开放平台回调地址",
"string third_reboost_url //开放平台reboot回调地址",
]
[[method]]
name = "Store"
desc = "创建项目"
[method.req]
field = [
"int64 company_id //企业id",
"int64 user_id //企业id",
"string title //项目名称",
"string domain //域名前缀",
"repeated string user_ids //关联的员工id",
"bool is_all //是否所有员工都可看",
"int32 scene //项目应用场景(1-app,2-web)",
"string logo_url //项目logo地址",
]
[method.res]
[[method]]
name = "Update"
desc = "更新项目"
[method.req]
field = [
"int64 id //项目id",
"string hash_id //对外项目id",
"string title //项目名称",
"repeated string user_ids //关联的员工id",
"bool is_all //是否所有员工都可看",
"string logo_url //项目logo地址",
]
[method.res]
[[method]]
name = "Destroy"
desc = "删除项目"
[method.req]
field = ["int64 id //项目id", "string hash_id //对外项目id"]
[method.res]
[[method]]
name = "Cert"
desc = "项目认证"
[method.req]
field = ["int64 id //项目id", "string hash_id //对外项目id", "string secret //项目私钥"]
[method.res]
field = [
"int64 id //项目id",
"string hash_id //对外项目id",
"string title //项目名称",
"string encrypt_str //数据加密字符串",
"int32 scene //项目应用场景(1-app,2-web)",
"repeated CertSecret cert_secrets //可认证的密钥",
]
[[method.res.message]]
name = "CertSecret"
field = ["string secret //密钥", "int64 expired_at //密钥过期时间,0为不过期"]
[[method]]
name = "ProjectSecret"
desc = "项目私钥"
[method.req]
field = ["int64 id //项目id", "string hash_id //对外项目id"]
[method.res]
field = ["string secret //项目私钥"]
[[method]]
name = "ChangeSecret"
desc = "修改密钥"
[method.req]
field = [
"int64 id //项目id",
"string hash_id //对外项目id",
"int64 user_id //创建的员工id",
"string username //管理账号",
"string passwd //管理员密码",
]
[method.res]
field = ["string secret //项目私钥"]
[[method]]
name = "ChangeOplatform"
desc = "修改开放平台"
[method.req]
field = [
"int64 id //项目id",
"string hash_id //对外项目id",
"string third_url //开放平台回调地址",
]
[method.res]
field = []
[[method]]
name = "DomainList"
desc = "获取项目域名绑定的项目"
[method.req]
field = ["string domain //项目域名"]
[method.res]
field = ["repeated One list //列表数据"]
[[method.res.message]]
name = "One"
field = [
"int64 id //项目id",
"string hash_id //对外项目id",
"int64 company_id //企业id",
"string title //项目名称",
"string domain //域名前缀",
"int64 created_time //创建时间时间戳",
]
[[method]]
name = "SaveAdsConfig"
desc = "保存广告配置"
[method.req]
field = [
"string project_hash_id //项目hash_id",
"int32 open_ad //开启广告模块(0-不开启,1-开启)",
"int32 campaign_ad //开启活动广告(0-不开启,1-开启)",
"int64 user_id //员工id(",
"string ip //操作的ip地址",
]
[method.res]
field = [
]
[[method]]
name = "AdsConfig"
desc = "获取广告配置"
[method.req]
field = [
"string project_hash_id //项目hash_id",
]
[method.res]
field = [
"int32 open_ad //开启广告模块(0-不开启,1-开启)",
"int32 campaign_ad //开启广告模块(0-不开启,1-开启)",
"int32 ad_custom_url //开启广告自定义链接配置(0-不开启,1-开启)",
]
[[method]]
name = "ChangeRebootUrl"
desc = "修改开放平台的活动回调地址"
[method.req]
field = [
"int64 id //项目id",
"string hash_id //对外项目id",
"string third_reboost_url //开放平台回调地址",
]
[method.res]
[[method]]
name = "FissionConfig"
desc = "获取广告配置"
[method.req]
field = [
"string project_hash_id //项目hash_id",
]
[method.res]
field = [
"int32 push_visit //用户访问推送(0-否,1-是)",
"int32 push_campaign_task //活动任务完成推送(0-否,1-是)",
]
[[method]]
name = "SetPushVisit"
desc = "设置活动访问推送开关"
[method.req]
field = [
"string project_hash_id //项目hash_id",
"int32 push_visit //用户访问推送(0-否,1-是)",
]
[method.res]
[[method]]
name = "SetPushCampaignTask"
desc = "设置活动任务完成推送开关"
[method.req]
field = [
"string project_hash_id //项目hash_id",
"int32 push_campaign_task //活动任务完成推送(0-否,1-是)",
]
[method.res]