qnc-server-tob/app/main/api/desc/admin/admin_agent.api

385 lines
18 KiB
Plaintext
Raw Normal View History

2025-06-09 12:34:52 +08:00
syntax = "v1"
info (
title: "后台代理管理服务"
desc: "后台代理相关接口"
author: "team"
version: "v1"
)
// 代理管理接口
@server(
prefix: /api/v1/admin/agent
group: admin_agent
)
service main {
// 代理分页查询
@handler AdminGetAgentList
get /list (AdminGetAgentListReq) returns (AdminGetAgentListResp)
// 代理推广链接分页查询
@handler AdminGetAgentLinkList
get /agent-link/list (AdminGetAgentLinkListReq) returns (AdminGetAgentLinkListResp)
// 代理佣金分页查询
@handler AdminGetAgentCommissionList
get /agent-commission/list (AdminGetAgentCommissionListReq) returns (AdminGetAgentCommissionListResp)
// 代理奖励分页查询
@handler AdminGetAgentRewardList
get /agent-reward/list (AdminGetAgentRewardListReq) returns (AdminGetAgentRewardListResp)
// 代理提现分页查询
@handler AdminGetAgentWithdrawalList
get /agent-withdrawal/list (AdminGetAgentWithdrawalListReq) returns (AdminGetAgentWithdrawalListResp)
// 代理上级抽佣分页查询
@handler AdminGetAgentCommissionDeductionList
get /agent-commission-deduction/list (AdminGetAgentCommissionDeductionListReq) returns (AdminGetAgentCommissionDeductionListResp)
// 平台抽佣分页查询
@handler AdminGetAgentPlatformDeductionList
get /agent-platform-deduction/list (AdminGetAgentPlatformDeductionListReq) returns (AdminGetAgentPlatformDeductionListResp)
// 代理产品配置分页查询
@handler AdminGetAgentProductionConfigList
get /agent-production-config/list (AdminGetAgentProductionConfigListReq) returns (AdminGetAgentProductionConfigListResp)
// 代理产品配置编辑
@handler AdminUpdateAgentProductionConfig
post /agent-production-config/update (AdminUpdateAgentProductionConfigReq) returns (AdminUpdateAgentProductionConfigResp)
// 代理会员充值订单分页查询
@handler AdminGetAgentMembershipRechargeOrderList
get /agent-membership-recharge-order/list (AdminGetAgentMembershipRechargeOrderListReq) returns (AdminGetAgentMembershipRechargeOrderListResp)
// 代理会员配置分页查询
@handler AdminGetAgentMembershipConfigList
get /agent-membership-config/list (AdminGetAgentMembershipConfigListReq) returns (AdminGetAgentMembershipConfigListResp)
// 代理会员配置编辑
@handler AdminUpdateAgentMembershipConfig
post /agent-membership-config/update (AdminUpdateAgentMembershipConfigReq) returns (AdminUpdateAgentMembershipConfigResp)
}
type (
// 代理分页查询请求
AdminGetAgentListReq {
Page int64 `form:"page"` // 页码
PageSize int64 `form:"pageSize"` // 每页数量
Mobile *string `form:"mobile,optional"` // 手机号(可选)
Region *string `form:"region,optional"` // 区域(可选)
ParentAgentId *int64 `form:"parent_agent_id,optional"` // 上级代理ID可选
}
// 代理列表项
AgentListItem {
Id int64 `json:"id"` // 主键
UserId int64 `json:"user_id"` // 用户ID
ParentAgentId int64 `json:"parent_agent_id"` // 上级代理ID
LevelName string `json:"level_name"` // 等级名称
Region string `json:"region"` // 区域
Mobile string `json:"mobile"` // 手机号
MembershipExpiryTime string `json:"membership_expiry_time"` // 会员到期时间
Balance float64 `json:"balance"` // 钱包余额
TotalEarnings float64 `json:"total_earnings"` // 累计收益
FrozenBalance float64 `json:"frozen_balance"` // 冻结余额
WithdrawnAmount float64 `json:"withdrawn_amount"` // 提现总额
CreateTime string `json:"create_time"` // 创建时间
IsRealNameVerified bool `json:"is_real_name_verified"` // 是否已实名认证
RealName string `json:"real_name"` // 实名姓名
IdCard string `json:"id_card"` // 身份证号
RealNameStatus string `json:"real_name_status"` // 实名状态pending/approved/rejected
}
// 代理分页查询响应
AdminGetAgentListResp {
Total int64 `json:"total"` // 总数
Items []AgentListItem `json:"items"` // 列表数据
}
// 代理推广链接分页查询请求
AdminGetAgentLinkListReq {
Page int64 `form:"page"` // 页码
PageSize int64 `form:"pageSize"` // 每页数量
AgentId *int64 `form:"agent_id,optional"` // 代理ID可选
ProductName *string `form:"product_name,optional"` // 产品名(可选)
LinkIdentifier *string `form:"link_identifier,optional"` // 推广码(可选)
}
// 代理推广链接列表项
AgentLinkListItem {
AgentId int64 `json:"agent_id"` // 代理ID
ProductName string `json:"product_name"` // 产品名
Price float64 `json:"price"` // 价格
LinkIdentifier string `json:"link_identifier"` // 推广码
CreateTime string `json:"create_time"` // 创建时间
}
// 代理推广链接分页查询响应
AdminGetAgentLinkListResp {
Total int64 `json:"total"` // 总数
Items []AgentLinkListItem `json:"items"` // 列表数据
}
// 代理佣金分页查询请求
AdminGetAgentCommissionListReq {
Page int64 `form:"page"` // 页码
PageSize int64 `form:"pageSize"` // 每页数量
AgentId *int64 `form:"agent_id,optional"` // 代理ID可选
ProductName *string `form:"product_name,optional"` // 产品名(可选)
Status *int64 `form:"status,optional"` // 状态(可选)
}
// 代理佣金列表项
AgentCommissionListItem {
Id int64 `json:"id"` // 主键
AgentId int64 `json:"agent_id"` // 代理ID
OrderId int64 `json:"order_id"` // 订单ID
Amount float64 `json:"amount"` // 金额
ProductName string `json:"product_name"` // 产品名
Status int64 `json:"status"` // 状态
CreateTime string `json:"create_time"` // 创建时间
}
// 代理佣金分页查询响应
AdminGetAgentCommissionListResp {
Total int64 `json:"total"` // 总数
Items []AgentCommissionListItem `json:"items"` // 列表数据
}
// 代理奖励分页查询请求
AdminGetAgentRewardListReq {
Page int64 `form:"page"` // 页码
PageSize int64 `form:"pageSize"` // 每页数量
AgentId *int64 `form:"agent_id,optional"` // 代理ID可选
RelationAgentId *int64 `form:"relation_agent_id,optional"` // 关联代理ID可选
Type *string `form:"type,optional"` // 奖励类型(可选)
}
// 代理奖励列表项
AgentRewardListItem {
Id int64 `json:"id"` // 主键
AgentId int64 `json:"agent_id"` // 代理ID
RelationAgentId int64 `json:"relation_agent_id"` // 关联代理ID
Amount float64 `json:"amount"` // 金额
Type string `json:"type"` // 奖励类型
CreateTime string `json:"create_time"` // 创建时间
}
// 代理奖励分页查询响应
AdminGetAgentRewardListResp {
Total int64 `json:"total"` // 总数
Items []AgentRewardListItem `json:"items"` // 列表数据
}
// 代理提现分页查询请求
AdminGetAgentWithdrawalListReq {
Page int64 `form:"page"` // 页码
PageSize int64 `form:"pageSize"` // 每页数量
AgentId *int64 `form:"agent_id,optional"` // 代理ID可选
Status *int64 `form:"status,optional"` // 状态(可选)
WithdrawNo *string `form:"withdraw_no,optional"` // 提现单号(可选)
}
// 代理提现列表项
AgentWithdrawalListItem {
Id int64 `json:"id"` // 主键
AgentId int64 `json:"agent_id"` // 代理ID
WithdrawNo string `json:"withdraw_no"` // 提现单号
Amount float64 `json:"amount"` // 金额
Status int64 `json:"status"` // 状态
PayeeAccount string `json:"payee_account"` // 收款账户
Remark string `json:"remark"` // 备注
CreateTime string `json:"create_time"` // 创建时间
}
// 代理提现分页查询响应
AdminGetAgentWithdrawalListResp {
Total int64 `json:"total"` // 总数
Items []AgentWithdrawalListItem `json:"items"` // 列表数据
}
// 代理抽佣分页查询请求
AdminGetAgentCommissionDeductionListReq {
Page int64 `form:"page"` // 页码
PageSize int64 `form:"pageSize"` // 每页数量
AgentId *int64 `form:"agent_id,optional"` // 代理ID可选
ProductName *string `form:"product_name,optional"` // 产品名(可选)
Type *string `form:"type,optional"` // 类型cost/pricing可选
Status *int64 `form:"status,optional"` // 状态(可选)
}
// 代理抽佣列表项
AgentCommissionDeductionListItem {
Id int64 `json:"id"` // 主键
AgentId int64 `json:"agent_id"` // 代理ID
DeductedAgentId int64 `json:"deducted_agent_id"` // 被扣代理ID
Amount float64 `json:"amount"` // 金额
ProductName string `json:"product_name"` // 产品名
Type string `json:"type"` // 类型cost/pricing
Status int64 `json:"status"` // 状态
CreateTime string `json:"create_time"` // 创建时间
}
// 代理抽佣分页查询响应
AdminGetAgentCommissionDeductionListResp {
Total int64 `json:"total"` // 总数
Items []AgentCommissionDeductionListItem `json:"items"` // 列表数据
}
// 平台抽佣分页查询请求
AdminGetAgentPlatformDeductionListReq {
Page int64 `form:"page"` // 页码
PageSize int64 `form:"pageSize"` // 每页数量
AgentId *int64 `form:"agent_id,optional"` // 代理ID可选
Type *string `form:"type,optional"` // 类型cost/pricing可选
Status *int64 `form:"status,optional"` // 状态(可选)
}
// 平台抽佣列表项
AgentPlatformDeductionListItem {
Id int64 `json:"id"` // 主键
AgentId int64 `json:"agent_id"` // 代理ID
Amount float64 `json:"amount"` // 金额
Type string `json:"type"` // 类型cost/pricing
Status int64 `json:"status"` // 状态
CreateTime string `json:"create_time"` // 创建时间
}
// 平台抽佣分页查询响应
AdminGetAgentPlatformDeductionListResp {
Total int64 `json:"total"` // 总数
Items []AgentPlatformDeductionListItem `json:"items"` // 列表数据
}
// 代理产品配置分页查询请求
AdminGetAgentProductionConfigListReq {
Page int64 `form:"page"` // 页码
PageSize int64 `form:"pageSize"` // 每页数量
ProductName *string `form:"product_name,optional"` // 产品名(可选)
Id *int64 `form:"id,optional"` // 配置ID可选
}
// 代理产品配置分页查询响应
AdminGetAgentProductionConfigListResp {
Total int64 `json:"total"` // 总数
Items []AgentProductionConfigItem `json:"items"` // 列表数据
}
// 代理产品配置列表项
AgentProductionConfigItem {
Id int64 `json:"id"` // 主键
ProductName string `json:"product_name"` // 产品名
CostPrice float64 `json:"cost_price"` // 成本
PriceRangeMin float64 `json:"price_range_min"` // 最低定价
PriceRangeMax float64 `json:"price_range_max"` // 最高定价
PricingStandard float64 `json:"pricing_standard"` // 定价标准
OverpricingRatio float64 `json:"overpricing_ratio"` // 超价比例
CreateTime string `json:"create_time"` // 创建时间
}
// 代理产品配置编辑请求
AdminUpdateAgentProductionConfigReq {
Id int64 `json:"id"` // 主键
CostPrice float64 `json:"cost_price"` // 成本
PriceRangeMin float64 `json:"price_range_min"` // 最低定价
PriceRangeMax float64 `json:"price_range_max"` // 最高定价
PricingStandard float64 `json:"pricing_standard"` // 定价标准
OverpricingRatio float64 `json:"overpricing_ratio"` // 超价比例
}
// 代理产品配置编辑响应
AdminUpdateAgentProductionConfigResp {
Success bool `json:"success"` // 是否成功
}
// 代理会员充值订单分页查询请求
AdminGetAgentMembershipRechargeOrderListReq {
Page int64 `form:"page"` // 页码
PageSize int64 `form:"pageSize"` // 每页数量
UserId *int64 `form:"user_id,optional"` // 用户ID可选
AgentId *int64 `form:"agent_id,optional"` // 代理ID可选
OrderNo *string `form:"order_no,optional"` // 订单号(可选)
PlatformOrderId *string `form:"platform_order_id,optional"` // 平台订单号(可选)
Status *string `form:"status,optional"` // 状态(可选)
PaymentMethod *string `form:"payment_method,optional"` // 支付方式(可选)
}
// 代理会员充值订单列表项
AgentMembershipRechargeOrderListItem {
Id int64 `json:"id"` // 主键
UserId int64 `json:"user_id"` // 用户ID
AgentId int64 `json:"agent_id"` // 代理ID
LevelName string `json:"level_name"` // 等级名称
Amount float64 `json:"amount"` // 金额
PaymentMethod string `json:"payment_method"` // 支付方式
OrderNo string `json:"order_no"` // 订单号
PlatformOrderId string `json:"platform_order_id"` // 平台订单号
Status string `json:"status"` // 状态
CreateTime string `json:"create_time"` // 创建时间
}
// 代理会员充值订单分页查询响应
AdminGetAgentMembershipRechargeOrderListResp {
Total int64 `json:"total"` // 总数
Items []AgentMembershipRechargeOrderListItem `json:"items"` // 列表数据
}
// 代理会员配置分页查询请求
AdminGetAgentMembershipConfigListReq {
Page int64 `form:"page"` // 页码
PageSize int64 `form:"pageSize"` // 每页数量
LevelName *string `form:"level_name,optional"` // 会员级别名称(可选)
}
// 代理会员配置分页查询响应
AdminGetAgentMembershipConfigListResp {
Total int64 `json:"total"` // 总数
Items []AgentMembershipConfigListItem `json:"items"` // 列表数据
}
// 代理会员配置列表项
AgentMembershipConfigListItem {
Id int64 `json:"id"` // 主键
LevelName string `json:"level_name"` // 会员级别名称
Price *float64 `json:"price"` // 会员年费
ReportCommission *float64 `json:"report_commission"` // 直推报告收益
LowerActivityReward *float64 `json:"lower_activity_reward"` // 下级活跃奖励金额
NewActivityReward *float64 `json:"new_activity_reward"` // 新增活跃奖励金额
LowerStandardCount *int64 `json:"lower_standard_count"` // 活跃下级达标个数
NewLowerStandardCount *int64 `json:"new_lower_standard_count"` // 新增活跃下级达标个数
LowerWithdrawRewardRatio *float64 `json:"lower_withdraw_reward_ratio"` // 下级提现奖励比例
LowerConvertVipReward *float64 `json:"lower_convert_vip_reward"` // 下级转化VIP奖励
LowerConvertSvipReward *float64 `json:"lower_convert_svip_reward"` // 下级转化SVIP奖励
ExemptionAmount *float64 `json:"exemption_amount"` // 免责金额
PriceIncreaseMax *float64 `json:"price_increase_max"` // 提价最高金额
PriceRatio *float64 `json:"price_ratio"` // 提价区间收取比例
PriceIncreaseAmount *float64 `json:"price_increase_amount"` // 在原本成本上加价的金额
CreateTime string `json:"create_time"` // 创建时间
}
// 代理会员配置编辑请求
AdminUpdateAgentMembershipConfigReq {
Id int64 `json:"id"` // 主键
LevelName string `json:"level_name"` // 会员级别名称
Price float64 `json:"price"` // 会员年费
ReportCommission float64 `json:"report_commission"` // 直推报告收益
LowerActivityReward *float64 `json:"lower_activity_reward,optional,omitempty"` // 下级活跃奖励金额
NewActivityReward *float64 `json:"new_activity_reward,optional,omitempty"` // 新增活跃奖励金额
LowerStandardCount *int64 `json:"lower_standard_count,optional,omitempty"` // 活跃下级达标个数
NewLowerStandardCount *int64 `json:"new_lower_standard_count,optional,omitempty"` // 新增活跃下级达标个数
LowerWithdrawRewardRatio *float64 `json:"lower_withdraw_reward_ratio,optional,omitempty"` // 下级提现奖励比例
LowerConvertVipReward *float64 `json:"lower_convert_vip_reward,optional,omitempty"` // 下级转化VIP奖励
LowerConvertSvipReward *float64 `json:"lower_convert_svip_reward,optional,omitempty"` // 下级转化SVIP奖励
ExemptionAmount *float64 `json:"exemption_amount,optional,omitempty"` // 免责金额
PriceIncreaseMax *float64 `json:"price_increase_max,optional,omitempty"` // 提价最高金额
PriceRatio *float64 `json:"price_ratio,optional,omitempty"` // 提价区间收取比例
PriceIncreaseAmount *float64 `json:"price_increase_amount,optional,omitempty"` // 在原本成本上加价的金额
}
// 代理会员配置编辑响应
AdminUpdateAgentMembershipConfigResp {
Success bool `json:"success"` // 是否成功
}
)