pokeapi_client 1.2.0 → 2.0.0

data/docs/BerryDetail.md

@@ -0,0 +1,40 @@
+# PokeApiClient::BerryDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [readonly] |
+| **name** | **String** |  |  |
+| **growth_time** | **Integer** |  |  |
+| **max_harvest** | **Integer** |  |  |
+| **natural_gift_power** | **Integer** |  |  |
+| **size** | **Integer** |  |  |
+| **smoothness** | **Integer** |  |  |
+| **soil_dryness** | **Integer** |  |  |
+| **firmness** | [**BerryFirmnessSummary**](BerryFirmnessSummary.md) |  |  |
+| **flavors** | [**Array<BerryDetailFlavorsInner>**](BerryDetailFlavorsInner.md) |  |  |
+| **item** | [**ItemSummary**](ItemSummary.md) |  |  |
+| **natural_gift_type** | [**TypeSummary**](TypeSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerryDetail.new(
+  id: null,
+  name: null,
+  growth_time: null,
+  max_harvest: null,
+  natural_gift_power: null,
+  size: null,
+  smoothness: null,
+  soil_dryness: null,
+  firmness: null,
+  flavors: null,
+  item: null,
+  natural_gift_type: null
+)
+```
+

data/docs/BerryDetailFlavorsInner.md

@@ -0,0 +1,20 @@
+# PokeApiClient::BerryDetailFlavorsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **potency** | **Integer** |  |  |
+| **flavor** | [**BerryDetailFlavorsInnerFlavor**](BerryDetailFlavorsInnerFlavor.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerryDetailFlavorsInner.new(
+  potency: null,
+  flavor: null
+)
+```
+

data/docs/BerryDetailFlavorsInnerFlavor.md

@@ -0,0 +1,20 @@
+# PokeApiClient::BerryDetailFlavorsInnerFlavor
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the flavor | [optional] |
+| **url** | **String** | The URL to get more information about the flavor | [optional] |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerryDetailFlavorsInnerFlavor.new(
+  name: null,
+  url: null
+)
+```
+

data/docs/BerryFirmnessDetail.md

@@ -0,0 +1,24 @@
+# PokeApiClient::BerryFirmnessDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [readonly] |
+| **name** | **String** |  |  |
+| **berries** | [**Array<BerrySummary>**](BerrySummary.md) |  |  |
+| **names** | [**Array<BerryFirmnessName>**](BerryFirmnessName.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerryFirmnessDetail.new(
+  id: null,
+  name: null,
+  berries: null,
+  names: null
+)
+```
+

data/docs/BerryFirmnessName.md

@@ -0,0 +1,20 @@
+# PokeApiClient::BerryFirmnessName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **language** | [**LanguageSummary**](LanguageSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerryFirmnessName.new(
+  name: null,
+  language: null
+)
+```
+

data/docs/BerryFirmnessSummary.md

@@ -0,0 +1,20 @@
+# PokeApiClient::BerryFirmnessSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **url** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerryFirmnessSummary.new(
+  name: null,
+  url: null
+)
+```
+

data/docs/BerryFlavorDetail.md

@@ -0,0 +1,26 @@
+# PokeApiClient::BerryFlavorDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [readonly] |
+| **name** | **String** |  |  |
+| **berries** | [**Array<BerryFlavorDetailBerriesInner>**](BerryFlavorDetailBerriesInner.md) |  |  |
+| **contest_type** | [**ContestTypeSummary**](ContestTypeSummary.md) |  |  |
+| **names** | [**Array<BerryFlavorName>**](BerryFlavorName.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerryFlavorDetail.new(
+  id: null,
+  name: null,
+  berries: null,
+  contest_type: null,
+  names: null
+)
+```
+

data/docs/BerryFlavorDetailBerriesInner.md

@@ -0,0 +1,20 @@
+# PokeApiClient::BerryFlavorDetailBerriesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **potency** | **Integer** |  |  |
+| **berry** | [**BerryFlavorDetailBerriesInnerBerry**](BerryFlavorDetailBerriesInnerBerry.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerryFlavorDetailBerriesInner.new(
+  potency: null,
+  berry: null
+)
+```
+

data/docs/BerryFlavorDetailBerriesInnerBerry.md

@@ -0,0 +1,20 @@
+# PokeApiClient::BerryFlavorDetailBerriesInnerBerry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the berry | [optional] |
+| **url** | **String** | The URL to get more information about the berry | [optional] |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerryFlavorDetailBerriesInnerBerry.new(
+  name: null,
+  url: null
+)
+```
+

data/docs/BerryFlavorName.md

@@ -0,0 +1,20 @@
+# PokeApiClient::BerryFlavorName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **language** | [**LanguageSummary**](LanguageSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerryFlavorName.new(
+  name: null,
+  language: null
+)
+```
+

data/docs/BerryFlavorSummary.md

@@ -0,0 +1,20 @@
+# PokeApiClient::BerryFlavorSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **url** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerryFlavorSummary.new(
+  name: null,
+  url: null
+)
+```
+

data/docs/BerrySummary.md

@@ -0,0 +1,20 @@
+# PokeApiClient::BerrySummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **url** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::BerrySummary.new(
+  name: null,
+  url: null
+)
+```
+

