VRt.Monitor [MT]

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for veeroute from gravatar.com veeroute

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Proprietary
  • Author: Veeroute Support Team
  • Tags OpenAPI , VRt.Monitor [MT]
  • Requires: Python >=3.9
Report project as malware

Project description

vrt_lss_monitor

Veeroute Monitor API.

Description

Server part of the Veeroute Monitor.

Trip status model

Status Code Description Expected Action
FREE Trip created, crew not assigned Operator will assign crew
ASSIGNED Crew assigned Operator will send task to crew
SENT Task sent to crew Crew will acknowledge receipt
RECEIVED Crew received trip (fact TRIP_RECEIVED) Crew will accept or reject trip
CONFIRMED Crew agreed to operate trip (fact TRIP_CONFIRMED) Crew will begin operating trip
REJECTED Crew refused to operate trip (fact TRIP_REJECTED) Operator will assign new crew or cancel trip
EXECUTING The crew is executing a trip (fact TRIP_EXECUTED) The crew will complete all tasks
FINISHED The trip is completed - no work remains for the trip This is the final status
CANCELLED The trip has been canceled by the operator This is the final status

Status transitions:

Operator: FREE → ASSIGNED → SENT

Crew: RECEIVED → CONFIRMED / REJECTED → EXECUTING

Conditions: EXECUTING → FINISHED / CANCELLED

Facts

Depending on the fact type, in addition to the main mandatory fields (described in the API), additional mandatory fields appear:

Fact designation order_key demand_key performer_key location_key attributes
NEW_LOCATION + +
ORDER_DONE +
DEMAND_START +
DEMAND_DONE +
TRIP_RECEIVED
TRIP_CONFIRMED
TRIP_REJECTED
TRIP_EXECUTED

Entity relationship diagram

