Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 2 additions & 41 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ docs/CreatorPartialDtoPaginationDto.md
docs/CreatorRarityDto.md
docs/CreatorShareDto.md
docs/CreatorTransactionDto.md
docs/CreatorsApi.md
docs/DiscordTokenDto.md
docs/LinkDiscordTwitchDto.md
docs/LootBoxDto.md
Expand All @@ -25,15 +24,13 @@ docs/PlayerPartialDto.md
docs/PlayerShareDto.md
docs/PlayerTransactionDto.md
docs/PlayerType.md
docs/PlayersApi.md
docs/PortfolioSnapshotDto.md
docs/Rarity.md
docs/SessionsApi.md
docs/StreamStatusDto.md
docs/TTXClientApi.md
docs/TimeStep.md
docs/TokenDto.md
docs/TransactionAction.md
docs/TransactionsApi.md
docs/TwitchUserDto.md
docs/VoteDto.md
git_push.sh
Expand All @@ -43,46 +40,10 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_create_transaction_dto.py
test/test_creator_dto.py
test/test_creator_order_by.py
test/test_creator_partial_dto.py
test/test_creator_partial_dto_pagination_dto.py
test/test_creator_rarity_dto.py
test/test_creator_share_dto.py
test/test_creator_transaction_dto.py
test/test_creators_api.py
test/test_discord_token_dto.py
test/test_link_discord_twitch_dto.py
test/test_loot_box_dto.py
test/test_loot_box_result_dto.py
test/test_model_id.py
test/test_order_direction.py
test/test_player_dto.py
test/test_player_dto_pagination_dto.py
test/test_player_order_by.py
test/test_player_partial_dto.py
test/test_player_share_dto.py
test/test_player_transaction_dto.py
test/test_player_type.py
test/test_players_api.py
test/test_portfolio_snapshot_dto.py
test/test_rarity.py
test/test_sessions_api.py
test/test_stream_status_dto.py
test/test_time_step.py
test/test_token_dto.py
test/test_transaction_action.py
test/test_transactions_api.py
test/test_twitch_user_dto.py
test/test_vote_dto.py
tox.ini
ttx/__init__.py
ttx/api/__init__.py
ttx/api/creators_api.py
ttx/api/players_api.py
ttx/api/sessions_api.py
ttx/api/transactions_api.py
ttx/api/ttx_client_api.py
ttx/api_client.py
ttx/api_response.py
ttx/configuration.py
Expand Down
107 changes: 55 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
# Python API wrapper for TTX
# ttx

## Requirements.
TTX API Wrapper

## 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/ttxdev/ttx.py.git
```

(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/ttxdev/ttx.py.git`)

Then import the package:

```python
import ttx
```
Expand All @@ -26,9 +31,11 @@ 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 ttx
```
Expand Down Expand Up @@ -58,16 +65,16 @@ configuration = ttx.Configuration(
# Enter a context with an instance of the API client
with ttx.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ttx.CreatorsApi(api_client)
api_instance = ttx.TTXClientApi(api_client)
username = 'username_example' # str | (optional)
ticker = 'ticker_example' # str | (optional)

try:
api_response = api_instance.create_creator(username=username, ticker=ticker)
print("The response of CreatorsApi->create_creator:\n")
print("The response of TTXClientApi->create_creator:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling CreatorsApi->create_creator: %s\n" % e)
print("Exception when calling TTXClientApi->create_creator: %s\n" % e)

```

