reportr-backend-client 0.0.1741447097.dev0

backend

reportr-backend-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

• API version: 0.1.0
• Package version: 1.0.0
• Generator version: 7.13.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

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 reportr_backend_client

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 reportr_backend_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import reportr_backend_client
from reportr_backend_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = reportr_backend_client.Configuration(
    host = "http://localhost"
)

# 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: HTTPBearer
configuration = reportr_backend_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with reportr_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = reportr_backend_client.EventsApi(api_client)
    user_id = 'user_id_example' # str |  (optional)
    news_id = 56 # int |  (optional)
    event_type = 'event_type_example' # str |  (optional)
    page = 1 # int |  (optional) (default to 1)
    page_size = 20 # int |  (optional) (default to 20)

    try:
        # Get Events
        api_response = api_instance.get_events(user_id=user_id, news_id=news_id, event_type=event_type, page=page, page_size=page_size)
        print("The response of EventsApi->get_events:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling EventsApi->get_events: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
EventsApi	get_events	GET /events/	Get Events
EventsApi	insert_event	POST /events/	Insert Event
NewsApi	create_news	POST /news/	Create News
NewsApi	get_news	GET /news/	Get News
NewsApi	get_news_by_id	GET /news/{news_id}	Get News By Id
StatusApi	get_health	GET /health	Health
StatusApi	get_readiness	GET /ready	Ready

Documentation For Models

• EventCreate
• EventCreated
• EventRead
• HTTPValidationError
• Health
• NewsItem
• NewsItemCreated
• PaginatedResponseEventRead
• PaginatedResponseNewsItem
• Readiness
• TimeFilter
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication

Author