iplaygames-api 1.0.5

Game Aggregator API Documentation

iplaygames-api

Universal API for casino operators to access games from multiple providers through a single integration.

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

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.19.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

Python 3.9+

Installation & Usage

pip install

Install via pip:

pip install iplaygames-api

Or install the high-level SDK wrapper:

pip install iplaygames-sdk

Then import the package:

import iplaygames_api

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 iplaygames_api

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import iplaygames_api
from iplaygames_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.iplaygames.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = iplaygames_api.Configuration(
    host = "https://api.iplaygames.ai"
)

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


# Enter a context with an instance of the API client
with iplaygames_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = iplaygames_api.EndpointsApi(api_client)
    add_a_contribution_to_a_jackpot_pool_request = iplaygames_api.AddAContributionToAJackpotPoolRequest() # AddAContributionToAJackpotPoolRequest | 

    try:
        # Add a contribution to a jackpot pool
        api_instance.add_a_contribution_to_a_jackpot_pool(add_a_contribution_to_a_jackpot_pool_request)
    except ApiException as e:
        print("Exception when calling EndpointsApi->add_a_contribution_to_a_jackpot_pool: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.iplaygames.ai

Class	Method	HTTP request	Description
EndpointsApi	add_a_contribution_to_a_jackpot_pool	POST /api/v1/jackpot/contribute	Add a contribution to a jackpot pool
EndpointsApi	add_games_to_a_jackpot_pool_type	POST /api/v1/jackpot/games	Add games to a jackpot pool type
EndpointsApi	bulk_create_external_games_from_json_array	POST /api/v1/external-games/bulk	Bulk create external games from JSON array
EndpointsApi	bulk_delete_external_games_by_ids	DELETE /api/v1/external-games/bulk	Bulk delete external games by IDs
EndpointsApi	configure_jackpot_settings_for_the_operator	POST /api/v1/jackpot/configure	Configure jackpot settings for the operator
EndpointsApi	configure_live_mode_settings_for_a_pool	PUT /api/v1/jackpot/pools/{poolId}/live-mode	Configure live mode settings for a pool
EndpointsApi	create_a_new_promotion	POST /api/v1/promotions	Create a new promotion
EndpointsApi	create_a_single_external_game	POST /api/v1/external-games	Create a single external game
EndpointsApi	create_a_targeted_player_configuration	POST /api/v1/jackpot/targeted-players	Create a targeted player configuration
EndpointsApi	deactivate_a_targeted_player_configuration	DELETE /api/v1/jackpot/targeted-players/{targetedPlayerId}	Deactivate a targeted player configuration
EndpointsApi	delete_a_promotion	DELETE /api/v1/promotions/{id}	Delete a promotion
EndpointsApi	delete_an_external_game	DELETE /api/v1/external-games/{id}	Delete an external game
EndpointsApi	get_a_single_external_game	GET /api/v1/external-games/{id}	Get a single external game
EndpointsApi	get_a_specific_promotion	GET /api/v1/promotions/{id}	Get a specific promotion
EndpointsApi	get_api_v1_producers	GET /api/v1/producers
EndpointsApi	get_api_v1_producers_id	GET /api/v1/producers/{id}
EndpointsApi	get_api_v1_transaction_exports_export_id_download	GET /api/v1/transaction-exports/{export_id}/download
EndpointsApi	get_current_configuration_with_games	GET /api/v1/jackpot/configuration	Get current configuration with games
EndpointsApi	get_games_for_a_pool_type_or_all_pool_types	GET /api/v1/jackpot/games	Get games for a pool type or all pool types
EndpointsApi	get_leaderboard_for_a_promotion	GET /api/v1/promotions/{id}/leaderboard	Get leaderboard for a promotion
EndpointsApi	get_player_contribution_history	GET /api/v1/jackpot/contributions	Get player contribution history
EndpointsApi	get_pool_details	GET /api/v1/jackpot/pools/{poolId}	Get pool details
EndpointsApi	get_pool_winners	GET /api/v1/jackpot/pools/{poolId}/winners	Get pool winners
EndpointsApi	get_targeted_player_details	GET /api/v1/jackpot/targeted-players/{targetedPlayerId}	Get targeted player details
EndpointsApi	get_unique_producer_names_for_filtering	GET /api/v1/external-games/producers	Get unique producer names for filtering
EndpointsApi	get_winners_for_a_promotion	GET /api/v1/promotions/{id}/winners	Get winners for a promotion
EndpointsApi	import_external_games_from_csv_file	POST /api/v1/external-games/import/csv	Import external games from CSV file
EndpointsApi	import_external_games_from_json_paste	POST /api/v1/external-games/import/json	Import external games from JSON paste
EndpointsApi	list_external_games_for_operator	GET /api/v1/external-games	List external games for operator
EndpointsApi	list_operators_jackpot_pools	GET /api/v1/jackpot/pools	List operator's jackpot pools
EndpointsApi	list_promotions_for_the_operator	GET /api/v1/promotions	List promotions for the operator
EndpointsApi	list_targeted_players_for_operator	GET /api/v1/jackpot/targeted-players	List targeted players for operator
EndpointsApi	manage_games_for_a_promotion	POST /api/v1/promotions/{id}/games	Manage games for a promotion
EndpointsApi	manually_distribute_prizes_for_a_period	POST /api/v1/promotions/{id}/periods/{periodId}/distribute	Manually distribute prizes for a period
EndpointsApi	manually_trigger_pool_release	POST /api/v1/jackpot/pools/{poolId}/release	Manually trigger pool release
EndpointsApi	opt_in_operator_to_a_platformnetwork_promotion	POST /api/v1/promotions/{id}/opt-in	Opt-in operator to a platform/network promotion
EndpointsApi	opt_out_operator_from_a_platformnetwork_promotion	POST /api/v1/promotions/{id}/opt-out	Opt-out operator from a platform/network promotion
EndpointsApi	post_api_v1_game_transactions_export	POST /api/v1/game-transactions/export
EndpointsApi	remove_games_from_a_jackpot_pool_type	DELETE /api/v1/jackpot/games	Remove games from a jackpot pool type
EndpointsApi	set_grand_prize_expiration_date	PUT /api/v1/jackpot/pools/{poolId}/expiration	Set grand prize expiration date
EndpointsApi	update_a_promotion	PUT /api/v1/promotions/{id}	Update a promotion
EndpointsApi	update_an_external_game	PUT /api/v1/external-games/{id}	Update an external game
FreespinsApi	cancel_a_standalone_freespin	POST /api/v1/freespins/{freespin_id}/cancel	Cancel a standalone freespin
FreespinsApi	create_a_standalone_freespin	POST /api/v1/freespins	Create a standalone freespin
GameSessionsApi	end_a_game_session	POST /api/v1/game-sessions/{session_id}/end	End a game session
GameSessionsApi	get_session_status	GET /api/v1/game-sessions/{session_id}/status	Get session status
GameSessionsApi	start_a_game_session	POST /api/v1/game-sessions/start	Start a game session
GameTransactionsApi	get_transaction_details	GET /api/v1/game-transactions/{id}	Get transaction details
GameTransactionsApi	get_transaction_history	GET /api/v1/game-transactions	Get transaction history
GamesApi	get_api_v1_games_id	GET /api/v1/games/{id}
GamesApi	list_games	GET /api/v1/games	List games
MultiSessionsApi	end_multi_session	POST /api/v1/multi-sessions/{token}/end	End multi-session
MultiSessionsApi	get_multi_session_status	GET /api/v1/multi-sessions/{token}/status	Get multi-session status
MultiSessionsApi	start_a_multi_session	POST /api/v1/multi-sessions/start	Start a multi-session
WidgetManagementApi	bulk_revoke_tokens	POST /api/v1/widget/tokens/bulk-revoke	Bulk revoke tokens
WidgetManagementApi	generate_a_widget_token	POST /api/v1/widget/tokens	Generate a widget token
WidgetManagementApi	get_domain_details	GET /api/v1/widget/domains/{id}	Get domain details
WidgetManagementApi	get_token_details	GET /api/v1/widget/tokens/{id}	Get token details
WidgetManagementApi	list_registered_domains	GET /api/v1/widget/domains	List registered domains
WidgetManagementApi	list_widget_tokens	GET /api/v1/widget/tokens	List widget tokens
WidgetManagementApi	regenerate_domain_token	POST /api/v1/widget/domains/{id}/regenerate-token	Regenerate domain token
WidgetManagementApi	register_a_new_domain	POST /api/v1/widget/domains	Register a new domain
WidgetManagementApi	remove_a_domain	DELETE /api/v1/widget/domains/{id}	Remove a domain
WidgetManagementApi	revoke_a_token	DELETE /api/v1/widget/tokens/{id}	Revoke a token
WidgetManagementApi	update_domain_settings	PUT /api/v1/widget/domains/{id}	Update domain settings

Documentation For Models

• AddAContributionToAJackpotPoolRequest
• AddGamesToAJackpotPoolTypeRequest
• BulkCreateExternalGamesFromJSONArrayRequest
• BulkDeleteExternalGamesByIDsRequest
• BulkRevokeTokens200Response
• BulkRevokeTokensRequest
• CancelAStandaloneFreespin200Response
• CancelAStandaloneFreespin200ResponseData
• CancelAStandaloneFreespin401Response
• CancelAStandaloneFreespin404Response
• CancelAStandaloneFreespin409Response
• CancelAStandaloneFreespin500Response
• CancelAStandaloneFreespinRequest
• ConfigureJackpotSettingsForTheOperatorRequest
• ConfigureJackpotSettingsForTheOperatorRequestPrizeTiersInner
• ConfigureLiveModeSettingsForAPoolRequest
• CreateANewPromotionRequest
• CreateASingleExternalGameRequest
• CreateAStandaloneFreespin201Response
• CreateAStandaloneFreespin201ResponseData
• CreateAStandaloneFreespin400Response
• CreateAStandaloneFreespin403Response
• CreateAStandaloneFreespin404Response
• CreateAStandaloneFreespin409Response
• CreateAStandaloneFreespin503Response
• CreateAStandaloneFreespinRequest
• CreateATargetedPlayerConfigurationRequest
• EndAGameSession200Response
• EndMultiSession200Response
• GenerateAWidgetToken201Response
• GenerateAWidgetToken201ResponseData
• GenerateAWidgetToken400Response
• GenerateAWidgetToken401Response
• GenerateAWidgetTokenRequest
• GetApiV1Producers401Response
• GetApiV1TransactionExportsExportIdDownload500Response
• GetDomainDetails200Response
• GetDomainDetails200ResponseData
• GetGamesForAPoolTypeOrAllPoolTypesRequest
• GetMultiSessionStatus200Response
• GetMultiSessionStatus200ResponseData
• GetMultiSessionStatus200ResponseDataGamesInner
• GetMultiSessionStatus404Response
• GetPlayerContributionHistoryRequest
• GetSessionStatus200Response
• GetSessionStatus200ResponseData
• GetSessionStatus200ResponseDataGame
• GetSessionStatus404Response
• GetTokenDetails200Response
• GetTokenDetails200ResponseData
• GetTransactionDetails404Response
• GetTransactionHistory200Response
• GetTransactionHistory200ResponseDataInner
• GetTransactionHistory200ResponseMeta
• GetTransactionHistory200ResponseMetaSummary
• ImportExternalGamesFromJSONPasteRequest
• ImportExternalGamesFromJSONPasteRequestGamesInner
• ListExternalGamesForOperatorRequest
• ListGames200Response
• ListGames200ResponseDataInner
• ListGames200ResponseMeta
• ListGamesRequest
• ListOperatorsJackpotPoolsRequest
• ListRegisteredDomains200Response
• ListRegisteredDomains200ResponseDataInner
• ListTargetedPlayersForOperatorRequest
• ListWidgetTokens200Response
• ListWidgetTokens200ResponseDataInner
• ManageGamesForAPromotionRequest
• PostApiV1GameTransactionsExportRequest
• RegenerateDomainToken200Response
• RegenerateDomainToken200ResponseData
• RegisterANewDomain201Response
• RegisterANewDomain201ResponseData
• RegisterANewDomain422Response
• RegisterANewDomainRequest
• RemoveADomain200Response
• RemoveGamesFromAJackpotPoolTypeRequest
• RevokeAToken200Response
• SetGrandPrizeExpirationDateRequest
• StartAGameSession201Response
• StartAGameSession201ResponseData
• StartAGameSession400Response
• StartAGameSession503Response
• StartAGameSessionRequest
• StartAMultiSession201Response
• StartAMultiSession201ResponseData
• StartAMultiSession201ResponseDataGamesInner
• StartAMultiSession400Response
• StartAMultiSessionRequest
• UpdateAPromotionRequest
• UpdateAnExternalGameRequest
• UpdateDomainSettings200Response
• UpdateDomainSettings200ResponseData
• UpdateDomainSettingsRequest

Documentation For Authorization

Authentication schemes defined for the API:

default

• Type: Bearer authentication

Author