Expand All @@ -77,61 +84,57 @@ All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CreatorsApi* | [**create_creator**](docs/CreatorsApi.md#create_creator) | **POST** /creators |
*CreatorsApi* | [**get_creator**](docs/CreatorsApi.md#get_creator) | **GET** /creators/{slug} |
*CreatorsApi* | [**get_creator_transactions**](docs/CreatorsApi.md#get_creator_transactions) | **GET** /creators/{creatorSlug}/transactions |
*CreatorsApi* | [**get_creators**](docs/CreatorsApi.md#get_creators) | **GET** /creators |
*PlayersApi* | [**gamba**](docs/PlayersApi.md#gamba) | **PUT** /players/me/lootboxes/{lootBoxId}/open |
*PlayersApi* | [**get_player**](docs/PlayersApi.md#get_player) | **GET** /players/{username} |
*PlayersApi* | [**get_players**](docs/PlayersApi.md#get_players) | **GET** /players |
*PlayersApi* | [**get_self**](docs/PlayersApi.md#get_self) | **GET** /players/me |
*SessionsApi* | [**discord_callback**](docs/SessionsApi.md#discord_callback) | **GET** /sessions/discord/callback |
*SessionsApi* | [**link_discord_twitch**](docs/SessionsApi.md#link_discord_twitch) | **POST** /sessions/discord/link |
*SessionsApi* | [**twitch_callback**](docs/SessionsApi.md#twitch_callback) | **GET** /sessions/twitch/callback |
*TransactionsApi* | [**place_order**](docs/TransactionsApi.md#place_order) | **POST** /transactions |

*TTXClientApi* | [**create_creator**](docs/TTXClientApi.md#create_creator) | **POST** /creators |
*TTXClientApi* | [**discord_callback**](docs/TTXClientApi.md#discord_callback) | **GET** /sessions/discord/callback |
*TTXClientApi* | [**gamba**](docs/TTXClientApi.md#gamba) | **PUT** /players/me/lootboxes/{lootBoxId}/open |
*TTXClientApi* | [**get_creator**](docs/TTXClientApi.md#get_creator) | **GET** /creators/{slug} |
*TTXClientApi* | [**get_creator_transactions**](docs/TTXClientApi.md#get_creator_transactions) | **GET** /creators/{creatorSlug}/transactions |
*TTXClientApi* | [**get_creators**](docs/TTXClientApi.md#get_creators) | **GET** /creators |
*TTXClientApi* | [**get_player**](docs/TTXClientApi.md#get_player) | **GET** /players/{username} |
*TTXClientApi* | [**get_players**](docs/TTXClientApi.md#get_players) | **GET** /players |
*TTXClientApi* | [**get_self**](docs/TTXClientApi.md#get_self) | **GET** /players/me |
*TTXClientApi* | [**link_discord_twitch**](docs/TTXClientApi.md#link_discord_twitch) | **POST** /sessions/discord/link |
*TTXClientApi* | [**place_order**](docs/TTXClientApi.md#place_order) | **POST** /transactions |
*TTXClientApi* | [**twitch_callback**](docs/TTXClientApi.md#twitch_callback) | **GET** /sessions/twitch/callback |

## Documentation For Models

- [CreateTransactionDto](docs/CreateTransactionDto.md)
- [CreatorDto](docs/CreatorDto.md)
- [CreatorOrderBy](docs/CreatorOrderBy.md)
- [CreatorPartialDto](docs/CreatorPartialDto.md)
- [CreatorPartialDtoPaginationDto](docs/CreatorPartialDtoPaginationDto.md)
- [CreatorRarityDto](docs/CreatorRarityDto.md)
- [CreatorShareDto](docs/CreatorShareDto.md)
- [CreatorTransactionDto](docs/CreatorTransactionDto.md)
- [DiscordTokenDto](docs/DiscordTokenDto.md)
- [LinkDiscordTwitchDto](docs/LinkDiscordTwitchDto.md)
- [LootBoxDto](docs/LootBoxDto.md)
- [LootBoxResultDto](docs/LootBoxResultDto.md)
- [ModelId](docs/ModelId.md)
- [OrderDirection](docs/OrderDirection.md)
- [PlayerDto](docs/PlayerDto.md)
- [PlayerDtoPaginationDto](docs/PlayerDtoPaginationDto.md)
- [PlayerOrderBy](docs/PlayerOrderBy.md)
- [PlayerPartialDto](docs/PlayerPartialDto.md)
- [PlayerShareDto](docs/PlayerShareDto.md)
- [PlayerTransactionDto](docs/PlayerTransactionDto.md)
- [PlayerType](docs/PlayerType.md)
- [PortfolioSnapshotDto](docs/PortfolioSnapshotDto.md)
- [Rarity](docs/Rarity.md)
- [StreamStatusDto](docs/StreamStatusDto.md)
- [TimeStep](docs/TimeStep.md)
- [TokenDto](docs/TokenDto.md)
- [TransactionAction](docs/TransactionAction.md)
- [TwitchUserDto](docs/TwitchUserDto.md)
- [VoteDto](docs/VoteDto.md)

- [CreateTransactionDto](docs/CreateTransactionDto.md)
- [CreatorDto](docs/CreatorDto.md)
- [CreatorOrderBy](docs/CreatorOrderBy.md)
- [CreatorPartialDto](docs/CreatorPartialDto.md)
- [CreatorPartialDtoPaginationDto](docs/CreatorPartialDtoPaginationDto.md)
- [CreatorRarityDto](docs/CreatorRarityDto.md)
- [CreatorShareDto](docs/CreatorShareDto.md)
- [CreatorTransactionDto](docs/CreatorTransactionDto.md)
- [DiscordTokenDto](docs/DiscordTokenDto.md)
- [LinkDiscordTwitchDto](docs/LinkDiscordTwitchDto.md)
- [LootBoxDto](docs/LootBoxDto.md)
- [LootBoxResultDto](docs/LootBoxResultDto.md)
- [ModelId](docs/ModelId.md)
- [OrderDirection](docs/OrderDirection.md)
- [PlayerDto](docs/PlayerDto.md)
- [PlayerDtoPaginationDto](docs/PlayerDtoPaginationDto.md)
- [PlayerOrderBy](docs/PlayerOrderBy.md)
- [PlayerPartialDto](docs/PlayerPartialDto.md)
- [PlayerShareDto](docs/PlayerShareDto.md)
- [PlayerTransactionDto](docs/PlayerTransactionDto.md)
- [PlayerType](docs/PlayerType.md)
- [PortfolioSnapshotDto](docs/PortfolioSnapshotDto.md)
- [Rarity](docs/Rarity.md)
- [StreamStatusDto](docs/StreamStatusDto.md)
- [TimeStep](docs/TimeStep.md)
- [TokenDto](docs/TokenDto.md)
- [TransactionAction](docs/TransactionAction.md)
- [TwitchUserDto](docs/TwitchUserDto.md)
- [VoteDto](docs/VoteDto.md)

<a id="documentation-for-authorization"></a>

## Documentation For Authorization

Endpoints do not require authorization.


## Author




[NathanRoberts55](https://github.com/nathanroberts55)
12 changes: 12 additions & 0 deletions config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
generatorName: python
inputSpec: https://api.ttx.gg/swagger/v1/swagger.json
outputDir: .
packageName: ttx
packageVersion: 1.0.0
projectName: ttx
packageUrl: https://github.com/ttxdev/ttx.py
gitHost: github.com
gitUserId: ttxdev
gitRepoId: ttx.py
openapiNormalizer:
SET_TAGS_FOR_ALL_OPERATIONS: TTXClient
Loading