fipe

package module
v1.0.2 Latest Latest
Warning

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

 Go to latest Published: Oct 30, 2021 License: MIT Imports: 22 Imported by: 0

README

Go API client for fipe

API de Consulta Tabela FIPE fornece preços médios de veículos no mercado nacional. Atualizada mensalmente com dados extraidos da tabela FIPE.

Essa API Fipe utiliza banco de dados próprio, onde todas as requisições acontecem internamente, sem sobrecarregar o Web Service da Fipe, evitando assim bloqueios por múltiplos acessos.

A API está online desde 2015 e totalmente gratuíta. Gostaria que ele continuasse gratuíta? O que acha de me pagar uma cerveja? 🍺

Make a donation

Available SDKs

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import sw "./fipe"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://parallelum.com.br/fipe/api/v2

Class Method HTTP request Description
FipeApi GetBrandsByType Get /{vehicleType}/brands Brands by type
FipeApi GetFipeInfo Get /{vehicleType}/brands/{brandId}/models/{modelId}/years/{yearId} Fipe info
FipeApi GetModelsByBrand Get /{vehicleType}/brands/{brandId}/models Models by brand
FipeApi GetReferences Get /references Fipe month references
FipeApi GetYearByModel Get /{vehicleType}/brands/{brandId}/models/{modelId}/years Years for model

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

deividfortuna@gmail.com

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)
View Source 
var AllowedVehiclesTypeEnumValues = []VehiclesType{
	"cars",
	"motorcycles",
	"trucks",
}

All allowed values of VehiclesType enum

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func PtrBool 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient 

type APIClient struct {
	FipeApi FipeApi
	// contains filtered or unexported fields
}

APIClient manages communication with the Fipe API API v2.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiGetBrandsByTypeRequest 

type ApiGetBrandsByTypeRequest struct {
	ApiService FipeApi
	// contains filtered or unexported fields
}

func (ApiGetBrandsByTypeRequest) Execute 

func (r ApiGetBrandsByTypeRequest) Execute() ([]NamedCode, *_nethttp.Response, error)

type ApiGetFipeInfoRequest 

type ApiGetFipeInfoRequest struct {
	ApiService FipeApi
	// contains filtered or unexported fields
}

func (ApiGetFipeInfoRequest) Execute 

func (r ApiGetFipeInfoRequest) Execute() (FipeResult, *_nethttp.Response, error)

func (ApiGetFipeInfoRequest) Reference 

func (r ApiGetFipeInfoRequest) Reference(reference int32) ApiGetFipeInfoRequest

Month reference code

type ApiGetModelsByBrandRequest 

type ApiGetModelsByBrandRequest struct {
	ApiService FipeApi
	// contains filtered or unexported fields
}

func (ApiGetModelsByBrandRequest) Execute 

func (r ApiGetModelsByBrandRequest) Execute() ([]NamedCode, *_nethttp.Response, error)

type ApiGetReferencesRequest 

type ApiGetReferencesRequest struct {
	ApiService FipeApi
	// contains filtered or unexported fields
}

func (ApiGetReferencesRequest) Execute 

func (r ApiGetReferencesRequest) Execute() ([]Reference, *_nethttp.Response, error)

type ApiGetYearByModelRequest 

type ApiGetYearByModelRequest struct {
	ApiService FipeApi
	// contains filtered or unexported fields
}

func (ApiGetYearByModelRequest) Execute 

func (r ApiGetYearByModelRequest) Execute() ([]NamedCode, *_nethttp.Response, error)

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type FipeApi 

