saved_homes

Documentation

Overview

Package saved_homes @title properties actions @host localhost:8090

Index

• type Handler
  • func NewHandler(service Service) Handler
  • func (t Handler) AddRoutes(e *echo.Group, m ...echo.MiddlewareFunc)
  • func (t Handler) Create(ctx echo.Context) error
  • func (t Handler) Delete(ctx echo.Context) error
  • func (t Handler) List(ctx echo.Context) error
• type Service

Types

type Handler

type Handler struct {
	common.BaseHandler
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(service Service) Handler

func (Handler) AddRoutes

func (t Handler) AddRoutes(e *echo.Group, m ...echo.MiddlewareFunc)

func (Handler) Create

func (t Handler) Create(ctx echo.Context) error

Create

@Summary Add saved home @Description Adds property to user saved homes @Accept json @Tags savedhomes @Produce json @Success 200 {object} propertyResponse @Failure 400 {object} common.ErrorResponse @Failure 401 {object} common.ErrorResponse @Failure 403 {object} common.ErrorResponse @Failure 404 {object} common.ErrorResponse @Failure 500 {object} common.ErrorResponse @Security ApiKeyAuth @Router /v1/saved-homes/{id} [PUT]

func (Handler) Delete

func (t Handler) Delete(ctx echo.Context) error

Delete

@Summary Delete user saved home. @Description Delete user saved home. @Tags savedhomes @Accept json @Produce json @Security ApiKeyAuth @Success 204 {object} common.EmptyResponse @Failure 400 {object} common.ErrorResponse @Failure 401 {object} common.ErrorResponse @Failure 403 {object} common.ErrorResponse @Failure 404 {object} common.ErrorResponse @Failure 500 {object} common.ErrorResponse @Router /v1/saved-homes/{id} [DELETE]

func (Handler) List

func (t Handler) List(ctx echo.Context) error

List

@Summary List saved properties @Description List properties by ids. @Tags savedhomes @Accept json @Produce json @Security ApiKeyAuth @Param Pagination body paginationRequest true "pagination" @Success 200 {object} common.DefaultResponse{data=[]propertyResponse} @Failure 400 {object} common.ErrorResponse @Failure 401 {object} common.ErrorResponse @Failure 403 {object} common.ErrorResponse @Failure 404 {object} common.ErrorResponse @Failure 500 {object} common.ErrorResponse @Router /v1/saved-homes/list [POST]

type Service

type Service interface {
	Delete(ctx context.Context, home properties.UserSavedHome) error
	List(ctx context.Context, userId int, pagination domain.Pagination) ([]properties.Property, error)
	Add(ctx context.Context, home properties.UserSavedHome) (*properties.Property, error)
}