Documentation
¶
Index ¶
- func DecodeVIN(dvq queries.DecodeVINQueryHandler) fiber.Handler
- func GetCompatibilityR1Sheet(m mediator.Mediator) fiber.Handler
- func GetDeviceDefinitionByID(m mediator.Mediator) fiber.Handler
- func GetDeviceDefinitionSearch(m mediator.Mediator) fiber.Handler
- func GetDeviceTypes(m mediator.Mediator) fiber.Handler
- func GetDeviceTypesByID(m mediator.Mediator) fiber.Handler
- func GetIntegrationByID(m mediator.Mediator) fiber.Handler
- func GetIntegrations(m mediator.Mediator) fiber.Handler
- func GetR1CompatibilitySearch(m mediator.Mediator) fiber.Handler
- func GetSmartcarManufacturers() fiber.Handler
- func VINProfile(m mediator.Mediator) fiber.Handler
- type DecodeVINRequest
- type DecodeVINResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DecodeVIN ¶ added in v1.2.47
func DecodeVIN(dvq queries.DecodeVINQueryHandler) fiber.Handler
DecodeVIN godoc @Summary returns device definition id corresponding to a given vin @ID DecodeVIN @Description decode a vin @Tags device-definitions @Produce json @Accept json @Param decodeRequest body DecodeVINRequest true "Decode VIN request" @Success 200 {object} DecodeVINResponse "Response with definition ID. @Failure 404 @Failure 500 @Security BearerAuth @Router /device-definitions/decode-vin [post]
func GetCompatibilityR1Sheet ¶ added in v1.2.56
GetCompatibilityR1Sheet godoc @Summary gets r1 MMY compatibility google sheet in JSON form @ID GetCompatibilityR1Sheet @Description gets r1 MMY compatibility google sheet in JSON form. returns an array of below objects @Tags device-definitions @Produce json @Success 200 {object} queries.CompatibilitySheetRow @Failure 500 @Router /compatibility/r1-sheet [get]
func GetDeviceDefinitionByID ¶
GetDeviceDefinitionByID godoc @Summary gets a device definition, from tableland on-chain records. Only support mmy style id's eg. ford_escape_2025 @ID GetDeviceDefinitionByID @Description gets a device definition @Tags device-definitions @Param id path string true "mmy definition_id eg. ford_escape_2020" @Produce json @Success 200 {object} models.DeviceDefinitionTablelandModel @Failure 404 @Failure 400 @Failure 500 @Router /device-definitions/{id} [get]
func GetDeviceDefinitionSearch ¶ added in v1.2.31
GetDeviceDefinitionSearch godoc @Summary gets device definitions by search filter @ID GetDeviceDefinitionSearch @Description gets a device definition by search filter @Tags device-definitions @Param query query string true "query filter" @Param makeSlug query string false "make Slug" @Param modelSlug query string false "model Slug" @Param year query number false "year" @Param page query number false "page" @Param pageSize query number false "pageSize" @Accept json @Produce json @Success 200 {object} queries.GetAllDeviceDefinitionBySearchQueryResult @Failure 500 @Router /device-definitions/search [get]
func GetDeviceTypes ¶ added in v1.0.37
GetDeviceTypes godoc @Summary gets a device type. @ID GetDeviceTypes @Description gets a devices type @Tags device-definitions @Produce json @Success 200 @Failure 500 @Router /device-types [get]
func GetDeviceTypesByID ¶ added in v0.2.0
GetDeviceTypesByID godoc @Summary gets a device type. @ID GetDeviceTypesByID @Description gets a devices type with attributes @Tags device-definitions @Param id path string true "device type id" @Produce json @Success 200 @Failure 404 @Failure 500 @Router /device-types/{id} [get]
func GetIntegrationByID ¶ added in v0.1.26
GetIntegrationByID godoc @Summary gets integration by id. @ID GetIntegrationByID @Description gets integration by id. @Tags device-definitions @Accept json @Produce json @Success 200 @Failure 404 @Failure 500 @Router /integrations/{id} [get]
func GetIntegrations ¶
GetIntegrations godoc @Summary gets list of integrations we have defined. @ID GetIntegrations @Description gets list of integrations we have defined. @Tags device-definitions @Produce json @Success 200 @Failure 404 @Failure 500 @Router /integrations [get]
func GetR1CompatibilitySearch ¶ added in v1.2.55
GetR1CompatibilitySearch godoc @Summary gets r1 MMY compatibility by search filter @ID GetR1CompatibilitySearch @Description gets r1 compatibility search by filter @Tags device-definitions @Param query query string true "query filter" @Param page query number false "page" @Param pageSize query number false "pageSize" @Accept json @Produce json @Success 200 {object} queries.GetR1CompatibilitySearchQueryResult @Failure 500 @Router /device-definitions/search-r1 [get]
func GetSmartcarManufacturers ¶ added in v1.2.37
func GetSmartcarManufacturers() fiber.Handler
GetSmartcarManufacturers godoc @Summary gets all supported manufacturers for the smartcar external integration @ID GetSmartcarManufacturers @Description gets manufacturers supported by smartcar @Tags device-definitions @Produce json @Success 200 @Failure 500 @Router /manufacturers/integrations/smartcar [get]
func VINProfile ¶ added in v1.3.2
VINProfile godoc @Summary gets any raw profile info we have on previously decoded VINs. USA Only. @ID VINProfile @Description gets VIN profile if we have it. @Tags device-definitions @Param vin path string true "17 character usa based VIN eg. WBA12345678901234" @Produce json @Success 200 {object} map[]string{} @Failure 404 @Failure 400 @Failure 500 @Security BearerAuth @Router /vin-profile/{vin} [get]
Types ¶
type DecodeVINRequest ¶ added in v1.2.47
type DecodeVINResponse ¶ added in v1.2.47
type DecodeVINResponse struct {
// new name slug based id, can use this to query identity-api
DeviceDefinitionID string `json:"deviceDefinitionId"`
// if a new device definition was created, the tableland transaction hash from the insert statement. Check this has completed before querying the ID
NewTransactionHash string `json:"newTransactionHash"`
}
Source Files