type FipeApi interface {

	/*
		GetBrandsByType Brands by type

		Returns brands for the type of vehicle

		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @param vehicleType Type of vehicle
		 @return ApiGetBrandsByTypeRequest
	*/
	GetBrandsByType(ctx _context.Context, vehicleType VehiclesType) ApiGetBrandsByTypeRequest

	// GetBrandsByTypeExecute executes the request
	//  @return []NamedCode
	GetBrandsByTypeExecute(r ApiGetBrandsByTypeRequest) ([]NamedCode, *_nethttp.Response, error)

	/*
		GetFipeInfo Fipe info

		Returns the Fipe information for the vehicle (price estimation)

		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @param vehicleType Type of vehicle
		 @param brandId Brand of the vehicle
		 @param modelId Model of the vehicle
		 @param yearId Year for the vehicle
		 @return ApiGetFipeInfoRequest
	*/
	GetFipeInfo(ctx _context.Context, vehicleType VehiclesType, brandId int32, modelId int32, yearId string) ApiGetFipeInfoRequest

	// GetFipeInfoExecute executes the request
	//  @return FipeResult
	GetFipeInfoExecute(r ApiGetFipeInfoRequest) (FipeResult, *_nethttp.Response, error)

	/*
		GetModelsByBrand Models by brand

		Returns models for the brand

		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @param vehicleType Type of vehicle
		 @param brandId Brand of the vehicle
		 @return ApiGetModelsByBrandRequest
	*/
	GetModelsByBrand(ctx _context.Context, vehicleType VehiclesType, brandId int32) ApiGetModelsByBrandRequest

	// GetModelsByBrandExecute executes the request
	//  @return []NamedCode
	GetModelsByBrandExecute(r ApiGetModelsByBrandRequest) ([]NamedCode, *_nethttp.Response, error)

	/*
		GetReferences Fipe month references

		Returns months and codes reference from Fipe

		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @return ApiGetReferencesRequest
	*/
	GetReferences(ctx _context.Context) ApiGetReferencesRequest

	// GetReferencesExecute executes the request
	//  @return []Reference
	GetReferencesExecute(r ApiGetReferencesRequest) ([]Reference, *_nethttp.Response, error)

	/*
		GetYearByModel Years for model

		Returns years for the specific model

		 @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
		 @param vehicleType Type of vehicle
		 @param brandId Brand of the vehicle
		 @param modelId Model of the vehicle
		 @return ApiGetYearByModelRequest
	*/
	GetYearByModel(ctx _context.Context, vehicleType VehiclesType, brandId int32, modelId int32) ApiGetYearByModelRequest

	// GetYearByModelExecute executes the request
	//  @return []NamedCode
	GetYearByModelExecute(r ApiGetYearByModelRequest) ([]NamedCode, *_nethttp.Response, error)
}

type FipeApiService 

type FipeApiService service

FipeApiService FipeApi service

func (*FipeApiService) GetBrandsByType 

func (a *FipeApiService) GetBrandsByType(ctx _context.Context, vehicleType VehiclesType) ApiGetBrandsByTypeRequest

GetBrandsByType Brands by type

Returns brands for the type of vehicle 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param vehicleType Type of vehicle
@return ApiGetBrandsByTypeRequest

func (*FipeApiService) GetBrandsByTypeExecute 

func (a *FipeApiService) GetBrandsByTypeExecute(r ApiGetBrandsByTypeRequest) ([]NamedCode, *_nethttp.Response, error)

Execute executes the request 

@return []NamedCode

func (*FipeApiService) GetFipeInfo 

func (a *FipeApiService) GetFipeInfo(ctx _context.Context, vehicleType VehiclesType, brandId int32, modelId int32, yearId string) ApiGetFipeInfoRequest

GetFipeInfo Fipe info

Returns the Fipe information for the vehicle (price estimation) 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param vehicleType Type of vehicle
@param brandId Brand of the vehicle
@param modelId Model of the vehicle
@param yearId Year for the vehicle
@return ApiGetFipeInfoRequest

func (*FipeApiService) GetFipeInfoExecute 

func (a *FipeApiService) GetFipeInfoExecute(r ApiGetFipeInfoRequest) (FipeResult, *_nethttp.Response, error)

Execute executes the request 

@return FipeResult

func (*FipeApiService) GetModelsByBrand 

func (a *FipeApiService) GetModelsByBrand(ctx _context.Context, vehicleType VehiclesType, brandId int32) ApiGetModelsByBrandRequest

GetModelsByBrand Models by brand

Returns models for the brand 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param vehicleType Type of vehicle
@param brandId Brand of the vehicle
@return ApiGetModelsByBrandRequest

