onelive-vgst 0.1.14

OneLive VGST API

onelive-vgst

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.14
• Package version: 0.1.14
• Generator version: 7.19.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 onelive_vgst

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 onelive_vgst

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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


# Enter a context with an instance of the API client
async with onelive_vgst.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelive_vgst.ApiKeysApi(api_client)
    api_key_create = onelive_vgst.ApiKeyCreate() # ApiKeyCreate | 

    try:
        # Create Api Key
        api_response = await api_instance.create_api_key_v1_api_keys_post(api_key_create)
        print("The response of ApiKeysApi->create_api_key_v1_api_keys_post:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiKeysApi->create_api_key_v1_api_keys_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ApiKeysApi	create_api_key_v1_api_keys_post	POST /v1/api-keys	Create Api Key
ApiKeysApi	get_api_key_guide_v1_api_keys_guide_get	GET /v1/api-keys/guide	Get API key guide
ApiKeysApi	get_api_key_info_v1_api_keys_me_get	GET /v1/api-keys/me	Get API key info
ApiKeysApi	get_api_key_v1_api_keys_api_key_id_get	GET /v1/api-keys/{api_key_id}	Get Api Key
ApiKeysApi	list_api_keys_v1_api_keys_get	GET /v1/api-keys	List Api Keys
ApiKeysApi	revoke_api_key_v1_api_keys_api_key_id_delete	DELETE /v1/api-keys/{api_key_id}	Revoke Api Key
BroadcastRedirectsApi	redirect_to_broadcast_v1_broadcasts_redirect_get	GET /v1/broadcasts/redirect	Redirect To Broadcast
BroadcastRedirectsApi	update_broadcast_v1_broadcasts_broadcast_id_patch	PATCH /v1/broadcasts/{broadcast_id}	Update broadcast
CustomerBlacklistsApi	create_blacklist_rule_v1_customers_customer_id_blacklists_post	POST /v1/customers/{customer_id}/blacklists	Create Blacklist Rule
CustomerBlacklistsApi	delete_blacklist_rule_v1_customers_customer_id_blacklists_rule_id_delete	DELETE /v1/customers/{customer_id}/blacklists/{rule_id}	Delete Blacklist Rule
CustomerBlacklistsApi	get_blacklist_audits_v1_customers_customer_id_blacklists_audits_all_get	GET /v1/customers/{customer_id}/blacklists/audits/all	Get Blacklist Audits
CustomerBlacklistsApi	get_blacklist_rules_v1_customers_customer_id_blacklists_get	GET /v1/customers/{customer_id}/blacklists	Get Blacklist Rules
CustomerBlacklistsApi	update_blacklist_rule_v1_customers_customer_id_blacklists_rule_id_put	PUT /v1/customers/{customer_id}/blacklists/{rule_id}	Update Blacklist Rule
CustomerMatchesApi	get_customer_match_broadcasts_v1_customer_matches_broadcasts_get	GET /v1/customer_matches/broadcasts	Get customer match broadcasts
CustomerMatchesApi	get_customer_match_by_id_v1_customer_matches_customer_match_id_get	GET /v1/customer_matches/{customer_match_id}	Get customer match by id
CustomerMatchesApi	get_customer_match_statistics_v1_customer_matches_statistics_get	GET /v1/customer_matches/statistics	Get customer match statistics
CustomerMatchesApi	get_customer_matches_v1_customer_matches_get	GET /v1/customer_matches	Get customer matches
CustomerMatchesApi	update_customer_match_v1_customer_matches_customer_match_id_patch	PATCH /v1/customer_matches/{customer_match_id}	Update customer match
CustomerMatchesApi	upsert_customer_matches_bulk_v1_customer_matches_bulk_post	POST /v1/customer_matches/bulk	Upsert Customer Matches Bulk
CustomersApi	create_customer_v1_customers_post	POST /v1/customers	Create Customer
CustomersApi	delete_customer_v1_customers_customer_id_delete	DELETE /v1/customers/{customer_id}	Delete Customer
CustomersApi	get_customer_v1_customers_customer_id_get	GET /v1/customers/{customer_id}	Get Customer
CustomersApi	get_customers_v1_customers_get	GET /v1/customers	Get Customers
CustomersApi	get_me_v1_customers_me_get	GET /v1/customers/me	Get Me
CustomersApi	update_customer_v1_customers_customer_id_put	PUT /v1/customers/{customer_id}	Update Customer
CustomersApi	update_me_last_activity_v1_customers_me_last_activity_post	POST /v1/customers/me/last-activity	Update Me Last Activity
CustomersApi	update_me_password_v1_customers_me_update_post	POST /v1/customers/me/update	Update Me Password
HealthApi	get_health_status_v1_health_check_get	GET /v1/health-check	Health check
MatchMappingReviewsApi	create_match_mapping_review_v1_match_mapping_reviews_post	POST /v1/match-mapping-reviews	Create a match mapping review
MatchMappingReviewsApi	get_match_mapping_reviews_v1_match_mapping_reviews_get	GET /v1/match-mapping-reviews	Get a list of match mapping reviews
MatchMappingReviewsApi	update_match_mapping_review_v1_match_mapping_reviews_task_id_patch	PATCH /v1/match-mapping-reviews/{task_id}	Update match mapping review status
MatchesApi	get_match_broadcasts_v1_matches_broadcasts_get	GET /v1/matches/broadcasts	Get match broadcasts
MatchesApi	get_match_by_id_v1_matches_match_id_get	GET /v1/matches/{match_id}	Get match by id
MatchesApi	get_matches_v1_matches_get	GET /v1/matches	Get matches
ProviderMatchesApi	upsert_provider_matches_bulk_v1_provider_matches_bulk_post	POST /v1/provider-matches/bulk	Upsert Provider Matches Bulk
ProvidersApi	create_provider_v1_providers_post	POST /v1/providers	Create Provider
ProvidersApi	delete_provider_v1_providers_provider_id_delete	DELETE /v1/providers/{provider_id}	Delete Provider
ProvidersApi	get_provider_v1_providers_provider_id_get	GET /v1/providers/{provider_id}	Get Provider
ProvidersApi	get_providers_v1_providers_get	GET /v1/providers	Get Providers
ProvidersApi	update_provider_v1_providers_provider_id_put	PUT /v1/providers/{provider_id}	Update Provider
SportsApi	create_sport_v1_sports_post	POST /v1/sports	Create Sport
SportsApi	delete_sport_v1_sports_sport_id_delete	DELETE /v1/sports/{sport_id}	Delete Sport
SportsApi	get_sport_v1_sports_sport_id_get	GET /v1/sports/{sport_id}	Get Sport
SportsApi	get_sports_v1_sports_get	GET /v1/sports	Get sports
SportsApi	update_sport_v1_sports_sport_id_put	PUT /v1/sports/{sport_id}	Update Sport

Documentation For Models

• ApiKeyCreate
• ApiKeyCreateResponse
• ApiKeyRead
• AuthEntityRead
• BlacklistAuditActionEnum
• BlacklistOperatorEnum
• BroadcastUpdate
• CustomerCreate
• CustomerMatchBlacklistAuditRead
• CustomerMatchBlacklistRuleCreate
• CustomerMatchBlacklistRuleRead
• CustomerMatchBlacklistRuleUpdate
• CustomerMatchBroadcastRead
• CustomerMatchBulkItem
• CustomerMatchRead
• CustomerMatchStatisticsRead
• CustomerMatchUpdate
• CustomerPasswordUpdate
• CustomerRead
• CustomerStateEnum
• CustomerUpdate
• DataResponseApiKeyCreateResponse
• DataResponseApiKeyRead
• DataResponseCustomerMatchBlacklistRuleRead
• DataResponseCustomerMatchRead
• DataResponseCustomerMatchStatisticsRead
• DataResponseCustomerRead
• DataResponseDict
• DataResponseHealthStatus
• DataResponseListApiKeyRead
• DataResponseListCustomerMatchBlacklistRuleRead
• DataResponseListCustomerMatchBroadcastRead
• DataResponseListCustomerMatchRead
• DataResponseListCustomerRead
• DataResponseListMatchBroadcastFullRead
• DataResponseListMatchMappingReviewRead
• DataResponseListProviderMatchRead
• DataResponseListProviderRead
• DataResponseListSportRead
• DataResponseMatchMappingReviewRead
• DataResponseMatchReadWithUrls
• DataResponseProviderRead
• DataResponseSportRead
• HTTPValidationError
• HealthStatus
• LocationInner
• MatchBroadcastFullRead
• MatchBroadcastRead
• MatchBroadcastRoleRead
• MatchMappingReviewCreate
• MatchMappingReviewRead
• MatchMappingReviewStatus
• MatchMappingReviewUpdate
• MatchRead
• MatchReadWithUrls
• PaginatedResponseCustomerMatchBlacklistAuditRead
• PaginatedResponseCustomerMatchRead
• PaginatedResponseMatchRead
• ProviderCreate
• ProviderMatchBulkItem
• ProviderMatchRead
• ProviderRead
• ProviderUpdate
• SportCreate
• SportRead
• SportShort
• SportUpdate
• ValidationError

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication

Author