erd

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 7.31.3182
  • Package version: 7.31.3182
  • Generator version: 7.17.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import vrt_lss_monitor

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import vrt_lss_monitor

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import vrt_lss_monitor
from vrt_lss_monitor.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.edge7.veeroute.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = vrt_lss_monitor.Configuration(
    host = "https://api.edge7.veeroute.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): ApiKeyAuth
configuration = vrt_lss_monitor.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with vrt_lss_monitor.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vrt_lss_monitor.BackupsApi(api_client)
    target_folder_key = 'target_folder_key_example' # str | Folder key, unique identifier.

    try:
        # Folder export
        api_response = api_instance.create_backup(target_folder_key)
        print("The response of BackupsApi->create_backup:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BackupsApi->create_backup: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.edge7.veeroute.cloud

Class Method HTTP request Description
BackupsApi create_backup POST /monitor/backups/{target_folder_key} Folder export
BackupsApi restore_backup PUT /monitor/backups/{target_folder_key} Folder import
CrewsApi create_crew POST /monitor/crews Crew creation
CrewsApi delete_crew DELETE /monitor/crews/{crew_key} Crew removal
CrewsApi delete_crews_batch DELETE /monitor/crews/table/batch Crews removal (batch)
CrewsApi read_crew GET /monitor/crews/{crew_key} Getting crew information
CrewsApi read_crews_geopoints POST /monitor/crews/table/geopoints Crew geopoints
CrewsApi read_crews_table POST /monitor/crews/table/batch Reading crews (table)
CrewsApi read_self_info GET /monitor/crews/self/info Self crew information
CrewsApi update_crew PUT /monitor/crews Crew update
CustomFieldsApi create_customfields_settings POST /monitor/settings/customfields/{settings_key} Create fields settings
CustomFieldsApi delete_customfields_settings DELETE /monitor/settings/customfields/{settings_key} Delete fields settings
CustomFieldsApi list_customfields_settings GET /monitor/settings/customfields Reading fields settings list
CustomFieldsApi read_customfields_settings GET /monitor/settings/customfields/{settings_key} Reading fields settings
CustomFieldsApi set_customfields_settings_active_key POST /monitor/settings/customfields Setting the active customfields key
CustomFieldsApi update_customfields_settings PUT /monitor/settings/customfields/{settings_key} Update fields settings
CustomIconsApi create_customicons_settings POST /monitor/settings/customicons/{settings_key} Update icons settings
CustomIconsApi delete_customicons_settings DELETE /monitor/settings/customicons/{settings_key} Delete icons settings
CustomIconsApi list_customicons_settings GET /monitor/settings/customicons Reading icons settings list
CustomIconsApi read_customicons_settings GET /monitor/settings/customicons/{settings_key} Reading icons settings
CustomIconsApi set_customicons_settings_active_key POST /monitor/settings/customicons Setting the active customicons key
CustomIconsApi update_customicons_settings PUT /monitor/settings/customicons/{settings_key} Update icons settings
DealsApi create_deal POST /monitor/deals Deal creation
DealsApi delete_deal DELETE /monitor/deals/{deal_key} Deal removal
DealsApi read_deal GET /monitor/deals/{deal_key} Getting deal information
DealsApi read_self_trips GET /monitor/deals/self/trips Self crew trips
DealsApi update_deal PUT /monitor/deals Deal update
ExplorerApi create_folder POST /monitor/explorer Create folder
ExplorerApi create_folders_batch POST /monitor/explorer/batch/folders Create folders (batch)
ExplorerApi delete_files_batch DELETE /monitor/explorer/batch/files Files removal (batch)
ExplorerApi delete_folder DELETE /monitor/explorer/{target_folder_key} Folder removal
ExplorerApi delete_folders_batch DELETE /monitor/explorer/batch/folders Folders removal (batch)
ExplorerApi read_file_key GET /monitor/explorer/batch/files File key
ExplorerApi read_filesystem GET /monitor/explorer Getting a filesystem
ExplorerApi read_filesystem_counters GET /monitor/explorer/batch/counters Filesystem counters
ExplorerApi read_folder_key POST /monitor/explorer/batch/folder-key Folder key
ExplorerApi read_folder_path GET /monitor/explorer/{target_folder_key}/path Folder path
ExplorerApi read_folder_specification GET /monitor/explorer/{target_folder_key}/specification Folder specification
ExplorerApi update_folder PUT /monitor/explorer/{target_folder_key} Update folder
FactsApi create_fact POST /monitor/waves/{file_key}/facts Create fact
FactsApi delete_fact DELETE /monitor/waves/{file_key}/facts/{essence_key} Deleting one fact
FactsApi delete_facts_batch DELETE /monitor/waves/{file_key}/facts/batch/table Delete facts (batch)
FactsApi disable_facts_batch DELETE /monitor/waves/{file_key}/facts/batch/ability Disable facts
FactsApi enable_facts_batch PUT /monitor/waves/{file_key}/facts/batch/ability Enable facts
FactsApi read_fact GET /monitor/waves/{file_key}/facts/{essence_key} Read fact
FactsApi read_facts_metrics POST /monitor/waves/{file_key}/facts/batch/metrics Fact metrics
FactsApi read_facts_table POST /monitor/waves/{file_key}/facts/batch/table List of facts
FactsApi update_fact PUT /monitor/waves/{file_key}/facts Update fact
HardlinksApi create_hardlink POST /monitor/waves/{file_key}/hardlinks Create hardlink
HardlinksApi delete_hardlink DELETE /monitor/waves/{file_key}/hardlinks/{essence_key} Remove hardlink
HardlinksApi delete_hardlinks_batch DELETE /monitor/waves/{file_key}/hardlinks/batch/table Delete hardlinks (batch)
HardlinksApi disable_hardlinks_batch DELETE /monitor/waves/{file_key}/hardlinks/batch/ability Disable hardlinks
HardlinksApi enable_hardlinks_batch PUT /monitor/waves/{file_key}/hardlinks/batch/ability Enable hardlinks
HardlinksApi read_hardlink GET /monitor/waves/{file_key}/hardlinks/{essence_key} Read hardlink
HardlinksApi read_hardlinks_metrics POST /monitor/waves/{file_key}/hardlinks/batch/metrics Hardlink metrics
HardlinksApi read_hardlinks_table POST /monitor/waves/{file_key}/hardlinks/batch/table List hardlinks
HardlinksApi update_hardlink PUT /monitor/waves/{file_key}/hardlinks Update hardlink
LocationsApi create_location POST /monitor/waves/{file_key}/locations Create location
LocationsApi delete_location DELETE /monitor/waves/{file_key}/locations/{essence_key} Remove location
LocationsApi delete_locations_batch DELETE /monitor/waves/{file_key}/locations/batch/table Delete locations (batch)
LocationsApi read_location GET /monitor/waves/{file_key}/locations/{essence_key} Read location
LocationsApi read_locations_geopoints POST /monitor/waves/{file_key}/locations/batch/geopoints Location geopoints
LocationsApi read_locations_metrics POST /monitor/waves/{file_key}/locations/batch/metrics Location metrics
LocationsApi read_locations_table POST /monitor/waves/{file_key}/locations/batch/table Locations list
LocationsApi update_location PUT /monitor/waves/{file_key}/locations Update location
OrdersApi create_order POST /monitor/waves/{file_key}/orders Create order
OrdersApi delete_order DELETE /monitor/waves/{file_key}/orders/{essence_key} Deleting one order
OrdersApi delete_orders_batch DELETE /monitor/waves/{file_key}/orders/batch/table Delete orders (batch)
OrdersApi disable_orders_batch DELETE /monitor/waves/{file_key}/orders/batch/ability Disable orders
OrdersApi enable_orders_batch PUT /monitor/waves/{file_key}/orders/batch/ability Enable orders
OrdersApi read_order GET /monitor/waves/{file_key}/orders/{essence_key} Reading order
OrdersApi read_orders_geopoints POST /monitor/waves/{file_key}/orders/batch/geopoints Order geopoints
OrdersApi read_orders_metrics POST /monitor/waves/{file_key}/orders/batch/metrics Order metrics
OrdersApi read_orders_table POST /monitor/waves/{file_key}/orders/batch/table List orders
OrdersApi update_order PUT /monitor/waves/{file_key}/orders Update order
PerformersApi create_performer POST /monitor/waves/{file_key}/performers Create performer
PerformersApi delete_performer DELETE /monitor/waves/{file_key}/performers/{essence_key} Remove performer
PerformersApi delete_performers_batch DELETE /monitor/waves/{file_key}/performers/batch/table Delete performers (batch)
PerformersApi disable_performers_batch DELETE /monitor/waves/{file_key}/performers/batch/ability Disable performers
PerformersApi enable_performers_batch PUT /monitor/waves/{file_key}/performers/batch/ability Enable performers
PerformersApi read_performer GET /monitor/waves/{file_key}/performers/{essence_key} Read performer
PerformersApi read_performers_geopoints POST /monitor/waves/{file_key}/performers/batch/geopoints Performer geopoints
PerformersApi read_performers_metrics POST /monitor/waves/{file_key}/performers/batch/metrics Performer metrics
PerformersApi read_performers_table POST /monitor/waves/{file_key}/performers/batch/table Performers list
PerformersApi update_performer PUT /monitor/waves/{file_key}/performers Update performer
SystemApi check GET /monitor/system/check Checking the availability
SystemApi file GET /monitor/file/{filename} Getting the documentation
SystemApi version GET /monitor/system/version Getting the service version
TransportsApi create_transport POST /monitor/waves/{file_key}/transports Create transport
TransportsApi delete_transport DELETE /monitor/waves/{file_key}/transports/{essence_key} Remove transport
TransportsApi delete_transports_batch DELETE /monitor/waves/{file_key}/transports/batch/table Delete transports (batch)
TransportsApi disable_transports_batch DELETE /monitor/waves/{file_key}/transports/batch/ability Disable transports
TransportsApi enable_transports_batch PUT /monitor/waves/{file_key}/transports/batch/ability Enable transports
TransportsApi read_transport GET /monitor/waves/{file_key}/transports/{essence_key} Reading transport
TransportsApi read_transports_geopoints POST /monitor/waves/{file_key}/transports/batch/geopoints Transport geopoints
TransportsApi read_transports_metrics POST /monitor/waves/{file_key}/transports/batch/metrics Transport metrics
TransportsApi read_transports_table POST /monitor/waves/{file_key}/transports/batch/table Transport list
TransportsApi update_transport PUT /monitor/waves/{file_key}/transports Update transport
TripsApi create_trip POST /monitor/waves/{file_key}/trips Trip create
TripsApi delete_custom_tracks DELETE /monitor/waves/{file_key}/trips/batch/tracks-custom Remove custom tracks
TripsApi delete_trip DELETE /monitor/waves/{file_key}/trips/{essence_key} Delete trip
TripsApi delete_trips_batch DELETE /monitor/waves/{file_key}/trips/batch/table Delete trips (batch)
TripsApi exec_trips_batch POST /monitor/waves/{file_key}/trips/actions/exec Run trips (batch)
TripsApi load_custom_tracks POST /monitor/waves/{file_key}/trips/batch/tracks-custom Load custom tracks
TripsApi read_roundtrips_metrics POST /monitor/waves/{file_key}/roundtrips/batch/metrics Roundrips metrics
TripsApi read_roundtrips_table POST /monitor/waves/{file_key}/roundtrips/batch/table Reading roundrips (table)
TripsApi read_trip GET /monitor/waves/{file_key}/trips/{essence_key} Read trip
TripsApi read_trip_available_crews POST /monitor/waves/{file_key}/trips/{essence_key}/crews/available Read available crews
TripsApi read_trip_orders GET /monitor/waves/{file_key}/trips/{essence_key}/orders/batch/mobile Orders from trip
TripsApi read_trip_stops POST /monitor/waves/{file_key}/trips/{essence_key}/stops/batch/table Trip stops list
TripsApi read_trips_charts POST /monitor/waves/{file_key}/trips/batch/charts Trips chart
TripsApi read_trips_metrics POST /monitor/waves/{file_key}/trips/batch/metrics Trips metrics
TripsApi read_trips_table POST /monitor/waves/{file_key}/trips/batch/table Reading trips (table)
TripsApi read_trips_tracks POST /monitor/waves/{file_key}/trips/batch/tracks/{tracks_type} Trip tracks
TripsApi stop_trips_batch DELETE /monitor/waves/{file_key}/trips/actions/exec Stop trips (batch)
TripsApi update_trip PUT /monitor/waves/{file_key}/trips Trip update
UserApi create_user_settings POST /monitor/settings/user/{settings_key} Create user settings
UserApi delete_user_settings DELETE /monitor/settings/user/{settings_key} Delete user settings
UserApi list_user_settings GET /monitor/settings/user Reading user settings list
UserApi read_user_settings GET /monitor/settings/user/{settings_key} Reading user settings
UserApi set_user_settings_active_key POST /monitor/settings/user Setting the active user settings key
UserApi update_user_settings PUT /monitor/settings/user/{settings_key} Update user settings
WavesApi create_wave POST /monitor/waves Create wave
WavesApi delete_wave DELETE /monitor/waves/{file_key} Wave removal
WavesApi duplicate_wave POST /monitor/waves/{file_key}/actions/duplicate Wave duplicate
WavesApi export_json POST /monitor/waves/{file_key}/actions/export/json Export (JSON)
WavesApi export_xlsx POST /monitor/waves/{file_key}/actions/export/xlsx Export (XLSX)
WavesApi import_json POST /monitor/waves/{file_key}/actions/import/json Import (JSON)
WavesApi import_xlsx POST /monitor/waves/{file_key}/actions/import/xlsx Import (XLSX)
WavesApi read_wave GET /monitor/waves/{file_key} Reading wave
WavesApi read_wave_path GET /monitor/waves/{file_key}/actions/locate Wave path
WavesApi read_waves_table GET /monitor/waves/batch/table Waves list (table)
WavesApi search_waves GET /monitor/waves/batch/search Wave search
WavesApi update_wave_specification PUT /monitor/waves/{file_key} Wave update

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: Bearer authentication (JWT)

Author

servicedesk@veeroute.com

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for veeroute from gravatar.com veeroute

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Proprietary
  • Author: Veeroute Support Team
  • Tags OpenAPI , VRt.Monitor [MT]
  • Requires: Python >=3.9

Release history Release notifications | RSS feed

7.38.3336

7.37.3331

7.36.3317

7.35.3290

7.34.3275

7.33.3222

7.32.3215

This version

7.31.3182

7.30.3153

7.29.3120

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vrt_lss_monitor-7.31.3182-py3-none-any.whl (764.9 kB view details)

Uploaded Python 3

File details

Details for the file vrt_lss_monitor-7.31.3182-py3-none-any.whl.

File metadata

File hashes

Hashes for vrt_lss_monitor-7.31.3182-py3-none-any.whl
Algorithm Hash digest
SHA256 f23b045c9ae91100dc3819744da75e39d9087bcea1b4edc7430c23a5e757c150
MD5 af35d5cca03e69bbdbd0773d4779f199
BLAKE2b-256 8fd8c5395ec6f9460c5eb9f6afd54d1520b3513bef6ee8c108cbcc10b348cbcb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page