admin

Documentation

Index

• func AddCoupon(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc
• func DeleteCoupon(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc
• func DisableUser(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc
• func EditCoupon(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc
• func GetCoupon(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc
• func GetCouponDetail(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc
• func GetReport(pg *db.DB, mc *minio.MC, logger *zap.SugaredLogger) echo.HandlerFunc
• func GetUser(pg *db.DB, mc *minio.MC, logger *zap.SugaredLogger) echo.HandlerFunc
• type PrettierCoupon

Functions

func AddCoupon

func AddCoupon(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc

@Summary Admin Add Coupon @Description Add global coupon. @Tags Admin, Coupon @Accept json @Produce json @Param coupon body db.AddCouponParams true "Coupon" @Success 200 {object} db.AddCouponRow @Failure 400 {object} echo.HTTPError @Failure 500 {object} echo.HTTPError @Router /admin/coupon [post]

func DeleteCoupon

func DeleteCoupon(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc

@Summary Admin Delete Coupon @Description Delete coupon (include shops'). @Tags Admin, Coupon @Produce json @Param id path int true "Coupon ID" @Success 200 {string} string constants.SUCCESS @Failure 400 {object} echo.HTTPError @Failure 500 {object} echo.HTTPError @Router /admin/coupon/{id} [delete]

func DisableUser

func DisableUser(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc

@Summary Admin Disable User @Description Disable user. @Tags Admin, User @Produce json @param username path string true "Username" @Success 200 {string} string constants.SUCCESS @Failure 400 {object} echo.HTTPError @Failure 404 {object} echo.HTTPError @Failure 500 {object} echo.HTTPError @Router /admin/user/{username} [delete]

func EditCoupon

func EditCoupon(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc

@Summary Admin Edit Coupon @Description Edit global coupon. All the coupon properties are required. @Tags Admin, Coupon @Accept json @Produce json @Param id path int true "Coupon ID" @Param coupon body PrettierCoupon true "Coupon" @Success 200 {object} db.EditCouponRow @Failure 400 {object} echo.HTTPError @Failure 500 {object} echo.HTTPError @Router /admin/coupon/{id} [patch]

func GetCoupon

func GetCoupon(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc

@Summary Admin Get Coupon @Description Get all global coupons . @Tags Admin, Coupon @Produce json @param offset query int false "Begin index" default(0) @param limit query int false "limit" default(10) @Success 200 {array} db.GetGlobalCouponsRow @Failure 400 {object} echo.HTTPError @Failure 500 {object} echo.HTTPError @Router /admin/coupon [get]

func GetCouponDetail

func GetCouponDetail(pg *db.DB, logger *zap.SugaredLogger) echo.HandlerFunc

@Summary Admin Get Coupon Detail @Description Get coupon details. @Tags Admin, Coupon, Shop @Produce json @Param id path int true "Coupon ID" @Success 200 {object} db.GetGlobalCouponDetailRow @Failure 400 {object} echo.HTTPError @Failure 404 {object} echo.HTTPError @Failure 500 {object} echo.HTTPError @Router /admin/coupon/{id} [get]

func GetReport

func GetReport(pg *db.DB, mc *minio.MC, logger *zap.SugaredLogger) echo.HandlerFunc

@Summary Admin Get Site Report @Description Get site report (top 3 sellers and total amount). @Tags Admin, Report @Produce json @Param date query string true "Start year/month" @Success 200 {object} adminReport @Failure 400 {object} echo.HTTPError @Failure 500 {object} echo.HTTPError @Router /admin/report [get]

func GetUser

func GetUser(pg *db.DB, mc *minio.MC, logger *zap.SugaredLogger) echo.HandlerFunc

@Summary Admin Get User @Description Get all user information. Include user's icon, name, email, created time and role. @Tags Admin, User @Produce json @Param offset query int false "Begin index" default(0) @Param limit query int false "limit" default(10) maximum(20) @Success 200 {array} db.GetUsersRow @Failure 400 {object} echo.HTTPError @Router /admin/user [get]

Types

type PrettierCoupon

type PrettierCoupon struct {
	Type        db.CouponType `json:"type"`
	Name        string        `json:"name"`
	Description string        `json:"description"`
	Discount    float32       `json:"discount"`
	StartDate   string        `json:"start_date"`
	ExpireDate  string        `json:"end_date"`
}