fusenapi/server_api/home-user-auth.api

165 lines
6.7 KiB
Plaintext
Raw Normal View History

2023-05-31 03:38:17 +00:00
syntax = "v1"
info (
title: // TODO: add title
desc: // TODO: add description
author: ""
email: ""
)
2023-05-31 10:33:02 +00:00
import "basic.api"
2023-05-31 03:38:17 +00:00
type request {
// TODO: add members here and delete this comment
2023-06-01 08:19:24 +00:00
// Name string `form:"name"` // parameters are auto validated
}
2023-06-06 12:08:32 +00:00
service home-user-auth {
@handler UserLoginHandler
2023-06-07 03:36:29 +00:00
post /user/login(RequestUserLogin) returns (response);
2023-06-06 12:08:32 +00:00
2023-06-14 10:17:45 +00:00
@handler AcceptCookieHandler
post /user/accept-cookie(request) returns (response);
2023-06-06 12:08:32 +00:00
@handler UserFontsHandler
get /user/fonts(request) returns (response);
2023-06-08 07:41:49 +00:00
@handler UserGetTypeHandler
2023-06-06 12:08:32 +00:00
get /user/get-type(request) returns (response);
@handler UserSaveBasicInfoHandler
post /user/basic-info(RequestBasicInfoForm) returns (response);
2023-06-07 10:30:58 +00:00
@handler UserStatusConfigHandler
2023-06-08 03:36:47 +00:00
post /user/status-config(request) returns (response);
2023-06-08 07:41:49 +00:00
2023-06-06 12:08:32 +00:00
@handler UserBasicInfoHandler
get /user/basic-info(request) returns (response);
2023-06-08 10:55:08 +00:00
@handler UserAddressListHandler
get /user/address-list(request) returns (response);
2023-06-19 10:27:31 +00:00
@handler UserAddAddressHandler
post /user/add-address(RequestAddAddress) returns (response);
2023-06-20 04:15:14 +00:00
@handler UserOderDeleteHandler
post /user/order-delete(RequestOrderId) returns (response);
2023-06-06 12:08:32 +00:00
}
2023-06-05 09:56:55 +00:00
type RequestBasicInfoForm {
2023-06-19 07:52:14 +00:00
FirstName string `json:"first_name"` // FirstName
LastName string `json:"last_name"` // LastName
Company string `json:"company"` // 公司名称
Mobile string `json:"mobile"` // 手机号码
Email string `json:"email"` // 邮箱
Type int64 `json:"type"` // 1正常 0不正常
IsOrderStatusEmail int64 `json:"is_order_status_email"` // 订单状态改变时是否接收邮件
IsEmailAdvertisement int64 `json:"is_email_advertisement"` // 是否接收邮件广告
IsOrderStatusPhone int64 `json:"is_order_status_phone"` // 订单状态改变是是否接收电话
IsPhoneAdvertisement int64 `json:"is_phone_advertisement"` // 是否接收短信广告
IsOpenRender int64 `json:"is_open_render"` // 是否打开个性化渲染1开启0关闭
IsLowRendering int64 `json:"is_low_rendering"` // 是否开启低渲染模型渲染
IsRemoveBg int64 `json:"is_remove_bg"` // 用户上传logo是否去除背景
2023-06-05 09:56:55 +00:00
2023-06-15 08:08:43 +00:00
// NewPassword string `form:"new_password,optional" db:"new_password"` // new_password 如果存在新密码
2023-06-05 09:56:55 +00:00
}
2023-06-19 10:27:31 +00:00
// UserAddAddressHandler 用户登录请求结构
2023-06-01 10:35:09 +00:00
type RequestUserLogin {
2023-06-08 10:55:08 +00:00
Name string `json:"name"`
Password string `json:"pwd"`
2023-06-01 10:35:09 +00:00
}
2023-06-20 04:15:14 +00:00
// RequestAddAddress 增加地址结构
2023-06-19 10:27:31 +00:00
type RequestAddAddress {
Id int64 `json:"id"` // address_id 地址id
2023-06-20 04:15:14 +00:00
IsDefault int64 `json:"is_default"` //是否默认
2023-06-19 10:27:31 +00:00
Name string `json:"name"` //收货人
FirstName string `json:"first_name"` //first_name
LastName string `json:"last_name"` //last_name
Mobile string `json:"mobile"` //手机
ZipCode string `json:"zip_code"` //邮编
Street string `json:"street"` //街道
Suite string `json:"suite"` //房号
City string `json:"city"` //城市
State string `json:"state"` //州
}
2023-06-20 04:15:14 +00:00
// RequestOrderId 传入订单id的结构
type RequestOrderId {
2023-06-20 09:29:02 +00:00
OrderId int64 `json:"id"` //订单id
RefundReasonId int64 `json:"refund_reason_id"` //取消原因id
RefundReason string `json:"refund_reason"` //取消原因
2023-06-20 04:15:14 +00:00
}
2023-06-01 10:35:09 +00:00
// UserLoginHandler 用户登录请求结构
type DataUserLogin {
2023-06-15 08:08:43 +00:00
Token string `json:"token"` // 登录jwt token
}
// DataGuest 游客获取toekn请求结构
type DataGuest {
Token string `json:"token"` // 登录jwt token
2023-06-01 10:35:09 +00:00
}
// UserBasicInfoHandler 返回data结构
type DataUserBasicInfo {
2023-06-15 09:51:06 +00:00
Type int64 `json:"type"` // 1普通餐厅 2连锁餐厅
2023-06-19 07:52:14 +00:00
IsOrderStatusEmail int64 `json:"is_order_status_email"` // 订单状态改变时是否接收邮件
IsEmailAdvertisement int64 `json:"is_email_advertisement"` // 是否接收邮件广告
IsOrderStatusPhone int64 `json:"is_order_status_phone"` // 订单状态改变是是否接收电话
IsPhoneAdvertisement int64 `json:"is_phone_advertisement"` // 是否接收短信广告
IsOpenRender int64 `json:"is_open_render"` // 是否打开个性化渲染1开启0关闭
IsThousandFace int64 `json:"is_thousand_face"` // 是否已经存在千人千面1存在0不存在
IsLowRendering int64 `json:"is_low_rendering"` // 是否开启低渲染模型渲染
IsRemoveBg int64 `json:"is_remove_bg"` // 用户上传logo是否去除背景
2023-06-01 10:35:09 +00:00
}
// /user/get-type reponse.data 结构
type DataGetType {
2023-06-19 07:52:14 +00:00
Id int64 `json:"key"` // ID
Name string `json:"name"` // 餐厅名字
2023-06-08 02:51:56 +00:00
}
// KeyName 普通的key name 对象结构. eg: /user/status-config 用在返回值
type KeyName {
2023-06-08 03:36:47 +00:00
Key int `json:"key"`
2023-06-08 02:51:56 +00:00
Name string `json:"name"`
}
// KeyNameButton 普通的key name button 对象结构 eg: /user/status-config 用在返回值
type KeyNameButton {
2023-06-08 03:36:47 +00:00
Key int `json:"key"`
2023-06-08 02:51:56 +00:00
Name string `json:"name"`
Button []string `json:"button"`
}
// DataStatusConfig /user/status-config 返回值data结构
type DataStatusConfig {
SearchList []KeyName `json:"search_list"` //搜索下拉列表
OrderStatus []KeyNameButton `json:"order_status"` //直邮单状态
InventoryStatus []KeyNameButton `json:"Inventory_status"` //云仓单状态
OrderLogisticsStatus []KeyName `json:"order_logistics_status"` //订单物流状态
InventoryLogisticsStatus []KeyName `json:"Inventory_logistics_status"` //订单物流状态
Time []KeyName `json:"time"` //返回订单时间筛选项
RefundReason []KeyName `json:"refund_reason"` //退款原因说明项
2023-06-08 03:36:47 +00:00
LogisticsStatus []KeyNameButton `json:"logistics_status"` //物流状态筛选项
2023-06-08 07:41:49 +00:00
}
// DataAddressList /user/address-list 返回值
type DataAddressList {
2023-06-19 07:52:14 +00:00
Id int64 `json:"id"`
UserId int64 `json:"user_id"` // 用户ID
Name string `json:"name"` // 地址名称
FirstName string `json:"first_name"` // FirstName
LastName string `json:"last_name"` // LastName
Mobile string `json:"mobile"` // 手机号码
Street string `json:"street"` // 街道
Suite string `json:"suite"` // 房号
City string `json:"city"` // 城市
State string `json:"state"` // 州名
// Country string `json:"country"` // 国家
ZipCode string `json:"zip_code"` // 邮编
// Status int64 `json:"status"` // 1正常 0异常
IsDefault int64 `json:"is_default"` // 1默认地址0非默认地址
2023-06-07 03:57:04 +00:00
}