GameBrain Video Game Discovery

# openapi_client OpenapiClient - the Ruby gem for the GameBrain API GameBrain API This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.0.1 - Package version: 1.0.0 - Generator version: 7.8.0-SNAPSHOT - Build package: org.openapitools.codegen.languages.RubyClientCodegen ## Installation ### Build a gem To build the Ruby code into a gem: ```shell gem build openapi_client.gemspec ``` Then either install the gem locally: ```shell gem install ./openapi_client-1.0.0.gem ``` (for development, run `gem install --dev ./openapi_client-1.0.0.gem` to install the development dependencies) or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/). Finally add this to the Gemfile: gem 'openapi_client', '~> 1.0.0' ### Install from Git If the Ruby gem is hosted at a git repository: https://github.com/ddsky/gamebrain-clients/tree/master/ruby/, then add the following in the Gemfile: gem 'openapi_client', :git => 'https://github.com/ddsky/gamebrain-clients/tree/master/ruby/.git' ### Include the Ruby code directly Include the Ruby code directly using `-I` as follows: ```shell ruby -Ilib script.rb ``` ## Getting Started Please follow the [installation](#installation) procedure and then run the following code: ```ruby # Load the gem require 'openapi_client' # Setup authorization OpenapiClient.configure do |config| # Configure API key authorization: apiKey config.api_key['apiKey'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['apiKey'] = 'Bearer' # Configure API key authorization: headerApiKey config.api_key['headerApiKey'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) # config.api_key_prefix['headerApiKey'] = 'Bearer' end api_instance = OpenapiClient::DefaultApi.new id = 56 # Integer | The unique identifier of the game. api_key = 'abc123' # String | Your API key for authentication. begin #Get Game Details result = api_instance.detail(id, api_key) p result rescue OpenapiClient::ApiError => e puts "Exception when calling DefaultApi->detail: #{e}" end ``` ## Documentation for API Endpoints All URIs are relative to *https://api.gamebrain.co/v1* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *OpenapiClient::DefaultApi* | [**detail**](docs/DefaultApi.md#detail) | **GET** /games/{id} | Get Game Details *OpenapiClient::DefaultApi* | [**news**](docs/DefaultApi.md#news) | **GET** /games/{id}/news | Get Game News *OpenapiClient::DefaultApi* | [**search**](docs/DefaultApi.md#search) | **GET** /games | Search Games *OpenapiClient::DefaultApi* | [**similar**](docs/DefaultApi.md#similar) | **GET** /games/{id}/similar | Get Similar Games *OpenapiClient::DefaultApi* | [**suggest**](docs/DefaultApi.md#suggest) | **GET** /games/suggestions | Get Game Suggestions ## Documentation for Models - [OpenapiClient::GameNewsItem](docs/GameNewsItem.md) - [OpenapiClient::GameNewsResponse](docs/GameNewsResponse.md) - [OpenapiClient::GameResponse](docs/GameResponse.md) - [OpenapiClient::GameResponseOffersInner](docs/GameResponseOffersInner.md) - [OpenapiClient::GameResponseOffersInnerPrice](docs/GameResponseOffersInnerPrice.md) - [OpenapiClient::GameResponseOfficialStoresInner](docs/GameResponseOfficialStoresInner.md) - [OpenapiClient::GameResponsePlatformsInner](docs/GameResponsePlatformsInner.md) - [OpenapiClient::GameResponsePlaytime](docs/GameResponsePlaytime.md) - [OpenapiClient::GameResponseRating](docs/GameResponseRating.md) - [OpenapiClient::SearchResponse](docs/SearchResponse.md) - [OpenapiClient::SearchResponseActiveFilterOptionsInner](docs/SearchResponseActiveFilterOptionsInner.md) - [OpenapiClient::SearchResponseActiveFilterOptionsInnerValuesInner](docs/SearchResponseActiveFilterOptionsInnerValuesInner.md) - [OpenapiClient::SearchResponseFilterOptionsInner](docs/SearchResponseFilterOptionsInner.md) - [OpenapiClient::SearchResponseFilterOptionsInnerValuesInner](docs/SearchResponseFilterOptionsInnerValuesInner.md) - [OpenapiClient::SearchResponseResultsInner](docs/SearchResponseResultsInner.md) - [OpenapiClient::SearchResponseResultsInnerRating](docs/SearchResponseResultsInnerRating.md) - [OpenapiClient::SearchResponseSorting](docs/SearchResponseSorting.md) - [OpenapiClient::SearchResponseSortingOptionsInner](docs/SearchResponseSortingOptionsInner.md) - [OpenapiClient::SearchSuggestionResponse](docs/SearchSuggestionResponse.md) - [OpenapiClient::SearchSuggestionResponseResultsInner](docs/SearchSuggestionResponseResultsInner.md) - [OpenapiClient::SimilarGamesResponse](docs/SimilarGamesResponse.md) ## Documentation for Authorization Authentication schemes defined for the API: ### apiKey - **Type**: API key - **API key parameter name**: api-key - **Location**: URL query string ### headerApiKey - **Type**: API key - **API key parameter name**: x-api-key - **Location**: HTTP header