pokeapi_client 0.9.0

data/docs/PokemonShapeApi.md

@@ -0,0 +1,137 @@
+# PokeApiClient::PokemonShapeApi
+
+All URIs are relative to *https://pokeapi.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**pokemon_shape_list**](PokemonShapeApi.md#pokemon_shape_list) | **GET** /api/v2/pokemon-shape/ |  |
+| [**pokemon_shape_read**](PokemonShapeApi.md#pokemon_shape_read) | **GET** /api/v2/pokemon-shape/{id}/ |  |
+
+
+## pokemon_shape_list
+
+> String pokemon_shape_list(opts)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+
+api_instance = PokeApiClient::PokemonShapeApi.new
+opts = {
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  
+  result = api_instance.pokemon_shape_list(opts)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling PokemonShapeApi->pokemon_shape_list: #{e}"
+end
+```
+
+#### Using the pokemon_shape_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> pokemon_shape_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.pokemon_shape_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling PokemonShapeApi->pokemon_shape_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+
+
+## pokemon_shape_read
+
+> String pokemon_shape_read(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+
+api_instance = PokeApiClient::PokemonShapeApi.new
+id = 56 # Integer | 
+
+begin
+  
+  result = api_instance.pokemon_shape_read(id)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling PokemonShapeApi->pokemon_shape_read: #{e}"
+end
+```
+
+#### Using the pokemon_shape_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> pokemon_shape_read_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.pokemon_shape_read_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling PokemonShapeApi->pokemon_shape_read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+

data/docs/PokemonSpeciesApi.md

@@ -0,0 +1,137 @@
+# PokeApiClient::PokemonSpeciesApi
+
+All URIs are relative to *https://pokeapi.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**pokemon_species_list**](PokemonSpeciesApi.md#pokemon_species_list) | **GET** /api/v2/pokemon-species/ |  |
+| [**pokemon_species_read**](PokemonSpeciesApi.md#pokemon_species_read) | **GET** /api/v2/pokemon-species/{id}/ |  |
+
+
+## pokemon_species_list
+
+> String pokemon_species_list(opts)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+
+api_instance = PokeApiClient::PokemonSpeciesApi.new
+opts = {
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  
+  result = api_instance.pokemon_species_list(opts)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling PokemonSpeciesApi->pokemon_species_list: #{e}"
+end
+```
+
+#### Using the pokemon_species_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> pokemon_species_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.pokemon_species_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling PokemonSpeciesApi->pokemon_species_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+
+
+## pokemon_species_read
+
+> String pokemon_species_read(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+
+api_instance = PokeApiClient::PokemonSpeciesApi.new
+id = 56 # Integer | 
+
+begin
+  
+  result = api_instance.pokemon_species_read(id)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling PokemonSpeciesApi->pokemon_species_read: #{e}"
+end
+```
+
+#### Using the pokemon_species_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> pokemon_species_read_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.pokemon_species_read_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling PokemonSpeciesApi->pokemon_species_read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+

data/docs/RegionApi.md

@@ -0,0 +1,137 @@
+# PokeApiClient::RegionApi
+
+All URIs are relative to *https://pokeapi.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**region_list**](RegionApi.md#region_list) | **GET** /api/v2/region/ |  |
+| [**region_read**](RegionApi.md#region_read) | **GET** /api/v2/region/{id}/ |  |
+
+
+## region_list
+
+> String region_list(opts)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+
+api_instance = PokeApiClient::RegionApi.new
+opts = {
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  
+  result = api_instance.region_list(opts)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling RegionApi->region_list: #{e}"
+end
+```
+
+#### Using the region_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> region_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.region_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling RegionApi->region_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+
+
+## region_read
+
+> String region_read(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+
+api_instance = PokeApiClient::RegionApi.new
+id = 56 # Integer | 
+
+begin
+  
+  result = api_instance.region_read(id)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling RegionApi->region_read: #{e}"
+end
+```
+
+#### Using the region_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> region_read_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.region_read_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling RegionApi->region_read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+

data/docs/StatApi.md

@@ -0,0 +1,137 @@
+# PokeApiClient::StatApi
+
+All URIs are relative to *https://pokeapi.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**stat_list**](StatApi.md#stat_list) | **GET** /api/v2/stat/ |  |
+| [**stat_read**](StatApi.md#stat_read) | **GET** /api/v2/stat/{id}/ |  |
+
+
+## stat_list
+
+> String stat_list(opts)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+
+api_instance = PokeApiClient::StatApi.new
+opts = {
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  
+  result = api_instance.stat_list(opts)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling StatApi->stat_list: #{e}"
+end
+```
+
+#### Using the stat_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> stat_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.stat_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling StatApi->stat_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+
+
+## stat_read
+
+> String stat_read(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+
+api_instance = PokeApiClient::StatApi.new
+id = 56 # Integer | 
+
+begin
+  
+  result = api_instance.stat_read(id)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling StatApi->stat_read: #{e}"
+end
+```
+
+#### Using the stat_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> stat_read_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.stat_read_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling StatApi->stat_read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+

data/docs/SuperContestEffectApi.md

@@ -0,0 +1,137 @@
+# PokeApiClient::SuperContestEffectApi
+
+All URIs are relative to *https://pokeapi.co*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**super_contest_effect_list**](SuperContestEffectApi.md#super_contest_effect_list) | **GET** /api/v2/super-contest-effect/ |  |
+| [**super_contest_effect_read**](SuperContestEffectApi.md#super_contest_effect_read) | **GET** /api/v2/super-contest-effect/{id}/ |  |
+
+
+## super_contest_effect_list
+
+> String super_contest_effect_list(opts)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+
+api_instance = PokeApiClient::SuperContestEffectApi.new
+opts = {
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  
+  result = api_instance.super_contest_effect_list(opts)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling SuperContestEffectApi->super_contest_effect_list: #{e}"
+end
+```
+
+#### Using the super_contest_effect_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> super_contest_effect_list_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.super_contest_effect_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling SuperContestEffectApi->super_contest_effect_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+
+
+## super_contest_effect_read
+
+> String super_contest_effect_read(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'pokeapi_client'
+
+api_instance = PokeApiClient::SuperContestEffectApi.new
+id = 56 # Integer | 
+
+begin
+  
+  result = api_instance.super_contest_effect_read(id)
+  p result
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling SuperContestEffectApi->super_contest_effect_read: #{e}"
+end
+```
+
+#### Using the super_contest_effect_read_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> super_contest_effect_read_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.super_contest_effect_read_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue PokeApiClient::ApiError => e
+  puts "Error when calling SuperContestEffectApi->super_contest_effect_read_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain
+