Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ValuationsController ¶
type ValuationsController struct {
// contains filtered or unexported fields
}
func NewValuationsController ¶
func NewValuationsController(log *zerolog.Logger, userDeviceSvc services.UserDeviceAPIService, natsService *services.NATSService) *ValuationsController
func (*ValuationsController) GetInstantOffer ¶ added in v0.2.3
func (vc *ValuationsController) GetInstantOffer(c *fiber.Ctx) error
GetInstantOffer godoc @Description makes a request for an instant offer for a particular user device. Simply returns success if able to create job. @Description You will need to query the offers endpoint to see if a new offer showed up. Job can take about a minute to complete. @Tags offers @Produce json @Param userDeviceID path string true "userDeviceID for vehicle to get offers" @Success 200 @Security BearerAuth @Router /user/devices/{userDeviceID}/instant-offer [get]
func (*ValuationsController) GetOffers ¶
func (vc *ValuationsController) GetOffers(c *fiber.Ctx) error
GetOffers godoc @Description gets any existing offers for a particular user device. You must call instant-offer endpoint first to pull. @Tags offers @Produce json @Param userDeviceID path string true "userDeviceID for vehicle to get offers" @Success 200 {object} core.DeviceOffer @Security BearerAuth @Router /user/devices/{userDeviceID}/offers [get]
func (*ValuationsController) GetValuations ¶
func (vc *ValuationsController) GetValuations(c *fiber.Ctx) error
GetValuations godoc @Description gets valuations for a particular user device. Includes only price valuations, not offers. only gets the latest valuation. @Tags valuations @Produce json @Param userDeviceID path string true "userDeviceID for vehicle to get offers" @Success 200 {object} core.DeviceValuation @Security BearerAuth @Router /user/devices/{userDeviceID}/valuations [get]
type VehiclesController ¶ added in v0.3.9
type VehiclesController struct {
// contains filtered or unexported fields
}
func NewVehiclesController ¶ added in v0.3.9
func NewVehiclesController(log *zerolog.Logger, userDeviceSvc services.UserDeviceAPIService, natsService *services.NATSService) *VehiclesController
func (*VehiclesController) GetOffers ¶ added in v0.3.9
func (vc *VehiclesController) GetOffers(c *fiber.Ctx) error
GetOffers godoc @Description gets any existing offers for a particular user device. You must call instant-offer endpoint first to pull newer. Returns list. @Tags offers @Produce json @Param tokenId path string true "tokenId for vehicle to get offers" @Success 200 {object} core.DeviceOffer @Security BearerAuth @Router /vehicles/{tokenId}/offers [get]
func (*VehiclesController) GetValuations ¶ added in v0.3.9
func (vc *VehiclesController) GetValuations(c *fiber.Ctx) error
GetValuations godoc @Description gets valuations for a particular user device. Includes only price valuations, not offers. gets list of most recent @Tags valuations @Produce json @Param tokenId path string true "tokenId for vehicle to get offers" @Success 200 {object} core.DeviceValuation @Security BearerAuth @Router /vehicles/{tokenId}/valuations [get]
func (*VehiclesController) RequestInstantOffer ¶ added in v0.3.9
func (vc *VehiclesController) RequestInstantOffer(c *fiber.Ctx) error
RequestInstantOffer godoc @Description makes a request for an instant offer for a particular user device. Simply returns success if able to create job. @Description You will need to query the offers endpoint to see if a new offer showed up. Job can take about a minute to complete. @Tags offers @Produce json @Param tokenId path string true "tokenId for vehicle to get offers" @Success 200 @Security BearerAuth @Router /vehicles/{tokenId}/instant-offer [post]
Source Files
Directories