dupr-prod-httpx 1.0.1

DUPR Production APIs with httpx

dupr-prod-httpx

External RESTful APIs to access DUPR ratings, users and provide matches.

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

• API version: v1.0.0
• Package version: 1.0.0
• Generator version: 7.16.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 dupr_prod_httpx

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 dupr_prod_httpx

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import dupr_prod_httpx
from dupr_prod_httpx.rest import ApiException
from pprint import pprint

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



# Enter a context with an instance of the API client
async with dupr_prod_httpx.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dupr_prod_httpx.ApiRegistrationApi(api_client)
    version = 'v1.0' # str | version (default to 'v1.0')

    try:
        # getAll
        api_response = await api_instance.get_all_using_get(version)
        print("The response of ApiRegistrationApi->get_all_using_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ApiRegistrationApi->get_all_using_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://prod.mydupr.com

Class	Method	HTTP request	Description
ApiRegistrationApi	get_all_using_get	GET /api/{version}/topic	getAll
ApiRegistrationApi	register_using_post	POST /api/{version}/webhook	register
AuthenticationApi	login_using_post	POST /api/auth/{version}/token	Generate Access Token
ClubApi	club_members_rating_using_post	POST /api/club/{version}/members	Club Members Rating
MatchApi	delete_match_using_delete	DELETE /api/match/{version}/delete	Delete Match
MatchApi	save_match_in_bulk_using_post	POST /api/match/{version}/batch	Create Match in Bulk
MatchApi	save_match_using_post	POST /api/match/{version}/create	Create Match
MatchApi	search_match_history_using_post	POST /api/match/history/search	Get Match History
MatchApi	update_match_using_post	POST /api/match/{version}/update	Update a match
MatchApi	view_match_using_get	GET /api/match/{version}/{id}	viewMatch
PlayerApi	get_player_duprid_by_email_using_post	POST /api/{version}/player/duprid-by-email	Get DUPR ID by Email
PlayerApi	get_rank_of_players_using_post	POST /api/{version}/player	Players Rating
PlayerRatingApi	get_client_players_subscription_using_get	GET /api/{version}/subscribe/rating-changes	Fetch Players subscription by Client
PlayerRatingApi	get_player_rating_history_by_user_using_post	POST /api/history	getPlayerRatingHistoryByUser
PlayerRatingApi	remove_player_subscription_using_delete	DELETE /api/{version}/subscribe/rating-changes	Removes players rating
PlayerRatingApi	subscribe_player_rating_using_post	POST /api/{version}/subscribe/rating-changes	Subscribe players rating
UsersApi	create_user_provisional_rating_using_post	POST /api/user/{version}/provisional_rating/create	Set the provisional rating for a player
UsersApi	delete_user_provisional_rating_using_delete	DELETE /api/user/{version}/provisional_rating/delete	Delete the provisional rating for a player
UsersApi	get_club_membership_by_dupr_id_using_get	GET /api/user/{version}/{id}/clubs	Retrieve the club membership for a user by DUPR Id
UsersApi	get_user_provisional_rating_using_post	POST /api/user/{version}/provisional_rating	Get the provisional rating for a player
UsersApi	invite_user_using_post	POST /api/user/{version}/invite	Pre-generate a dupr ID and invite a user to join
UsersApi	update_user_provisional_rating_using_post	POST /api/user/{version}/provisional_rating/update	Set the provisional rating for a player
UsersApi	user_detail_using_get	GET /api/user/{version}/{id}	User Info
UsersApi	user_search_using_post	POST /api/user/{version}/search	User Search

Documentation For Models

• ArrayWrapperOfExternalUserDetailResponse
• ArrayWrapperOfPlayerResponse
• ClientHookRequest
• CreateProvisionalRatingRequest
• DeleteProvisionalRatingRequest
• ExternalAgeRangeFilter
• ExternalClubMemberRequest
• ExternalDeleteMatchRequest
• ExternalFilterLocation
• ExternalInviteRequest
• ExternalMatchRequest
• ExternalMatchSearchRequest
• ExternalMatchTeam
• ExternalRatingFilter
• ExternalSearchFilter
• ExternalSearchRequest
• ExternalUpdateMatchRequest
• ExternalUserDetailResponse
• ExternalUserPerformance
• ExternalUserRatingResponse
• FindDuprIdByEmailRequest
• GetProvisionalRatingRequest
• Participant
• PlayerRatingResponse
• PlayerResponse
• PlayersSortedRequest
• ProvisionalRating
• RatingCoach
• RegistrationResponse
• SingleWrapperOfTokenResponse
• SponsorLogoResponse
• TokenResponse
• UpdateProvisionalRatingRequest
• WinLossCount

Documentation For Authorization

Endpoints do not require authorization.

Author