diff --git a/README.md b/README.md index fb50307..27a3910 100644 --- a/README.md +++ b/README.md @@ -64,4 +64,13 @@ With this app you will be able to : 2.4 Change car charge threshold to 80 percent http://localhost:5000/charge_control?vin=YOURVIN&percentage=80 - \ No newline at end of file + +## API specficication +The api spec is described here : [api_spec.md](api_spec.md). +You can use all fonction from the doc, for example : +```myp.api().get_car_last_position(myp.get_vehicle_id_with_vin("myvin"))``` +## More information +To analyse the traffics between the app and psa server, you can use mitmproxy. +You will need the client certificate present in the apk at asssets/MWPMYMA1.pem + +```mitmproxy --set client_certs=MWPMYMA1.pe``` \ No newline at end of file diff --git a/api_spec.md b/api_spec.md new file mode 100644 index 0000000..d17b69e --- /dev/null +++ b/api_spec.md @@ -0,0 +1,223 @@ +# psa-connectedcar +*PSA B2C Connected Car API* # Introduction This is the description of the *Groupe PSA Connected Car V2 API*. The speccification is is based on **OpenAPI Specification version 3** and can be displayed via [ReDoc](https://github.com/Rebilly/ReDoc)a or [Swagger](http://swagger.io). This API allows applications to fetch data from the connected Vehicles data platform. # Authentication PSA Connected Car APIs uses the [OAuth 2.0](https://tools.ietf.org/html/rfc6749) protocol for authentication and Authorization. any application require a valid [Access Token](https://tools.ietf.org/html/rfc6749#section-1.4) to access to user data. # Errors Error codes returned by all REST APIs comply with the standard. Nevertheless, PSA Services (callers) need to have more complete data structures (even when the answer is not Http-OK) to better detail the type of error by providing application code, message and a debugging code(for investigation purposes). The http code of the response is managed by the protocol itself (in the header). **Errors are returned as a generic error response:** * ```xError``` object model. + +This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: + +- API version: 4.0 +- Package version: 4.0 +- Build package: io.swagger.codegen.languages.PythonClientCodegen + +## Requirements. + +Python 2.7 and 3.4+ + + +## Documentation for API Endpoints + +All URIs are relative to *https://api.groupe-psa.com/connectedcar/v4* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*TripsApi* | [**get_path_for_trip**](docs/TripsApi.md#get_path_for_trip) | **GET** /user/trips/{tid}/wayPoints | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_path_for_trip_0**](docs/TripsApi.md#get_path_for_trip_0) | **GET** /user/vehicles/{id}/trips/{tid}/wayPoints | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_telemetry_for_trip**](docs/TripsApi.md#get_telemetry_for_trip) | **GET** /user/trips/{tid}/telemetry | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_telemetry_for_trip_0**](docs/TripsApi.md#get_telemetry_for_trip_0) | **GET** /user/vehicles/{id}/trips/{tid}/telemetry | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_trip_by_vehicle**](docs/TripsApi.md#get_trip_by_vehicle) | **GET** /user/vehicles/{id}/trips/{tid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_trips_by_vehicle**](docs/TripsApi.md#get_trips_by_vehicle) | **GET** /user/trips/{tid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_trips_by_vehicle_0**](docs/TripsApi.md#get_trips_by_vehicle_0) | **GET** /user/trips/{tid}/ecoaching | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_trips_by_vehicle_1**](docs/TripsApi.md#get_trips_by_vehicle_1) | **GET** /user/vehicles/{id}/trips | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_trips_by_vehicle_2**](docs/TripsApi.md#get_trips_by_vehicle_2) | **GET** /user/vehicles/{id}/trips/{tid}/ecoaching | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_user_collision_by_tip_by_id**](docs/TripsApi.md#get_user_collision_by_tip_by_id) | **GET** /user/trips/{tid}/collisions/{cid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_user_collisions_by_trip_id**](docs/TripsApi.md#get_user_collisions_by_trip_id) | **GET** /user/trips/{tid}/collisions | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_user_trip_alert_by_aid**](docs/TripsApi.md#get_user_trip_alert_by_aid) | **GET** /user/trips/{tid}/alerts/{aid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_user_trip_alerts**](docs/TripsApi.md#get_user_trip_alerts) | **GET** /user/trips/{tid}/alerts | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_user_trips**](docs/TripsApi.md#get_user_trips) | **GET** /user/trips | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_vehicle_collision_by_tip_by_id**](docs/TripsApi.md#get_vehicle_collision_by_tip_by_id) | **GET** /user/vehicles/{id}/trips/{tid}/collisions/{cid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_vehicle_collisions_by_trip_id**](docs/TripsApi.md#get_vehicle_collisions_by_trip_id) | **GET** /user/vehicles/{id}/trips/{tid}/collisions | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_vehicle_trip_alert_by_aid**](docs/TripsApi.md#get_vehicle_trip_alert_by_aid) | **GET** /user/vehicles/{id}/trips/{tid}/alerts/{aid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*TripsApi* | [**get_vehicle_trip_alerts**](docs/TripsApi.md#get_vehicle_trip_alerts) | **GET** /user/vehicles/{id}/trips/{tid}/alerts | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /user | User's information +*VehiclesApi* | [**delete_monitordd**](docs/VehiclesApi.md#delete_monitordd) | **DELETE** /user/vehicles/{id}/monitors/{mid} | Delete a Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*VehiclesApi* | [**get_car_last_position**](docs/VehiclesApi.md#get_car_last_position) | **GET** /user/vehicles/{id}/lastPosition | Last position identified +*VehiclesApi* | [**get_telemetry**](docs/VehiclesApi.md#get_telemetry) | **GET** /user/vehicles/{id}/telemetry | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*VehiclesApi* | [**get_vehicle_alerts**](docs/VehiclesApi.md#get_vehicle_alerts) | **GET** /user/vehicles/{id}/alerts | +*VehiclesApi* | [**get_vehicle_alerts_by_id**](docs/VehiclesApi.md#get_vehicle_alerts_by_id) | **GET** /user/vehicles/{id}/alerts/{aid} | +*VehiclesApi* | [**get_vehicle_byid**](docs/VehiclesApi.md#get_vehicle_byid) | **GET** /user/vehicles/{id} | Details of vehicule +*VehiclesApi* | [**get_vehicle_collision**](docs/VehiclesApi.md#get_vehicle_collision) | **GET** /user/vehicles/{id}/collisions | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*VehiclesApi* | [**get_vehicle_collision_by_id**](docs/VehiclesApi.md#get_vehicle_collision_by_id) | **GET** /user/vehicles/{id}/collisions/{cid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*VehiclesApi* | [**get_vehicle_maintenance**](docs/VehiclesApi.md#get_vehicle_maintenance) | **GET** /user/vehicles/{id}/maintenance | +*VehiclesApi* | [**get_vehicle_monitors**](docs/VehiclesApi.md#get_vehicle_monitors) | **GET** /user/vehicles/{id}/monitors | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*VehiclesApi* | [**get_vehicle_monitors_by_id**](docs/VehiclesApi.md#get_vehicle_monitors_by_id) | **GET** /user/vehicles/{id}/monitors/{mid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*VehiclesApi* | [**get_vehicle_status**](docs/VehiclesApi.md#get_vehicle_status) | **GET** /user/vehicles/{id}/status | Vehicle status. +*VehiclesApi* | [**get_vehicles_by_device**](docs/VehiclesApi.md#get_vehicles_by_device) | **GET** /user/vehicles | List of vehicules +*VehiclesApi* | [**set_fleet_vehicle_monitor_status**](docs/VehiclesApi.md#set_fleet_vehicle_monitor_status) | **PUT** /user/vehicles/{id}/monitors/{mid}/status | Set a new monitor status. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*VehiclesApi* | [**set_vehicle_monitor**](docs/VehiclesApi.md#set_vehicle_monitor) | **POST** /user/vehicles/{id}/monitors | Create a new Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +*VehiclesApi* | [**update_fleet_vehicle_monitor**](docs/VehiclesApi.md#update_fleet_vehicle_monitor) | **PUT** /user/vehicles/{id}/monitors/{mid} | Update and existing Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + + +## Documentation For Models + + - [Adas](docs/Adas.md) + - [AdasParkAssist](docs/AdasParkAssist.md) + - [Alert](docs/Alert.md) + - [AlertEndPosition](docs/AlertEndPosition.md) + - [AlertLinks](docs/AlertLinks.md) + - [AlertMsgEnum](docs/AlertMsgEnum.md) + - [Alerts](docs/Alerts.md) + - [AlertsEmbedded](docs/AlertsEmbedded.md) + - [Battery](docs/Battery.md) + - [BoundedProgram](docs/BoundedProgram.md) + - [ChargingStatusEnum](docs/ChargingStatusEnum.md) + - [CircleZone](docs/CircleZone.md) + - [CircleZoneCoordinates](docs/CircleZoneCoordinates.md) + - [CollectionResult](docs/CollectionResult.md) + - [Collision](docs/Collision.md) + - [CollisionLinks](docs/CollisionLinks.md) + - [CollisionObj](docs/CollisionObj.md) + - [CollisionObjFront](docs/CollisionObjFront.md) + - [Collisions](docs/Collisions.md) + - [CollisionsEmbedded](docs/CollisionsEmbedded.md) + - [CreatedAtField](docs/CreatedAtField.md) + - [DataMonitorTrigger](docs/DataMonitorTrigger.md) + - [DataTrigger](docs/DataTrigger.md) + - [DefaultAlertPush](docs/DefaultAlertPush.md) + - [DefaultAlertPushAttributes](docs/DefaultAlertPushAttributes.md) + - [DoorsState](docs/DoorsState.md) + - [DoorsStateOpening](docs/DoorsStateOpening.md) + - [ECoaching](docs/ECoaching.md) + - [ECoachingLinks](docs/ECoachingLinks.md) + - [ECoachingScores](docs/ECoachingScores.md) + - [Energy](docs/Energy.md) + - [Engine](docs/Engine.md) + - [EngineOil](docs/EngineOil.md) + - [Environment](docs/Environment.md) + - [EnvironmentLuminosity](docs/EnvironmentLuminosity.md) + - [Event](docs/Event.md) + - [EventLinks](docs/EventLinks.md) + - [Extension](docs/Extension.md) + - [ExtensionType](docs/ExtensionType.md) + - [Geometry](docs/Geometry.md) + - [Ignition](docs/Ignition.md) + - [IndexRange](docs/IndexRange.md) + - [Kinetic](docs/Kinetic.md) + - [Lighting](docs/Lighting.md) + - [Link](docs/Link.md) + - [Maintenance](docs/Maintenance.md) + - [MaintenanceLinks](docs/MaintenanceLinks.md) + - [MaintenanceObj](docs/MaintenanceObj.md) + - [Monitor](docs/Monitor.md) + - [MonitorId](docs/MonitorId.md) + - [MonitorLinks](docs/MonitorLinks.md) + - [MonitorParameter](docs/MonitorParameter.md) + - [MonitorParameterTriggerParam](docs/MonitorParameterTriggerParam.md) + - [MonitorRef](docs/MonitorRef.md) + - [MonitorRefLinks](docs/MonitorRefLinks.md) + - [MonitorStatus](docs/MonitorStatus.md) + - [MonitorStatusSetter](docs/MonitorStatusSetter.md) + - [MonitorSubscribe](docs/MonitorSubscribe.md) + - [MonitorSubscribeBatchNotify](docs/MonitorSubscribeBatchNotify.md) + - [MonitorSubscribeRetryPolicy](docs/MonitorSubscribeRetryPolicy.md) + - [MonitorTrigger](docs/MonitorTrigger.md) + - [MonitorWebhook](docs/MonitorWebhook.md) + - [MonitorWebhookAttributes](docs/MonitorWebhookAttributes.md) + - [Monitors](docs/Monitors.md) + - [MonitorsEmbedded](docs/MonitorsEmbedded.md) + - [OverallAutonomy](docs/OverallAutonomy.md) + - [Point](docs/Point.md) + - [PolygonZone](docs/PolygonZone.md) + - [Position](docs/Position.md) + - [PositionProperties](docs/PositionProperties.md) + - [Preconditioning](docs/Preconditioning.md) + - [PreconditioningAirConditioning](docs/PreconditioningAirConditioning.md) + - [PreconditioningProgram](docs/PreconditioningProgram.md) + - [Privacy](docs/Privacy.md) + - [Program](docs/Program.md) + - [ProgramOccurence](docs/ProgramOccurence.md) + - [Safety](docs/Safety.md) + - [ServiceType](docs/ServiceType.md) + - [Status](docs/Status.md) + - [StatusEmbedded](docs/StatusEmbedded.md) + - [StatusExtensionType](docs/StatusExtensionType.md) + - [StatusLinks](docs/StatusLinks.md) + - [TabLinks](docs/TabLinks.md) + - [Telemetry](docs/Telemetry.md) + - [TelemetryEmbedded](docs/TelemetryEmbedded.md) + - [TelemetryEnum](docs/TelemetryEnum.md) + - [TelemetryExtension](docs/TelemetryExtension.md) + - [TelemetryExtensionType](docs/TelemetryExtensionType.md) + - [TelemetryMessage](docs/TelemetryMessage.md) + - [TelemetryMessageEmbedded](docs/TelemetryMessageEmbedded.md) + - [TelemetryMessageVehicle](docs/TelemetryMessageVehicle.md) + - [TelemetryMessageVehicleBrakingSystem](docs/TelemetryMessageVehicleBrakingSystem.md) + - [TelemetryMessageVehicleTransmission](docs/TelemetryMessageVehicleTransmission.md) + - [TelemetryMessageVehicleTransmissionGearbox](docs/TelemetryMessageVehicleTransmissionGearbox.md) + - [TelemetryMessageVehicleTransmissionGearboxGear](docs/TelemetryMessageVehicleTransmissionGearboxGear.md) + - [TelemetryMessageVehicleTransmissionGearboxMode](docs/TelemetryMessageVehicleTransmissionGearboxMode.md) + - [TimeMonitorTrigger](docs/TimeMonitorTrigger.md) + - [TimeRange](docs/TimeRange.md) + - [TimeStamped](docs/TimeStamped.md) + - [TimeTrigger](docs/TimeTrigger.md) + - [TimeZoneMonitorTrigger](docs/TimeZoneMonitorTrigger.md) + - [TimeZoneTrigger](docs/TimeZoneTrigger.md) + - [Trip](docs/Trip.md) + - [TripAvgConsumption](docs/TripAvgConsumption.md) + - [TripLinks](docs/TripLinks.md) + - [Trips](docs/Trips.md) + - [TripsEmbedded](docs/TripsEmbedded.md) + - [UpdatedField](docs/UpdatedField.md) + - [Url](docs/Url.md) + - [User](docs/User.md) + - [UserEmbedded](docs/UserEmbedded.md) + - [UserLinks](docs/UserLinks.md) + - [Vect2D](docs/Vect2D.md) + - [Vehicle](docs/Vehicle.md) + - [VehicleEngine](docs/VehicleEngine.md) + - [VehicleLinks](docs/VehicleLinks.md) + - [VehicleOdometer](docs/VehicleOdometer.md) + - [Vehicles](docs/Vehicles.md) + - [VehiclesEmbedded](docs/VehiclesEmbedded.md) + - [WayPoints](docs/WayPoints.md) + - [WayPointsEmbedded](docs/WayPointsEmbedded.md) + - [XError](docs/XError.md) + - [ZoneMonitorTrigger](docs/ZoneMonitorTrigger.md) + - [ZoneTrigger](docs/ZoneTrigger.md) + - [ZoneTriggerPlace](docs/ZoneTriggerPlace.md) + - [ZoneTriggerPlaceCenter](docs/ZoneTriggerPlaceCenter.md) + + +## Documentation For Authorization + + +## Vehicle_auth + +- **Type**: OAuth +- **Flow**: implicit +- **Authorization URL**: +- **Scopes**: + - **Collision_read**: read Collision related data + - **Maintenance_read**: read Maintenance related data + - **Status_read**: read Vehicle related status + - **Telemetry_read**: read Telemetry related data + - **Trip_read**: read Trip related data + - **Vehicle_read**: read Vehicle related data + - **alert_read**: read alert related data + - **alert_write**: create, modify or delete alerte + - **localisation_read**: read location related data + +## client_id + +- **Type**: API key +- **API key parameter name**: client_id +- **Location**: URL query string + +## realm + +- **Type**: API key +- **API key parameter name**: x-introspect-realm +- **Location**: HTTP header + + +## Author + + + diff --git a/docs/Adas.md b/docs/Adas.md new file mode 100644 index 0000000..5643099 --- /dev/null +++ b/docs/Adas.md @@ -0,0 +1,23 @@ +# Adas + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**abs** | **bool** | Anti-lock braking system | [optional] +**accr** | **str** | Adaptive Cruise Control Regulation | [optional] +**aebs** | **str** | Advanced Emergency Braking System | [optional] +**afil** | **str** | Lane Departure Warning System | [optional] +**artiv** | **str** | Respect of inter vehicle time assist (ARTIV) | [optional] [default to 'unavailable'] +**bsm** | **str** | Blink SpotMonitoring | [optional] +**esp** | **bool** | Electronic Stability Programme | [optional] +**fse** | **bool** | Electric brake service | [optional] +**lrka** | **str** | Lane Keeping Assist left | [optional] +**lvv** | **bool** | | [optional] +**park_assist** | [**AdasParkAssist**](AdasParkAssist.md) | | [optional] +**rlka** | **str** | Lane Keeping Assist right | [optional] +**rvv** | **str** | | [optional] +**sli** | **int** | Speed Limit Information | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AdasParkAssist.md b/docs/AdasParkAssist.md new file mode 100644 index 0000000..ed1b088 --- /dev/null +++ b/docs/AdasParkAssist.md @@ -0,0 +1,11 @@ +# AdasParkAssist + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**front** | **list[str]** | | [optional] +**rear** | **list[str]** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Alert.md b/docs/Alert.md new file mode 100644 index 0000000..aa6f162 --- /dev/null +++ b/docs/Alert.md @@ -0,0 +1,18 @@ +# Alert + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **datetime** | Date when the resource has been created. | [optional] +**links** | [**AlertLinks**](AlertLinks.md) | | [optional] +**active** | **bool** | | [optional] +**end_at** | **datetime** | | [optional] +**end_position** | [**AlertEndPosition**](AlertEndPosition.md) | | [optional] +**id** | **str** | | [optional] +**start_position** | [**AlertEndPosition**](AlertEndPosition.md) | | [optional] +**started_at** | **datetime** | Date | [optional] +**type** | [**AlertMsgEnum**](AlertMsgEnum.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AlertEndPosition.md b/docs/AlertEndPosition.md new file mode 100644 index 0000000..1c1aabc --- /dev/null +++ b/docs/AlertEndPosition.md @@ -0,0 +1,9 @@ +# AlertEndPosition + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AlertLinks.md b/docs/AlertLinks.md new file mode 100644 index 0000000..816722c --- /dev/null +++ b/docs/AlertLinks.md @@ -0,0 +1,13 @@ +# AlertLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**position** | [**Link**](Link.md) | | [optional] +**_self** | [**Link**](Link.md) | | [optional] +**trip** | [**Link**](Link.md) | | [optional] +**vehicle** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AlertMsgEnum.md b/docs/AlertMsgEnum.md new file mode 100644 index 0000000..a2054e7 --- /dev/null +++ b/docs/AlertMsgEnum.md @@ -0,0 +1,9 @@ +# AlertMsgEnum + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Alerts.md b/docs/Alerts.md new file mode 100644 index 0000000..d6b3af3 --- /dev/null +++ b/docs/Alerts.md @@ -0,0 +1,10 @@ +# Alerts + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | [**AlertsEmbedded**](AlertsEmbedded.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AlertsEmbedded.md b/docs/AlertsEmbedded.md new file mode 100644 index 0000000..fe5fdb3 --- /dev/null +++ b/docs/AlertsEmbedded.md @@ -0,0 +1,10 @@ +# AlertsEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**alerts** | [**list[Alert]**](Alert.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Battery.md b/docs/Battery.md new file mode 100644 index 0000000..521823b --- /dev/null +++ b/docs/Battery.md @@ -0,0 +1,11 @@ +# Battery + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**current** | **float** | | [optional] +**voltage** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/BoundedProgram.md b/docs/BoundedProgram.md new file mode 100644 index 0000000..26d27bf --- /dev/null +++ b/docs/BoundedProgram.md @@ -0,0 +1,10 @@ +# BoundedProgram + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**duration** | **str** | Duration of the monitor action expressed using [ISO-8601 Duration spec](https://en.wikipedia.org/wiki/ISO_8601#Durations) | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ChargingStatusEnum.md b/docs/ChargingStatusEnum.md new file mode 100644 index 0000000..785d5f0 --- /dev/null +++ b/docs/ChargingStatusEnum.md @@ -0,0 +1,9 @@ +# ChargingStatusEnum + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CircleZone.md b/docs/CircleZone.md new file mode 100644 index 0000000..9146ecd --- /dev/null +++ b/docs/CircleZone.md @@ -0,0 +1,11 @@ +# CircleZone + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**coordinates** | [**CircleZoneCoordinates**](CircleZoneCoordinates.md) | | [optional] +**type** | **str** | | [optional] [default to 'extCircle'] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CircleZoneCoordinates.md b/docs/CircleZoneCoordinates.md new file mode 100644 index 0000000..e262493 --- /dev/null +++ b/docs/CircleZoneCoordinates.md @@ -0,0 +1,11 @@ +# CircleZoneCoordinates + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**center** | [**Point**](Point.md) | | +**radius** | **float** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CollectionResult.md b/docs/CollectionResult.md new file mode 100644 index 0000000..5bd2fa4 --- /dev/null +++ b/docs/CollectionResult.md @@ -0,0 +1,14 @@ +# CollectionResult + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | **object** | | +**links** | [**TabLinks**](TabLinks.md) | | [optional] +**current_page** | **int** | | +**total** | **int** | | +**total_page** | **int** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Collision.md b/docs/Collision.md new file mode 100644 index 0000000..34ba9e0 --- /dev/null +++ b/docs/Collision.md @@ -0,0 +1,19 @@ +# Collision + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **datetime** | | [optional] +**embedded** | **object** | | [optional] +**front** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional] +**id** | **str** | | [optional] +**lateral** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional] +**pedestrian** | **bool** | | [optional] +**rear** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional] +**roll_over** | **bool** | | [optional] +**updated_at** | **datetime** | | [optional] +**links** | [**CollisionLinks**](CollisionLinks.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CollisionLinks.md b/docs/CollisionLinks.md new file mode 100644 index 0000000..1c31674 --- /dev/null +++ b/docs/CollisionLinks.md @@ -0,0 +1,12 @@ +# CollisionLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**Link**](Link.md) | | [optional] +**trip** | [**Link**](Link.md) | | [optional] +**vehicle** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CollisionObj.md b/docs/CollisionObj.md new file mode 100644 index 0000000..53b3523 --- /dev/null +++ b/docs/CollisionObj.md @@ -0,0 +1,17 @@ +# CollisionObj + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | **object** | | [optional] +**front** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional] +**id** | **str** | | [optional] +**lateral** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional] +**pedestrian** | **bool** | | [optional] +**rear** | [**CollisionObjFront**](CollisionObjFront.md) | | [optional] +**roll_over** | **bool** | | [optional] +**updated_at** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CollisionObjFront.md b/docs/CollisionObjFront.md new file mode 100644 index 0000000..155e2b0 --- /dev/null +++ b/docs/CollisionObjFront.md @@ -0,0 +1,10 @@ +# CollisionObjFront + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**level** | **str** | | [optional] [default to 'none'] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Collisions.md b/docs/Collisions.md new file mode 100644 index 0000000..e57ff7f --- /dev/null +++ b/docs/Collisions.md @@ -0,0 +1,10 @@ +# Collisions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | [**CollisionsEmbedded**](CollisionsEmbedded.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CollisionsEmbedded.md b/docs/CollisionsEmbedded.md new file mode 100644 index 0000000..e118456 --- /dev/null +++ b/docs/CollisionsEmbedded.md @@ -0,0 +1,10 @@ +# CollisionsEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**collisions** | [**list[Collision]**](Collision.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/CreatedAtField.md b/docs/CreatedAtField.md new file mode 100644 index 0000000..7a9b810 --- /dev/null +++ b/docs/CreatedAtField.md @@ -0,0 +1,10 @@ +# CreatedAtField + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **datetime** | Date when the resource has been created. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DataMonitorTrigger.md b/docs/DataMonitorTrigger.md new file mode 100644 index 0000000..4a6f825 --- /dev/null +++ b/docs/DataMonitorTrigger.md @@ -0,0 +1,12 @@ +# DataMonitorTrigger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **str** | the left operand of the trigger function. | [optional] +**op** | **str** | the operator of the trigger function. | [optional] +**value** | **object** | the right operand of the trigger function. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DataTrigger.md b/docs/DataTrigger.md new file mode 100644 index 0000000..462e35e --- /dev/null +++ b/docs/DataTrigger.md @@ -0,0 +1,12 @@ +# DataTrigger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | **str** | The left operand of the trigger function. The following Table details for each operand data its type, the supported operator and the possibly retruned value: |**Data**|**Type**|**Op**|**Value**| |---|---| ---:| ---:| | Vehicle.alert | List of value | OnChange (at least one)/IncludedIn/EqualTo | Value (ObjetAlert) | | Vehicle.odometer | Integer | equalTo/greaterThan/lowerThan/ | Value | | vehicle.engines.running (boolean) | Boolean | OnChange/equalTo | Value (true/false) | | vehicle.engines.thermic.oil.temp | Integer | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.energy.electric.level | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.energy.electric.autonomy | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.energy.fuel.level | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.energy.fuel.autonomy | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.autonomy (global) | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.energy.charging.status | Enum(ChargingStatusEnum) | OnChange/equalTo | Value | | vehicle.energy.charging.plugged | Boolean | OnChange/equalTo | Value | | vehicle.doorsState.lockedState | N/A | OnChange | Value | | vehicle.doorsState.opening | N/A | OnChange | Value | | vehicle.kinetic.moving| Boolean | OnChange/equalTo | Value (true/false) | | vehicle.kinetic.speed | Number | equalTo/greaterThan/ lowerThan/ | Value | | vehicle.trip| Literal | OnChange| Value(IDTRIP) | | vehicle.maintenance.daysBeforeMaintenance, | Number | OnChange/equalTo/ greaterThan/ lowerThan/ | Value | | vehicle.maintenance.mileageBeforeMaintenance| Number | OnChange/equalTo/ greaterThan/ lowerThan/ | Value | | vehicle.safety.beltWarning | Enum(beltWarning) | OnChange/equalTo | Value | | environment.air.temp | Number | equalTo/greaterThan/lowerThan/ | Value | | privacy.state | Enum(Privacy) | equalTo / OnChange/IncludedIN | Value | | +**op** | **str** | The operator of the trigger function. | +**value** | **list[str]** | The right operand of the trigger function. It can be a uniq ```value``` or a list of value ```values```. The choice of one or the other depends on ```OP``` which in the case of ```includedIn``` must be a list. * _Disclaimer_: If the op field is not set to ```includeIn``` then only the first item will be used. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DefaultAlertPush.md b/docs/DefaultAlertPush.md new file mode 100644 index 0000000..0000666 --- /dev/null +++ b/docs/DefaultAlertPush.md @@ -0,0 +1,11 @@ +# DefaultAlertPush + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**list[DefaultAlertPushAttributes]**](DefaultAlertPushAttributes.md) | | [optional] +**name** | **str** | push event name | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DefaultAlertPushAttributes.md b/docs/DefaultAlertPushAttributes.md new file mode 100644 index 0000000..771f120 --- /dev/null +++ b/docs/DefaultAlertPushAttributes.md @@ -0,0 +1,11 @@ +# DefaultAlertPushAttributes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | | +**value** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DoorsState.md b/docs/DoorsState.md new file mode 100644 index 0000000..16a2945 --- /dev/null +++ b/docs/DoorsState.md @@ -0,0 +1,12 @@ +# DoorsState + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**locked_state** | **list[str]** | | [optional] +**opening** | [**list[DoorsStateOpening]**](DoorsStateOpening.md) | | [optional] +**updated_at** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DoorsStateOpening.md b/docs/DoorsStateOpening.md new file mode 100644 index 0000000..28ed638 --- /dev/null +++ b/docs/DoorsStateOpening.md @@ -0,0 +1,11 @@ +# DoorsStateOpening + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**identifier** | **str** | | [optional] +**state** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ECoaching.md b/docs/ECoaching.md new file mode 100644 index 0000000..a71b3ea --- /dev/null +++ b/docs/ECoaching.md @@ -0,0 +1,12 @@ +# ECoaching + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | **object** | | [optional] +**links** | [**ECoachingLinks**](ECoachingLinks.md) | | [optional] +**scores** | [**list[ECoachingScores]**](ECoachingScores.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ECoachingLinks.md b/docs/ECoachingLinks.md new file mode 100644 index 0000000..9a8b2ee --- /dev/null +++ b/docs/ECoachingLinks.md @@ -0,0 +1,12 @@ +# ECoachingLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**Link**](Link.md) | | [optional] +**trip** | [**Link**](Link.md) | | [optional] +**vehicle** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ECoachingScores.md b/docs/ECoachingScores.md new file mode 100644 index 0000000..d5539ba --- /dev/null +++ b/docs/ECoachingScores.md @@ -0,0 +1,11 @@ +# ECoachingScores + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**category** | **str** | category of the score. Global, ACCELERATION, BREAKING, A/C system, Runing cold engine, Direct Shift Gear, Speed, STT system, ZEV (Zero emission vehicle). | [optional] +**score** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Energy.md b/docs/Energy.md new file mode 100644 index 0000000..f33a551 --- /dev/null +++ b/docs/Energy.md @@ -0,0 +1,9 @@ +# Energy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Engine.md b/docs/Engine.md new file mode 100644 index 0000000..2563e1a --- /dev/null +++ b/docs/Engine.md @@ -0,0 +1,12 @@ +# Engine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**oil** | [**EngineOil**](EngineOil.md) | | [optional] +**speed** | **float** | | [optional] +**type** | **str** | | [optional] [default to 'Thermic'] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EngineOil.md b/docs/EngineOil.md new file mode 100644 index 0000000..7487fd1 --- /dev/null +++ b/docs/EngineOil.md @@ -0,0 +1,10 @@ +# EngineOil + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**temp** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Environment.md b/docs/Environment.md new file mode 100644 index 0000000..7558068 --- /dev/null +++ b/docs/Environment.md @@ -0,0 +1,12 @@ +# Environment + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **datetime** | Date when the resource has been created. | [optional] +**air** | [**EngineOil**](EngineOil.md) | | [optional] +**luminosity** | [**EnvironmentLuminosity**](EnvironmentLuminosity.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EnvironmentLuminosity.md b/docs/EnvironmentLuminosity.md new file mode 100644 index 0000000..4e9dbb1 --- /dev/null +++ b/docs/EnvironmentLuminosity.md @@ -0,0 +1,10 @@ +# EnvironmentLuminosity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**day** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Event.md b/docs/Event.md new file mode 100644 index 0000000..614b5a2 --- /dev/null +++ b/docs/Event.md @@ -0,0 +1,15 @@ +# Event + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **datetime** | Date when the resource has been created. | [optional] +**embedded** | **object** | | [optional] +**links** | [**EventLinks**](EventLinks.md) | | +**event_id** | **str** | | [optional] +**id** | **str** | | [optional] +**type** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/EventLinks.md b/docs/EventLinks.md new file mode 100644 index 0000000..565723a --- /dev/null +++ b/docs/EventLinks.md @@ -0,0 +1,10 @@ +# EventLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Extension.md b/docs/Extension.md new file mode 100644 index 0000000..9d4a1c0 --- /dev/null +++ b/docs/Extension.md @@ -0,0 +1,11 @@ +# Extension + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**kinetic** | [**Kinetic**](Kinetic.md) | | [optional] +**odemeter** | [**VehicleOdometer**](VehicleOdometer.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ExtensionType.md b/docs/ExtensionType.md new file mode 100644 index 0000000..c2e511e --- /dev/null +++ b/docs/ExtensionType.md @@ -0,0 +1,9 @@ +# ExtensionType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Geometry.md b/docs/Geometry.md new file mode 100644 index 0000000..ec5a909 --- /dev/null +++ b/docs/Geometry.md @@ -0,0 +1,11 @@ +# Geometry + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**coordinates** | **object** | Geometry coordinates | +**type** | **str** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Ignition.md b/docs/Ignition.md new file mode 100644 index 0000000..685e030 --- /dev/null +++ b/docs/Ignition.md @@ -0,0 +1,10 @@ +# Ignition + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/IndexRange.md b/docs/IndexRange.md new file mode 100644 index 0000000..02a99ed --- /dev/null +++ b/docs/IndexRange.md @@ -0,0 +1,9 @@ +# IndexRange + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Kinetic.md b/docs/Kinetic.md new file mode 100644 index 0000000..999a02a --- /dev/null +++ b/docs/Kinetic.md @@ -0,0 +1,13 @@ +# Kinetic + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**acceleration** | **float** | | [optional] +**moving** | **bool** | | [optional] +**pace** | **float** | | [optional] +**speed** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Lighting.md b/docs/Lighting.md new file mode 100644 index 0000000..b5b0880 --- /dev/null +++ b/docs/Lighting.md @@ -0,0 +1,11 @@ +# Lighting + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**light** | **list[str]** | | [optional] +**turn** | **list[str]** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Link.md b/docs/Link.md new file mode 100644 index 0000000..5543f36 --- /dev/null +++ b/docs/Link.md @@ -0,0 +1,17 @@ +# Link + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**deprecation** | [**AlertEndPosition**](AlertEndPosition.md) | | [optional] +**href** | [**Url**](Url.md) | | +**hreflang** | **str** | Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-kelly-json-hal-08#ref-I-D.wilde-profile-link)) of the target resource. | [optional] +**name** | **str** | | [optional] +**profile** | **str** | Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988]). | [optional] +**templated** | **bool** | SHOULD be true when the Link Object's \"href\" property is a URI Template | [optional] +**title** | **str** | Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)). | [optional] +**type** | **str** | a hint to indicate the media type expected when dereferencing the target resource. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Maintenance.md b/docs/Maintenance.md new file mode 100644 index 0000000..09a7214 --- /dev/null +++ b/docs/Maintenance.md @@ -0,0 +1,10 @@ +# Maintenance + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**MaintenanceLinks**](MaintenanceLinks.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MaintenanceLinks.md b/docs/MaintenanceLinks.md new file mode 100644 index 0000000..dfe920b --- /dev/null +++ b/docs/MaintenanceLinks.md @@ -0,0 +1,12 @@ +# MaintenanceLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**alerts** | [**Link**](Link.md) | | [optional] +**_self** | [**Link**](Link.md) | | [optional] +**vehicle** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MaintenanceObj.md b/docs/MaintenanceObj.md new file mode 100644 index 0000000..7190a74 --- /dev/null +++ b/docs/MaintenanceObj.md @@ -0,0 +1,12 @@ +# MaintenanceObj + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **datetime** | Date when the resource has been created. | [optional] +**days_before_maintenace** | **int** | | [optional] +**mileage_before_maintenance** | **int** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Monitor.md b/docs/Monitor.md new file mode 100644 index 0000000..cd4608e --- /dev/null +++ b/docs/Monitor.md @@ -0,0 +1,13 @@ +# Monitor + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**MonitorLinks**](MonitorLinks.md) | | [optional] +**mid** | [**MonitorId**](MonitorId.md) | | +**monitor** | [**MonitorParameter**](MonitorParameter.md) | | +**status** | [**MonitorStatus**](MonitorStatus.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorId.md b/docs/MonitorId.md new file mode 100644 index 0000000..c271fe4 --- /dev/null +++ b/docs/MonitorId.md @@ -0,0 +1,9 @@ +# MonitorId + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorLinks.md b/docs/MonitorLinks.md new file mode 100644 index 0000000..051052d --- /dev/null +++ b/docs/MonitorLinks.md @@ -0,0 +1,11 @@ +# MonitorLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fleet** | [**Link**](Link.md) | | [optional] +**_self** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorParameter.md b/docs/MonitorParameter.md new file mode 100644 index 0000000..18a8f27 --- /dev/null +++ b/docs/MonitorParameter.md @@ -0,0 +1,14 @@ +# MonitorParameter + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**extended_event_param** | **list[object]** | Allow to set extra vehicle data (defined in data model) to add to the monitor event when publishing. The possible values are |value|description|Related model | |----------|:-------------|------:| |vehicle.doorsState|Latest know door state (timestamped)|DoorState| |vehicle.status|Latest know vehicle status (timestamped)|Status| |vehicle.maintenance|Latest know maintenance(timestamped)|Maintenance| |vehicle.position|Last vehicle position (timestamped)|Position| |vehicle.telemetry${.TelemetryEnum}|Latest known telemetry (timestamped). |Telemetry |vehicle.alerts|List of active alerts|Alert| * For telemetry extension: * The suffix ```${.TelemetryEnum}``` can be selected to refine with telemetry type (from the TelemetryEnum list). This value (with suffix) can be selected **_several times_** to included suitable telemetry messages with the extention. * Using ```vehicle.telemetry``` without suffix means to include all available telemetries. | [optional] +**label** | **str** | Monitor lablel (usually its name). | +**locale** | **str** | Locale is used for rendering text according to language and country for. It should match the REGEX ```\\w(-\\w)?```. For more details about possible standard values, please refer to [locals list](https://en.wikipedia.org/wiki/Language_localisation). | [optional] +**subscribe_param** | [**MonitorSubscribe**](MonitorSubscribe.md) | | +**trigger_param** | [**MonitorParameterTriggerParam**](MonitorParameterTriggerParam.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorParameterTriggerParam.md b/docs/MonitorParameterTriggerParam.md new file mode 100644 index 0000000..e2aa996 --- /dev/null +++ b/docs/MonitorParameterTriggerParam.md @@ -0,0 +1,13 @@ +# MonitorParameterTriggerParam + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bool_exp** | **str** | A boolean expression that allow defining a logical relationship between triggers. Used Operands with this expression should only be the names of the defined triggers. Grammar: ``` exp ::= exp '&' exp | exp '|' exp | (exp) | !exp ``` * **example**: having two-zone trigger (two towns) named z1 an z2, one time-trigger (8h00 to 20h00) named t1 and finally three data triggerd named as follow: f(fuel), a(autonomy) , o(odometer). we can have a boolean expression such as: : ``` ((z1 & t1) | (z2 & !t1) | (f & z1) | (a & (z1|t)) | (o & (z1 | z2))) ``` | +**data_triggers** | [**list[DataTrigger]**](DataTrigger.md) | Compound data triggers (will be evaluated with an AND relationship) *Note*: ```dataTriggers``` is depricated according the new monitor spec. Please use the new data schema. | [optional] +**time_zone_triggers** | [**TimeZoneTrigger**](TimeZoneTrigger.md) | | [optional] +**triggers** | [**list[MonitorTrigger]**](MonitorTrigger.md) | Compound monitor triggers (will be evaluated using boolean expresion :```boo.exp```) | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorRef.md b/docs/MonitorRef.md new file mode 100644 index 0000000..a1cc470 --- /dev/null +++ b/docs/MonitorRef.md @@ -0,0 +1,11 @@ +# MonitorRef + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**MonitorRefLinks**](MonitorRefLinks.md) | | [optional] +**monitor_id** | [**MonitorId**](MonitorId.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorRefLinks.md b/docs/MonitorRefLinks.md new file mode 100644 index 0000000..7a0c786 --- /dev/null +++ b/docs/MonitorRefLinks.md @@ -0,0 +1,12 @@ +# MonitorRefLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**delete** | [**Link**](Link.md) | | [optional] +**monitor** | [**Link**](Link.md) | | [optional] +**vehicle** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorStatus.md b/docs/MonitorStatus.md new file mode 100644 index 0000000..fbecd9d --- /dev/null +++ b/docs/MonitorStatus.md @@ -0,0 +1,9 @@ +# MonitorStatus + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorStatusSetter.md b/docs/MonitorStatusSetter.md new file mode 100644 index 0000000..b76c06f --- /dev/null +++ b/docs/MonitorStatusSetter.md @@ -0,0 +1,10 @@ +# MonitorStatusSetter + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorSubscribe.md b/docs/MonitorSubscribe.md new file mode 100644 index 0000000..b70e406 --- /dev/null +++ b/docs/MonitorSubscribe.md @@ -0,0 +1,13 @@ +# MonitorSubscribe + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batch_notify** | [**MonitorSubscribeBatchNotify**](MonitorSubscribeBatchNotify.md) | | [optional] +**callback** | [**MonitorWebhook**](MonitorWebhook.md) | | +**refresh_event** | **float** | Define the period (in sec.) between two refresh events. The refresh-events are sent when the condition of the monitor is satisfied (Trigger -> toggled true).A kind of periodic reminder. | [optional] +**retry_policy** | [**MonitorSubscribeRetryPolicy**](MonitorSubscribeRetryPolicy.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorSubscribeBatchNotify.md b/docs/MonitorSubscribeBatchNotify.md new file mode 100644 index 0000000..7acdbd1 --- /dev/null +++ b/docs/MonitorSubscribeBatchNotify.md @@ -0,0 +1,11 @@ +# MonitorSubscribeBatchNotify + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**size** | **float** | Batch size | [optional] +**time_window** | **float** | Notification batch window size (expressed in seconds). | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorSubscribeRetryPolicy.md b/docs/MonitorSubscribeRetryPolicy.md new file mode 100644 index 0000000..7d4d0f4 --- /dev/null +++ b/docs/MonitorSubscribeRetryPolicy.md @@ -0,0 +1,12 @@ +# MonitorSubscribeRetryPolicy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**max_retry_number** | **int** | Maximum number of attempts (to be used with retryPolicy set to Bounded). | [optional] +**policy** | **str** | Defines the retry rules following a WebHook notification failure (ie the return code is not HTTP 2XX). '_None_' means with a single try, '_Bounded_' with a limited number of tries and '_Always_' with an infinite number of tries. | +**retry_delay** | **int** | Time to wait (expressed in seconds) befor retrying to push a notification. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorTrigger.md b/docs/MonitorTrigger.md new file mode 100644 index 0000000..89aa23e --- /dev/null +++ b/docs/MonitorTrigger.md @@ -0,0 +1,13 @@ +# MonitorTrigger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**data** | [**DataTrigger**](DataTrigger.md) | | [optional] +**name** | **str** | The trigger name(should be uniq) | +**time** | [**TimeTrigger**](TimeTrigger.md) | | [optional] +**zone** | [**ZoneTrigger**](ZoneTrigger.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorWebhook.md b/docs/MonitorWebhook.md new file mode 100644 index 0000000..3282093 --- /dev/null +++ b/docs/MonitorWebhook.md @@ -0,0 +1,12 @@ +# MonitorWebhook + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**attributes** | [**list[MonitorWebhookAttributes]**](MonitorWebhookAttributes.md) | Additional attributes-set that can be used as http header enhencement (such as headers can be used as an authentication parameter when posting the event) or simply added to the notification event body (as set of key/values) or finally as additional query parameters. | [optional] +**name** | **str** | Webhook name. | +**target** | [**Url**](Url.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorWebhookAttributes.md b/docs/MonitorWebhookAttributes.md new file mode 100644 index 0000000..eb567dc --- /dev/null +++ b/docs/MonitorWebhookAttributes.md @@ -0,0 +1,12 @@ +# MonitorWebhookAttributes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **str** | | +**type** | **str** | 3 attributes type: |Attribute-type|Role| |----------|-------------| |Header|-Will be add as http header extension \"x-######:\"| |Body|-Will be simply add to event body map attribute (see monitor event definition in template document)| |Query|-Will set as http query parameter when invoking the Webhook| | +**value** | **object** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Monitors.md b/docs/Monitors.md new file mode 100644 index 0000000..0e10d8d --- /dev/null +++ b/docs/Monitors.md @@ -0,0 +1,10 @@ +# Monitors + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | [**MonitorsEmbedded**](MonitorsEmbedded.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/MonitorsEmbedded.md b/docs/MonitorsEmbedded.md new file mode 100644 index 0000000..c5f129d --- /dev/null +++ b/docs/MonitorsEmbedded.md @@ -0,0 +1,10 @@ +# MonitorsEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**monitors** | [**list[MonitorParameter]**](MonitorParameter.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/OverallAutonomy.md b/docs/OverallAutonomy.md new file mode 100644 index 0000000..0b4baee --- /dev/null +++ b/docs/OverallAutonomy.md @@ -0,0 +1,10 @@ +# OverallAutonomy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**autonomy** | **float** | Vehicle global autonomy expressed in KM. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Point.md b/docs/Point.md new file mode 100644 index 0000000..f9e2095 --- /dev/null +++ b/docs/Point.md @@ -0,0 +1,11 @@ +# Point + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**coordinates** | [**Vect2D**](Vect2D.md) | | [optional] +**type** | **str** | | [optional] [default to 'Point'] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PolygonZone.md b/docs/PolygonZone.md new file mode 100644 index 0000000..d91bec5 --- /dev/null +++ b/docs/PolygonZone.md @@ -0,0 +1,11 @@ +# PolygonZone + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**coordinates** | [**list[Vect2D]**](Vect2D.md) | | [optional] +**type** | **str** | | [optional] [default to 'Polygon'] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Position.md b/docs/Position.md new file mode 100644 index 0000000..e24921f --- /dev/null +++ b/docs/Position.md @@ -0,0 +1,13 @@ +# Position + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **datetime** | Date when the resource has been created. | [optional] +**geometry** | [**Point**](Point.md) | | [optional] +**properties** | [**PositionProperties**](PositionProperties.md) | | +**type** | **str** | | [optional] [default to 'Feature'] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PositionProperties.md b/docs/PositionProperties.md new file mode 100644 index 0000000..d2f1a4c --- /dev/null +++ b/docs/PositionProperties.md @@ -0,0 +1,12 @@ +# PositionProperties + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**heading** | **float** | | [optional] +**signal_quality** | **float** | | [optional] +**type** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Preconditioning.md b/docs/Preconditioning.md new file mode 100644 index 0000000..b3407e5 --- /dev/null +++ b/docs/Preconditioning.md @@ -0,0 +1,10 @@ +# Preconditioning + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**air_conditioning** | [**PreconditioningAirConditioning**](PreconditioningAirConditioning.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PreconditioningAirConditioning.md b/docs/PreconditioningAirConditioning.md new file mode 100644 index 0000000..89364e5 --- /dev/null +++ b/docs/PreconditioningAirConditioning.md @@ -0,0 +1,13 @@ +# PreconditioningAirConditioning + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**failure_cause** | **str** | failure cause | [optional] +**programs** | [**list[PreconditioningProgram]**](PreconditioningProgram.md) | | [optional] +**status** | **str** | The status of the preconditionning feature. | [optional] +**updated_at** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/PreconditioningProgram.md b/docs/PreconditioningProgram.md new file mode 100644 index 0000000..d037807 --- /dev/null +++ b/docs/PreconditioningProgram.md @@ -0,0 +1,9 @@ +# PreconditioningProgram + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Privacy.md b/docs/Privacy.md new file mode 100644 index 0000000..85822c8 --- /dev/null +++ b/docs/Privacy.md @@ -0,0 +1,10 @@ +# Privacy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**state** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Program.md b/docs/Program.md new file mode 100644 index 0000000..6a7ad23 --- /dev/null +++ b/docs/Program.md @@ -0,0 +1,12 @@ +# Program + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**occurence** | [**ProgramOccurence**](ProgramOccurence.md) | | +**recurrence** | **str** | Determines the recurrence of the program. * None: means no recurrence. * Daily: repeated over the week. * Weekly: repeated over the weeks of the year from w1 to w52 specified in an array unitary or grouped by ranges (w1, w2,w34-w46, w52). | [default to 'Daily'] +**start** | **str** | The program start time formatted using the duration format based on [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) with the schema: P[n]Y[n]M[n]DT[n]H[n]M[n]S _example_: * PT14H30M : 14H30min | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ProgramOccurence.md b/docs/ProgramOccurence.md new file mode 100644 index 0000000..5fe7fe6 --- /dev/null +++ b/docs/ProgramOccurence.md @@ -0,0 +1,11 @@ +# ProgramOccurence + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**day** | **list[str]** | | +**week** | **list[str]** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Safety.md b/docs/Safety.md new file mode 100644 index 0000000..ad6a8a9 --- /dev/null +++ b/docs/Safety.md @@ -0,0 +1,11 @@ +# Safety + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**belt_warning** | **str** | | [optional] +**e_call_triggering_request** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ServiceType.md b/docs/ServiceType.md new file mode 100644 index 0000000..cba0b8a --- /dev/null +++ b/docs/ServiceType.md @@ -0,0 +1,11 @@ +# ServiceType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | [optional] +**updated_at** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Status.md b/docs/Status.md new file mode 100644 index 0000000..82e4f41 --- /dev/null +++ b/docs/Status.md @@ -0,0 +1,22 @@ +# Status + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | [**StatusEmbedded**](StatusEmbedded.md) | | [optional] +**links** | [**StatusLinks**](StatusLinks.md) | | +**battery** | [**Battery**](Battery.md) | | [optional] +**doors_state** | [**DoorsState**](DoorsState.md) | | [optional] +**energy** | [**list[Energy]**](Energy.md) | Describe vehicle energy supply for thermic, low emission vehicle or both. | [optional] +**environment** | [**Environment**](Environment.md) | | [optional] +**ignition** | [**Ignition**](Ignition.md) | | [optional] +**kinetic** | [**Kinetic**](Kinetic.md) | | [optional] +**last_position** | [**Position**](Position.md) | | [optional] +**preconditionning** | [**Preconditioning**](Preconditioning.md) | | [optional] +**privacy** | [**Privacy**](Privacy.md) | | [optional] +**safety** | [**Safety**](Safety.md) | | [optional] +**service** | [**ServiceType**](ServiceType.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StatusEmbedded.md b/docs/StatusEmbedded.md new file mode 100644 index 0000000..2988e17 --- /dev/null +++ b/docs/StatusEmbedded.md @@ -0,0 +1,10 @@ +# StatusEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**extension** | [**Extension**](Extension.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StatusExtensionType.md b/docs/StatusExtensionType.md new file mode 100644 index 0000000..31319e4 --- /dev/null +++ b/docs/StatusExtensionType.md @@ -0,0 +1,9 @@ +# StatusExtensionType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StatusLinks.md b/docs/StatusLinks.md new file mode 100644 index 0000000..d83a015 --- /dev/null +++ b/docs/StatusLinks.md @@ -0,0 +1,11 @@ +# StatusLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**Link**](Link.md) | | [optional] +**vehicle** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TabLinks.md b/docs/TabLinks.md new file mode 100644 index 0000000..a068177 --- /dev/null +++ b/docs/TabLinks.md @@ -0,0 +1,14 @@ +# TabLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first** | [**Link**](Link.md) | | [optional] +**last** | [**Link**](Link.md) | | [optional] +**next** | [**Link**](Link.md) | | [optional] +**prev** | [**Link**](Link.md) | | [optional] +**_self** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Telemetry.md b/docs/Telemetry.md new file mode 100644 index 0000000..5b501d2 --- /dev/null +++ b/docs/Telemetry.md @@ -0,0 +1,10 @@ +# Telemetry + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | [**TelemetryEmbedded**](TelemetryEmbedded.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryEmbedded.md b/docs/TelemetryEmbedded.md new file mode 100644 index 0000000..5e01a0d --- /dev/null +++ b/docs/TelemetryEmbedded.md @@ -0,0 +1,10 @@ +# TelemetryEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**telemetries** | [**list[TelemetryMessage]**](TelemetryMessage.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryEnum.md b/docs/TelemetryEnum.md new file mode 100644 index 0000000..b7a55ea --- /dev/null +++ b/docs/TelemetryEnum.md @@ -0,0 +1,9 @@ +# TelemetryEnum + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryExtension.md b/docs/TelemetryExtension.md new file mode 100644 index 0000000..0236a39 --- /dev/null +++ b/docs/TelemetryExtension.md @@ -0,0 +1,13 @@ +# TelemetryExtension + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**alerts** | [**list[Alert]**](Alert.md) | | [optional] +**collision** | [**Collision**](Collision.md) | | [optional] +**location** | [**Position**](Position.md) | | [optional] +**maintenance** | [**MaintenanceObj**](MaintenanceObj.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryExtensionType.md b/docs/TelemetryExtensionType.md new file mode 100644 index 0000000..3968d75 --- /dev/null +++ b/docs/TelemetryExtensionType.md @@ -0,0 +1,9 @@ +# TelemetryExtensionType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryMessage.md b/docs/TelemetryMessage.md new file mode 100644 index 0000000..f640c19 --- /dev/null +++ b/docs/TelemetryMessage.md @@ -0,0 +1,15 @@ +# TelemetryMessage + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | [**TelemetryMessageEmbedded**](TelemetryMessageEmbedded.md) | | [optional] +**links** | [**StatusLinks**](StatusLinks.md) | | [optional] +**environment** | [**Environment**](Environment.md) | | [optional] +**id** | **str** | | [optional] +**privacy** | [**Privacy**](Privacy.md) | | [optional] +**vehicle** | [**TelemetryMessageVehicle**](TelemetryMessageVehicle.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryMessageEmbedded.md b/docs/TelemetryMessageEmbedded.md new file mode 100644 index 0000000..c5ea1f2 --- /dev/null +++ b/docs/TelemetryMessageEmbedded.md @@ -0,0 +1,10 @@ +# TelemetryMessageEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**extension** | [**TelemetryExtension**](TelemetryExtension.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryMessageVehicle.md b/docs/TelemetryMessageVehicle.md new file mode 100644 index 0000000..1e3af9d --- /dev/null +++ b/docs/TelemetryMessageVehicle.md @@ -0,0 +1,19 @@ +# TelemetryMessageVehicle + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**adas** | [**Adas**](Adas.md) | | [optional] +**battery** | [**Battery**](Battery.md) | | [optional] +**braking_system** | [**TelemetryMessageVehicleBrakingSystem**](TelemetryMessageVehicleBrakingSystem.md) | | [optional] +**doors_state** | [**DoorsState**](DoorsState.md) | | [optional] +**energy** | [**Energy**](Energy.md) | | [optional] +**engines** | [**list[Engine]**](Engine.md) | | [optional] +**ignition** | [**Ignition**](Ignition.md) | | [optional] +**lighting** | [**Lighting**](Lighting.md) | | [optional] +**safety** | [**Safety**](Safety.md) | | [optional] +**transmission** | [**TelemetryMessageVehicleTransmission**](TelemetryMessageVehicleTransmission.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryMessageVehicleBrakingSystem.md b/docs/TelemetryMessageVehicleBrakingSystem.md new file mode 100644 index 0000000..c3c9e0d --- /dev/null +++ b/docs/TelemetryMessageVehicleBrakingSystem.md @@ -0,0 +1,10 @@ +# TelemetryMessageVehicleBrakingSystem + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**parking** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryMessageVehicleTransmission.md b/docs/TelemetryMessageVehicleTransmission.md new file mode 100644 index 0000000..ee803d5 --- /dev/null +++ b/docs/TelemetryMessageVehicleTransmission.md @@ -0,0 +1,10 @@ +# TelemetryMessageVehicleTransmission + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**gearbox** | [**TelemetryMessageVehicleTransmissionGearbox**](TelemetryMessageVehicleTransmissionGearbox.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryMessageVehicleTransmissionGearbox.md b/docs/TelemetryMessageVehicleTransmissionGearbox.md new file mode 100644 index 0000000..2d97353 --- /dev/null +++ b/docs/TelemetryMessageVehicleTransmissionGearbox.md @@ -0,0 +1,11 @@ +# TelemetryMessageVehicleTransmissionGearbox + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**gear** | [**TelemetryMessageVehicleTransmissionGearboxGear**](TelemetryMessageVehicleTransmissionGearboxGear.md) | | [optional] +**mode** | [**TelemetryMessageVehicleTransmissionGearboxMode**](TelemetryMessageVehicleTransmissionGearboxMode.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryMessageVehicleTransmissionGearboxGear.md b/docs/TelemetryMessageVehicleTransmissionGearboxGear.md new file mode 100644 index 0000000..50cef26 --- /dev/null +++ b/docs/TelemetryMessageVehicleTransmissionGearboxGear.md @@ -0,0 +1,10 @@ +# TelemetryMessageVehicleTransmissionGearboxGear + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**recommended** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TelemetryMessageVehicleTransmissionGearboxMode.md b/docs/TelemetryMessageVehicleTransmissionGearboxMode.md new file mode 100644 index 0000000..85484d7 --- /dev/null +++ b/docs/TelemetryMessageVehicleTransmissionGearboxMode.md @@ -0,0 +1,12 @@ +# TelemetryMessageVehicleTransmissionGearboxMode + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**automatic** | **bool** | | [optional] +**snow** | **bool** | | [optional] +**sport** | **bool** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TimeMonitorTrigger.md b/docs/TimeMonitorTrigger.md new file mode 100644 index 0000000..70de02a --- /dev/null +++ b/docs/TimeMonitorTrigger.md @@ -0,0 +1,11 @@ +# TimeMonitorTrigger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**times** | [**list[TimeRange]**](TimeRange.md) | | [optional] +**type** | **str** | | [optional] [default to 'Temporal'] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TimeRange.md b/docs/TimeRange.md new file mode 100644 index 0000000..4240fb1 --- /dev/null +++ b/docs/TimeRange.md @@ -0,0 +1,9 @@ +# TimeRange + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TimeStamped.md b/docs/TimeStamped.md new file mode 100644 index 0000000..b690409 --- /dev/null +++ b/docs/TimeStamped.md @@ -0,0 +1,10 @@ +# TimeStamped + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **datetime** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TimeTrigger.md b/docs/TimeTrigger.md new file mode 100644 index 0000000..79cbe4c --- /dev/null +++ b/docs/TimeTrigger.md @@ -0,0 +1,11 @@ +# TimeTrigger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time_zone** | **str** | The standard time [zone code](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the region where to apply this time trigger monitor. This allows to adapt this trigger to the time change according to local (region/country) criteria/rules. | [optional] [default to 'Europe/Paris'] +**times** | [**list[BoundedProgram]**](BoundedProgram.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TimeZoneMonitorTrigger.md b/docs/TimeZoneMonitorTrigger.md new file mode 100644 index 0000000..3757617 --- /dev/null +++ b/docs/TimeZoneMonitorTrigger.md @@ -0,0 +1,12 @@ +# TimeZoneMonitorTrigger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**place** | **object** | | [optional] +**type** | **str** | | [optional] [default to 'SpacialTemporal'] +**within** | **str** | containing mode. i.e wayPoints (such as Trip) start and /or end within or cross the container, | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TimeZoneTrigger.md b/docs/TimeZoneTrigger.md new file mode 100644 index 0000000..07c1b42 --- /dev/null +++ b/docs/TimeZoneTrigger.md @@ -0,0 +1,11 @@ +# TimeZoneTrigger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**time_trigger** | [**TimeTrigger**](TimeTrigger.md) | | [optional] +**zone_trigger** | [**ZoneTrigger**](ZoneTrigger.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Trip.md b/docs/Trip.md new file mode 100644 index 0000000..18a4453 --- /dev/null +++ b/docs/Trip.md @@ -0,0 +1,23 @@ +# Trip + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **datetime** | Date when the resource has been created. | [optional] +**links** | [**TripLinks**](TripLinks.md) | | [optional] +**avg_consumption** | [**list[TripAvgConsumption]**](TripAvgConsumption.md) | | [optional] +**distance** | **float** | Distance in Km of the trip | [optional] +**done** | **bool** | Determines whether this trip is finished or not. | [optional] +**duration** | **str** | Duration of the trip | [optional] +**faults** | **list[str]** | The faults of this finished or in progress trip. This means that we lacked data from the vehicle to complete the trip description during one of its step (starting, progressing, or finishing). | [optional] +**id** | **str** | Identifier of a trip | [optional] +**odometer** | **float** | The mileage of the vehicle at the end of a trip | [optional] +**start_position** | [**Position**](Position.md) | | [optional] +**started_at** | **datetime** | Date & Time when the trip started | [optional] +**stop_position** | [**Position**](Position.md) | | [optional] +**stopped_at** | **datetime** | Date & Time when the trip stopped | [optional] +**zero_emission_ratio** | **float** | Part of trip distance with zero gaz emission of the trip expressed in percent (0-100%). | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TripAvgConsumption.md b/docs/TripAvgConsumption.md new file mode 100644 index 0000000..cc45bcc --- /dev/null +++ b/docs/TripAvgConsumption.md @@ -0,0 +1,11 @@ +# TripAvgConsumption + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **str** | | [optional] +**value** | **float** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TripLinks.md b/docs/TripLinks.md new file mode 100644 index 0000000..475e0f3 --- /dev/null +++ b/docs/TripLinks.md @@ -0,0 +1,13 @@ +# TripLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**alerts** | [**Link**](Link.md) | | [optional] +**_self** | [**Link**](Link.md) | | [optional] +**vehicle** | [**Link**](Link.md) | | [optional] +**waypoints** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Trips.md b/docs/Trips.md new file mode 100644 index 0000000..14ce03e --- /dev/null +++ b/docs/Trips.md @@ -0,0 +1,14 @@ +# Trips + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | [**TripsEmbedded**](TripsEmbedded.md) | | [optional] +**links** | [**TabLinks**](TabLinks.md) | | [optional] +**current_page** | **int** | | [optional] +**total** | **int** | | [optional] +**total_page** | **int** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/TripsApi.md b/docs/TripsApi.md new file mode 100644 index 0000000..b2d7aaa --- /dev/null +++ b/docs/TripsApi.md @@ -0,0 +1,1252 @@ +# psa_connectedcar.TripsApi + +All URIs are relative to *https://api.groupe-psa.com/connectedcar/v4* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_path_for_trip**](TripsApi.md#get_path_for_trip) | **GET** /user/trips/{tid}/wayPoints | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_path_for_trip_0**](TripsApi.md#get_path_for_trip_0) | **GET** /user/vehicles/{id}/trips/{tid}/wayPoints | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_telemetry_for_trip**](TripsApi.md#get_telemetry_for_trip) | **GET** /user/trips/{tid}/telemetry | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_telemetry_for_trip_0**](TripsApi.md#get_telemetry_for_trip_0) | **GET** /user/vehicles/{id}/trips/{tid}/telemetry | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_trip_by_vehicle**](TripsApi.md#get_trip_by_vehicle) | **GET** /user/vehicles/{id}/trips/{tid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_trips_by_vehicle**](TripsApi.md#get_trips_by_vehicle) | **GET** /user/trips/{tid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_trips_by_vehicle_0**](TripsApi.md#get_trips_by_vehicle_0) | **GET** /user/trips/{tid}/ecoaching | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_trips_by_vehicle_1**](TripsApi.md#get_trips_by_vehicle_1) | **GET** /user/vehicles/{id}/trips | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_trips_by_vehicle_2**](TripsApi.md#get_trips_by_vehicle_2) | **GET** /user/vehicles/{id}/trips/{tid}/ecoaching | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_user_collision_by_tip_by_id**](TripsApi.md#get_user_collision_by_tip_by_id) | **GET** /user/trips/{tid}/collisions/{cid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_user_collisions_by_trip_id**](TripsApi.md#get_user_collisions_by_trip_id) | **GET** /user/trips/{tid}/collisions | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_user_trip_alert_by_aid**](TripsApi.md#get_user_trip_alert_by_aid) | **GET** /user/trips/{tid}/alerts/{aid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_user_trip_alerts**](TripsApi.md#get_user_trip_alerts) | **GET** /user/trips/{tid}/alerts | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_user_trips**](TripsApi.md#get_user_trips) | **GET** /user/trips | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_vehicle_collision_by_tip_by_id**](TripsApi.md#get_vehicle_collision_by_tip_by_id) | **GET** /user/vehicles/{id}/trips/{tid}/collisions/{cid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_vehicle_collisions_by_trip_id**](TripsApi.md#get_vehicle_collisions_by_trip_id) | **GET** /user/vehicles/{id}/trips/{tid}/collisions | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_vehicle_trip_alert_by_aid**](TripsApi.md#get_vehicle_trip_alert_by_aid) | **GET** /user/vehicles/{id}/trips/{tid}/alerts/{aid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_vehicle_trip_alerts**](TripsApi.md#get_vehicle_trip_alerts) | **GET** /user/vehicles/{id}/trips/{tid}/alerts | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + + +# **get_path_for_trip** +> WayPoints get_path_for_trip(tid, index_range=index_range) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Gives the wayPoints for a specified User Trip. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +tid = 'tid_example' # str | the *id* of Trip +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_path_for_trip(tid, index_range=index_range) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_path_for_trip: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tid** | **str**| the *id* of Trip | + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + +### Return type + +[**WayPoints**](WayPoints.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_path_for_trip_0** +> WayPoints get_path_for_trip_0(id, tid, index_range=index_range, timestamps=timestamps, tolerance=tolerance) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Gives the Vehicle's wayPoints for a specified Trip. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +tid = 'tid_example' # str | the *id* of Trip +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +timestamps = [psa_connectedcar.TimeRange()] # list[TimeRange] | Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. (optional) +tolerance = 3.4 # float | Tolerance factor is expressed in length KM unit and is used to simplify path by reducing the total number of points by is using Douglas-Peucker algorithme to find a similar curve with fewer points (find more info here: [Ramer_Douglas_Peucker_algorithm](https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm#Algorithm) ). (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_path_for_trip_0(id, tid, index_range=index_range, timestamps=timestamps, tolerance=tolerance) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_path_for_trip_0: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **tid** | **str**| the *id* of Trip | + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **timestamps** | [**list[TimeRange]**](TimeRange.md)| Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. | [optional] + **tolerance** | **float**| Tolerance factor is expressed in length KM unit and is used to simplify path by reducing the total number of points by is using Douglas-Peucker algorithme to find a similar curve with fewer points (find more info here: [Ramer_Douglas_Peucker_algorithm](https://en.wikipedia.org/wiki/Ramer%E2%80%93Douglas%E2%80%93Peucker_algorithm#Algorithm) ). | [optional] + +### Return type + +[**WayPoints**](WayPoints.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_telemetry_for_trip** +> Telemetry get_telemetry_for_trip(tid, timestamps=timestamps, index_range=index_range, locale=locale, type=type, extension=extension) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the set of Telemetry values that occurred for a given vehicle (id) and a speific Trip (tid) during the timestamp ranges and bounded by an index range. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +tid = 'tid_example' # str | the *id* of Trip +timestamps = [psa_connectedcar.TimeRange()] # list[TimeRange] | Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. (optional) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? (optional) +type = ['type_example'] # list[str] | Results will only contain Telemetry messages of this kind. You can add more than one message type. (optional) +extension = ['extension_example'] # list[str] | Additional data set that will be included in embedded field * _Disclaimer_: **Enabling ```maintenance``` extension will automatically disable ```Kinetic``` telemetry message** (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_telemetry_for_trip(tid, timestamps=timestamps, index_range=index_range, locale=locale, type=type, extension=extension) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_telemetry_for_trip: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tid** | **str**| the *id* of Trip | + **timestamps** | [**list[TimeRange]**](TimeRange.md)| Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. | [optional] + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? | [optional] + **type** | [**list[str]**](str.md)| Results will only contain Telemetry messages of this kind. You can add more than one message type. | [optional] + **extension** | [**list[str]**](str.md)| Additional data set that will be included in embedded field * _Disclaimer_: **Enabling ```maintenance``` extension will automatically disable ```Kinetic``` telemetry message** | [optional] + +### Return type + +[**Telemetry**](Telemetry.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_telemetry_for_trip_0** +> Telemetry get_telemetry_for_trip_0(id, tid, timestamps=timestamps, index_range=index_range, locale=locale, type=type, extension=extension) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the set of Telemetry values that occurred for a given vehicle (id) and a speific Trip (tid) during the timestamp ranges and bounded by an index range. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +tid = 'tid_example' # str | the *id* of Trip +timestamps = [psa_connectedcar.TimeRange()] # list[TimeRange] | Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. (optional) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? (optional) +type = ['type_example'] # list[str] | Results will only contain Telemetry messages of this kind. You can add more than one message type. (optional) +extension = ['extension_example'] # list[str] | Additional data set that will be included in embedded field * _Disclaimer_: **Enabling ```maintenance``` extension will automatically disable ```Kinetic``` telemetry message** (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_telemetry_for_trip_0(id, tid, timestamps=timestamps, index_range=index_range, locale=locale, type=type, extension=extension) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_telemetry_for_trip_0: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **tid** | **str**| the *id* of Trip | + **timestamps** | [**list[TimeRange]**](TimeRange.md)| Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. | [optional] + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? | [optional] + **type** | [**list[str]**](str.md)| Results will only contain Telemetry messages of this kind. You can add more than one message type. | [optional] + **extension** | [**list[str]**](str.md)| Additional data set that will be included in embedded field * _Disclaimer_: **Enabling ```maintenance``` extension will automatically disable ```Kinetic``` telemetry message** | [optional] + +### Return type + +[**Telemetry**](Telemetry.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_trip_by_vehicle** +> Trip get_trip_by_vehicle(id, tid) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +This method returns the Trip that matches the Trip id (tid) a given Vehicle (id) has taken. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +tid = 'tid_example' # str | the *id* of Trip + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_trip_by_vehicle(id, tid) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_trip_by_vehicle: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **tid** | **str**| the *id* of Trip | + +### Return type + +[**Trip**](Trip.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_trips_by_vehicle** +> Trip get_trips_by_vehicle(tid) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +This method returns the Trip that matches the Trip id (tid) User has taken. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +tid = 'tid_example' # str | the *id* of Trip + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_trips_by_vehicle(tid) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_trips_by_vehicle: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tid** | **str**| the *id* of Trip | + +### Return type + +[**Trip**](Trip.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_trips_by_vehicle_0** +> ECoaching get_trips_by_vehicle_0(tid, locale=locale) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Return the User Trip ECoaching evaluation. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +tid = 'tid_example' # str | the *id* of Trip +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_trips_by_vehicle_0(tid, locale=locale) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_trips_by_vehicle_0: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tid** | **str**| the *id* of Trip | + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? | [optional] + +### Return type + +[**ECoaching**](ECoaching.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_trips_by_vehicle_1** +> Trips get_trips_by_vehicle_1(id, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +This method returns a list of all Trips that a given Vehicle has taken. This will NOT include Trips that have not yet been completed. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +timestamps = [psa_connectedcar.TimeRange()] # list[TimeRange] | Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. (optional) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +page_size = 60 # int | The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. (optional) (default to 60) +page_token = 'page_token_example' # str | Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_trips_by_vehicle_1(id, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_trips_by_vehicle_1: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **timestamps** | [**list[TimeRange]**](TimeRange.md)| Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. | [optional] + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **page_size** | **int**| The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. | [optional] [default to 60] + **page_token** | **str**| Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. | [optional] + +### Return type + +[**Trips**](Trips.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_trips_by_vehicle_2** +> ECoaching get_trips_by_vehicle_2(id, tid, locale=locale) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Return the Trip ECoaching evaluation. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +tid = 'tid_example' # str | the *id* of Trip +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_trips_by_vehicle_2(id, tid, locale=locale) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_trips_by_vehicle_2: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **tid** | **str**| the *id* of Trip | + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? | [optional] + +### Return type + +[**ECoaching**](ECoaching.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_user_collision_by_tip_by_id** +> Collision get_user_collision_by_tip_by_id(tid, cid) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the Collision(cid) that occurred for a given vehicle(id) during a Trip(tid) . + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +tid = 'tid_example' # str | the *id* of Trip +cid = 'cid_example' # str | Results will only contain the Collision related to this Collision *id*. + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_user_collision_by_tip_by_id(tid, cid) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_user_collision_by_tip_by_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tid** | **str**| the *id* of Trip | + **cid** | **str**| Results will only contain the Collision related to this Collision *id*. | + +### Return type + +[**Collision**](Collision.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_user_collisions_by_trip_id** +> Collisions get_user_collisions_by_trip_id(tid, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the set of Collisions that occurred for a given vehicle (id) and a speific Trip (tid) during the timestamp ranges and bounded by an index range. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +tid = 'tid_example' # str | the *id* of Trip +timestamps = [psa_connectedcar.TimeRange()] # list[TimeRange] | Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. (optional) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +page_size = 60 # int | The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. (optional) (default to 60) +page_token = 'page_token_example' # str | Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_user_collisions_by_trip_id(tid, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_user_collisions_by_trip_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tid** | **str**| the *id* of Trip | + **timestamps** | [**list[TimeRange]**](TimeRange.md)| Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. | [optional] + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **page_size** | **int**| The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. | [optional] [default to 60] + **page_token** | **str**| Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. | [optional] + +### Return type + +[**Collisions**](Collisions.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_user_trip_alert_by_aid** +> Alert get_user_trip_alert_by_aid(tid, aid, locale=locale) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns information about a specific alert messages for a given Trip. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +tid = 'tid_example' # str | the *id* of Trip +aid = 'aid_example' # str | id of the alert. +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_user_trip_alert_by_aid(tid, aid, locale=locale) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_user_trip_alert_by_aid: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tid** | **str**| the *id* of Trip | + **aid** | **str**| id of the alert. | + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? | [optional] + +### Return type + +[**Alert**](Alert.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_user_trip_alerts** +> Alerts get_user_trip_alerts(tid, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token, locale=locale) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the latest alert messages during a Trip. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +tid = 'tid_example' # str | the *id* of Trip +timestamps = [psa_connectedcar.TimeRange()] # list[TimeRange] | Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. (optional) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +page_size = 60 # int | The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. (optional) (default to 60) +page_token = 'page_token_example' # str | Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. (optional) +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_user_trip_alerts(tid, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token, locale=locale) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_user_trip_alerts: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tid** | **str**| the *id* of Trip | + **timestamps** | [**list[TimeRange]**](TimeRange.md)| Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. | [optional] + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **page_size** | **int**| The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. | [optional] [default to 60] + **page_token** | **str**| Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. | [optional] + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. | [optional] + +### Return type + +[**Alerts**](Alerts.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_user_trips** +> Trips get_user_trips(timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +This method returns a list of all Trips the User has taken. This will NOT include Trips that have not yet been completed. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +timestamps = [psa_connectedcar.TimeRange()] # list[TimeRange] | Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. (optional) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +page_size = 60 # int | The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. (optional) (default to 60) +page_token = 'page_token_example' # str | Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_user_trips(timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_user_trips: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **timestamps** | [**list[TimeRange]**](TimeRange.md)| Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. | [optional] + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **page_size** | **int**| The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. | [optional] [default to 60] + **page_token** | **str**| Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. | [optional] + +### Return type + +[**Trips**](Trips.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_collision_by_tip_by_id** +> Collision get_vehicle_collision_by_tip_by_id(id, tid, cid) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the Collision(cid) that occurred for a given vehicle(id) during a Trip(tid) . + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +tid = 'tid_example' # str | the *id* of Trip +cid = 'cid_example' # str | Results will only contain the Collision related to this Collision *id*. + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_vehicle_collision_by_tip_by_id(id, tid, cid) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_vehicle_collision_by_tip_by_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **tid** | **str**| the *id* of Trip | + **cid** | **str**| Results will only contain the Collision related to this Collision *id*. | + +### Return type + +[**Collision**](Collision.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_collisions_by_trip_id** +> Collisions get_vehicle_collisions_by_trip_id(id, tid, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the set of Collisions that occurred for a given vehicle (id) and a speific Trip (tid) during the timestamp ranges and bounded by an index range. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +tid = 'tid_example' # str | the *id* of Trip +timestamps = [psa_connectedcar.TimeRange()] # list[TimeRange] | Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. (optional) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +page_size = 60 # int | The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. (optional) (default to 60) +page_token = 'page_token_example' # str | Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_vehicle_collisions_by_trip_id(id, tid, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_vehicle_collisions_by_trip_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **tid** | **str**| the *id* of Trip | + **timestamps** | [**list[TimeRange]**](TimeRange.md)| Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. | [optional] + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **page_size** | **int**| The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. | [optional] [default to 60] + **page_token** | **str**| Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. | [optional] + +### Return type + +[**Collisions**](Collisions.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_trip_alert_by_aid** +> Alert get_vehicle_trip_alert_by_aid(id, tid, aid, locale=locale) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns information about a specific alert messages for a given Vehicle and Trip. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +tid = 'tid_example' # str | the *id* of Trip +aid = 'aid_example' # str | id of the alert. +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_vehicle_trip_alert_by_aid(id, tid, aid, locale=locale) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_vehicle_trip_alert_by_aid: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **tid** | **str**| the *id* of Trip | + **aid** | **str**| id of the alert. | + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? | [optional] + +### Return type + +[**Alert**](Alert.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_trip_alerts** +> Alerts get_vehicle_trip_alerts(id, tid, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token, locale=locale) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the latest alert messages for a Vehicle. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.TripsApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +tid = 'tid_example' # str | the *id* of Trip +timestamps = [psa_connectedcar.TimeRange()] # list[TimeRange] | Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. (optional) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +page_size = 60 # int | The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. (optional) (default to 60) +page_token = 'page_token_example' # str | Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. (optional) +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_vehicle_trip_alerts(id, tid, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token, locale=locale) + pprint(api_response) +except ApiException as e: + print("Exception when calling TripsApi->get_vehicle_trip_alerts: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **tid** | **str**| the *id* of Trip | + **timestamps** | [**list[TimeRange]**](TimeRange.md)| Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. | [optional] + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **page_size** | **int**| The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. | [optional] [default to 60] + **page_token** | **str**| Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. | [optional] + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. | [optional] + +### Return type + +[**Alerts**](Alerts.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/TripsEmbedded.md b/docs/TripsEmbedded.md new file mode 100644 index 0000000..3e2fff7 --- /dev/null +++ b/docs/TripsEmbedded.md @@ -0,0 +1,10 @@ +# TripsEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**trips** | [**list[Trip]**](Trip.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UpdatedField.md b/docs/UpdatedField.md new file mode 100644 index 0000000..4a22898 --- /dev/null +++ b/docs/UpdatedField.md @@ -0,0 +1,10 @@ +# UpdatedField + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**updated_at** | **datetime** | Date when the resource has been updated. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Url.md b/docs/Url.md new file mode 100644 index 0000000..3881b9d --- /dev/null +++ b/docs/Url.md @@ -0,0 +1,9 @@ +# Url + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/User.md b/docs/User.md new file mode 100644 index 0000000..ab5756a --- /dev/null +++ b/docs/User.md @@ -0,0 +1,15 @@ +# User + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **datetime** | Date when the resource has been created. | [optional] +**embedded** | [**UserEmbedded**](UserEmbedded.md) | | [optional] +**links** | [**UserLinks**](UserLinks.md) | | [optional] +**email** | **str** | Mail of user | [optional] +**first_name** | **str** | First name of user | [optional] +**last_name** | **str** | Last name of user | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UserApi.md b/docs/UserApi.md new file mode 100644 index 0000000..911b440 --- /dev/null +++ b/docs/UserApi.md @@ -0,0 +1,53 @@ +# psa_connectedcar.UserApi + +All URIs are relative to *https://api.groupe-psa.com/connectedcar/v4* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_user**](UserApi.md#get_user) | **GET** /user | User's information + + +# **get_user** +> User get_user() + +User's information + +Returns the User's information. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = psa_connectedcar.UserApi() + +try: + # User's information + api_response = api_instance.get_user() + pprint(api_response) +except ApiException as e: + print("Exception when calling UserApi->get_user: %s\n" % e) +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**User**](User.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json, application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/UserEmbedded.md b/docs/UserEmbedded.md new file mode 100644 index 0000000..11120e8 --- /dev/null +++ b/docs/UserEmbedded.md @@ -0,0 +1,10 @@ +# UserEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**vehicles** | [**list[Vehicle]**](Vehicle.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/UserLinks.md b/docs/UserLinks.md new file mode 100644 index 0000000..6c5daa0 --- /dev/null +++ b/docs/UserLinks.md @@ -0,0 +1,11 @@ +# UserLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_self** | [**Link**](Link.md) | | [optional] +**vehicles** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Vect2D.md b/docs/Vect2D.md new file mode 100644 index 0000000..9675a44 --- /dev/null +++ b/docs/Vect2D.md @@ -0,0 +1,9 @@ +# Vect2D + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Vehicle.md b/docs/Vehicle.md new file mode 100644 index 0000000..83beb4d --- /dev/null +++ b/docs/Vehicle.md @@ -0,0 +1,18 @@ +# Vehicle + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**created_at** | **datetime** | Date when the resource has been created. | [optional] +**embedded** | **object** | | [optional] +**links** | [**VehicleLinks**](VehicleLinks.md) | | [optional] +**brand** | **str** | Brand of a vehicle | [optional] +**engine** | [**list[VehicleEngine]**](VehicleEngine.md) | Engine of a vehicle | [optional] +**id** | **str** | | [optional] +**label** | **str** | Version of a vehicle | [optional] +**pictures** | [**list[Url]**](Url.md) | With the links it's possible to see the pictures of the vehicle | [optional] +**vin** | **str** | Vehicle Identification Number | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VehicleEngine.md b/docs/VehicleEngine.md new file mode 100644 index 0000000..99f9099 --- /dev/null +++ b/docs/VehicleEngine.md @@ -0,0 +1,11 @@ +# VehicleEngine + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_class** | **str** | | [optional] [default to 'Thermic'] +**energy** | **str** | Type of energy of a vehicle (Not available for Electric class) | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VehicleLinks.md b/docs/VehicleLinks.md new file mode 100644 index 0000000..bfdc64a --- /dev/null +++ b/docs/VehicleLinks.md @@ -0,0 +1,16 @@ +# VehicleLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**alerts** | [**Link**](Link.md) | | [optional] +**last_position** | [**Link**](Link.md) | | [optional] +**maintenance** | [**Link**](Link.md) | | [optional] +**_self** | [**Link**](Link.md) | | [optional] +**status** | [**Link**](Link.md) | | [optional] +**telemetry** | [**Link**](Link.md) | | [optional] +**trips** | [**Link**](Link.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VehicleOdometer.md b/docs/VehicleOdometer.md new file mode 100644 index 0000000..3dc3e4c --- /dev/null +++ b/docs/VehicleOdometer.md @@ -0,0 +1,10 @@ +# VehicleOdometer + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**mileage** | **float** | Vehicle mileage expressed in KM. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/Vehicles.md b/docs/Vehicles.md new file mode 100644 index 0000000..dd23e18 --- /dev/null +++ b/docs/Vehicles.md @@ -0,0 +1,10 @@ +# Vehicles + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | [**VehiclesEmbedded**](VehiclesEmbedded.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/VehiclesApi.md b/docs/VehiclesApi.md new file mode 100644 index 0000000..0b52fb7 --- /dev/null +++ b/docs/VehiclesApi.md @@ -0,0 +1,1050 @@ +# psa_connectedcar.VehiclesApi + +All URIs are relative to *https://api.groupe-psa.com/connectedcar/v4* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_monitordd**](VehiclesApi.md#delete_monitordd) | **DELETE** /user/vehicles/{id}/monitors/{mid} | Delete a Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_car_last_position**](VehiclesApi.md#get_car_last_position) | **GET** /user/vehicles/{id}/lastPosition | Last position identified +[**get_telemetry**](VehiclesApi.md#get_telemetry) | **GET** /user/vehicles/{id}/telemetry | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_vehicle_alerts**](VehiclesApi.md#get_vehicle_alerts) | **GET** /user/vehicles/{id}/alerts | +[**get_vehicle_alerts_by_id**](VehiclesApi.md#get_vehicle_alerts_by_id) | **GET** /user/vehicles/{id}/alerts/{aid} | +[**get_vehicle_byid**](VehiclesApi.md#get_vehicle_byid) | **GET** /user/vehicles/{id} | Details of vehicule +[**get_vehicle_collision**](VehiclesApi.md#get_vehicle_collision) | **GET** /user/vehicles/{id}/collisions | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_vehicle_collision_by_id**](VehiclesApi.md#get_vehicle_collision_by_id) | **GET** /user/vehicles/{id}/collisions/{cid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_vehicle_maintenance**](VehiclesApi.md#get_vehicle_maintenance) | **GET** /user/vehicles/{id}/maintenance | +[**get_vehicle_monitors**](VehiclesApi.md#get_vehicle_monitors) | **GET** /user/vehicles/{id}/monitors | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_vehicle_monitors_by_id**](VehiclesApi.md#get_vehicle_monitors_by_id) | **GET** /user/vehicles/{id}/monitors/{mid} | OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**get_vehicle_status**](VehiclesApi.md#get_vehicle_status) | **GET** /user/vehicles/{id}/status | Vehicle status. +[**get_vehicles_by_device**](VehiclesApi.md#get_vehicles_by_device) | **GET** /user/vehicles | List of vehicules +[**set_fleet_vehicle_monitor_status**](VehiclesApi.md#set_fleet_vehicle_monitor_status) | **PUT** /user/vehicles/{id}/monitors/{mid}/status | Set a new monitor status. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**set_vehicle_monitor**](VehiclesApi.md#set_vehicle_monitor) | **POST** /user/vehicles/{id}/monitors | Create a new Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE +[**update_fleet_vehicle_monitor**](VehiclesApi.md#update_fleet_vehicle_monitor) | **PUT** /user/vehicles/{id}/monitors/{mid} | Update and existing Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + + +# **delete_monitordd** +> delete_monitordd(id, mid) + +Delete a Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Stop (disable) an existing Monitor. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +mid = 'mid_example' # str | id of the alert. + +try: + # Delete a Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_instance.delete_monitordd(id, mid) +except ApiException as e: + print("Exception when calling VehiclesApi->delete_monitordd: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **mid** | **str**| id of the alert. | + +### Return type + +void (empty response body) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_car_last_position** +> Position get_car_last_position(id) + +Last position identified + +Returns the latest GPS Position of the Vehicle. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. + +try: + # Last position identified + api_response = api_instance.get_car_last_position(id) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_car_last_position: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + +### Return type + +[**Position**](Position.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/vnd.geo+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_telemetry** +> Telemetry get_telemetry(id, type=type, index_range=index_range, page_size=page_size, page_token=page_token, locale=locale, extension=extension) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the latest Telemetry messages that occurred during a selective timestamp-ranges and bounded by an index range. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +type = ['type_example'] # list[str] | Results will only contain Telemetry messages of this kind. You can add more than one message type. (optional) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +page_size = 60 # int | The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. (optional) (default to 60) +page_token = 'page_token_example' # str | Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. (optional) +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? (optional) +extension = ['extension_example'] # list[str] | Additional data set that will be included in embedded field * _Disclaimer_: **Enabling ```maintenance``` extension will automatically disable ```Kinetic``` telemetry message** (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_telemetry(id, type=type, index_range=index_range, page_size=page_size, page_token=page_token, locale=locale, extension=extension) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_telemetry: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **type** | [**list[str]**](str.md)| Results will only contain Telemetry messages of this kind. You can add more than one message type. | [optional] + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **page_size** | **int**| The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. | [optional] [default to 60] + **page_token** | **str**| Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. | [optional] + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? | [optional] + **extension** | [**list[str]**](str.md)| Additional data set that will be included in embedded field * _Disclaimer_: **Enabling ```maintenance``` extension will automatically disable ```Kinetic``` telemetry message** | [optional] + +### Return type + +[**Telemetry**](Telemetry.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_alerts** +> Alerts get_vehicle_alerts(id, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token, locale=locale, locale2=locale2) + + + +Returns the latest alert messages for a Vehicle. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +timestamps = [psa_connectedcar.TimeRange()] # list[TimeRange] | Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. (optional) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +page_size = 60 # int | The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. (optional) (default to 60) +page_token = 'page_token_example' # str | Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. (optional) +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? (optional) +locale2 = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. (optional) + +try: + api_response = api_instance.get_vehicle_alerts(id, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token, locale=locale, locale2=locale2) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_vehicle_alerts: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **timestamps** | [**list[TimeRange]**](TimeRange.md)| Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. | [optional] + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **page_size** | **int**| The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. | [optional] [default to 60] + **page_token** | **str**| Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. | [optional] + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? | [optional] + **locale2** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. | [optional] + +### Return type + +[**Alerts**](Alerts.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_alerts_by_id** +> Alert get_vehicle_alerts_by_id(id, aid, locale=locale) + + + +Returns information about a specific alert messages for a Vehicle. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +aid = 'aid_example' # str | id of the alert. +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? (optional) + +try: + api_response = api_instance.get_vehicle_alerts_by_id(id, aid, locale=locale) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_vehicle_alerts_by_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **aid** | **str**| id of the alert. | + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? | [optional] + +### Return type + +[**Alert**](Alert.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_byid** +> Vehicle get_vehicle_byid(id) + +Details of vehicule + +Returns detailed information about a Vehicle. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. + +try: + # Details of vehicule + api_response = api_instance.get_vehicle_byid(id) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_vehicle_byid: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + +### Return type + +[**Vehicle**](Vehicle.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_collision** +> Collisions get_vehicle_collision(id, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the set of Collisions that occurred for a given vehicle (id) during the timestamp ranges and bounded by an index range. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +timestamps = [psa_connectedcar.TimeRange()] # list[TimeRange] | Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. (optional) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +page_size = 60 # int | The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. (optional) (default to 60) +page_token = 'page_token_example' # str | Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_vehicle_collision(id, timestamps=timestamps, index_range=index_range, page_size=page_size, page_token=page_token) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_vehicle_collision: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **timestamps** | [**list[TimeRange]**](TimeRange.md)| Array of **\"timestamp\"** ranges. Results will contain results whose timestamps are included in those date-time ranges (see **timestamp** data model).**\"timestamp\"** items should be expressed as in '[RFC3339](https://www.ietf.org/rfc/rfc3339.txt)'. | [optional] + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **page_size** | **int**| The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. | [optional] [default to 60] + **page_token** | **str**| Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. | [optional] + +### Return type + +[**Collisions**](Collisions.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_collision_by_id** +> Collision get_vehicle_collision_by_id(id, cid) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the Collision that matches the vehicle id and the Collision cid. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +cid = 'cid_example' # str | Results will only contain the Collision related to this Collision *id*. + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_vehicle_collision_by_id(id, cid) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_vehicle_collision_by_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **cid** | **str**| Results will only contain the Collision related to this Collision *id*. | + +### Return type + +[**Collision**](Collision.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_maintenance** +> Maintenance get_vehicle_maintenance(id) + + + +Returns the latest Maintenance information for a Vehicle. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. + +try: + api_response = api_instance.get_vehicle_maintenance(id) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_vehicle_maintenance: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + +### Return type + +[**Maintenance**](Maintenance.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_monitors** +> Monitors get_vehicle_monitors(id, index_range=index_range, page_size=page_size, page_token=page_token) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns the list of subscribed Monitors for a Vehicle. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +page_size = 60 # int | The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. (optional) (default to 60) +page_token = 'page_token_example' # str | Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. (optional) + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_vehicle_monitors(id, index_range=index_range, page_size=page_size, page_token=page_token) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_vehicle_monitors: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **page_size** | **int**| The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. | [optional] [default to 60] + **page_token** | **str**| Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. | [optional] + +### Return type + +[**Monitors**](Monitors.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_monitors_by_id** +> MonitorParameter get_vehicle_monitors_by_id(id, mid) + +OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Returns information about a specific Monitor for a Vehicle. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +mid = 'mid_example' # str | id of the alert. + +try: + # OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.get_vehicle_monitors_by_id(id, mid) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_vehicle_monitors_by_id: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **mid** | **str**| id of the alert. | + +### Return type + +[**MonitorParameter**](MonitorParameter.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicle_status** +> Status get_vehicle_status(id, extension=extension) + +Vehicle status. + +Returns the latest vehicle status. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +extension = ['extension_example'] # list[str] | Additional data set that will be included in embedded field * _Disclaimer_: **Enabling ```odometer``` extension will automatically disable ```kinetic``` telemetry message** (optional) + +try: + # Vehicle status. + api_response = api_instance.get_vehicle_status(id, extension=extension) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_vehicle_status: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **extension** | [**list[str]**](str.md)| Additional data set that will be included in embedded field * _Disclaimer_: **Enabling ```odometer``` extension will automatically disable ```kinetic``` telemetry message** | [optional] + +### Return type + +[**Status**](Status.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_vehicles_by_device** +> Vehicles get_vehicles_by_device(index_range=index_range, page_size=page_size, locale=locale, page_token=page_token) + +List of vehicules + +Returns the Vehicles associated with the User. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +index_range = '0-' # str | Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 (optional) (default to 0-) +page_size = 60 # int | The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. (optional) (default to 60) +locale = 'locale_example' # str | Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? (optional) +page_token = 'page_token_example' # str | Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. (optional) + +try: + # List of vehicules + api_response = api_instance.get_vehicles_by_device(index_range=index_range, page_size=page_size, locale=locale, page_token=page_token) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->get_vehicles_by_device: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **index_range** | **str**| Results indexes will be included in this range (see **indexRange** model). default: 0- example: 0-, 0-5 | [optional] [default to 0-] + **page_size** | **int**| The maximum number of results (for a collection results response) to return per page. When not set, at most 60 results will be returned. | [optional] [default to 60] + **locale** | **str**| Locale is used for rendering text, correctly displaying regional monetary values, time and date formats. Respect REGEX \\w(-\\w)? | [optional] + **page_token** | **str**| Start-Page marker, the token for continuing a previous list request on the next page. It is built and used **only** by the server. | [optional] + +### Return type + +[**Vehicles**](Vehicles.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_fleet_vehicle_monitor_status** +> MonitorRef set_fleet_vehicle_monitor_status(id, mid, body=body) + +Set a new monitor status. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Set monitor status. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi() +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +mid = 'mid_example' # str | id of the alert. +body = psa_connectedcar.MonitorStatusSetter() # MonitorStatusSetter | (optional) + +try: + # Set a new monitor status. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.set_fleet_vehicle_monitor_status(id, mid, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->set_fleet_vehicle_monitor_status: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **mid** | **str**| id of the alert. | + **body** | [**MonitorStatusSetter**](MonitorStatusSetter.md)| | [optional] + +### Return type + +[**MonitorRef**](MonitorRef.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_vehicle_monitor** +> MonitorParameter set_vehicle_monitor(id, body=body) + +Create a new Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +>Create a Monitor for a Vehicle. This is a kind of vehicle monitor that generates an event following the transition state of one of the (monitored) data of the vehicles. As for example the fuel level, the moving out of a defined geographical area. >When the the trigger occurs, the built event expressed as a JSON object will be sent over the callback. + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# Configure OAuth2 access token for authorization: Vehicle_auth +configuration = psa_connectedcar.Configuration() +configuration.access_token = 'YOUR_ACCESS_TOKEN' +# Configure API key authorization: client_id +configuration = psa_connectedcar.Configuration() +configuration.api_key['client_id'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['client_id'] = 'Bearer' +# Configure API key authorization: realm +configuration = psa_connectedcar.Configuration() +configuration.api_key['x-introspect-realm'] = 'YOUR_API_KEY' +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['x-introspect-realm'] = 'Bearer' + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi(psa_connectedcar.ApiClient(configuration)) +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +body = psa_connectedcar.MonitorParameter() # MonitorParameter | (optional) + +try: + # Create a new Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.set_vehicle_monitor(id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->set_vehicle_monitor: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **str**| Results will only be related to this Vehicle *id*. | + **body** | [**MonitorParameter**](MonitorParameter.md)| | [optional] + +### Return type + +[**MonitorParameter**](MonitorParameter.md) + +### Authorization + +[Vehicle_auth](../README.md#Vehicle_auth), [client_id](../README.md#client_id), [realm](../README.md#realm) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/hal+json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_fleet_vehicle_monitor** +> MonitorRef update_fleet_vehicle_monitor(mid, id, body=body) + +Update and existing Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + +Update an existing ```Monitor``` that has been posted (and accepted previously) for this vehicle. The monitor object (body) provided should be complete because the aggregation is not supported for the update of the ```monitor```. you can retrieve this object using the ```GET /monitor/{mid}``` API then modify it and finally publish it (via this ```PUT API```) + +### Example +```python +from __future__ import print_function +import time +import psa_connectedcar +from psa_connectedcar.rest import ApiException +from pprint import pprint + +# create an instance of the API class +api_instance = psa_connectedcar.VehiclesApi() +mid = 'mid_example' # str | id of the alert. +id = 'id_example' # str | Results will only be related to this Vehicle *id*. +body = psa_connectedcar.MonitorParameter() # MonitorParameter | (optional) + +try: + # Update and existing Monitor. OUT OF 1ST RELEASE (R-LEV 1.1) SCOPE + api_response = api_instance.update_fleet_vehicle_monitor(mid, id, body=body) + pprint(api_response) +except ApiException as e: + print("Exception when calling VehiclesApi->update_fleet_vehicle_monitor: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mid** | **str**| id of the alert. | + **id** | **str**| Results will only be related to this Vehicle *id*. | + **body** | [**MonitorParameter**](MonitorParameter.md)| | [optional] + +### Return type + +[**MonitorRef**](MonitorRef.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/docs/VehiclesEmbedded.md b/docs/VehiclesEmbedded.md new file mode 100644 index 0000000..b5608e7 --- /dev/null +++ b/docs/VehiclesEmbedded.md @@ -0,0 +1,10 @@ +# VehiclesEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**vehicles** | [**list[Vehicle]**](Vehicle.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/WayPoints.md b/docs/WayPoints.md new file mode 100644 index 0000000..0693a98 --- /dev/null +++ b/docs/WayPoints.md @@ -0,0 +1,10 @@ +# WayPoints + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**embedded** | [**WayPointsEmbedded**](WayPointsEmbedded.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/WayPointsEmbedded.md b/docs/WayPointsEmbedded.md new file mode 100644 index 0000000..d045a7e --- /dev/null +++ b/docs/WayPointsEmbedded.md @@ -0,0 +1,11 @@ +# WayPointsEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**positions** | [**list[Position]**](Position.md) | | +**reduced** | **bool** | Determines whether this result set (page) has been reduced due to path simplifying (by providing a tolerance factor). ### Note: The number of results may be lower than the specified page 'size' due to the applying of the path simplifying after resolving the page resultset. | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/XError.md b/docs/XError.md new file mode 100644 index 0000000..c4f7f23 --- /dev/null +++ b/docs/XError.md @@ -0,0 +1,12 @@ +# XError + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **int** | | [optional] +**debug** | **str** | | [optional] +**message** | **str** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ZoneMonitorTrigger.md b/docs/ZoneMonitorTrigger.md new file mode 100644 index 0000000..dfc2425 --- /dev/null +++ b/docs/ZoneMonitorTrigger.md @@ -0,0 +1,12 @@ +# ZoneMonitorTrigger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**place** | **object** | | [optional] +**type** | **str** | | [optional] [default to 'Spacial'] +**within** | **str** | containing mode. i.e wayPoints (such as Trip) start and /or end within or cross the container, | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ZoneTrigger.md b/docs/ZoneTrigger.md new file mode 100644 index 0000000..b581631 --- /dev/null +++ b/docs/ZoneTrigger.md @@ -0,0 +1,11 @@ +# ZoneTrigger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**place** | [**ZoneTriggerPlace**](ZoneTriggerPlace.md) | | +**transition** | **str** | Zone monitoring type ('In' for monitoring entering zone and 'Out' formonitoring leaving zone), | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ZoneTriggerPlace.md b/docs/ZoneTriggerPlace.md new file mode 100644 index 0000000..e9911f7 --- /dev/null +++ b/docs/ZoneTriggerPlace.md @@ -0,0 +1,11 @@ +# ZoneTriggerPlace + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**center** | [**ZoneTriggerPlaceCenter**](ZoneTriggerPlaceCenter.md) | | +**radius** | **float** | Circle radius (expressed in KM) | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ZoneTriggerPlaceCenter.md b/docs/ZoneTriggerPlaceCenter.md new file mode 100644 index 0000000..5cfc4c8 --- /dev/null +++ b/docs/ZoneTriggerPlaceCenter.md @@ -0,0 +1,11 @@ +# ZoneTriggerPlaceCenter + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**latitude** | **float** | | +**longitude** | **float** | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/server.py b/server.py index 54a88d2..6a0cb62 100644 --- a/server.py +++ b/server.py @@ -70,7 +70,6 @@ def parse_args(): if __name__ == "__main__": parser = parse_args() args = parser.parse_args() - print(args.__dict__) if args.config: myp = MyPSACC.loadconfig(name=args.config.name) else: