Files

65 lines
3.1 KiB
Go

package v1
import (
"github.com/gogf/gf/v2/frame/g"
"git.5iot.com/iotlcm-public/iotlcm-openapi/internal/model"
)
type SimSubscribeReq struct {
g.Meta `path:"/sim-subscribe" method:"POST" tags:"V3 Change API" summary:"Single SIM subscription renewal"`
AppId string `json:"appId" v:"required#appId is required"`
Iccid string `json:"iccid,omitempty"`
Msisdn string `json:"msisdn,omitempty"`
Imsi string `json:"imsi,omitempty"`
PackageId string `json:"packageId" v:"required#packageId is required"`
Validity int `json:"validity" v:"required|min:1#validity is required|validity must be greater than 0"`
Remark string `json:"remark,omitempty"`
}
type BatchSimSubscribeReq struct {
g.Meta `path:"/batch-sim-subscribe" method:"POST" tags:"V3 Change API" summary:"Batch SIM subscription renewal"`
AppId string `json:"appId" v:"required#appId is required"`
Cards []model.CommonRenewCard `json:"cards,omitempty"`
Iccid []string `json:"iccid,omitempty"`
PackageId string `json:"packageId" v:"required#packageId is required"`
Validity int `json:"validity" v:"required|min:1#validity is required|validity must be greater than 0"`
Remark string `json:"remark,omitempty"`
}
// RenewReq 历史批量续费兼容入口,与 /batch-sim-subscribe 共用 SubmitRenew 实现。
// 说明:g.Meta 的 deprecated 标签在 GoFrame v2.9.6 中不被解析,无任何运行时或文档生成效果,
// 不能替代对外废弃告知;对外说明见 openapi-docs「标准入口与兼容入口」一节。
type RenewReq struct {
g.Meta `path:"/renew" method:"POST" tags:"V3 Compatibility API" summary:"Deprecated compatibility endpoint; use /change/batch-sim-subscribe"`
model.CommonRenewParam
}
type RenewRes struct{ model.CommonRenewRes }
type SingleRenewRes struct{ model.CommonSingleRenewRes }
type TrafficCutoffConfigRes struct {
model.CommonTrafficCutoffConfigRes
}
type SingleTrafficCutoffRes struct {
model.CommonSingleTrafficCutoffRes
}
type SimTrafficCutoffReq struct {
g.Meta `path:"/sim-traffic-cutoff" method:"POST" tags:"V3 Change API" summary:"Single traffic cutoff configuration"`
model.CommonTrafficCutoffSingleParam
}
type BatchSimTrafficCutoffReq struct {
g.Meta `path:"/batch-sim-traffic-cutoff" method:"POST" tags:"V3 Change API" summary:"Batch traffic cutoff configuration"`
model.CommonTrafficCutoffConfigParam
}
// TrafficCutoffConfigReq 历史批量达量断网变更入口,已决定下线:不登记资源、不授权,
// 调用返回 10014。与 /batch-sim-traffic-cutoff 的参数类型与实现完全相同,客户应改用标准入口。
// 路由与结构体保留以便可逆恢复(取消登记 SQL 文末注释即可),故不删除代码。
// 说明:deprecated 标签在 GoFrame v2.9.6 中不被解析,无运行时效果。
type TrafficCutoffConfigReq struct {
g.Meta `path:"/traffic-cutoff-config" method:"POST" tags:"V3 Compatibility API" summary:"Deprecated write endpoint; use /change/batch-sim-traffic-cutoff"`
model.CommonTrafficCutoffConfigParam
}