Metadata-Version: 2.4
Name: dupr_prod_httpx
Version: 1.0.1
Summary: DUPR Production APIs with httpx
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/Lighthouse-Pickleball/dupr_prod_httpx.git
Keywords: OpenAPI,OpenAPI-Generator,DUPR APIs
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: aiohttp>=3.8.4
Requires-Dist: aiohttp-retry>=2.8.3
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# dupr-prod-httpx
External RESTful APIs to access DUPR ratings, users and provide matches.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) 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:

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

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

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

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**](docs/ApiRegistrationApi.md#get_all_using_get) | **GET** /api/{version}/topic | getAll
*ApiRegistrationApi* | [**register_using_post**](docs/ApiRegistrationApi.md#register_using_post) | **POST** /api/{version}/webhook | register
*AuthenticationApi* | [**login_using_post**](docs/AuthenticationApi.md#login_using_post) | **POST** /api/auth/{version}/token | Generate Access Token
*ClubApi* | [**club_members_rating_using_post**](docs/ClubApi.md#club_members_rating_using_post) | **POST** /api/club/{version}/members | Club Members Rating
*MatchApi* | [**delete_match_using_delete**](docs/MatchApi.md#delete_match_using_delete) | **DELETE** /api/match/{version}/delete | Delete Match
*MatchApi* | [**save_match_in_bulk_using_post**](docs/MatchApi.md#save_match_in_bulk_using_post) | **POST** /api/match/{version}/batch | Create Match in Bulk
*MatchApi* | [**save_match_using_post**](docs/MatchApi.md#save_match_using_post) | **POST** /api/match/{version}/create | Create Match
*MatchApi* | [**search_match_history_using_post**](docs/MatchApi.md#search_match_history_using_post) | **POST** /api/match/history/search | Get Match History
*MatchApi* | [**update_match_using_post**](docs/MatchApi.md#update_match_using_post) | **POST** /api/match/{version}/update | Update a match
*MatchApi* | [**view_match_using_get**](docs/MatchApi.md#view_match_using_get) | **GET** /api/match/{version}/{id} | viewMatch
*PlayerApi* | [**get_player_duprid_by_email_using_post**](docs/PlayerApi.md#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**](docs/PlayerApi.md#get_rank_of_players_using_post) | **POST** /api/{version}/player | Players Rating
*PlayerRatingApi* | [**get_client_players_subscription_using_get**](docs/PlayerRatingApi.md#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**](docs/PlayerRatingApi.md#get_player_rating_history_by_user_using_post) | **POST** /api/history | getPlayerRatingHistoryByUser
*PlayerRatingApi* | [**remove_player_subscription_using_delete**](docs/PlayerRatingApi.md#remove_player_subscription_using_delete) | **DELETE** /api/{version}/subscribe/rating-changes | Removes players rating
*PlayerRatingApi* | [**subscribe_player_rating_using_post**](docs/PlayerRatingApi.md#subscribe_player_rating_using_post) | **POST** /api/{version}/subscribe/rating-changes | Subscribe players rating
*UsersApi* | [**create_user_provisional_rating_using_post**](docs/UsersApi.md#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**](docs/UsersApi.md#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**](docs/UsersApi.md#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**](docs/UsersApi.md#get_user_provisional_rating_using_post) | **POST** /api/user/{version}/provisional_rating | Get the provisional rating for a player
*UsersApi* | [**invite_user_using_post**](docs/UsersApi.md#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**](docs/UsersApi.md#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**](docs/UsersApi.md#user_detail_using_get) | **GET** /api/user/{version}/{id} | User Info
*UsersApi* | [**user_search_using_post**](docs/UsersApi.md#user_search_using_post) | **POST** /api/user/{version}/search | User Search


## Documentation For Models

 - [ArrayWrapperOfExternalUserDetailResponse](docs/ArrayWrapperOfExternalUserDetailResponse.md)
 - [ArrayWrapperOfPlayerResponse](docs/ArrayWrapperOfPlayerResponse.md)
 - [ClientHookRequest](docs/ClientHookRequest.md)
 - [CreateProvisionalRatingRequest](docs/CreateProvisionalRatingRequest.md)
 - [DeleteProvisionalRatingRequest](docs/DeleteProvisionalRatingRequest.md)
 - [ExternalAgeRangeFilter](docs/ExternalAgeRangeFilter.md)
 - [ExternalClubMemberRequest](docs/ExternalClubMemberRequest.md)
 - [ExternalDeleteMatchRequest](docs/ExternalDeleteMatchRequest.md)
 - [ExternalFilterLocation](docs/ExternalFilterLocation.md)
 - [ExternalInviteRequest](docs/ExternalInviteRequest.md)
 - [ExternalMatchRequest](docs/ExternalMatchRequest.md)
 - [ExternalMatchSearchRequest](docs/ExternalMatchSearchRequest.md)
 - [ExternalMatchTeam](docs/ExternalMatchTeam.md)
 - [ExternalRatingFilter](docs/ExternalRatingFilter.md)
 - [ExternalSearchFilter](docs/ExternalSearchFilter.md)
 - [ExternalSearchRequest](docs/ExternalSearchRequest.md)
 - [ExternalUpdateMatchRequest](docs/ExternalUpdateMatchRequest.md)
 - [ExternalUserDetailResponse](docs/ExternalUserDetailResponse.md)
 - [ExternalUserPerformance](docs/ExternalUserPerformance.md)
 - [ExternalUserRatingResponse](docs/ExternalUserRatingResponse.md)
 - [FindDuprIdByEmailRequest](docs/FindDuprIdByEmailRequest.md)
 - [GetProvisionalRatingRequest](docs/GetProvisionalRatingRequest.md)
 - [Participant](docs/Participant.md)
 - [PlayerRatingResponse](docs/PlayerRatingResponse.md)
 - [PlayerResponse](docs/PlayerResponse.md)
 - [PlayersSortedRequest](docs/PlayersSortedRequest.md)
 - [ProvisionalRating](docs/ProvisionalRating.md)
 - [RatingCoach](docs/RatingCoach.md)
 - [RegistrationResponse](docs/RegistrationResponse.md)
 - [SingleWrapperOfTokenResponse](docs/SingleWrapperOfTokenResponse.md)
 - [SponsorLogoResponse](docs/SponsorLogoResponse.md)
 - [TokenResponse](docs/TokenResponse.md)
 - [UpdateProvisionalRatingRequest](docs/UpdateProvisionalRatingRequest.md)
 - [WinLossCount](docs/WinLossCount.md)


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

Endpoints do not require authorization.


## Author