func (*FipeApiService) GetModelsByBrandExecute 

func (a *FipeApiService) GetModelsByBrandExecute(r ApiGetModelsByBrandRequest) ([]NamedCode, *_nethttp.Response, error)

Execute executes the request 

@return []NamedCode

func (*FipeApiService) GetReferences 

func (a *FipeApiService) GetReferences(ctx _context.Context) ApiGetReferencesRequest

GetReferences Fipe month references

Returns months and codes reference from Fipe 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetReferencesRequest

func (*FipeApiService) GetReferencesExecute 

func (a *FipeApiService) GetReferencesExecute(r ApiGetReferencesRequest) ([]Reference, *_nethttp.Response, error)

Execute executes the request 

@return []Reference

func (*FipeApiService) GetYearByModel 

func (a *FipeApiService) GetYearByModel(ctx _context.Context, vehicleType VehiclesType, brandId int32, modelId int32) ApiGetYearByModelRequest

GetYearByModel Years for model

Returns years for the specific model 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param vehicleType Type of vehicle
@param brandId Brand of the vehicle
@param modelId Model of the vehicle
@return ApiGetYearByModelRequest

func (*FipeApiService) GetYearByModelExecute 

func (a *FipeApiService) GetYearByModelExecute(r ApiGetYearByModelRequest) ([]NamedCode, *_nethttp.Response, error)

Execute executes the request 

@return []NamedCode

type FipeResult 

type FipeResult struct {
	// Price in Brazilian Real
	Price *string `json:"price,omitempty"`
	// Brand of the vehicle
	Brand *string `json:"brand,omitempty"`
	// Model of the vehicle
	Model *string `json:"model,omitempty"`
	// Year of vehicle production
	ModelYear *int32 `json:"modelYear,omitempty"`
	// Fuel used by the vehicle
	Fuel *string `json:"fuel,omitempty"`
	// Unique Fipe identifier
	CodeFipe *string `json:"codeFipe,omitempty"`
	// Month of the price
	ReferenceMonth *string `json:"referenceMonth,omitempty"`
	// Type of the vehicle
	VehicleType *int32 `json:"vehicleType,omitempty"`
	// Fuel acronym (eg. G)
	FuelAcronym *string `json:"fuelAcronym,omitempty"`
}

FipeResult struct for FipeResult

func NewFipeResult 

func NewFipeResult() *FipeResult

NewFipeResult instantiates a new FipeResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewFipeResultWithDefaults 

func NewFipeResultWithDefaults() *FipeResult

NewFipeResultWithDefaults instantiates a new FipeResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*FipeResult) GetBrand 

func (o *FipeResult) GetBrand() string

GetBrand returns the Brand field value if set, zero value otherwise.

func (*FipeResult) GetBrandOk 

func (o *FipeResult) GetBrandOk() (*string, bool)

GetBrandOk returns a tuple with the Brand field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FipeResult) GetCodeFipe 

func (o *FipeResult) GetCodeFipe() string

GetCodeFipe returns the CodeFipe field value if set, zero value otherwise.

func (*FipeResult) GetCodeFipeOk 

func (o *FipeResult) GetCodeFipeOk() (*string, bool)

GetCodeFipeOk returns a tuple with the CodeFipe field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FipeResult) GetFuel 

func (o *FipeResult) GetFuel() string

GetFuel returns the Fuel field value if set, zero value otherwise.

func (*FipeResult) GetFuelAcronym 

func (o *FipeResult) GetFuelAcronym() string

GetFuelAcronym returns the FuelAcronym field value if set, zero value otherwise.

func (*FipeResult) GetFuelAcronymOk 

func (o *FipeResult) GetFuelAcronymOk() (*string, bool)

GetFuelAcronymOk returns a tuple with the FuelAcronym field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FipeResult) GetFuelOk 

func (o *FipeResult) GetFuelOk() (*string, bool)

GetFuelOk returns a tuple with the Fuel field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FipeResult) GetModel 

func (o *FipeResult) GetModel() string

GetModel returns the Model field value if set, zero value otherwise.

func (*FipeResult) GetModelOk 

func (o *FipeResult) GetModelOk() (*string, bool)

GetModelOk returns a tuple with the Model field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FipeResult) GetModelYear 

func (o *FipeResult) GetModelYear() int32

GetModelYear returns the ModelYear field value if set, zero value otherwise.

func (*FipeResult) GetModelYearOk 

func (o *FipeResult) GetModelYearOk() (*int32, bool)

GetModelYearOk returns a tuple with the ModelYear field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FipeResult) GetPrice 

func (o *FipeResult) GetPrice() string

GetPrice returns the Price field value if set, zero value otherwise.

func (*FipeResult) GetPriceOk 

func (o *FipeResult) GetPriceOk() (*string, bool)

GetPriceOk returns a tuple with the Price field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FipeResult) GetReferenceMonth 

func (o *FipeResult) GetReferenceMonth() string

GetReferenceMonth returns the ReferenceMonth field value if set, zero value otherwise.

func (*FipeResult) GetReferenceMonthOk 

func (o *FipeResult) GetReferenceMonthOk() (*string, bool)

GetReferenceMonthOk returns a tuple with the ReferenceMonth field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FipeResult) GetVehicleType 

func (o *FipeResult) GetVehicleType() int32

GetVehicleType returns the VehicleType field value if set, zero value otherwise.

func (*FipeResult) GetVehicleTypeOk 

func (o *FipeResult) GetVehicleTypeOk() (*int32, bool)

GetVehicleTypeOk returns a tuple with the VehicleType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FipeResult) HasBrand 

func (o *FipeResult) HasBrand() bool

HasBrand returns a boolean if a field has been set.

func (*FipeResult) HasCodeFipe 

func (o *FipeResult) HasCodeFipe() bool

HasCodeFipe returns a boolean if a field has been set.

func (*FipeResult) HasFuel 

func (o *FipeResult) HasFuel() bool

HasFuel returns a boolean if a field has been set.

func (*FipeResult) HasFuelAcronym 

func (o *FipeResult) HasFuelAcronym() bool

HasFuelAcronym returns a boolean if a field has been set.

func (*FipeResult) HasModel 

func (o *FipeResult) HasModel() bool

HasModel returns a boolean if a field has been set.

func (*FipeResult) HasModelYear 

func (o *FipeResult) HasModelYear() bool

HasModelYear returns a boolean if a field has been set.

func (*FipeResult) HasPrice 

func (o *FipeResult) HasPrice() bool

HasPrice returns a boolean if a field has been set.

func (*FipeResult) HasReferenceMonth 

func (o *FipeResult) HasReferenceMonth() bool

HasReferenceMonth returns a boolean if a field has been set.

func (*FipeResult) HasVehicleType 

func (o *FipeResult) HasVehicleType() bool

HasVehicleType returns a boolean if a field has been set.

func (FipeResult) MarshalJSON 

func (o FipeResult) MarshalJSON() ([]byte, error)

func (*FipeResult) SetBrand 

func (o *FipeResult) SetBrand(v string)

SetBrand gets a reference to the given string and assigns it to the Brand field.

func (*FipeResult) SetCodeFipe 

func (o *FipeResult) SetCodeFipe(v string)

SetCodeFipe gets a reference to the given string and assigns it to the CodeFipe field.

func (*FipeResult) SetFuel 

func (o *FipeResult) SetFuel(v string)

SetFuel gets a reference to the given string and assigns it to the Fuel field.

func (*FipeResult) SetFuelAcronym 

func (o *FipeResult) SetFuelAcronym(v string)

SetFuelAcronym gets a reference to the given string and assigns it to the FuelAcronym field.

func (*FipeResult) SetModel 

func (o *FipeResult) SetModel(v string)

SetModel gets a reference to the given string and assigns it to the Model field.

func (*FipeResult) SetModelYear 

func (o *FipeResult) SetModelYear(v int32)

SetModelYear gets a reference to the given int32 and assigns it to the ModelYear field.

func (*FipeResult) SetPrice 

func (o *FipeResult) SetPrice(v string)

SetPrice gets a reference to the given string and assigns it to the Price field.

func (*FipeResult) SetReferenceMonth 

func (o *FipeResult) SetReferenceMonth(v string)

SetReferenceMonth gets a reference to the given string and assigns it to the ReferenceMonth field.

func (*FipeResult) SetVehicleType 

func (o *FipeResult) SetVehicleType(v int32)

SetVehicleType gets a reference to the given int32 and assigns it to the VehicleType field.

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type NamedCode 

type NamedCode struct {
	Name *string `json:"name,omitempty"`
	Code *string `json:"code,omitempty"`
}

NamedCode struct for NamedCode

func NewNamedCode 

func NewNamedCode() *NamedCode

NewNamedCode instantiates a new NamedCode object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewNamedCodeWithDefaults 

func NewNamedCodeWithDefaults() *NamedCode

NewNamedCodeWithDefaults instantiates a new NamedCode object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*NamedCode) GetCode 

func (o *NamedCode) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*NamedCode) GetCodeOk 

func (o *NamedCode) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*NamedCode) GetName 

func (o *NamedCode) GetName() string

GetName returns the Name field value if set, zero value otherwise.

func (*NamedCode) GetNameOk 

func (o *NamedCode) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field value if set, nil otherwise and a boolean to check if the value has been set.

func (*NamedCode) HasCode 

func (o *NamedCode) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*NamedCode) HasName 

func (o *NamedCode) HasName() bool

HasName returns a boolean if a field has been set.

func (NamedCode) MarshalJSON 

func (o NamedCode) MarshalJSON() ([]byte, error)

func (*NamedCode) SetCode 

func (o *NamedCode) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*NamedCode) SetName 

func (o *NamedCode) SetName(v string)

SetName gets a reference to the given string and assigns it to the Name field.

type NullableBool 

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset 

func (v *NullableBool) Unset()

type NullableFipeResult 

type NullableFipeResult struct {
	// contains filtered or unexported fields
}

func NewNullableFipeResult 

func NewNullableFipeResult(val *FipeResult) *NullableFipeResult

func (NullableFipeResult) Get 

func (v NullableFipeResult) Get() *FipeResult

func (NullableFipeResult) IsSet 

func (v NullableFipeResult) IsSet() bool

func (NullableFipeResult) MarshalJSON 

func (v NullableFipeResult) MarshalJSON() ([]byte, error)

func (*NullableFipeResult) Set 

func (v *NullableFipeResult) Set(val *FipeResult)

func (*NullableFipeResult) UnmarshalJSON 

func (v *NullableFipeResult) UnmarshalJSON(src []byte) error

func (*NullableFipeResult) Unset 

func (v *NullableFipeResult) Unset()

type NullableFloat32 

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset 

func (v *NullableFloat32) Unset()

type NullableFloat64 

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset 

func (v *NullableFloat64) Unset()

type NullableInt 

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get 

func (v NullableInt) Get() *int

func (NullableInt) IsSet 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset 

func (v *NullableInt) Unset()

type NullableInt32 

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset 

func (v *NullableInt32) Unset()

type NullableInt64 

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset 

func (v *NullableInt64) Unset()

type NullableNamedCode 

type NullableNamedCode struct {
	// contains filtered or unexported fields
}

func NewNullableNamedCode 

func NewNullableNamedCode(val *NamedCode) *NullableNamedCode

func (NullableNamedCode) Get 

func (v NullableNamedCode) Get() *NamedCode

func (NullableNamedCode) IsSet 

func (v NullableNamedCode) IsSet() bool

func (NullableNamedCode) MarshalJSON 

func (v NullableNamedCode) MarshalJSON() ([]byte, error)

func (*NullableNamedCode) Set 

func (v *NullableNamedCode) Set(val *NamedCode)

func (*NullableNamedCode) UnmarshalJSON 

func (v *NullableNamedCode) UnmarshalJSON(src []byte) error

func (*NullableNamedCode) Unset 

func (v *NullableNamedCode) Unset()

type NullableReference 

type NullableReference struct {
	// contains filtered or unexported fields
}

func NewNullableReference 

func NewNullableReference(val *Reference) *NullableReference

func (NullableReference) Get 

func (v NullableReference) Get() *Reference

func (NullableReference) IsSet 

func (v NullableReference) IsSet() bool

func (NullableReference) MarshalJSON 

func (v NullableReference) MarshalJSON() ([]byte, error)

func (*NullableReference) Set 

func (v *NullableReference) Set(val *Reference)

func (*NullableReference) UnmarshalJSON 

func (v *NullableReference) UnmarshalJSON(src []byte) error

func (*NullableReference) Unset 

func (v *NullableReference) Unset()

type NullableString 

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString 

func NewNullableString(val *string) *NullableString

func (NullableString) Get 

func (v NullableString) Get() *string

func (NullableString) IsSet 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset 

func (v *NullableString) Unset()

type NullableTime 

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset 

func (v *NullableTime) Unset()

type NullableVehiclesType 

type NullableVehiclesType struct {
	// contains filtered or unexported fields
}

func NewNullableVehiclesType 

func NewNullableVehiclesType(val *VehiclesType) *NullableVehiclesType

func (NullableVehiclesType) Get 

func (v NullableVehiclesType) Get() *VehiclesType

func (NullableVehiclesType) IsSet 

func (v NullableVehiclesType) IsSet() bool

func (NullableVehiclesType) MarshalJSON 

func (v NullableVehiclesType) MarshalJSON() ([]byte, error)

func (*NullableVehiclesType) Set 

func (v *NullableVehiclesType) Set(val *VehiclesType)

func (*NullableVehiclesType) UnmarshalJSON 

func (v *NullableVehiclesType) UnmarshalJSON(src []byte) error

func (*NullableVehiclesType) Unset 

func (v *NullableVehiclesType) Unset()

type Reference 

type Reference struct {
	Code  *string `json:"code,omitempty"`
	Month *string `json:"month,omitempty"`
}

Reference struct for Reference

func NewReference 

func NewReference() *Reference

NewReference instantiates a new Reference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewReferenceWithDefaults 

func NewReferenceWithDefaults() *Reference

NewReferenceWithDefaults instantiates a new Reference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Reference) GetCode 

func (o *Reference) GetCode() string

GetCode returns the Code field value if set, zero value otherwise.

func (*Reference) GetCodeOk 

func (o *Reference) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Reference) GetMonth 

func (o *Reference) GetMonth() string

GetMonth returns the Month field value if set, zero value otherwise.

func (*Reference) GetMonthOk 

func (o *Reference) GetMonthOk() (*string, bool)

GetMonthOk returns a tuple with the Month field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Reference) HasCode 

func (o *Reference) HasCode() bool

HasCode returns a boolean if a field has been set.

func (*Reference) HasMonth 

func (o *Reference) HasMonth() bool

HasMonth returns a boolean if a field has been set.

func (Reference) MarshalJSON 

func (o Reference) MarshalJSON() ([]byte, error)

func (*Reference) SetCode 

func (o *Reference) SetCode(v string)

SetCode gets a reference to the given string and assigns it to the Code field.

func (*Reference) SetMonth 

func (o *Reference) SetMonth(v string)

SetMonth gets a reference to the given string and assigns it to the Month field.

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type VehiclesType 

type VehiclesType string

VehiclesType the model 'VehiclesType' 

const (
	CARS        VehiclesType = "cars"
	MOTORCYCLES VehiclesType = "motorcycles"
	TRUCKS      VehiclesType = "trucks"
)

List of VehiclesType

func NewVehiclesTypeFromValue 

func NewVehiclesTypeFromValue(v string) (*VehiclesType, error)

NewVehiclesTypeFromValue returns a pointer to a valid VehiclesType for the value passed as argument, or an error if the value passed is not allowed by the enum

func (VehiclesType) IsValid 

func (v VehiclesType) IsValid() bool

IsValid return true if the value is valid for the enum, false otherwise

func (VehiclesType) Ptr 

func (v VehiclesType) Ptr() *VehiclesType

Ptr returns reference to VehiclesType value

func (*VehiclesType) UnmarshalJSON 

func (v *VehiclesType) UnmarshalJSON(src []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.