data/docs/CharacteristicDescription.md

@@ -0,0 +1,20 @@
+# PokeApiClient::CharacteristicDescription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** |  | [optional] |
+| **language** | [**LanguageSummary**](LanguageSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::CharacteristicDescription.new(
+  description: null,
+  language: null
+)
+```
+

data/docs/CharacteristicDetail.md

@@ -0,0 +1,26 @@
+# PokeApiClient::CharacteristicDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [readonly] |
+| **gene_modulo** | **Integer** |  |  |
+| **possible_values** | **Array<Integer>** |  |  |
+| **highest_stat** | [**StatSummary**](StatSummary.md) |  |  |
+| **descriptions** | [**Array<CharacteristicDescription>**](CharacteristicDescription.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::CharacteristicDetail.new(
+  id: null,
+  gene_modulo: null,
+  possible_values: null,
+  highest_stat: null,
+  descriptions: null
+)
+```
+

data/docs/CharacteristicSummary.md

@@ -0,0 +1,18 @@
+# PokeApiClient::CharacteristicSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::CharacteristicSummary.new(
+  url: null
+)
+```
+

data/docs/ContestEffectDetail.md

@@ -0,0 +1,26 @@
+# PokeApiClient::ContestEffectDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [readonly] |
+| **appeal** | **Integer** |  |  |
+| **jam** | **Integer** |  |  |
+| **effect_entries** | [**Array<ContestEffectEffectText>**](ContestEffectEffectText.md) |  |  |
+| **flavor_text_entries** | [**Array<ContestEffectFlavorText>**](ContestEffectFlavorText.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::ContestEffectDetail.new(
+  id: null,
+  appeal: null,
+  jam: null,
+  effect_entries: null,
+  flavor_text_entries: null
+)
+```
+

data/docs/ContestEffectEffectText.md

@@ -0,0 +1,20 @@
+# PokeApiClient::ContestEffectEffectText
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **effect** | **String** |  |  |
+| **language** | [**LanguageSummary**](LanguageSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::ContestEffectEffectText.new(
+  effect: null,
+  language: null
+)
+```
+

data/docs/ContestEffectFlavorText.md

@@ -0,0 +1,20 @@
+# PokeApiClient::ContestEffectFlavorText
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **flavor_text** | **String** |  |  |
+| **language** | [**LanguageSummary**](LanguageSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::ContestEffectFlavorText.new(
+  flavor_text: null,
+  language: null
+)
+```
+

data/docs/ContestEffectSummary.md

@@ -0,0 +1,18 @@
+# PokeApiClient::ContestEffectSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::ContestEffectSummary.new(
+  url: null
+)
+```
+

data/docs/ContestTypeDetail.md

@@ -0,0 +1,24 @@
+# PokeApiClient::ContestTypeDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  | [readonly] |
+| **name** | **String** |  |  |
+| **berry_flavor** | [**BerryFlavorSummary**](BerryFlavorSummary.md) |  | [readonly] |
+| **names** | [**Array<ContestTypeName>**](ContestTypeName.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::ContestTypeDetail.new(
+  id: null,
+  name: null,
+  berry_flavor: null,
+  names: null
+)
+```
+

data/docs/ContestTypeName.md

@@ -0,0 +1,22 @@
+# PokeApiClient::ContestTypeName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **color** | **String** |  |  |
+| **language** | [**LanguageSummary**](LanguageSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::ContestTypeName.new(
+  name: null,
+  color: null,
+  language: null
+)
+```
+

data/docs/ContestTypeSummary.md

@@ -0,0 +1,20 @@
+# PokeApiClient::ContestTypeSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **url** | **String** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'pokeapi_client'
+
+instance = PokeApiClient::ContestTypeSummary.new(
+  name: null,
+  url: null
+)
+```
+