Metadata-Version: 2.4
Name: vrt_lss_account
Version: 7.37.3331
Summary: VRt.Account [AC]
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.Account [AC]
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_account
# Description

Veeroute Account Panel.

## Usage metrics

Service usage metrics are computed for each client and for each process type. They can be retrieved from the personal cabinet or via the [api method](#operation/generate_statistics).

The metrics are described by the following object:

<SchemaDefinition schemaRef=\"#/components/schemas/process_statistics\" />

## Entity diagram

![erd](../uml/account.svg)


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 7.37.3331
- Package version: 7.37.3331
- 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:

```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_account
```

### 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_account
```

### 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_account
from vrt_lss_account.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_account.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_account.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with vrt_lss_account.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vrt_lss_account.AuditApi(api_client)
    offset = 0 # int | The number of items to skip before starting to collect the result set. (optional) (default to 0)
    limit = 100 # int | The number of items to return. (optional) (default to 100)
    var_from = '2026-04-21T09:30:00+03:00' # datetime | Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. If no datetime is specified, audit data are returned from the beginning of the day.  (optional)
    to = '2026-04-21T18:00:00+03:00' # datetime | Date and time in the [ISO 8601](https://tools.ietf.org/html/rfc3339#section-5.6) format. If not specified, data up to the current time is returned.  (optional)
    service = vrt_lss_account.Service() # Service | Service name. (optional)
    operation = 'operation_example' # str | Operation name. (optional)
    process_type = vrt_lss_account.ProcessType() # ProcessType | Process type. (optional)
    status = vrt_lss_account.CalculationStatus() # CalculationStatus | Process status. (optional)
    sort_field = 'name' # str | Field to sort by. (optional)
    sort_direction = ASC # str | Sort direction. (optional) (default to ASC)

    try:
        # Actions for the period
        api_response = api_instance.read_audit(offset=offset, limit=limit, var_from=var_from, to=to, service=service, operation=operation, process_type=process_type, status=status, sort_field=sort_field, sort_direction=sort_direction)
        print("The response of AuditApi->read_audit:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuditApi->read_audit: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuditApi* | [**read_audit**](docs/AuditApi.md#read_audit) | **GET** /account/audit | Actions for the period
*AuthApi* | [**change_password**](docs/AuthApi.md#change_password) | **POST** /account/password | Change password
*AuthApi* | [**run_token_generation**](docs/AuthApi.md#run_token_generation) | **POST** /account/token/generation | Obtaining a token
*AuthApi* | [**run_token_validation**](docs/AuthApi.md#run_token_validation) | **POST** /account/token/validation | Validating a token
*DataApi* | [**read_data**](docs/DataApi.md#read_data) | **GET** /account/data/{process_code} | Reading input data
*InfoApi* | [**read_info**](docs/InfoApi.md#read_info) | **GET** /account/info | Account information
*InfoApi* | [**update_info**](docs/InfoApi.md#update_info) | **PUT** /account/info | Account update
*QuotaApi* | [**read_quota**](docs/QuotaApi.md#read_quota) | **GET** /account/quota | Obtaining the quotas
*StatisticsApi* | [**generate_report**](docs/StatisticsApi.md#generate_report) | **GET** /account/report | Report creating
*StatisticsApi* | [**generate_statistics**](docs/StatisticsApi.md#generate_statistics) | **GET** /account/statistics | Statistics for the period
*SystemApi* | [**check**](docs/SystemApi.md#check) | **GET** /account/system/check | Checking the availability
*SystemApi* | [**file**](docs/SystemApi.md#file) | **GET** /account/file/{filename} | Getting the documentation
*SystemApi* | [**version**](docs/SystemApi.md#version) | **GET** /account/system/version | Getting the service version


## Documentation For Models

 - [AccountAuditResult](docs/AccountAuditResult.md)
 - [Attribute](docs/Attribute.md)
 - [AuditAction](docs/AuditAction.md)
 - [AuditActionStatistics](docs/AuditActionStatistics.md)
 - [AuditCounters](docs/AuditCounters.md)
 - [AuditCountersDetail](docs/AuditCountersDetail.md)
 - [CalculationInfo](docs/CalculationInfo.md)
 - [CalculationStatus](docs/CalculationStatus.md)
 - [CheckResult](docs/CheckResult.md)
 - [DateStatistics](docs/DateStatistics.md)
 - [FlowStage](docs/FlowStage.md)
 - [FlowType](docs/FlowType.md)
 - [General400](docs/General400.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)
 - [InfoChangeRequest](docs/InfoChangeRequest.md)
 - [PasswordChangeRequest](docs/PasswordChangeRequest.md)
 - [ProcessQuota](docs/ProcessQuota.md)
 - [ProcessStatistics](docs/ProcessStatistics.md)
 - [ProcessType](docs/ProcessType.md)
 - [QuotaBase](docs/QuotaBase.md)
 - [QuotasResult](docs/QuotasResult.md)
 - [SchemaError](docs/SchemaError.md)
 - [Service](docs/Service.md)
 - [ServiceQuota](docs/ServiceQuota.md)
 - [ServiceStatistics](docs/ServiceStatistics.md)
 - [TokenRequest](docs/TokenRequest.md)
 - [TokenValidationResult](docs/TokenValidationResult.md)
 - [Tracedata](docs/Tracedata.md)
 - [User](docs/User.md)
 - [UserRole](docs/UserRole.md)
 - [UserStatistics](docs/UserStatistics.md)
 - [VersionResult](docs/VersionResult.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


