controllers

package
v0.3.82 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 31, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

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} models.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} models.DeviceValuation @Security BearerAuth @Router /user/devices/{userDeviceID}/valuations [get]

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL