openapi

package module
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: May 31, 2024 License: GPL-3.0 Imports: 21 Imported by: 0

README

Go API client for openapi

Specification for BringAuto fleet backend HTTP API

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.

  • API version: 3.1.0
  • Package version: 2.0.0
  • Generator version: 7.6.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://bringauto.com

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 openapi "github.com/bringauto/fleet-management-http-client-go"

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 openapi.ContextServerIndex of type int.

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

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

ctx := context.WithValue(context.Background(), openapi.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 openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to /v2/management

Class Method HTTP request Description
ApiAPI CheckApiIsAlive Head /apialive Check HTTP server is running and accessible.
CarAPI CreateCar Post /car Create a new Car object.
CarAPI DeleteCar Delete /car/{carId} Delete a Car identified by its ID.
CarAPI GetCar Get /car/{carId} Find a single Car by its ID.
CarAPI GetCars Get /car Find and return all existing Cars.
CarAPI UpdateCar Put /car Update already existing Car.
CarStateAPI AddCarState Post /carstate Add a new Car State.
CarStateAPI GetAllCarStates Get /carstate Find one or all Car States for all existing Cars.
CarStateAPI GetCarStates Get /carstate/{carId} Find one or all Car States for a Car with given ID.
OrderAPI CreateOrder Post /order Create a new Order.
OrderAPI DeleteOrder Delete /order/{carId}/{orderId} Delete an Order identified by its ID and ID of a car to which it is assigned.
OrderAPI GetCarOrders Get /order/{carId} Find existing Orders by the corresponding Car ID and return them.
OrderAPI GetOrder Get /order/{carId}/{orderId} Find an existing Order by the car ID and the order ID and return it.
OrderAPI GetOrders Get /order Find all currently existing Orders.
OrderStateAPI CreateOrderState Post /orderstate Add a new Order State.
OrderStateAPI GetAllOrderStates Get /orderstate Find Order States for all existing Orders.
OrderStateAPI GetOrderStates Get /orderstate/{orderId} Find all Order States for a particular Order specified by its ID.
PlatformHWAPI CreateHw Post /platformhw Create a new Platform HW object.
PlatformHWAPI DeleteHw Delete /platformhw/{platformHwId} Delete Platform HW with the given ID.
PlatformHWAPI GetHw Get /platformhw/{platformHwId} Find Platform HW with the given ID.
PlatformHWAPI GetHws Get /platformhw Find and return all existing Platform HW.
RouteAPI CreateRoute Post /route Create a new Route.
RouteAPI DeleteRoute Delete /route/{routeId} Delete a Route with the specified ID.
RouteAPI GetRoute Get /route/{routeId} Find a single Route with the specified ID.
RouteAPI GetRouteVisualization Get /route-visualization/{routeId} Find Route Visualization for a Route identified by the route's ID.
RouteAPI GetRoutes Get /route Find and return all existing Routes.
RouteAPI RedefineRouteVisualization Post /route-visualization Redefine Route Visualization for an existing Route.
RouteAPI UpdateRoute Put /route Update already existing Route.
SecurityAPI Login Get /login
SecurityAPI TokenGet Get /token_get
SecurityAPI TokenRefresh Get /token_refresh
StopAPI CreateStop Post /stop Create a new Stop.
StopAPI DeleteStop Delete /stop/{stopId} Delete a Stop with the specified ID.
StopAPI GetStop Get /stop/{stopId} Find and return a single Stop by its ID.
StopAPI GetStops Get /stop Find and return all existing Stops.
StopAPI UpdateStop Put /stop Update already existing Stop.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

APIKeyAuth
  • Type: API key
  • API key parameter name: api_key
  • Location: URL query string

Note, each API key must be added to a map of map[string]APIKey where the key is: api_key and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		openapi.ContextAPIKeys,
		map[string]openapi.APIKey{
			"api_key": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)
oAuth2AuthCode

Example

auth := context.WithValue(context.Background(), openapi.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, openapi.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

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

fleet@bringauto.com

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

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

	// 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 AllowedCarStatusEnumValues = []CarStatus{
	"idle",
	"charging",
	"out_of_order",
	"driving",
	"in_stop",
	"paused_by_phone",
	"paused_by_obstacle",
	"paused_by_button",
}

All allowed values of CarStatus enum

View Source 
var AllowedOrderStatusEnumValues = []OrderStatus{
	"to_accept",
	"accepted",
	"in_progress",
	"done",
	"canceled",
}

All allowed values of OrderStatus enum

Functions

func CacheExpires 

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

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

func IsNil 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

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 {
	ApiAPI *ApiAPIService

	CarAPI *CarAPIService

	CarStateAPI *CarStateAPIService

	OrderAPI *OrderAPIService

	OrderStateAPI *OrderStateAPIService

	PlatformHWAPI *PlatformHWAPIService

	RouteAPI *RouteAPIService

	SecurityAPI *SecurityAPIService

	StopAPI *StopAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the BringAuto Fleet Management v2 API API v3.1.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 ApiAPIService 

type ApiAPIService service

ApiAPIService ApiAPI service

func (*ApiAPIService) CheckApiIsAlive 

func (a *ApiAPIService) CheckApiIsAlive(ctx context.Context) ApiCheckApiIsAliveRequest

CheckApiIsAlive Check HTTP server is running and accessible. 

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

func (*ApiAPIService) CheckApiIsAliveExecute 

func (a *ApiAPIService) CheckApiIsAliveExecute(r ApiCheckApiIsAliveRequest) (*http.Response, error)

Execute executes the request

type ApiCheckApiIsAliveRequest 

type ApiCheckApiIsAliveRequest struct {
	ApiService *ApiAPIService
	// contains filtered or unexported fields
}

func (ApiCheckApiIsAliveRequest) Execute 

func (r ApiCheckApiIsAliveRequest) Execute() (*http.Response, error)

type ApiCreateCarStatesRequest added in v1.1.0 

type ApiCreateCarStatesRequest struct {
	ApiService *CarStateAPIService
	// contains filtered or unexported fields
}

func (ApiCreateCarStatesRequest) CarState added in v1.1.0 

func (r ApiCreateCarStatesRequest) CarState(carState []CarState) ApiCreateCarStatesRequest

A list of Car State model in JSON format.

func (ApiCreateCarStatesRequest) Execute added in v1.1.0 

func (r ApiCreateCarStatesRequest) Execute() (*http.Response, error)

type ApiCreateCarsRequest added in v1.1.0 

type ApiCreateCarsRequest struct {
	ApiService *CarAPIService
	// contains filtered or unexported fields
}

func (ApiCreateCarsRequest) Car added in v1.1.0 

func (r ApiCreateCarsRequest) Car(car []Car) ApiCreateCarsRequest

A list of Car models in JSON format.

func (ApiCreateCarsRequest) Execute added in v1.1.0 

func (r ApiCreateCarsRequest) Execute() ([]Car, *http.Response, error)

type ApiCreateHwsRequest added in v1.1.0 

type ApiCreateHwsRequest struct {
	ApiService *PlatformHWAPIService
	// contains filtered or unexported fields
}

func (ApiCreateHwsRequest) Execute added in v1.1.0 

func (r ApiCreateHwsRequest) Execute() ([]PlatformHW, *http.Response, error)

func (ApiCreateHwsRequest) PlatformHW added in v1.1.0 

func (r ApiCreateHwsRequest) PlatformHW(platformHW []PlatformHW) ApiCreateHwsRequest

A list of Platform HW models in JSON format.

type ApiCreateOrderStatesRequest added in v1.1.0 

type ApiCreateOrderStatesRequest struct {
	ApiService *OrderStateAPIService
	// contains filtered or unexported fields
}

func (ApiCreateOrderStatesRequest) Execute added in v1.1.0 

func (r ApiCreateOrderStatesRequest) Execute() (*OrderState, *http.Response, error)

func (ApiCreateOrderStatesRequest) OrderState added in v1.1.0 

func (r ApiCreateOrderStatesRequest) OrderState(orderState []OrderState) ApiCreateOrderStatesRequest

A list of Order State models in JSON format.

type ApiCreateOrdersRequest added in v1.1.0 

type ApiCreateOrdersRequest struct {
	ApiService *OrderAPIService
	// contains filtered or unexported fields
}

func (ApiCreateOrdersRequest) Execute added in v1.1.0 

func (r ApiCreateOrdersRequest) Execute() ([]Order, *http.Response, error)

func (ApiCreateOrdersRequest) Order added in v1.1.0 

func (r ApiCreateOrdersRequest) Order(order []Order) ApiCreateOrdersRequest

A list of Order models in JSON format.

type ApiCreateRoutesRequest added in v1.1.0 

type ApiCreateRoutesRequest struct {
	ApiService *RouteAPIService
	// contains filtered or unexported fields
}

func (ApiCreateRoutesRequest) Execute added in v1.1.0 

func (r ApiCreateRoutesRequest) Execute() ([]Route, *http.Response, error)

func (ApiCreateRoutesRequest) Route added in v1.1.0 

func (r ApiCreateRoutesRequest) Route(route []Route) ApiCreateRoutesRequest

A list of Route models in JSON format.

type ApiCreateStopsRequest added in v1.1.0 

type ApiCreateStopsRequest struct {
	ApiService *StopAPIService
	// contains filtered or unexported fields
}

func (ApiCreateStopsRequest) Execute added in v1.1.0 

func (r ApiCreateStopsRequest) Execute() ([]Stop, *http.Response, error)

func (ApiCreateStopsRequest) Stop added in v1.1.0 

func (r ApiCreateStopsRequest) Stop(stop []Stop) ApiCreateStopsRequest

A list of Stop models in JSON format.

type ApiDeleteCarRequest 

type ApiDeleteCarRequest struct {
	ApiService *CarAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteCarRequest) Execute 

func (r ApiDeleteCarRequest) Execute() (*http.Response, error)

type ApiDeleteHwRequest 

type ApiDeleteHwRequest struct {
	ApiService *PlatformHWAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteHwRequest) Execute 

func (r ApiDeleteHwRequest) Execute() (*http.Response, error)

type ApiDeleteOrderRequest 

type ApiDeleteOrderRequest struct {
	ApiService *OrderAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteOrderRequest) Execute 

func (r ApiDeleteOrderRequest) Execute() (*http.Response, error)

type ApiDeleteRouteRequest 

type ApiDeleteRouteRequest struct {
	ApiService *RouteAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteRouteRequest) Execute 

func (r ApiDeleteRouteRequest) Execute() (*http.Response, error)

type ApiDeleteStopRequest 

type ApiDeleteStopRequest struct {
	ApiService *StopAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteStopRequest) Execute 

func (r ApiDeleteStopRequest) Execute() (*http.Response, error)

type ApiGetAllCarStatesRequest 

type ApiGetAllCarStatesRequest struct {
	ApiService *CarStateAPIService
	// contains filtered or unexported fields
}

func (ApiGetAllCarStatesRequest) Execute 

func (r ApiGetAllCarStatesRequest) Execute() ([]CarState, *http.Response, error)

func (ApiGetAllCarStatesRequest) LastN 

func (r ApiGetAllCarStatesRequest) LastN(lastN int32) ApiGetAllCarStatesRequest

If specified, only the last N objects will be returned. If unspecified, all objects are returned. \\ If some states have identical timestamps and they all do not fit into the maximum N states, only those with higher IDs are returned. If value smaller than 1 is provided, this filtering is ignored.

func (ApiGetAllCarStatesRequest) Since 

func (r ApiGetAllCarStatesRequest) Since(since int64) ApiGetAllCarStatesRequest

A Unix timestamp in milliseconds. If specified, only objects created at the time or later will be returned. If unspecified, all objects are returned (since is set to 0 in that case).

func (ApiGetAllCarStatesRequest) Wait 

func (r ApiGetAllCarStatesRequest) Wait(wait bool) ApiGetAllCarStatesRequest

Applies to GET methods when no objects would be returned at the moment of request. If wait=true, \\ the request will wait for the next object to be created and then returns it. If wait=False or unspecified, the request will return \\ an empty list.

type ApiGetAllOrderStatesRequest 

type ApiGetAllOrderStatesRequest struct {
	ApiService *OrderStateAPIService
	// contains filtered or unexported fields
}

func (ApiGetAllOrderStatesRequest) CarId added in v1.1.0 

func (r ApiGetAllOrderStatesRequest) CarId(carId int32) ApiGetAllOrderStatesRequest

An optional parameter for filtering only objects related to a car with the specified ID.

func (ApiGetAllOrderStatesRequest) Execute 

func (r ApiGetAllOrderStatesRequest) Execute() ([]OrderState, *http.Response, error)

func (ApiGetAllOrderStatesRequest) LastN 

func (r ApiGetAllOrderStatesRequest) LastN(lastN int32) ApiGetAllOrderStatesRequest

If specified, only the last N objects will be returned. If unspecified, all objects are returned. \\ If some states have identical timestamps and they all do not fit into the maximum N states, only those with higher IDs are returned. If value smaller than 1 is provided, this filtering is ignored.

func (ApiGetAllOrderStatesRequest) Since 

func (r ApiGetAllOrderStatesRequest) Since(since int64) ApiGetAllOrderStatesRequest

A Unix timestamp in milliseconds. If specified, only objects created at the time or later will be returned. If unspecified, all objects are returned (since is set to 0 in that case).

func (ApiGetAllOrderStatesRequest) Wait 

func (r ApiGetAllOrderStatesRequest) Wait(wait bool) ApiGetAllOrderStatesRequest

Applies to GET methods when no objects would be returned at the moment of request. If wait=true, \\ the request will wait for the next object to be created and then returns it. If wait=False or unspecified, the request will return \\ an empty list.

type ApiGetCarOrdersRequest 

type ApiGetCarOrdersRequest struct {
	ApiService *OrderAPIService
	// contains filtered or unexported fields
}

func (ApiGetCarOrdersRequest) Execute 

func (r ApiGetCarOrdersRequest) Execute() ([]Order, *http.Response, error)

func (ApiGetCarOrdersRequest) Since 

func (r ApiGetCarOrdersRequest) Since(since int64) ApiGetCarOrdersRequest

A Unix timestamp in milliseconds. If specified, only objects created at the time or later will be returned. If unspecified, all objects are returned (since is set to 0 in that case).

type ApiGetCarRequest 

type ApiGetCarRequest struct {
	ApiService *CarAPIService
	// contains filtered or unexported fields
}

func (ApiGetCarRequest) Execute 

func (r ApiGetCarRequest) Execute() (*Car, *http.Response, error)

type ApiGetCarStatesRequest 

type ApiGetCarStatesRequest struct {
	ApiService *CarStateAPIService
	// contains filtered or unexported fields
}

func (ApiGetCarStatesRequest) Execute 

func (r ApiGetCarStatesRequest) Execute() ([]CarState, *http.Response, error)

func (ApiGetCarStatesRequest) LastN 

func (r ApiGetCarStatesRequest) LastN(lastN int32) ApiGetCarStatesRequest

If specified, only the last N objects will be returned. If unspecified, all objects are returned. \\ If some states have identical timestamps and they all do not fit into the maximum N states, only those with higher IDs are returned. If value smaller than 1 is provided, this filtering is ignored.

func (ApiGetCarStatesRequest) Since 

func (r ApiGetCarStatesRequest) Since(since int64) ApiGetCarStatesRequest

A Unix timestamp in milliseconds. If specified, only objects created at the time or later will be returned. If unspecified, all objects are returned (since is set to 0 in that case).

func (ApiGetCarStatesRequest) Wait 

func (r ApiGetCarStatesRequest) Wait(wait bool) ApiGetCarStatesRequest

Applies to GET methods when no objects would be returned at the moment of request. If wait=true, \\ the request will wait for the next object to be created and then returns it. If wait=False or unspecified, the request will return \\ an empty list.

type ApiGetCarsRequest 

type ApiGetCarsRequest struct {
	ApiService *CarAPIService
	// contains filtered or unexported fields
}

func (ApiGetCarsRequest) Execute 

func (r ApiGetCarsRequest) Execute() ([]Car, *http.Response, error)

type ApiGetHwRequest 

type ApiGetHwRequest struct {
	ApiService *PlatformHWAPIService
	// contains filtered or unexported fields
}

func (ApiGetHwRequest) Execute 

func (r ApiGetHwRequest) Execute() (*PlatformHW, *http.Response, error)

type ApiGetHwsRequest 

type ApiGetHwsRequest struct {
	ApiService *PlatformHWAPIService
	// contains filtered or unexported fields
}

func (ApiGetHwsRequest) Execute 

func (r ApiGetHwsRequest) Execute() ([]PlatformHW, *http.Response, error)

type ApiGetOrderRequest 

type ApiGetOrderRequest struct {
	ApiService *OrderAPIService
	// contains filtered or unexported fields
}

func (ApiGetOrderRequest) Execute 

func (r ApiGetOrderRequest) Execute() (*Order, *http.Response, error)

type ApiGetOrderStatesRequest 

type ApiGetOrderStatesRequest struct {
	ApiService *OrderStateAPIService
	// contains filtered or unexported fields
}

func (ApiGetOrderStatesRequest) Execute 

func (r ApiGetOrderStatesRequest) Execute() ([]OrderState, *http.Response, error)

func (ApiGetOrderStatesRequest) LastN 

func (r ApiGetOrderStatesRequest) LastN(lastN int32) ApiGetOrderStatesRequest

If specified, only the last N objects will be returned. If unspecified, all objects are returned. \\ If some states have identical timestamps and they all do not fit into the maximum N states, only those with higher IDs are returned. If value smaller than 1 is provided, this filtering is ignored.

func (ApiGetOrderStatesRequest) Since 

func (r ApiGetOrderStatesRequest) Since(since int64) ApiGetOrderStatesRequest

A Unix timestamp in milliseconds. If specified, only objects created at the time or later will be returned. If unspecified, all objects are returned (since is set to 0 in that case).

func (ApiGetOrderStatesRequest) Wait 

func (r ApiGetOrderStatesRequest) Wait(wait bool) ApiGetOrderStatesRequest

Applies to GET methods when no objects would be returned at the moment of request. If wait=true, \\ the request will wait for the next object to be created and then returns it. If wait=False or unspecified, the request will return \\ an empty list.

type ApiGetOrdersRequest 

type ApiGetOrdersRequest struct {
	ApiService *OrderAPIService
	// contains filtered or unexported fields
}

func (ApiGetOrdersRequest) Execute 

func (r ApiGetOrdersRequest) Execute() ([]Order, *http.Response, error)

func (ApiGetOrdersRequest) Since 

func (r ApiGetOrdersRequest) Since(since int64) ApiGetOrdersRequest

A Unix timestamp in milliseconds. If specified, only objects created at the time or later will be returned. If unspecified, all objects are returned (since is set to 0 in that case).

type ApiGetRouteRequest 

type ApiGetRouteRequest struct {
	ApiService *RouteAPIService
	// contains filtered or unexported fields
}

func (ApiGetRouteRequest) Execute 

func (r ApiGetRouteRequest) Execute() (*Route, *http.Response, error)

type ApiGetRouteVisualizationRequest 

type ApiGetRouteVisualizationRequest struct {
	ApiService *RouteAPIService
	// contains filtered or unexported fields
}

func (ApiGetRouteVisualizationRequest) Execute 

func (r ApiGetRouteVisualizationRequest) Execute() (*RouteVisualization, *http.Response, error)

type ApiGetRoutesRequest 

type ApiGetRoutesRequest struct {
	ApiService *RouteAPIService
	// contains filtered or unexported fields
}

func (ApiGetRoutesRequest) Execute 

func (r ApiGetRoutesRequest) Execute() ([]Route, *http.Response, error)

type ApiGetStopRequest 

type ApiGetStopRequest struct {
	ApiService *StopAPIService
	// contains filtered or unexported fields
}

func (ApiGetStopRequest) Execute 

func (r ApiGetStopRequest) Execute() (*Stop, *http.Response, error)

type ApiGetStopsRequest 

type ApiGetStopsRequest struct {
	ApiService *StopAPIService
	// contains filtered or unexported fields
}

func (ApiGetStopsRequest) Execute 

func (r ApiGetStopsRequest) Execute() ([]Stop, *http.Response, error)

type ApiLoginRequest 

type ApiLoginRequest struct {
	ApiService *SecurityAPIService
	// contains filtered or unexported fields
}

func (ApiLoginRequest) Execute 

func (r ApiLoginRequest) Execute() (*http.Response, error)

type ApiRedefineRouteVisualizationsRequest added in v1.1.0 

type ApiRedefineRouteVisualizationsRequest struct {
	ApiService *RouteAPIService
	// contains filtered or unexported fields
}

func (ApiRedefineRouteVisualizationsRequest) Execute added in v1.1.0 

func (r ApiRedefineRouteVisualizationsRequest) Execute() ([]RouteVisualization, *http.Response, error)

func (ApiRedefineRouteVisualizationsRequest) RouteVisualization added in v1.1.0 

func (r ApiRedefineRouteVisualizationsRequest) RouteVisualization(routeVisualization []RouteVisualization) ApiRedefineRouteVisualizationsRequest

A list of Route Visualization models in JSON format.

type ApiTokenGetRequest 

type ApiTokenGetRequest struct {
	ApiService *SecurityAPIService
	// contains filtered or unexported fields
}

func (ApiTokenGetRequest) Code 

func (r ApiTokenGetRequest) Code(code string) ApiTokenGetRequest

Code used for JWT token generation returned by Keycloak authentication.

func (ApiTokenGetRequest) Execute 

func (r ApiTokenGetRequest) Execute() (*http.Response, error)

func (ApiTokenGetRequest) Iss 

func (r ApiTokenGetRequest) Iss(iss string) ApiTokenGetRequest

Code issuer returned by the Keycloak authentication.

func (ApiTokenGetRequest) SessionState 

func (r ApiTokenGetRequest) SessionState(sessionState string) ApiTokenGetRequest

Session state returned by the Keycloak authentication.

func (ApiTokenGetRequest) State 

func (r ApiTokenGetRequest) State(state string) ApiTokenGetRequest

State returned by the Keycloak authentication.

type ApiTokenRefreshRequest 

type ApiTokenRefreshRequest struct {
	ApiService *SecurityAPIService
	// contains filtered or unexported fields
}

func (ApiTokenRefreshRequest) Execute 

func (r ApiTokenRefreshRequest) Execute() (*http.Response, error)

func (ApiTokenRefreshRequest) RefreshToken 

func (r ApiTokenRefreshRequest) RefreshToken(refreshToken string) ApiTokenRefreshRequest

Refresh token used for JWT token generation.

type ApiUpdateCarsRequest added in v1.1.0 

type ApiUpdateCarsRequest struct {
	ApiService *CarAPIService
	// contains filtered or unexported fields
}

func (ApiUpdateCarsRequest) Car added in v1.1.0 

func (r ApiUpdateCarsRequest) Car(car []Car) ApiUpdateCarsRequest

JSON representation of a list of the Cars with updated data.

func (ApiUpdateCarsRequest) Execute added in v1.1.0 

func (r ApiUpdateCarsRequest) Execute() (*http.Response, error)

type ApiUpdateRoutesRequest added in v1.1.0 

type ApiUpdateRoutesRequest struct {
	ApiService *RouteAPIService
	// contains filtered or unexported fields
}

func (ApiUpdateRoutesRequest) Execute added in v1.1.0 

func (r ApiUpdateRoutesRequest) Execute() (*http.Response, error)

func (ApiUpdateRoutesRequest) Route added in v1.1.0 

func (r ApiUpdateRoutesRequest) Route(route []Route) ApiUpdateRoutesRequest

JSON representation of a list of the Routes with updated data.

type ApiUpdateStopsRequest added in v1.1.0 

type ApiUpdateStopsRequest struct {
	ApiService *StopAPIService
	// contains filtered or unexported fields
}

func (ApiUpdateStopsRequest) Execute added in v1.1.0 

func (r ApiUpdateStopsRequest) Execute() (*http.Response, error)

func (ApiUpdateStopsRequest) Stop added in v1.1.0 

func (r ApiUpdateStopsRequest) Stop(stop []Stop) ApiUpdateStopsRequest

JSON representation of a list of the Stops with updated data.

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 Car 

type Car struct {
	Id             *int32      `json:"id,omitempty"`
	PlatformHwId   int32       `json:"platformHwId"`
	Name           string      `json:"name"`
	CarAdminPhone  MobilePhone `json:"carAdminPhone"`
	DefaultRouteId *int32      `json:"defaultRouteId,omitempty"`
	UnderTest      *bool       `json:"underTest,omitempty"`
	LastState      *CarState   `json:"lastState,omitempty"`
}

Car Car model structure.

func NewCar 

func NewCar(platformHwId int32, name string, carAdminPhone MobilePhone) *Car

NewCar instantiates a new Car 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 NewCarWithDefaults 

func NewCarWithDefaults() *Car

NewCarWithDefaults instantiates a new Car 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 (*Car) GetCarAdminPhone 

func (o *Car) GetCarAdminPhone() MobilePhone

GetCarAdminPhone returns the CarAdminPhone field value

func (*Car) GetCarAdminPhoneOk 

func (o *Car) GetCarAdminPhoneOk() (*MobilePhone, bool)

GetCarAdminPhoneOk returns a tuple with the CarAdminPhone field value and a boolean to check if the value has been set.

func (*Car) GetDefaultRouteId 

func (o *Car) GetDefaultRouteId() int32

GetDefaultRouteId returns the DefaultRouteId field value if set, zero value otherwise.

func (*Car) GetDefaultRouteIdOk 

func (o *Car) GetDefaultRouteIdOk() (*int32, bool)

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

func (*Car) GetId 

func (o *Car) GetId() int32

GetId returns the Id field value if set, zero value otherwise.

func (*Car) GetIdOk 

func (o *Car) GetIdOk() (*int32, bool)

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

func (*Car) GetLastState 

func (o *Car) GetLastState() CarState

GetLastState returns the LastState field value if set, zero value otherwise.

func (*Car) GetLastStateOk 

func (o *Car) GetLastStateOk() (*CarState, bool)

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

func (*Car) GetName 

func (o *Car) GetName() string

GetName returns the Name field value

func (*Car) GetNameOk 

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

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

func (*Car) GetPlatformHwId 

func (o *Car) GetPlatformHwId() int32

GetPlatformHwId returns the PlatformHwId field value

func (*Car) GetPlatformHwIdOk 

func (o *Car) GetPlatformHwIdOk() (*int32, bool)

GetPlatformHwIdOk returns a tuple with the PlatformHwId field value and a boolean to check if the value has been set.

func (*Car) GetUnderTest 

func (o *Car) GetUnderTest() bool

GetUnderTest returns the UnderTest field value if set, zero value otherwise.

func (*Car) GetUnderTestOk 

func (o *Car) GetUnderTestOk() (*bool, bool)

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

func (*Car) HasDefaultRouteId 

func (o *Car) HasDefaultRouteId() bool

HasDefaultRouteId returns a boolean if a field has been set.

func (*Car) HasId 

func (o *Car) HasId() bool

HasId returns a boolean if a field has been set.

func (*Car) HasLastState 

func (o *Car) HasLastState() bool

HasLastState returns a boolean if a field has been set.

func (*Car) HasUnderTest 

func (o *Car) HasUnderTest() bool

HasUnderTest returns a boolean if a field has been set.

func (Car) MarshalJSON 

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

func (*Car) SetCarAdminPhone 

func (o *Car) SetCarAdminPhone(v MobilePhone)

SetCarAdminPhone sets field value

func (*Car) SetDefaultRouteId 

func (o *Car) SetDefaultRouteId(v int32)

SetDefaultRouteId gets a reference to the given int32 and assigns it to the DefaultRouteId field.

func (*Car) SetId 

func (o *Car) SetId(v int32)

SetId gets a reference to the given int32 and assigns it to the Id field.

func (*Car) SetLastState 

func (o *Car) SetLastState(v CarState)

SetLastState gets a reference to the given CarState and assigns it to the LastState field.

func (*Car) SetName 

func (o *Car) SetName(v string)

SetName sets field value

func (*Car) SetPlatformHwId 

func (o *Car) SetPlatformHwId(v int32)

SetPlatformHwId sets field value

func (*Car) SetUnderTest 

func (o *Car) SetUnderTest(v bool)

SetUnderTest gets a reference to the given bool and assigns it to the UnderTest field.

func (Car) ToMap 

func (o Car) ToMap() (map[string]interface{}, error)

func (*Car) UnmarshalJSON 

func (o *Car) UnmarshalJSON(data []byte) (err error)

type CarAPIService 

type CarAPIService service

CarAPIService CarAPI service

func (*CarAPIService) CreateCars added in v1.1.0 

func (a *CarAPIService) CreateCars(ctx context.Context) ApiCreateCarsRequest

CreateCars Create new Car objects. 

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

func (*CarAPIService) CreateCarsExecute added in v1.1.0 

func (a *CarAPIService) CreateCarsExecute(r ApiCreateCarsRequest) ([]Car, *http.Response, error)

Execute executes the request 

@return []Car

func (*CarAPIService) DeleteCar 

func (a *CarAPIService) DeleteCar(ctx context.Context, carId int32) ApiDeleteCarRequest

DeleteCar Delete a Car identified by its ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param carId The ID of the Car to be deleted.
@return ApiDeleteCarRequest

func (*CarAPIService) DeleteCarExecute 

func (a *CarAPIService) DeleteCarExecute(r ApiDeleteCarRequest) (*http.Response, error)

Execute executes the request

func (*CarAPIService) GetCar 

func (a *CarAPIService) GetCar(ctx context.Context, carId int32) ApiGetCarRequest

GetCar Find a single Car by its ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param carId An ID of the Car to be returned.
@return ApiGetCarRequest

func (*CarAPIService) GetCarExecute 

func (a *CarAPIService) GetCarExecute(r ApiGetCarRequest) (*Car, *http.Response, error)

Execute executes the request 

@return Car

func (*CarAPIService) GetCars 

func (a *CarAPIService) GetCars(ctx context.Context) ApiGetCarsRequest

GetCars Find and return all existing Cars. 

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

func (*CarAPIService) GetCarsExecute 

func (a *CarAPIService) GetCarsExecute(r ApiGetCarsRequest) ([]Car, *http.Response, error)

Execute executes the request 

@return []Car

func (*CarAPIService) UpdateCars added in v1.1.0 

func (a *CarAPIService) UpdateCars(ctx context.Context) ApiUpdateCarsRequest

UpdateCars Update already existing Cars. 

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

func (*CarAPIService) UpdateCarsExecute added in v1.1.0 

func (a *CarAPIService) UpdateCarsExecute(r ApiUpdateCarsRequest) (*http.Response, error)

Execute executes the request

type CarState 

type CarState struct {
	Id *int32 `json:"id,omitempty"`
	// A Unix timestamp in milliseconds. The timestamp is used to determine the time of creation of an object.
	Timestamp *int64        `json:"timestamp,omitempty"`
	Status    CarStatus     `json:"status"`
	Fuel      *int32        `json:"fuel,omitempty"`
	CarId     int32         `json:"carId"`
	Speed     *float32      `json:"speed,omitempty"`
	Position  *GNSSPosition `json:"position,omitempty"`
}

CarState Car State object structure

func NewCarState 

func NewCarState(status CarStatus, carId int32) *CarState

NewCarState instantiates a new CarState 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 NewCarStateWithDefaults 

func NewCarStateWithDefaults() *CarState

NewCarStateWithDefaults instantiates a new CarState 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 (*CarState) GetCarId 

func (o *CarState) GetCarId() int32

GetCarId returns the CarId field value

func (*CarState) GetCarIdOk 

func (o *CarState) GetCarIdOk() (*int32, bool)

GetCarIdOk returns a tuple with the CarId field value and a boolean to check if the value has been set.

func (*CarState) GetFuel 

func (o *CarState) GetFuel() int32

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

func (*CarState) GetFuelOk 

func (o *CarState) GetFuelOk() (*int32, 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 (*CarState) GetId 

func (o *CarState) GetId() int32

GetId returns the Id field value if set, zero value otherwise.

func (*CarState) GetIdOk 

func (o *CarState) GetIdOk() (*int32, bool)

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

func (*CarState) GetPosition 

func (o *CarState) GetPosition() GNSSPosition

GetPosition returns the Position field value if set, zero value otherwise.

func (*CarState) GetPositionOk 

func (o *CarState) GetPositionOk() (*GNSSPosition, bool)

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

func (*CarState) GetSpeed 

func (o *CarState) GetSpeed() float32

GetSpeed returns the Speed field value if set, zero value otherwise.

func (*CarState) GetSpeedOk 

func (o *CarState) GetSpeedOk() (*float32, bool)

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

func (*CarState) GetStatus 

func (o *CarState) GetStatus() CarStatus

GetStatus returns the Status field value

func (*CarState) GetStatusOk 

func (o *CarState) GetStatusOk() (*CarStatus, bool)

GetStatusOk returns a tuple with the Status field value and a boolean to check if the value has been set.

func (*CarState) GetTimestamp 

func (o *CarState) GetTimestamp() int64

GetTimestamp returns the Timestamp field value if set, zero value otherwise.

func (*CarState) GetTimestampOk 

func (o *CarState) GetTimestampOk() (*int64, bool)

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

func (*CarState) HasFuel 

func (o *CarState) HasFuel() bool

HasFuel returns a boolean if a field has been set.

func (*CarState) HasId 

func (o *CarState) HasId() bool

HasId returns a boolean if a field has been set.

func (*CarState) HasPosition 

func (o *CarState) HasPosition() bool

HasPosition returns a boolean if a field has been set.

func (*CarState) HasSpeed 

func (o *CarState) HasSpeed() bool

HasSpeed returns a boolean if a field has been set.

func (*CarState) HasTimestamp 

func (o *CarState) HasTimestamp() bool

HasTimestamp returns a boolean if a field has been set.

func (CarState) MarshalJSON 

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

func (*CarState) SetCarId 

func (o *CarState) SetCarId(v int32)

SetCarId sets field value

func (*CarState) SetFuel 

func (o *CarState) SetFuel(v int32)

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

func (*CarState) SetId 

func (o *CarState) SetId(v int32)

SetId gets a reference to the given int32 and assigns it to the Id field.

func (*CarState) SetPosition 

func (o *CarState) SetPosition(v GNSSPosition)

SetPosition gets a reference to the given GNSSPosition and assigns it to the Position field.

func (*CarState) SetSpeed 

func (o *CarState) SetSpeed(v float32)

SetSpeed gets a reference to the given float32 and assigns it to the Speed field.

func (*CarState) SetStatus 

func (o *CarState) SetStatus(v CarStatus)

SetStatus sets field value

func (*CarState) SetTimestamp 

func (o *CarState) SetTimestamp(v int64)

SetTimestamp gets a reference to the given int64 and assigns it to the Timestamp field.

func (CarState) ToMap 

func (o CarState) ToMap() (map[string]interface{}, error)

func (*CarState) UnmarshalJSON 

func (o *CarState) UnmarshalJSON(data []byte) (err error)

type CarStateAPIService 

type CarStateAPIService service

CarStateAPIService CarStateAPI service

func (*CarStateAPIService) CreateCarStates added in v1.1.0 

func (a *CarStateAPIService) CreateCarStates(ctx context.Context) ApiCreateCarStatesRequest

CreateCarStates Add new Car States. 

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

func (*CarStateAPIService) CreateCarStatesExecute added in v1.1.0 

func (a *CarStateAPIService) CreateCarStatesExecute(r ApiCreateCarStatesRequest) (*http.Response, error)

Execute executes the request

func (*CarStateAPIService) GetAllCarStates 

func (a *CarStateAPIService) GetAllCarStates(ctx context.Context) ApiGetAllCarStatesRequest

GetAllCarStates Find one or all Car States for all existing Cars. 

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

func (*CarStateAPIService) GetAllCarStatesExecute 

func (a *CarStateAPIService) GetAllCarStatesExecute(r ApiGetAllCarStatesRequest) ([]CarState, *http.Response, error)

Execute executes the request 

@return []CarState

func (*CarStateAPIService) GetCarStates 

func (a *CarStateAPIService) GetCarStates(ctx context.Context, carId int32) ApiGetCarStatesRequest

GetCarStates Find one or all Car States for a Car with given ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param carId ID of the Car for which to find the Car States.
@return ApiGetCarStatesRequest

func (*CarStateAPIService) GetCarStatesExecute 

func (a *CarStateAPIService) GetCarStatesExecute(r ApiGetCarStatesRequest) ([]CarState, *http.Response, error)

Execute executes the request 

@return []CarState

type CarStatus 

type CarStatus string

CarStatus Car Status enum 

const (
	IDLE               CarStatus = "idle"
	CHARGING           CarStatus = "charging"
	OUT_OF_ORDER       CarStatus = "out_of_order"
	DRIVING            CarStatus = "driving"
	IN_STOP            CarStatus = "in_stop"
	PAUSED_BY_PHONE    CarStatus = "paused_by_phone"
	PAUSED_BY_OBSTACLE CarStatus = "paused_by_obstacle"
	PAUSED_BY_BUTTON   CarStatus = "paused_by_button"
)

List of CarStatus

func NewCarStatusFromValue 

func NewCarStatusFromValue(v string) (*CarStatus, error)

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

func (CarStatus) IsValid 

func (v CarStatus) IsValid() bool

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

func (CarStatus) Ptr 

func (v CarStatus) Ptr() *CarStatus

Ptr returns reference to CarStatus value

func (*CarStatus) UnmarshalJSON 

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

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 Error 

type Error struct {
	Code    int32  `json:"code"`
	Message string `json:"message"`
}

Error Error object structure.

func NewError 

func NewError(code int32, message string) *Error

NewError instantiates a new Error 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 NewErrorWithDefaults 

func NewErrorWithDefaults() *Error

NewErrorWithDefaults instantiates a new Error 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 (*Error) GetCode 

func (o *Error) GetCode() int32

GetCode returns the Code field value

func (*Error) GetCodeOk 

func (o *Error) GetCodeOk() (*int32, bool)

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

func (*Error) GetMessage 

func (o *Error) GetMessage() string

GetMessage returns the Message field value

func (*Error) GetMessageOk 

func (o *Error) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field value and a boolean to check if the value has been set.

func (Error) MarshalJSON 

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

func (*Error) SetCode 

func (o *Error) SetCode(v int32)

SetCode sets field value

func (*Error) SetMessage 

func (o *Error) SetMessage(v string)

SetMessage sets field value

func (Error) ToMap 

func (o Error) ToMap() (map[string]interface{}, error)

func (*Error) UnmarshalJSON 

func (o *Error) UnmarshalJSON(data []byte) (err error)

type GNSSPosition 

type GNSSPosition struct {
	Latitude  *float32 `json:"latitude,omitempty"`
	Longitude *float32 `json:"longitude,omitempty"`
	Altitude  *float32 `json:"altitude,omitempty"`
}

GNSSPosition GNSSPosition primitive structure.

func NewGNSSPosition 

func NewGNSSPosition() *GNSSPosition

NewGNSSPosition instantiates a new GNSSPosition 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 NewGNSSPositionWithDefaults 

func NewGNSSPositionWithDefaults() *GNSSPosition

NewGNSSPositionWithDefaults instantiates a new GNSSPosition 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 (*GNSSPosition) GetAltitude 

func (o *GNSSPosition) GetAltitude() float32

GetAltitude returns the Altitude field value if set, zero value otherwise.

func (*GNSSPosition) GetAltitudeOk 

func (o *GNSSPosition) GetAltitudeOk() (*float32, bool)

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

func (*GNSSPosition) GetLatitude 

func (o *GNSSPosition) GetLatitude() float32

GetLatitude returns the Latitude field value if set, zero value otherwise.

func (*GNSSPosition) GetLatitudeOk 

func (o *GNSSPosition) GetLatitudeOk() (*float32, bool)

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

func (*GNSSPosition) GetLongitude 

func (o *GNSSPosition) GetLongitude() float32

GetLongitude returns the Longitude field value if set, zero value otherwise.

func (*GNSSPosition) GetLongitudeOk 

func (o *GNSSPosition) GetLongitudeOk() (*float32, bool)

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

func (*GNSSPosition) HasAltitude 

func (o *GNSSPosition) HasAltitude() bool

HasAltitude returns a boolean if a field has been set.

func (*GNSSPosition) HasLatitude 

func (o *GNSSPosition) HasLatitude() bool

HasLatitude returns a boolean if a field has been set.

func (*GNSSPosition) HasLongitude 

func (o *GNSSPosition) HasLongitude() bool

HasLongitude returns a boolean if a field has been set.

func (GNSSPosition) MarshalJSON 

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

func (*GNSSPosition) SetAltitude 

func (o *GNSSPosition) SetAltitude(v float32)

SetAltitude gets a reference to the given float32 and assigns it to the Altitude field.

func (*GNSSPosition) SetLatitude 

func (o *GNSSPosition) SetLatitude(v float32)

SetLatitude gets a reference to the given float32 and assigns it to the Latitude field.

func (*GNSSPosition) SetLongitude 

func (o *GNSSPosition) SetLongitude(v float32)

SetLongitude gets a reference to the given float32 and assigns it to the Longitude field.

func (GNSSPosition) ToMap 

func (o GNSSPosition) ToMap() (map[string]interface{}, error)

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 MappedNullable 

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type MobilePhone 

type MobilePhone struct {
	Phone *string `json:"phone,omitempty"`
}

MobilePhone MobilePhone Primitive structure.

func NewMobilePhone 

func NewMobilePhone() *MobilePhone

NewMobilePhone instantiates a new MobilePhone 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 NewMobilePhoneWithDefaults 

func NewMobilePhoneWithDefaults() *MobilePhone

NewMobilePhoneWithDefaults instantiates a new MobilePhone 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 (*MobilePhone) GetPhone 

func (o *MobilePhone) GetPhone() string

GetPhone returns the Phone field value if set, zero value otherwise.

func (*MobilePhone) GetPhoneOk 

func (o *MobilePhone) GetPhoneOk() (*string, bool)

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

func (*MobilePhone) HasPhone 

func (o *MobilePhone) HasPhone() bool

HasPhone returns a boolean if a field has been set.

func (MobilePhone) MarshalJSON 

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

func (*MobilePhone) SetPhone 

func (o *MobilePhone) SetPhone(v string)

SetPhone gets a reference to the given string and assigns it to the Phone field.

func (MobilePhone) ToMap 

func (o MobilePhone) ToMap() (map[string]interface{}, error)

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 NullableCar 

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

func NewNullableCar 

func NewNullableCar(val *Car) *NullableCar

func (NullableCar) Get 

func (v NullableCar) Get() *Car

func (NullableCar) IsSet 

func (v NullableCar) IsSet() bool

func (NullableCar) MarshalJSON 

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

func (*NullableCar) Set 

func (v *NullableCar) Set(val *Car)

func (*NullableCar) UnmarshalJSON 

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

func (*NullableCar) Unset 

func (v *NullableCar) Unset()

type NullableCarState 

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

func NewNullableCarState 

func NewNullableCarState(val *CarState) *NullableCarState

func (NullableCarState) Get 

func (v NullableCarState) Get() *CarState

func (NullableCarState) IsSet 

func (v NullableCarState) IsSet() bool

func (NullableCarState) MarshalJSON 

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

func (*NullableCarState) Set 

func (v *NullableCarState) Set(val *CarState)

func (*NullableCarState) UnmarshalJSON 

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

func (*NullableCarState) Unset 

func (v *NullableCarState) Unset()

type NullableCarStatus 

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

func NewNullableCarStatus 

func NewNullableCarStatus(val *CarStatus) *NullableCarStatus

func (NullableCarStatus) Get 

func (v NullableCarStatus) Get() *CarStatus

func (NullableCarStatus) IsSet 

func (v NullableCarStatus) IsSet() bool

func (NullableCarStatus) MarshalJSON 

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

func (*NullableCarStatus) Set 

func (v *NullableCarStatus) Set(val *CarStatus)

func (*NullableCarStatus) UnmarshalJSON 

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

func (*NullableCarStatus) Unset 

func (v *NullableCarStatus) Unset()

type NullableError 

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

func NewNullableError 

func NewNullableError(val *Error) *NullableError

func (NullableError) Get 

func (v NullableError) Get() *Error

func (NullableError) IsSet 

func (v NullableError) IsSet() bool

func (NullableError) MarshalJSON 

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

func (*NullableError) Set 

func (v *NullableError) Set(val *Error)

func (*NullableError) UnmarshalJSON 

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

func (*NullableError) Unset 

func (v *NullableError) 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 NullableGNSSPosition 

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

func NewNullableGNSSPosition 

func NewNullableGNSSPosition(val *GNSSPosition) *NullableGNSSPosition

func (NullableGNSSPosition) Get 

func (v NullableGNSSPosition) Get() *GNSSPosition

func (NullableGNSSPosition) IsSet 

func (v NullableGNSSPosition) IsSet() bool

func (NullableGNSSPosition) MarshalJSON 

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

func (*NullableGNSSPosition) Set 

func (v *NullableGNSSPosition) Set(val *GNSSPosition)

func (*NullableGNSSPosition) UnmarshalJSON 

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

func (*NullableGNSSPosition) Unset 

func (v *NullableGNSSPosition) 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 NullableMobilePhone 

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

func NewNullableMobilePhone 

func NewNullableMobilePhone(val *MobilePhone) *NullableMobilePhone

func (NullableMobilePhone) Get 

func (v NullableMobilePhone) Get() *MobilePhone

func (NullableMobilePhone) IsSet 

func (v NullableMobilePhone) IsSet() bool

func (NullableMobilePhone) MarshalJSON 

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

func (*NullableMobilePhone) Set 

func (v *NullableMobilePhone) Set(val *MobilePhone)

func (*NullableMobilePhone) UnmarshalJSON 

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

func (*NullableMobilePhone) Unset 

func (v *NullableMobilePhone) Unset()

type NullableOrder 

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

func NewNullableOrder 

func NewNullableOrder(val *Order) *NullableOrder

func (NullableOrder) Get 

func (v NullableOrder) Get() *Order

func (NullableOrder) IsSet 

func (v NullableOrder) IsSet() bool

func (NullableOrder) MarshalJSON 

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

func (*NullableOrder) Set 

func (v *NullableOrder) Set(val *Order)

func (*NullableOrder) UnmarshalJSON 

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

func (*NullableOrder) Unset 

func (v *NullableOrder) Unset()

type NullableOrderState 

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

func NewNullableOrderState 

func NewNullableOrderState(val *OrderState) *NullableOrderState

func (NullableOrderState) Get 

func (v NullableOrderState) Get() *OrderState

func (NullableOrderState) IsSet 

func (v NullableOrderState) IsSet() bool

func (NullableOrderState) MarshalJSON 

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

func (*NullableOrderState) Set 

func (v *NullableOrderState) Set(val *OrderState)

func (*NullableOrderState) UnmarshalJSON 

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

func (*NullableOrderState) Unset 

func (v *NullableOrderState) Unset()

type NullableOrderStatus 

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

func NewNullableOrderStatus 

func NewNullableOrderStatus(val *OrderStatus) *NullableOrderStatus

func (NullableOrderStatus) Get 

func (v NullableOrderStatus) Get() *OrderStatus

func (NullableOrderStatus) IsSet 

func (v NullableOrderStatus) IsSet() bool

func (NullableOrderStatus) MarshalJSON 

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

func (*NullableOrderStatus) Set 

func (v *NullableOrderStatus) Set(val *OrderStatus)

func (*NullableOrderStatus) UnmarshalJSON 

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

func (*NullableOrderStatus) Unset 

func (v *NullableOrderStatus) Unset()

type NullablePlatformHW 

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

func NewNullablePlatformHW 

func NewNullablePlatformHW(val *PlatformHW) *NullablePlatformHW

func (NullablePlatformHW) Get 

func (v NullablePlatformHW) Get() *PlatformHW

func (NullablePlatformHW) IsSet 

func (v NullablePlatformHW) IsSet() bool

func (NullablePlatformHW) MarshalJSON 

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

func (*NullablePlatformHW) Set 

func (v *NullablePlatformHW) Set(val *PlatformHW)

func (*NullablePlatformHW) UnmarshalJSON 

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

func (*NullablePlatformHW) Unset 

func (v *NullablePlatformHW) Unset()

type NullableRoute 

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

func NewNullableRoute 

func NewNullableRoute(val *Route) *NullableRoute

func (NullableRoute) Get 

func (v NullableRoute) Get() *Route

func (NullableRoute) IsSet 

func (v NullableRoute) IsSet() bool

func (NullableRoute) MarshalJSON 

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

func (*NullableRoute) Set 

func (v *NullableRoute) Set(val *Route)

func (*NullableRoute) UnmarshalJSON 

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

func (*NullableRoute) Unset 

func (v *NullableRoute) Unset()

type NullableRouteVisualization 

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

func NewNullableRouteVisualization 

func NewNullableRouteVisualization(val *RouteVisualization) *NullableRouteVisualization

func (NullableRouteVisualization) Get 

func (v NullableRouteVisualization) Get() *RouteVisualization

func (NullableRouteVisualization) IsSet 

func (v NullableRouteVisualization) IsSet() bool

func (NullableRouteVisualization) MarshalJSON 

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

func (*NullableRouteVisualization) Set 

func (v *NullableRouteVisualization) Set(val *RouteVisualization)

func (*NullableRouteVisualization) UnmarshalJSON 

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

func (*NullableRouteVisualization) Unset 

func (v *NullableRouteVisualization) Unset()

type NullableStop 

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

func NewNullableStop 

func NewNullableStop(val *Stop) *NullableStop

func (NullableStop) Get 

func (v NullableStop) Get() *Stop

func (NullableStop) IsSet 

func (v NullableStop) IsSet() bool

func (NullableStop) MarshalJSON 

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

func (*NullableStop) Set 

func (v *NullableStop) Set(val *Stop)

func (*NullableStop) UnmarshalJSON 

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

func (*NullableStop) Unset 

func (v *NullableStop) 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 Order 

type Order struct {
	Id *int32 `json:"id,omitempty"`
	// Priority (low, normal, high)
	Priority *string `json:"priority,omitempty"`
	// A Unix timestamp in milliseconds. The timestamp is used to determine the time of creation of an object.
	Timestamp         *int64       `json:"timestamp,omitempty"`
	CarId             int32        `json:"carId"`
	Notification      *string      `json:"notification,omitempty"`
	TargetStopId      int32        `json:"targetStopId"`
	StopRouteId       int32        `json:"stopRouteId"`
	NotificationPhone *MobilePhone `json:"notificationPhone,omitempty"`
	LastState         *OrderState  `json:"lastState,omitempty"`
	IsVisible         *bool        `json:"isVisible,omitempty"`
}

Order Order object structure.

func NewOrder 

func NewOrder(carId int32, targetStopId int32, stopRouteId int32) *Order

NewOrder instantiates a new Order 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 NewOrderWithDefaults 

func NewOrderWithDefaults() *Order

NewOrderWithDefaults instantiates a new Order 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 (*Order) GetCarId 

func (o *Order) GetCarId() int32

GetCarId returns the CarId field value

func (*Order) GetCarIdOk 

func (o *Order) GetCarIdOk() (*int32, bool)

GetCarIdOk returns a tuple with the CarId field value and a boolean to check if the value has been set.

func (*Order) GetId 

func (o *Order) GetId() int32

GetId returns the Id field value if set, zero value otherwise.

func (*Order) GetIdOk 

func (o *Order) GetIdOk() (*int32, bool)

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

func (*Order) GetIsVisible added in v1.1.0 

func (o *Order) GetIsVisible() bool

GetIsVisible returns the IsVisible field value if set, zero value otherwise.

func (*Order) GetIsVisibleOk added in v1.1.0 

func (o *Order) GetIsVisibleOk() (*bool, bool)

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

func (*Order) GetLastState 

func (o *Order) GetLastState() OrderState

GetLastState returns the LastState field value if set, zero value otherwise.

func (*Order) GetLastStateOk 

func (o *Order) GetLastStateOk() (*OrderState, bool)

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

func (*Order) GetNotification 

func (o *Order) GetNotification() string

GetNotification returns the Notification field value if set, zero value otherwise.

func (*Order) GetNotificationOk 

func (o *Order) GetNotificationOk() (*string, bool)

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

func (*Order) GetNotificationPhone 

func (o *Order) GetNotificationPhone() MobilePhone

GetNotificationPhone returns the NotificationPhone field value if set, zero value otherwise.

func (*Order) GetNotificationPhoneOk 

func (o *Order) GetNotificationPhoneOk() (*MobilePhone, bool)

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

func (*Order) GetPriority 

func (o *Order) GetPriority() string

GetPriority returns the Priority field value if set, zero value otherwise.

func (*Order) GetPriorityOk 

func (o *Order) GetPriorityOk() (*string, bool)

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

func (*Order) GetStopRouteId 

func (o *Order) GetStopRouteId() int32

GetStopRouteId returns the StopRouteId field value

func (*Order) GetStopRouteIdOk 

func (o *Order) GetStopRouteIdOk() (*int32, bool)

GetStopRouteIdOk returns a tuple with the StopRouteId field value and a boolean to check if the value has been set.

func (*Order) GetTargetStopId 

func (o *Order) GetTargetStopId() int32

GetTargetStopId returns the TargetStopId field value

func (*Order) GetTargetStopIdOk 

func (o *Order) GetTargetStopIdOk() (*int32, bool)

GetTargetStopIdOk returns a tuple with the TargetStopId field value and a boolean to check if the value has been set.

func (*Order) GetTimestamp 

func (o *Order) GetTimestamp() int64

GetTimestamp returns the Timestamp field value if set, zero value otherwise.

func (*Order) GetTimestampOk 

func (o *Order) GetTimestampOk() (*int64, bool)

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

func (*Order) HasId 

func (o *Order) HasId() bool

HasId returns a boolean if a field has been set.

func (*Order) HasIsVisible added in v1.1.0 

func (o *Order) HasIsVisible() bool

HasIsVisible returns a boolean if a field has been set.

func (*Order) HasLastState 

func (o *Order) HasLastState() bool

HasLastState returns a boolean if a field has been set.

func (*Order) HasNotification 

func (o *Order) HasNotification() bool

HasNotification returns a boolean if a field has been set.

func (*Order) HasNotificationPhone 

func (o *Order) HasNotificationPhone() bool

HasNotificationPhone returns a boolean if a field has been set.

func (*Order) HasPriority 

func (o *Order) HasPriority() bool

HasPriority returns a boolean if a field has been set.

func (*Order) HasTimestamp 

func (o *Order) HasTimestamp() bool

HasTimestamp returns a boolean if a field has been set.

func (Order) MarshalJSON 

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

func (*Order) SetCarId 

func (o *Order) SetCarId(v int32)

SetCarId sets field value

func (*Order) SetId 

func (o *Order) SetId(v int32)

SetId gets a reference to the given int32 and assigns it to the Id field.

func (*Order) SetIsVisible added in v1.1.0 

func (o *Order) SetIsVisible(v bool)

SetIsVisible gets a reference to the given bool and assigns it to the IsVisible field.

func (*Order) SetLastState 

func (o *Order) SetLastState(v OrderState)

SetLastState gets a reference to the given OrderState and assigns it to the LastState field.

func (*Order) SetNotification 

func (o *Order) SetNotification(v string)

SetNotification gets a reference to the given string and assigns it to the Notification field.

func (*Order) SetNotificationPhone 

func (o *Order) SetNotificationPhone(v MobilePhone)

SetNotificationPhone gets a reference to the given MobilePhone and assigns it to the NotificationPhone field.

func (*Order) SetPriority 

func (o *Order) SetPriority(v string)

SetPriority gets a reference to the given string and assigns it to the Priority field.

func (*Order) SetStopRouteId 

func (o *Order) SetStopRouteId(v int32)

SetStopRouteId sets field value

func (*Order) SetTargetStopId 

func (o *Order) SetTargetStopId(v int32)

SetTargetStopId sets field value

func (*Order) SetTimestamp 

func (o *Order) SetTimestamp(v int64)

SetTimestamp gets a reference to the given int64 and assigns it to the Timestamp field.

func (Order) ToMap 

func (o Order) ToMap() (map[string]interface{}, error)

func (*Order) UnmarshalJSON 

func (o *Order) UnmarshalJSON(data []byte) (err error)

type OrderAPIService 

type OrderAPIService service

OrderAPIService OrderAPI service

func (*OrderAPIService) CreateOrders added in v1.1.0 

func (a *OrderAPIService) CreateOrders(ctx context.Context) ApiCreateOrdersRequest

CreateOrders Create new Orders. 

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

func (*OrderAPIService) CreateOrdersExecute added in v1.1.0 

func (a *OrderAPIService) CreateOrdersExecute(r ApiCreateOrdersRequest) ([]Order, *http.Response, error)

Execute executes the request 

@return []Order

func (*OrderAPIService) DeleteOrder 

func (a *OrderAPIService) DeleteOrder(ctx context.Context, carId int32, orderId int32) ApiDeleteOrderRequest

DeleteOrder Delete an Order identified by its ID and ID of a car to which it is assigned. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param carId ID of the Car to which the Order is assigned.
@param orderId ID of the Order to be returned.
@return ApiDeleteOrderRequest

func (*OrderAPIService) DeleteOrderExecute 

func (a *OrderAPIService) DeleteOrderExecute(r ApiDeleteOrderRequest) (*http.Response, error)

Execute executes the request

func (*OrderAPIService) GetCarOrders 

func (a *OrderAPIService) GetCarOrders(ctx context.Context, carId int32) ApiGetCarOrdersRequest

GetCarOrders Find existing Orders by the corresponding Car ID and return them. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param carId ID of the Car for which Orders shall be returned.
@return ApiGetCarOrdersRequest

func (*OrderAPIService) GetCarOrdersExecute 

func (a *OrderAPIService) GetCarOrdersExecute(r ApiGetCarOrdersRequest) ([]Order, *http.Response, error)

Execute executes the request 

@return []Order

func (*OrderAPIService) GetOrder 

func (a *OrderAPIService) GetOrder(ctx context.Context, carId int32, orderId int32) ApiGetOrderRequest

GetOrder Find an existing Order by the car ID and the order ID and return it. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param carId ID of the Car to which the Order is assigned.
@param orderId ID of the Order to be returned.
@return ApiGetOrderRequest

func (*OrderAPIService) GetOrderExecute 

func (a *OrderAPIService) GetOrderExecute(r ApiGetOrderRequest) (*Order, *http.Response, error)

Execute executes the request 

@return Order

func (*OrderAPIService) GetOrders 

func (a *OrderAPIService) GetOrders(ctx context.Context) ApiGetOrdersRequest

GetOrders Find all currently existing Orders. 

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

func (*OrderAPIService) GetOrdersExecute 

func (a *OrderAPIService) GetOrdersExecute(r ApiGetOrdersRequest) ([]Order, *http.Response, error)

Execute executes the request 

@return []Order

type OrderState 

type OrderState struct {
	Id      *int32      `json:"id,omitempty"`
	Status  OrderStatus `json:"status"`
	OrderId int32       `json:"orderId"`
	// A Unix timestamp in milliseconds. The timestamp is used to determine the time of creation of an object.
	Timestamp *int64 `json:"timestamp,omitempty"`
}

OrderState Order state object structure.

func NewOrderState 

func NewOrderState(status OrderStatus, orderId int32) *OrderState

NewOrderState instantiates a new OrderState 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 NewOrderStateWithDefaults 

func NewOrderStateWithDefaults() *OrderState

NewOrderStateWithDefaults instantiates a new OrderState 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 (*OrderState) GetId 

func (o *OrderState) GetId() int32

GetId returns the Id field value if set, zero value otherwise.

func (*OrderState) GetIdOk 

func (o *OrderState) GetIdOk() (*int32, bool)

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

func (*OrderState) GetOrderId 

func (o *OrderState) GetOrderId() int32

GetOrderId returns the OrderId field value

func (*OrderState) GetOrderIdOk 

func (o *OrderState) GetOrderIdOk() (*int32, bool)

GetOrderIdOk returns a tuple with the OrderId field value and a boolean to check if the value has been set.

func (*OrderState) GetStatus 

func (o *OrderState) GetStatus() OrderStatus

GetStatus returns the Status field value

func (*OrderState) GetStatusOk 

func (o *OrderState) GetStatusOk() (*OrderStatus, bool)

GetStatusOk returns a tuple with the Status field value and a boolean to check if the value has been set.

func (*OrderState) GetTimestamp 

func (o *OrderState) GetTimestamp() int64

GetTimestamp returns the Timestamp field value if set, zero value otherwise.

func (*OrderState) GetTimestampOk 

func (o *OrderState) GetTimestampOk() (*int64, bool)

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

func (*OrderState) HasId 

func (o *OrderState) HasId() bool

HasId returns a boolean if a field has been set.

func (*OrderState) HasTimestamp 

func (o *OrderState) HasTimestamp() bool

HasTimestamp returns a boolean if a field has been set.

func (OrderState) MarshalJSON 

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

func (*OrderState) SetId 

func (o *OrderState) SetId(v int32)

SetId gets a reference to the given int32 and assigns it to the Id field.

func (*OrderState) SetOrderId 

func (o *OrderState) SetOrderId(v int32)

SetOrderId sets field value

func (*OrderState) SetStatus 

func (o *OrderState) SetStatus(v OrderStatus)

SetStatus sets field value

func (*OrderState) SetTimestamp 

func (o *OrderState) SetTimestamp(v int64)

SetTimestamp gets a reference to the given int64 and assigns it to the Timestamp field.

func (OrderState) ToMap 

func (o OrderState) ToMap() (map[string]interface{}, error)

func (*OrderState) UnmarshalJSON 

func (o *OrderState) UnmarshalJSON(data []byte) (err error)

type OrderStateAPIService 

type OrderStateAPIService service

OrderStateAPIService OrderStateAPI service

func (*OrderStateAPIService) CreateOrderStates added in v1.1.0 

func (a *OrderStateAPIService) CreateOrderStates(ctx context.Context) ApiCreateOrderStatesRequest

CreateOrderStates Add new Order States. 

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

func (*OrderStateAPIService) CreateOrderStatesExecute added in v1.1.0 

func (a *OrderStateAPIService) CreateOrderStatesExecute(r ApiCreateOrderStatesRequest) (*OrderState, *http.Response, error)

Execute executes the request 

@return OrderState

func (*OrderStateAPIService) GetAllOrderStates 

func (a *OrderStateAPIService) GetAllOrderStates(ctx context.Context) ApiGetAllOrderStatesRequest

GetAllOrderStates Find Order States for all existing Orders. 

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

func (*OrderStateAPIService) GetAllOrderStatesExecute 

func (a *OrderStateAPIService) GetAllOrderStatesExecute(r ApiGetAllOrderStatesRequest) ([]OrderState, *http.Response, error)

Execute executes the request 

@return []OrderState

func (*OrderStateAPIService) GetOrderStates 

func (a *OrderStateAPIService) GetOrderStates(ctx context.Context, orderId int32) ApiGetOrderStatesRequest

GetOrderStates Find all Order States for a particular Order specified by its ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param orderId ID of the Order for which to find the Order States.
@return ApiGetOrderStatesRequest

func (*OrderStateAPIService) GetOrderStatesExecute 

func (a *OrderStateAPIService) GetOrderStatesExecute(r ApiGetOrderStatesRequest) ([]OrderState, *http.Response, error)

Execute executes the request 

@return []OrderState

type OrderStatus 

type OrderStatus string

OrderStatus OrderStatus (to_accept, accepted, in_progress, done, canceled). 

const (
	TO_ACCEPT   OrderStatus = "to_accept"
	ACCEPTED    OrderStatus = "accepted"
	IN_PROGRESS OrderStatus = "in_progress"
	DONE        OrderStatus = "done"
	CANCELED    OrderStatus = "canceled"
)

List of OrderStatus

func NewOrderStatusFromValue 

func NewOrderStatusFromValue(v string) (*OrderStatus, error)

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

func (OrderStatus) IsValid 

func (v OrderStatus) IsValid() bool

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

func (OrderStatus) Ptr 

func (v OrderStatus) Ptr() *OrderStatus

Ptr returns reference to OrderStatus value

func (*OrderStatus) UnmarshalJSON 

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

type PlatformHW 

type PlatformHW struct {
	Id   *int32 `json:"id,omitempty"`
	Name string `json:"name"`
}

PlatformHW PlatformHW object structure.

func NewPlatformHW 

func NewPlatformHW(name string) *PlatformHW

NewPlatformHW instantiates a new PlatformHW 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 NewPlatformHWWithDefaults 

func NewPlatformHWWithDefaults() *PlatformHW

NewPlatformHWWithDefaults instantiates a new PlatformHW 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 (*PlatformHW) GetId 

func (o *PlatformHW) GetId() int32

GetId returns the Id field value if set, zero value otherwise.

func (*PlatformHW) GetIdOk 

func (o *PlatformHW) GetIdOk() (*int32, bool)

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

func (*PlatformHW) GetName 

func (o *PlatformHW) GetName() string

GetName returns the Name field value

func (*PlatformHW) GetNameOk 

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

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

func (*PlatformHW) HasId 

func (o *PlatformHW) HasId() bool

HasId returns a boolean if a field has been set.

func (PlatformHW) MarshalJSON 

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

func (*PlatformHW) SetId 

func (o *PlatformHW) SetId(v int32)

SetId gets a reference to the given int32 and assigns it to the Id field.

func (*PlatformHW) SetName 

func (o *PlatformHW) SetName(v string)

SetName sets field value

func (PlatformHW) ToMap 

func (o PlatformHW) ToMap() (map[string]interface{}, error)

func (*PlatformHW) UnmarshalJSON 

func (o *PlatformHW) UnmarshalJSON(data []byte) (err error)

type PlatformHWAPIService 

type PlatformHWAPIService service

PlatformHWAPIService PlatformHWAPI service

func (*PlatformHWAPIService) CreateHws added in v1.1.0 

func (a *PlatformHWAPIService) CreateHws(ctx context.Context) ApiCreateHwsRequest

CreateHws Create new Platform HW objects. 

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

func (*PlatformHWAPIService) CreateHwsExecute added in v1.1.0 

func (a *PlatformHWAPIService) CreateHwsExecute(r ApiCreateHwsRequest) ([]PlatformHW, *http.Response, error)

Execute executes the request 

@return []PlatformHW

func (*PlatformHWAPIService) DeleteHw 

func (a *PlatformHWAPIService) DeleteHw(ctx context.Context, platformHwId int32) ApiDeleteHwRequest

DeleteHw Delete Platform HW with the given ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param platformHwId ID of Platform HW to delete.
@return ApiDeleteHwRequest

func (*PlatformHWAPIService) DeleteHwExecute 

func (a *PlatformHWAPIService) DeleteHwExecute(r ApiDeleteHwRequest) (*http.Response, error)

Execute executes the request

func (*PlatformHWAPIService) GetHw 

func (a *PlatformHWAPIService) GetHw(ctx context.Context, platformHwId int32) ApiGetHwRequest

GetHw Find Platform HW with the given ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param platformHwId ID of the Platform HW to return.
@return ApiGetHwRequest

func (*PlatformHWAPIService) GetHwExecute 

func (a *PlatformHWAPIService) GetHwExecute(r ApiGetHwRequest) (*PlatformHW, *http.Response, error)

Execute executes the request 

@return PlatformHW

func (*PlatformHWAPIService) GetHws 

func (a *PlatformHWAPIService) GetHws(ctx context.Context) ApiGetHwsRequest

GetHws Find and return all existing Platform HW. 

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

func (*PlatformHWAPIService) GetHwsExecute 

func (a *PlatformHWAPIService) GetHwsExecute(r ApiGetHwsRequest) ([]PlatformHW, *http.Response, error)

Execute executes the request 

@return []PlatformHW

type Route 

type Route struct {
	Id      *int32  `json:"id,omitempty"`
	Name    string  `json:"name"`
	StopIds []int32 `json:"stopIds,omitempty"`
}

Route Route object structure.

func NewRoute 

func NewRoute(name string) *Route

NewRoute instantiates a new Route 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 NewRouteWithDefaults 

func NewRouteWithDefaults() *Route

NewRouteWithDefaults instantiates a new Route 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 (*Route) GetId 

func (o *Route) GetId() int32

GetId returns the Id field value if set, zero value otherwise.

func (*Route) GetIdOk 

func (o *Route) GetIdOk() (*int32, bool)

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

func (*Route) GetName 

func (o *Route) GetName() string

GetName returns the Name field value

func (*Route) GetNameOk 

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

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

func (*Route) GetStopIds 

func (o *Route) GetStopIds() []int32

GetStopIds returns the StopIds field value if set, zero value otherwise.

func (*Route) GetStopIdsOk 

func (o *Route) GetStopIdsOk() ([]int32, bool)

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

func (*Route) HasId 

func (o *Route) HasId() bool

HasId returns a boolean if a field has been set.

func (*Route) HasStopIds 

func (o *Route) HasStopIds() bool

HasStopIds returns a boolean if a field has been set.

func (Route) MarshalJSON 

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

func (*Route) SetId 

func (o *Route) SetId(v int32)

SetId gets a reference to the given int32 and assigns it to the Id field.

func (*Route) SetName 

func (o *Route) SetName(v string)

SetName sets field value

func (*Route) SetStopIds 

func (o *Route) SetStopIds(v []int32)

SetStopIds gets a reference to the given []int32 and assigns it to the StopIds field.

func (Route) ToMap 

func (o Route) ToMap() (map[string]interface{}, error)

func (*Route) UnmarshalJSON 

func (o *Route) UnmarshalJSON(data []byte) (err error)

type RouteAPIService 

type RouteAPIService service

RouteAPIService RouteAPI service

func (*RouteAPIService) CreateRoutes added in v1.1.0 

func (a *RouteAPIService) CreateRoutes(ctx context.Context) ApiCreateRoutesRequest

CreateRoutes Create new Routes. 

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

func (*RouteAPIService) CreateRoutesExecute added in v1.1.0 

func (a *RouteAPIService) CreateRoutesExecute(r ApiCreateRoutesRequest) ([]Route, *http.Response, error)

Execute executes the request 

@return []Route

func (*RouteAPIService) DeleteRoute 

func (a *RouteAPIService) DeleteRoute(ctx context.Context, routeId int32) ApiDeleteRouteRequest

DeleteRoute Delete a Route with the specified ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param routeId An ID a the Route
@return ApiDeleteRouteRequest

func (*RouteAPIService) DeleteRouteExecute 

func (a *RouteAPIService) DeleteRouteExecute(r ApiDeleteRouteRequest) (*http.Response, error)

Execute executes the request

func (*RouteAPIService) GetRoute 

func (a *RouteAPIService) GetRoute(ctx context.Context, routeId int32) ApiGetRouteRequest

GetRoute Find a single Route with the specified ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param routeId An ID a the Route
@return ApiGetRouteRequest

func (*RouteAPIService) GetRouteExecute 

func (a *RouteAPIService) GetRouteExecute(r ApiGetRouteRequest) (*Route, *http.Response, error)

Execute executes the request 

@return Route

func (*RouteAPIService) GetRouteVisualization 

func (a *RouteAPIService) GetRouteVisualization(ctx context.Context, routeId int32) ApiGetRouteVisualizationRequest

GetRouteVisualization Find Route Visualization for a Route identified by the route's ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param routeId An ID a the Route
@return ApiGetRouteVisualizationRequest

func (*RouteAPIService) GetRouteVisualizationExecute 

func (a *RouteAPIService) GetRouteVisualizationExecute(r ApiGetRouteVisualizationRequest) (*RouteVisualization, *http.Response, error)

Execute executes the request 

@return RouteVisualization

func (*RouteAPIService) GetRoutes 

func (a *RouteAPIService) GetRoutes(ctx context.Context) ApiGetRoutesRequest

GetRoutes Find and return all existing Routes. 

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

func (*RouteAPIService) GetRoutesExecute 

func (a *RouteAPIService) GetRoutesExecute(r ApiGetRoutesRequest) ([]Route, *http.Response, error)

Execute executes the request 

@return []Route

func (*RouteAPIService) RedefineRouteVisualizations added in v1.1.0 

func (a *RouteAPIService) RedefineRouteVisualizations(ctx context.Context) ApiRedefineRouteVisualizationsRequest

RedefineRouteVisualizations Redefine Route Visualizations for existing Routes. 

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

func (*RouteAPIService) RedefineRouteVisualizationsExecute added in v1.1.0 

func (a *RouteAPIService) RedefineRouteVisualizationsExecute(r ApiRedefineRouteVisualizationsRequest) ([]RouteVisualization, *http.Response, error)

Execute executes the request 

@return []RouteVisualization

func (*RouteAPIService) UpdateRoutes added in v1.1.0 

func (a *RouteAPIService) UpdateRoutes(ctx context.Context) ApiUpdateRoutesRequest

UpdateRoutes Update already existing Routes. 

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

func (*RouteAPIService) UpdateRoutesExecute added in v1.1.0 

func (a *RouteAPIService) UpdateRoutesExecute(r ApiUpdateRoutesRequest) (*http.Response, error)

Execute executes the request

type RouteVisualization 

type RouteVisualization struct {
	Id      *int32 `json:"id,omitempty"`
	RouteId int32  `json:"routeId"`
	// Color in hexadecimal format.
	Hexcolor *string        `json:"hexcolor,omitempty"`
	Points   []GNSSPosition `json:"points"`
}

RouteVisualization Route Visualization object structure.

func NewRouteVisualization 

func NewRouteVisualization(routeId int32, points []GNSSPosition) *RouteVisualization

NewRouteVisualization instantiates a new RouteVisualization 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 NewRouteVisualizationWithDefaults 

func NewRouteVisualizationWithDefaults() *RouteVisualization

NewRouteVisualizationWithDefaults instantiates a new RouteVisualization 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 (*RouteVisualization) GetHexcolor 

func (o *RouteVisualization) GetHexcolor() string

GetHexcolor returns the Hexcolor field value if set, zero value otherwise.

func (*RouteVisualization) GetHexcolorOk 

func (o *RouteVisualization) GetHexcolorOk() (*string, bool)

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

func (*RouteVisualization) GetId 

func (o *RouteVisualization) GetId() int32

GetId returns the Id field value if set, zero value otherwise.

func (*RouteVisualization) GetIdOk 

func (o *RouteVisualization) GetIdOk() (*int32, bool)

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

func (*RouteVisualization) GetPoints 

func (o *RouteVisualization) GetPoints() []GNSSPosition

GetPoints returns the Points field value

func (*RouteVisualization) GetPointsOk 

func (o *RouteVisualization) GetPointsOk() ([]GNSSPosition, bool)

GetPointsOk returns a tuple with the Points field value and a boolean to check if the value has been set.

func (*RouteVisualization) GetRouteId 

func (o *RouteVisualization) GetRouteId() int32

GetRouteId returns the RouteId field value

func (*RouteVisualization) GetRouteIdOk 

func (o *RouteVisualization) GetRouteIdOk() (*int32, bool)

GetRouteIdOk returns a tuple with the RouteId field value and a boolean to check if the value has been set.

func (*RouteVisualization) HasHexcolor 

func (o *RouteVisualization) HasHexcolor() bool

HasHexcolor returns a boolean if a field has been set.

func (*RouteVisualization) HasId 

func (o *RouteVisualization) HasId() bool

HasId returns a boolean if a field has been set.

func (RouteVisualization) MarshalJSON 

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

func (*RouteVisualization) SetHexcolor 

func (o *RouteVisualization) SetHexcolor(v string)

SetHexcolor gets a reference to the given string and assigns it to the Hexcolor field.

func (*RouteVisualization) SetId 

func (o *RouteVisualization) SetId(v int32)

SetId gets a reference to the given int32 and assigns it to the Id field.

func (*RouteVisualization) SetPoints 

func (o *RouteVisualization) SetPoints(v []GNSSPosition)

SetPoints sets field value

func (*RouteVisualization) SetRouteId 

func (o *RouteVisualization) SetRouteId(v int32)

SetRouteId sets field value

func (RouteVisualization) ToMap 

func (o RouteVisualization) ToMap() (map[string]interface{}, error)

func (*RouteVisualization) UnmarshalJSON 

func (o *RouteVisualization) UnmarshalJSON(data []byte) (err error)

type SecurityAPIService 

type SecurityAPIService service

SecurityAPIService SecurityAPI service

func (*SecurityAPIService) Login 

func (a *SecurityAPIService) Login(ctx context.Context) ApiLoginRequest

Login Method for Login

Login using Keycloak. 

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

func (*SecurityAPIService) LoginExecute 

func (a *SecurityAPIService) LoginExecute(r ApiLoginRequest) (*http.Response, error)

Execute executes the request

func (*SecurityAPIService) TokenGet 

func (a *SecurityAPIService) TokenGet(ctx context.Context) ApiTokenGetRequest

TokenGet Method for TokenGet

Callback endpoint for the Keycloak to receive JWT token. 

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

func (*SecurityAPIService) TokenGetExecute 

func (a *SecurityAPIService) TokenGetExecute(r ApiTokenGetRequest) (*http.Response, error)

Execute executes the request

func (*SecurityAPIService) TokenRefresh 

func (a *SecurityAPIService) TokenRefresh(ctx context.Context) ApiTokenRefreshRequest

TokenRefresh Method for TokenRefresh

Endpoint to receive JWT token from refresh token. 

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

func (*SecurityAPIService) TokenRefreshExecute 

func (a *SecurityAPIService) TokenRefreshExecute(r ApiTokenRefreshRequest) (*http.Response, error)

Execute executes the request

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 Stop 

type Stop struct {
	Id                *int32       `json:"id,omitempty"`
	Name              string       `json:"name"`
	Position          GNSSPosition `json:"position"`
	NotificationPhone *MobilePhone `json:"notificationPhone,omitempty"`
	// If set to true, an Order to this Stop is always automatically created when creating Orders for the Route containing this Stop.
	IsAutoStop *bool `json:"isAutoStop,omitempty"`
}

Stop Stop object structure.

func NewStop 

func NewStop(name string, position GNSSPosition) *Stop

NewStop instantiates a new Stop 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 NewStopWithDefaults 

func NewStopWithDefaults() *Stop

NewStopWithDefaults instantiates a new Stop 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 (*Stop) GetId 

func (o *Stop) GetId() int32

GetId returns the Id field value if set, zero value otherwise.

func (*Stop) GetIdOk 

func (o *Stop) GetIdOk() (*int32, bool)

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

func (*Stop) GetIsAutoStop added in v1.1.0 

func (o *Stop) GetIsAutoStop() bool

GetIsAutoStop returns the IsAutoStop field value if set, zero value otherwise.

func (*Stop) GetIsAutoStopOk added in v1.1.0 

func (o *Stop) GetIsAutoStopOk() (*bool, bool)

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

func (*Stop) GetName 

func (o *Stop) GetName() string

GetName returns the Name field value

func (*Stop) GetNameOk 

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

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

func (*Stop) GetNotificationPhone 

func (o *Stop) GetNotificationPhone() MobilePhone

GetNotificationPhone returns the NotificationPhone field value if set, zero value otherwise.

func (*Stop) GetNotificationPhoneOk 

func (o *Stop) GetNotificationPhoneOk() (*MobilePhone, bool)

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

func (*Stop) GetPosition 

func (o *Stop) GetPosition() GNSSPosition

GetPosition returns the Position field value

func (*Stop) GetPositionOk 

func (o *Stop) GetPositionOk() (*GNSSPosition, bool)

GetPositionOk returns a tuple with the Position field value and a boolean to check if the value has been set.

func (*Stop) HasId 

func (o *Stop) HasId() bool

HasId returns a boolean if a field has been set.

func (*Stop) HasIsAutoStop added in v1.1.0 

func (o *Stop) HasIsAutoStop() bool

HasIsAutoStop returns a boolean if a field has been set.

func (*Stop) HasNotificationPhone 

func (o *Stop) HasNotificationPhone() bool

HasNotificationPhone returns a boolean if a field has been set.

func (Stop) MarshalJSON 

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

func (*Stop) SetId 

func (o *Stop) SetId(v int32)

SetId gets a reference to the given int32 and assigns it to the Id field.

func (*Stop) SetIsAutoStop added in v1.1.0 

func (o *Stop) SetIsAutoStop(v bool)

SetIsAutoStop gets a reference to the given bool and assigns it to the IsAutoStop field.

func (*Stop) SetName 

func (o *Stop) SetName(v string)

SetName sets field value

func (*Stop) SetNotificationPhone 

func (o *Stop) SetNotificationPhone(v MobilePhone)

SetNotificationPhone gets a reference to the given MobilePhone and assigns it to the NotificationPhone field.

func (*Stop) SetPosition 

func (o *Stop) SetPosition(v GNSSPosition)

SetPosition sets field value

func (Stop) ToMap 

func (o Stop) ToMap() (map[string]interface{}, error)

func (*Stop) UnmarshalJSON 

func (o *Stop) UnmarshalJSON(data []byte) (err error)

type StopAPIService 

type StopAPIService service

StopAPIService StopAPI service

func (*StopAPIService) CreateStops added in v1.1.0 

func (a *StopAPIService) CreateStops(ctx context.Context) ApiCreateStopsRequest

CreateStops Create new Stops. 

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

func (*StopAPIService) CreateStopsExecute added in v1.1.0 

func (a *StopAPIService) CreateStopsExecute(r ApiCreateStopsRequest) ([]Stop, *http.Response, error)

Execute executes the request 

@return []Stop

func (*StopAPIService) DeleteStop 

func (a *StopAPIService) DeleteStop(ctx context.Context, stopId int32) ApiDeleteStopRequest

DeleteStop Delete a Stop with the specified ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param stopId ID of the Stop to be deleted.
@return ApiDeleteStopRequest

func (*StopAPIService) DeleteStopExecute 

func (a *StopAPIService) DeleteStopExecute(r ApiDeleteStopRequest) (*http.Response, error)

Execute executes the request

func (*StopAPIService) GetStop 

func (a *StopAPIService) GetStop(ctx context.Context, stopId int32) ApiGetStopRequest

GetStop Find and return a single Stop by its ID. 

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param stopId ID of Stop to be returned.
@return ApiGetStopRequest

func (*StopAPIService) GetStopExecute 

func (a *StopAPIService) GetStopExecute(r ApiGetStopRequest) (*Stop, *http.Response, error)

Execute executes the request 

@return Stop

func (*StopAPIService) GetStops 

func (a *StopAPIService) GetStops(ctx context.Context) ApiGetStopsRequest

GetStops Find and return all existing Stops. 

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

func (*StopAPIService) GetStopsExecute 

func (a *StopAPIService) GetStopsExecute(r ApiGetStopsRequest) ([]Stop, *http.Response, error)

Execute executes the request 

@return []Stop

func (*StopAPIService) UpdateStops added in v1.1.0 

func (a *StopAPIService) UpdateStops(ctx context.Context) ApiUpdateStopsRequest

UpdateStops Update already existing Stops. 

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

func (*StopAPIService) UpdateStopsExecute added in v1.1.0 

func (a *StopAPIService) UpdateStopsExecute(r ApiUpdateStopsRequest) (*http.Response, error)

Execute executes the request

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.