Metadata-Version: 2.4
Name: vrt_lss_universal
Version: 7.42.3498
Summary: VRt.Universal [UV]
Home-page: 
Author: Veeroute Support Team
Author-email: Veeroute Support Team <support@veeroute.com>
License: Proprietary
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,VRt.Universal [UV]
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# vrt_lss_universal

- API version: 7.42.3498
- Package version: 7.42.3498
- Build date: 2026-09-07T18:25:41.201136840+03:00[Europe/Moscow]
- Generator version: 7.17.0

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

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

```sh
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:
```python
import vrt_lss_universal
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import vrt_lss_universal
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import vrt_lss_universal
from vrt_lss_universal.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_universal.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_universal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with vrt_lss_universal.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vrt_lss_universal.ConvertApi(api_client)
    universal_data = vrt_lss_universal.UniversalData() # UniversalData | Conversion request to the THRIFT.

    try:
        # JSON >> THRIFT
        api_response = api_instance.run_convert_json_to_thrift(universal_data)
        print("The response of ConvertApi->run_convert_json_to_thrift:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ConvertApi->run_convert_json_to_thrift: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ConvertApi* | [**run_convert_json_to_thrift**](docs/ConvertApi.md#run_convert_json_to_thrift) | **POST** /universal/convert/json-to-thrift | JSON &gt;&gt; THRIFT
*ConvertApi* | [**run_convert_json_to_xlsx**](docs/ConvertApi.md#run_convert_json_to_xlsx) | **POST** /universal/convert/json-to-xlsx | JSON &gt;&gt; XLSX
*ConvertApi* | [**run_convert_xlsx_to_json**](docs/ConvertApi.md#run_convert_xlsx_to_json) | **POST** /universal/convert/xlsx-to-json | XLSX &gt;&gt; JSON
*PlanApi* | [**cancel_plan_calculation**](docs/PlanApi.md#cancel_plan_calculation) | **DELETE** /universal/plan/calculation-async/{process_code} | Cancel calculation
*PlanApi* | [**delete_plan_result**](docs/PlanApi.md#delete_plan_result) | **DELETE** /universal/plan/result/{process_code} | Result removal
*PlanApi* | [**generate_plan_statistics**](docs/PlanApi.md#generate_plan_statistics) | **POST** /universal/plan/statistics | Calculation of statistics on trips
*PlanApi* | [**read_plan_result**](docs/PlanApi.md#read_plan_result) | **GET** /universal/plan/result/{process_code} | Getting the result
*PlanApi* | [**read_plan_state**](docs/PlanApi.md#read_plan_state) | **GET** /universal/plan/state/{process_code} | Calculation state
*PlanApi* | [**run_plan_calculation**](docs/PlanApi.md#run_plan_calculation) | **POST** /universal/plan/calculation | Planning (SYNC)
*PlanApi* | [**run_plan_calculation_async**](docs/PlanApi.md#run_plan_calculation_async) | **POST** /universal/plan/calculation-async | Planning (ASYNC)
*PlanApi* | [**run_plan_refine**](docs/PlanApi.md#run_plan_refine) | **POST** /universal/plan/refine | Data refine
*PlanApi* | [**run_plan_validation**](docs/PlanApi.md#run_plan_validation) | **POST** /universal/plan/validation | Data validation
*ReplanApi* | [**cancel_replan_calculation**](docs/ReplanApi.md#cancel_replan_calculation) | **DELETE** /universal/replan/calculation-async/{process_code} | Cancel calculation
*ReplanApi* | [**delete_replan_result**](docs/ReplanApi.md#delete_replan_result) | **DELETE** /universal/replan/result/{process_code} | Result removal
*ReplanApi* | [**read_replan_result**](docs/ReplanApi.md#read_replan_result) | **GET** /universal/replan/result/{process_code} | Getting the result
*ReplanApi* | [**read_replan_state**](docs/ReplanApi.md#read_replan_state) | **GET** /universal/replan/state/{process_code} | Calculation state
*ReplanApi* | [**run_replan_calculation**](docs/ReplanApi.md#run_replan_calculation) | **POST** /universal/replan/calculation | Replanning (SYNC)
*ReplanApi* | [**run_replan_calculation_async**](docs/ReplanApi.md#run_replan_calculation_async) | **POST** /universal/replan/calculation-async | Replanning (ASYNC)
*ReplanApi* | [**run_replan_refine**](docs/ReplanApi.md#run_replan_refine) | **POST** /universal/replan/refine | Data refine
*ReplanApi* | [**run_replan_validation**](docs/ReplanApi.md#run_replan_validation) | **POST** /universal/replan/validation | Data validation
*SystemApi* | [**check**](docs/SystemApi.md#check) | **GET** /universal/system/check | Checking the availability
*SystemApi* | [**file**](docs/SystemApi.md#file) | **GET** /universal/file/{filename} | Getting the documentation
*SystemApi* | [**version**](docs/SystemApi.md#version) | **GET** /universal/system/version | Getting the service version


## Documentation For Models

 - [ActualizeSettings](docs/ActualizeSettings.md)
 - [AdditionalAttributes](docs/AdditionalAttributes.md)
 - [AdditionalAttributesElement](docs/AdditionalAttributesElement.md)
 - [AssignedPerformer](docs/AssignedPerformer.md)
 - [AssignedTransport](docs/AssignedTransport.md)
 - [Attribute](docs/Attribute.md)
 - [Box](docs/Box.md)
 - [BoxCompatibilities](docs/BoxCompatibilities.md)
 - [BoxLimits](docs/BoxLimits.md)
 - [BreakRules](docs/BreakRules.md)
 - [CalculationAsyncResult](docs/CalculationAsyncResult.md)
 - [CalculationInfo](docs/CalculationInfo.md)
 - [CalculationSettings](docs/CalculationSettings.md)
 - [CalculationState](docs/CalculationState.md)
 - [CalculationStatus](docs/CalculationStatus.md)
 - [Capacity](docs/Capacity.md)
 - [CapacityCost](docs/CapacityCost.md)
 - [CapacityLimit](docs/CapacityLimit.md)
 - [CapacityMultiplier](docs/CapacityMultiplier.md)
 - [CapacityStatisticsLoad](docs/CapacityStatisticsLoad.md)
 - [CapacityStatisticsRatio](docs/CapacityStatisticsRatio.md)
 - [CapacityStatisticsSum](docs/CapacityStatisticsSum.md)
 - [Cargo](docs/Cargo.md)
 - [CargoAction](docs/CargoAction.md)
 - [CargoActionType](docs/CargoActionType.md)
 - [CargoCompatibilities](docs/CargoCompatibilities.md)
 - [CargoInvoice](docs/CargoInvoice.md)
 - [CargoInvoiceDetail](docs/CargoInvoiceDetail.md)
 - [CargoInvoiceHonestSign](docs/CargoInvoiceHonestSign.md)
 - [CargoInvoiceReceipt](docs/CargoInvoiceReceipt.md)
 - [CargoInvoiceTax](docs/CargoInvoiceTax.md)
 - [CargoInvoiceWaybill](docs/CargoInvoiceWaybill.md)
 - [CargoInvoiceWaybillStatus](docs/CargoInvoiceWaybillStatus.md)
 - [CargoRotationType](docs/CargoRotationType.md)
 - [CheckResult](docs/CheckResult.md)
 - [CompatibilityPenalty](docs/CompatibilityPenalty.md)
 - [Demand](docs/Demand.md)
 - [DemandExtraDuration](docs/DemandExtraDuration.md)
 - [DemandType](docs/DemandType.md)
 - [EntityError](docs/EntityError.md)
 - [EntityErrorType](docs/EntityErrorType.md)
 - [EntityPath](docs/EntityPath.md)
 - [EntityType](docs/EntityType.md)
 - [EntityWarning](docs/EntityWarning.md)
 - [EntityWarningType](docs/EntityWarningType.md)
 - [ExtensionSettings](docs/ExtensionSettings.md)
 - [Fact](docs/Fact.md)
 - [FactLore](docs/FactLore.md)
 - [FactResult](docs/FactResult.md)
 - [FactStatus](docs/FactStatus.md)
 - [FactStatusError](docs/FactStatusError.md)
 - [FactType](docs/FactType.md)
 - [FeatureLifetime](docs/FeatureLifetime.md)
 - [General402](docs/General402.md)
 - [General403](docs/General403.md)
 - [General404](docs/General404.md)
 - [General404Detail](docs/General404Detail.md)
 - [General429](docs/General429.md)
 - [General500](docs/General500.md)
 - [GeneralStatistics](docs/GeneralStatistics.md)
 - [GeoSettings](docs/GeoSettings.md)
 - [Geopoint](docs/Geopoint.md)
 - [Hardlink](docs/Hardlink.md)
 - [HardlinkElement](docs/HardlinkElement.md)
 - [HardlinkElementType](docs/HardlinkElementType.md)
 - [LoadStatistics](docs/LoadStatistics.md)
 - [Location](docs/Location.md)
 - [LocationCargosLimit](docs/LocationCargosLimit.md)
 - [LocationCompatibilities](docs/LocationCompatibilities.md)
 - [LocationLimit](docs/LocationLimit.md)
 - [LocationLimitStatistics](docs/LocationLimitStatistics.md)
 - [LocationStatistics](docs/LocationStatistics.md)
 - [LocationTimetableElement](docs/LocationTimetableElement.md)
 - [LocationTransportsLimit](docs/LocationTransportsLimit.md)
 - [LoreDemandCanceled](docs/LoreDemandCanceled.md)
 - [LoreDemandDone](docs/LoreDemandDone.md)
 - [LoreDemandPayment](docs/LoreDemandPayment.md)
 - [LoreDemandStart](docs/LoreDemandStart.md)
 - [LoreGeotrackUpdated](docs/LoreGeotrackUpdated.md)
 - [LoreJobDone](docs/LoreJobDone.md)
 - [LoreOrderCanceled](docs/LoreOrderCanceled.md)
 - [LoreOrderDone](docs/LoreOrderDone.md)
 - [LoreTripPrecedenceChanged](docs/LoreTripPrecedenceChanged.md)
 - [Measurements](docs/Measurements.md)
 - [ModelBreak](docs/ModelBreak.md)
 - [Order](docs/Order.md)
 - [OrderCompatibilities](docs/OrderCompatibilities.md)
 - [OrderResult](docs/OrderResult.md)
 - [OrderStatus](docs/OrderStatus.md)
 - [PaymentDetails](docs/PaymentDetails.md)
 - [Performer](docs/Performer.md)
 - [PerformerCompatibilities](docs/PerformerCompatibilities.md)
 - [PerformerLimits](docs/PerformerLimits.md)
 - [PerformerShift](docs/PerformerShift.md)
 - [PerformerTariff](docs/PerformerTariff.md)
 - [PerformerTariffConstraint](docs/PerformerTariffConstraint.md)
 - [PlanResult](docs/PlanResult.md)
 - [PlanSettings](docs/PlanSettings.md)
 - [PlanStatistics](docs/PlanStatistics.md)
 - [PlanTask](docs/PlanTask.md)
 - [PossibleEvent](docs/PossibleEvent.md)
 - [PossibleEventContact](docs/PossibleEventContact.md)
 - [ProcessedItems](docs/ProcessedItems.md)
 - [ProductConclusion](docs/ProductConclusion.md)
 - [ProductConclusionType](docs/ProductConclusionType.md)
 - [Quality](docs/Quality.md)
 - [RefineResult](docs/RefineResult.md)
 - [RemovedItems](docs/RemovedItems.md)
 - [ReplanResult](docs/ReplanResult.md)
 - [ReplanSettings](docs/ReplanSettings.md)
 - [ReplanStrategy](docs/ReplanStrategy.md)
 - [ReplanTask](docs/ReplanTask.md)
 - [Rest](docs/Rest.md)
 - [RestRules](docs/RestRules.md)
 - [RoundtripStatistics](docs/RoundtripStatistics.md)
 - [RoutingMatrix](docs/RoutingMatrix.md)
 - [RoutingMatrixWaypoint](docs/RoutingMatrixWaypoint.md)
 - [RoutingTransportMatrix](docs/RoutingTransportMatrix.md)
 - [SchemaError](docs/SchemaError.md)
 - [Service](docs/Service.md)
 - [StatisticsTask](docs/StatisticsTask.md)
 - [StopDemand](docs/StopDemand.md)
 - [StopStatistics](docs/StopStatistics.md)
 - [TaskStatistics](docs/TaskStatistics.md)
 - [TimeWindow](docs/TimeWindow.md)
 - [TimeWindowViolationDetail](docs/TimeWindowViolationDetail.md)
 - [TimeWindowViolations](docs/TimeWindowViolations.md)
 - [Tracedata](docs/Tracedata.md)
 - [Trackpoint](docs/Trackpoint.md)
 - [Transport](docs/Transport.md)
 - [TransportCapacityMultiplier](docs/TransportCapacityMultiplier.md)
 - [TransportCompatibilities](docs/TransportCompatibilities.md)
 - [TransportLimits](docs/TransportLimits.md)
 - [TransportLoad](docs/TransportLoad.md)
 - [TransportShift](docs/TransportShift.md)
 - [TransportSpeedMultiplier](docs/TransportSpeedMultiplier.md)
 - [TransportTariff](docs/TransportTariff.md)
 - [TransportTariffConstraint](docs/TransportTariffConstraint.md)
 - [TransportType](docs/TransportType.md)
 - [Trip](docs/Trip.md)
 - [TripAssumptions](docs/TripAssumptions.md)
 - [TripDemandPrecedence](docs/TripDemandPrecedence.md)
 - [TripExpectations](docs/TripExpectations.md)
 - [TripPenalties](docs/TripPenalties.md)
 - [TripStartTimeStrategy](docs/TripStartTimeStrategy.md)
 - [TripState](docs/TripState.md)
 - [TripStateFlag](docs/TripStateFlag.md)
 - [TripStatistics](docs/TripStatistics.md)
 - [TripStatus](docs/TripStatus.md)
 - [TripsSettings](docs/TripsSettings.md)
 - [Universal400WithErrorsAndWarnings](docs/Universal400WithErrorsAndWarnings.md)
 - [UniversalData](docs/UniversalData.md)
 - [UnplannedItems](docs/UnplannedItems.md)
 - [ValidateResult](docs/ValidateResult.md)
 - [VersionResult](docs/VersionResult.md)
 - [WorkAndRestRules](docs/WorkAndRestRules.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth

- **Type**: Bearer authentication (JWT)


## Author

support@veeroute.com


