pokeapi_client 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +70 -0
- data/README.md +185 -0
- data/Rakefile +10 -0
- data/bin/bundle +114 -0
- data/bin/byebug +27 -0
- data/bin/coderay +27 -0
- data/bin/htmldiff +27 -0
- data/bin/ldiff +27 -0
- data/bin/pry +27 -0
- data/bin/rake +27 -0
- data/bin/rspec +27 -0
- data/bin/rubocop +27 -0
- data/bin/ruby-parse +27 -0
- data/bin/ruby-rewrite +27 -0
- data/docs/AbilityApi.md +137 -0
- data/docs/BerryApi.md +137 -0
- data/docs/BerryFirmnessApi.md +137 -0
- data/docs/BerryFlavorApi.md +137 -0
- data/docs/CharacteristicApi.md +137 -0
- data/docs/ContestEffectApi.md +137 -0
- data/docs/ContestTypeApi.md +137 -0
- data/docs/EggGroupApi.md +137 -0
- data/docs/EncounterConditionApi.md +137 -0
- data/docs/EncounterConditionValueApi.md +137 -0
- data/docs/EncounterMethodApi.md +137 -0
- data/docs/EvolutionChainApi.md +137 -0
- data/docs/EvolutionTriggerApi.md +137 -0
- data/docs/GenderApi.md +137 -0
- data/docs/GenerationApi.md +137 -0
- data/docs/GrowthRateApi.md +137 -0
- data/docs/ItemApi.md +137 -0
- data/docs/ItemAttributeApi.md +137 -0
- data/docs/ItemCategoryApi.md +137 -0
- data/docs/ItemFlingEffectApi.md +137 -0
- data/docs/ItemPocketApi.md +137 -0
- data/docs/LanguageApi.md +137 -0
- data/docs/LocationApi.md +137 -0
- data/docs/LocationAreaApi.md +137 -0
- data/docs/MachineApi.md +137 -0
- data/docs/MoveAilmentApi.md +137 -0
- data/docs/MoveApi.md +137 -0
- data/docs/MoveBattleStyleApi.md +137 -0
- data/docs/MoveCategoryApi.md +137 -0
- data/docs/MoveDamageClassApi.md +137 -0
- data/docs/MoveLearnMethodApi.md +137 -0
- data/docs/MoveTargetApi.md +137 -0
- data/docs/NatureApi.md +137 -0
- data/docs/PalParkAreaApi.md +137 -0
- data/docs/PokeathlonStatApi.md +137 -0
- data/docs/PokedexApi.md +137 -0
- data/docs/PokemonApi.md +137 -0
- data/docs/PokemonColorApi.md +137 -0
- data/docs/PokemonFormApi.md +137 -0
- data/docs/PokemonHabitatApi.md +137 -0
- data/docs/PokemonShapeApi.md +137 -0
- data/docs/PokemonSpeciesApi.md +137 -0
- data/docs/RegionApi.md +137 -0
- data/docs/StatApi.md +137 -0
- data/docs/SuperContestEffectApi.md +137 -0
- data/docs/TypeApi.md +137 -0
- data/docs/VersionApi.md +137 -0
- data/docs/VersionGroupApi.md +137 -0
- data/git_push.sh +57 -0
- data/pokeapi_client.gemspec +36 -0
- data/spec/api/ability_api_spec.rb +54 -0
- data/spec/api/berry_api_spec.rb +54 -0
- data/spec/api/berry_firmness_api_spec.rb +54 -0
- data/spec/api/berry_flavor_api_spec.rb +54 -0
- data/spec/api/characteristic_api_spec.rb +54 -0
- data/spec/api/contest_effect_api_spec.rb +54 -0
- data/spec/api/contest_type_api_spec.rb +54 -0
- data/spec/api/egg_group_api_spec.rb +54 -0
- data/spec/api/encounter_condition_api_spec.rb +54 -0
- data/spec/api/encounter_condition_value_api_spec.rb +54 -0
- data/spec/api/encounter_method_api_spec.rb +54 -0
- data/spec/api/evolution_chain_api_spec.rb +54 -0
- data/spec/api/evolution_trigger_api_spec.rb +54 -0
- data/spec/api/gender_api_spec.rb +54 -0
- data/spec/api/generation_api_spec.rb +54 -0
- data/spec/api/growth_rate_api_spec.rb +54 -0
- data/spec/api/item_api_spec.rb +54 -0
- data/spec/api/item_attribute_api_spec.rb +54 -0
- data/spec/api/item_category_api_spec.rb +54 -0
- data/spec/api/item_fling_effect_api_spec.rb +54 -0
- data/spec/api/item_pocket_api_spec.rb +54 -0
- data/spec/api/language_api_spec.rb +54 -0
- data/spec/api/location_api_spec.rb +54 -0
- data/spec/api/location_area_api_spec.rb +54 -0
- data/spec/api/machine_api_spec.rb +54 -0
- data/spec/api/move_ailment_api_spec.rb +54 -0
- data/spec/api/move_api_spec.rb +54 -0
- data/spec/api/move_battle_style_api_spec.rb +54 -0
- data/spec/api/move_category_api_spec.rb +54 -0
- data/spec/api/move_damage_class_api_spec.rb +54 -0
- data/spec/api/move_learn_method_api_spec.rb +54 -0
- data/spec/api/move_target_api_spec.rb +54 -0
- data/spec/api/nature_api_spec.rb +54 -0
- data/spec/api/pal_park_area_api_spec.rb +54 -0
- data/spec/api/pokeathlon_stat_api_spec.rb +54 -0
- data/spec/api/pokedex_api_spec.rb +54 -0
- data/spec/api/pokemon_api_spec.rb +54 -0
- data/spec/api/pokemon_color_api_spec.rb +54 -0
- data/spec/api/pokemon_form_api_spec.rb +54 -0
- data/spec/api/pokemon_habitat_api_spec.rb +54 -0
- data/spec/api/pokemon_shape_api_spec.rb +54 -0
- data/spec/api/pokemon_species_api_spec.rb +54 -0
- data/spec/api/region_api_spec.rb +54 -0
- data/spec/api/stat_api_spec.rb +54 -0
- data/spec/api/super_contest_effect_api_spec.rb +54 -0
- data/spec/api/type_api_spec.rb +54 -0
- data/spec/api/version_api_spec.rb +54 -0
- data/spec/api/version_group_api_spec.rb +54 -0
- data/spec/api_client_spec.rb +224 -0
- data/spec/configuration_spec.rb +40 -0
- data/spec/spec_helper.rb +109 -0
- metadata +250 -0
@@ -0,0 +1,137 @@
|
|
1
|
+
# PokeApiClient::ItemPocketApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pokeapi.co*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**item_pocket_list**](ItemPocketApi.md#item_pocket_list) | **GET** /api/v2/item-pocket/ | |
|
8
|
+
| [**item_pocket_read**](ItemPocketApi.md#item_pocket_read) | **GET** /api/v2/item-pocket/{id}/ | |
|
9
|
+
|
10
|
+
|
11
|
+
## item_pocket_list
|
12
|
+
|
13
|
+
> String item_pocket_list(opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
### Examples
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'time'
|
21
|
+
require 'pokeapi_client'
|
22
|
+
|
23
|
+
api_instance = PokeApiClient::ItemPocketApi.new
|
24
|
+
opts = {
|
25
|
+
limit: 56, # Integer |
|
26
|
+
offset: 56 # Integer |
|
27
|
+
}
|
28
|
+
|
29
|
+
begin
|
30
|
+
|
31
|
+
result = api_instance.item_pocket_list(opts)
|
32
|
+
p result
|
33
|
+
rescue PokeApiClient::ApiError => e
|
34
|
+
puts "Error when calling ItemPocketApi->item_pocket_list: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Using the item_pocket_list_with_http_info variant
|
39
|
+
|
40
|
+
This returns an Array which contains the response data, status code and headers.
|
41
|
+
|
42
|
+
> <Array(String, Integer, Hash)> item_pocket_list_with_http_info(opts)
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
begin
|
46
|
+
|
47
|
+
data, status_code, headers = api_instance.item_pocket_list_with_http_info(opts)
|
48
|
+
p status_code # => 2xx
|
49
|
+
p headers # => { ... }
|
50
|
+
p data # => String
|
51
|
+
rescue PokeApiClient::ApiError => e
|
52
|
+
puts "Error when calling ItemPocketApi->item_pocket_list_with_http_info: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
| Name | Type | Description | Notes |
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
60
|
+
| **limit** | **Integer** | | [optional] |
|
61
|
+
| **offset** | **Integer** | | [optional] |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
**String**
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
No authorization required
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: Not defined
|
74
|
+
- **Accept**: text/plain
|
75
|
+
|
76
|
+
|
77
|
+
## item_pocket_read
|
78
|
+
|
79
|
+
> String item_pocket_read(id)
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
### Examples
|
84
|
+
|
85
|
+
```ruby
|
86
|
+
require 'time'
|
87
|
+
require 'pokeapi_client'
|
88
|
+
|
89
|
+
api_instance = PokeApiClient::ItemPocketApi.new
|
90
|
+
id = 56 # Integer |
|
91
|
+
|
92
|
+
begin
|
93
|
+
|
94
|
+
result = api_instance.item_pocket_read(id)
|
95
|
+
p result
|
96
|
+
rescue PokeApiClient::ApiError => e
|
97
|
+
puts "Error when calling ItemPocketApi->item_pocket_read: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
#### Using the item_pocket_read_with_http_info variant
|
102
|
+
|
103
|
+
This returns an Array which contains the response data, status code and headers.
|
104
|
+
|
105
|
+
> <Array(String, Integer, Hash)> item_pocket_read_with_http_info(id)
|
106
|
+
|
107
|
+
```ruby
|
108
|
+
begin
|
109
|
+
|
110
|
+
data, status_code, headers = api_instance.item_pocket_read_with_http_info(id)
|
111
|
+
p status_code # => 2xx
|
112
|
+
p headers # => { ... }
|
113
|
+
p data # => String
|
114
|
+
rescue PokeApiClient::ApiError => e
|
115
|
+
puts "Error when calling ItemPocketApi->item_pocket_read_with_http_info: #{e}"
|
116
|
+
end
|
117
|
+
```
|
118
|
+
|
119
|
+
### Parameters
|
120
|
+
|
121
|
+
| Name | Type | Description | Notes |
|
122
|
+
| ---- | ---- | ----------- | ----- |
|
123
|
+
| **id** | **Integer** | | |
|
124
|
+
|
125
|
+
### Return type
|
126
|
+
|
127
|
+
**String**
|
128
|
+
|
129
|
+
### Authorization
|
130
|
+
|
131
|
+
No authorization required
|
132
|
+
|
133
|
+
### HTTP request headers
|
134
|
+
|
135
|
+
- **Content-Type**: Not defined
|
136
|
+
- **Accept**: text/plain
|
137
|
+
|
data/docs/LanguageApi.md
ADDED
@@ -0,0 +1,137 @@
|
|
1
|
+
# PokeApiClient::LanguageApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pokeapi.co*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**language_list**](LanguageApi.md#language_list) | **GET** /api/v2/language/ | |
|
8
|
+
| [**language_read**](LanguageApi.md#language_read) | **GET** /api/v2/language/{id}/ | |
|
9
|
+
|
10
|
+
|
11
|
+
## language_list
|
12
|
+
|
13
|
+
> String language_list(opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
### Examples
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'time'
|
21
|
+
require 'pokeapi_client'
|
22
|
+
|
23
|
+
api_instance = PokeApiClient::LanguageApi.new
|
24
|
+
opts = {
|
25
|
+
limit: 56, # Integer |
|
26
|
+
offset: 56 # Integer |
|
27
|
+
}
|
28
|
+
|
29
|
+
begin
|
30
|
+
|
31
|
+
result = api_instance.language_list(opts)
|
32
|
+
p result
|
33
|
+
rescue PokeApiClient::ApiError => e
|
34
|
+
puts "Error when calling LanguageApi->language_list: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Using the language_list_with_http_info variant
|
39
|
+
|
40
|
+
This returns an Array which contains the response data, status code and headers.
|
41
|
+
|
42
|
+
> <Array(String, Integer, Hash)> language_list_with_http_info(opts)
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
begin
|
46
|
+
|
47
|
+
data, status_code, headers = api_instance.language_list_with_http_info(opts)
|
48
|
+
p status_code # => 2xx
|
49
|
+
p headers # => { ... }
|
50
|
+
p data # => String
|
51
|
+
rescue PokeApiClient::ApiError => e
|
52
|
+
puts "Error when calling LanguageApi->language_list_with_http_info: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
| Name | Type | Description | Notes |
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
60
|
+
| **limit** | **Integer** | | [optional] |
|
61
|
+
| **offset** | **Integer** | | [optional] |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
**String**
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
No authorization required
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: Not defined
|
74
|
+
- **Accept**: text/plain
|
75
|
+
|
76
|
+
|
77
|
+
## language_read
|
78
|
+
|
79
|
+
> String language_read(id)
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
### Examples
|
84
|
+
|
85
|
+
```ruby
|
86
|
+
require 'time'
|
87
|
+
require 'pokeapi_client'
|
88
|
+
|
89
|
+
api_instance = PokeApiClient::LanguageApi.new
|
90
|
+
id = 56 # Integer |
|
91
|
+
|
92
|
+
begin
|
93
|
+
|
94
|
+
result = api_instance.language_read(id)
|
95
|
+
p result
|
96
|
+
rescue PokeApiClient::ApiError => e
|
97
|
+
puts "Error when calling LanguageApi->language_read: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
#### Using the language_read_with_http_info variant
|
102
|
+
|
103
|
+
This returns an Array which contains the response data, status code and headers.
|
104
|
+
|
105
|
+
> <Array(String, Integer, Hash)> language_read_with_http_info(id)
|
106
|
+
|
107
|
+
```ruby
|
108
|
+
begin
|
109
|
+
|
110
|
+
data, status_code, headers = api_instance.language_read_with_http_info(id)
|
111
|
+
p status_code # => 2xx
|
112
|
+
p headers # => { ... }
|
113
|
+
p data # => String
|
114
|
+
rescue PokeApiClient::ApiError => e
|
115
|
+
puts "Error when calling LanguageApi->language_read_with_http_info: #{e}"
|
116
|
+
end
|
117
|
+
```
|
118
|
+
|
119
|
+
### Parameters
|
120
|
+
|
121
|
+
| Name | Type | Description | Notes |
|
122
|
+
| ---- | ---- | ----------- | ----- |
|
123
|
+
| **id** | **Integer** | | |
|
124
|
+
|
125
|
+
### Return type
|
126
|
+
|
127
|
+
**String**
|
128
|
+
|
129
|
+
### Authorization
|
130
|
+
|
131
|
+
No authorization required
|
132
|
+
|
133
|
+
### HTTP request headers
|
134
|
+
|
135
|
+
- **Content-Type**: Not defined
|
136
|
+
- **Accept**: text/plain
|
137
|
+
|
data/docs/LocationApi.md
ADDED
@@ -0,0 +1,137 @@
|
|
1
|
+
# PokeApiClient::LocationApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pokeapi.co*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**location_list**](LocationApi.md#location_list) | **GET** /api/v2/location/ | |
|
8
|
+
| [**location_read**](LocationApi.md#location_read) | **GET** /api/v2/location/{id}/ | |
|
9
|
+
|
10
|
+
|
11
|
+
## location_list
|
12
|
+
|
13
|
+
> String location_list(opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
### Examples
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'time'
|
21
|
+
require 'pokeapi_client'
|
22
|
+
|
23
|
+
api_instance = PokeApiClient::LocationApi.new
|
24
|
+
opts = {
|
25
|
+
limit: 56, # Integer |
|
26
|
+
offset: 56 # Integer |
|
27
|
+
}
|
28
|
+
|
29
|
+
begin
|
30
|
+
|
31
|
+
result = api_instance.location_list(opts)
|
32
|
+
p result
|
33
|
+
rescue PokeApiClient::ApiError => e
|
34
|
+
puts "Error when calling LocationApi->location_list: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Using the location_list_with_http_info variant
|
39
|
+
|
40
|
+
This returns an Array which contains the response data, status code and headers.
|
41
|
+
|
42
|
+
> <Array(String, Integer, Hash)> location_list_with_http_info(opts)
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
begin
|
46
|
+
|
47
|
+
data, status_code, headers = api_instance.location_list_with_http_info(opts)
|
48
|
+
p status_code # => 2xx
|
49
|
+
p headers # => { ... }
|
50
|
+
p data # => String
|
51
|
+
rescue PokeApiClient::ApiError => e
|
52
|
+
puts "Error when calling LocationApi->location_list_with_http_info: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
| Name | Type | Description | Notes |
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
60
|
+
| **limit** | **Integer** | | [optional] |
|
61
|
+
| **offset** | **Integer** | | [optional] |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
**String**
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
No authorization required
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: Not defined
|
74
|
+
- **Accept**: text/plain
|
75
|
+
|
76
|
+
|
77
|
+
## location_read
|
78
|
+
|
79
|
+
> String location_read(id)
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
### Examples
|
84
|
+
|
85
|
+
```ruby
|
86
|
+
require 'time'
|
87
|
+
require 'pokeapi_client'
|
88
|
+
|
89
|
+
api_instance = PokeApiClient::LocationApi.new
|
90
|
+
id = 56 # Integer |
|
91
|
+
|
92
|
+
begin
|
93
|
+
|
94
|
+
result = api_instance.location_read(id)
|
95
|
+
p result
|
96
|
+
rescue PokeApiClient::ApiError => e
|
97
|
+
puts "Error when calling LocationApi->location_read: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
#### Using the location_read_with_http_info variant
|
102
|
+
|
103
|
+
This returns an Array which contains the response data, status code and headers.
|
104
|
+
|
105
|
+
> <Array(String, Integer, Hash)> location_read_with_http_info(id)
|
106
|
+
|
107
|
+
```ruby
|
108
|
+
begin
|
109
|
+
|
110
|
+
data, status_code, headers = api_instance.location_read_with_http_info(id)
|
111
|
+
p status_code # => 2xx
|
112
|
+
p headers # => { ... }
|
113
|
+
p data # => String
|
114
|
+
rescue PokeApiClient::ApiError => e
|
115
|
+
puts "Error when calling LocationApi->location_read_with_http_info: #{e}"
|
116
|
+
end
|
117
|
+
```
|
118
|
+
|
119
|
+
### Parameters
|
120
|
+
|
121
|
+
| Name | Type | Description | Notes |
|
122
|
+
| ---- | ---- | ----------- | ----- |
|
123
|
+
| **id** | **Integer** | | |
|
124
|
+
|
125
|
+
### Return type
|
126
|
+
|
127
|
+
**String**
|
128
|
+
|
129
|
+
### Authorization
|
130
|
+
|
131
|
+
No authorization required
|
132
|
+
|
133
|
+
### HTTP request headers
|
134
|
+
|
135
|
+
- **Content-Type**: Not defined
|
136
|
+
- **Accept**: text/plain
|
137
|
+
|
@@ -0,0 +1,137 @@
|
|
1
|
+
# PokeApiClient::LocationAreaApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pokeapi.co*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**location_area_list**](LocationAreaApi.md#location_area_list) | **GET** /api/v2/location-area/ | |
|
8
|
+
| [**location_area_read**](LocationAreaApi.md#location_area_read) | **GET** /api/v2/location-area/{id}/ | |
|
9
|
+
|
10
|
+
|
11
|
+
## location_area_list
|
12
|
+
|
13
|
+
> String location_area_list(opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
### Examples
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'time'
|
21
|
+
require 'pokeapi_client'
|
22
|
+
|
23
|
+
api_instance = PokeApiClient::LocationAreaApi.new
|
24
|
+
opts = {
|
25
|
+
limit: 56, # Integer |
|
26
|
+
offset: 56 # Integer |
|
27
|
+
}
|
28
|
+
|
29
|
+
begin
|
30
|
+
|
31
|
+
result = api_instance.location_area_list(opts)
|
32
|
+
p result
|
33
|
+
rescue PokeApiClient::ApiError => e
|
34
|
+
puts "Error when calling LocationAreaApi->location_area_list: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Using the location_area_list_with_http_info variant
|
39
|
+
|
40
|
+
This returns an Array which contains the response data, status code and headers.
|
41
|
+
|
42
|
+
> <Array(String, Integer, Hash)> location_area_list_with_http_info(opts)
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
begin
|
46
|
+
|
47
|
+
data, status_code, headers = api_instance.location_area_list_with_http_info(opts)
|
48
|
+
p status_code # => 2xx
|
49
|
+
p headers # => { ... }
|
50
|
+
p data # => String
|
51
|
+
rescue PokeApiClient::ApiError => e
|
52
|
+
puts "Error when calling LocationAreaApi->location_area_list_with_http_info: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
| Name | Type | Description | Notes |
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
60
|
+
| **limit** | **Integer** | | [optional] |
|
61
|
+
| **offset** | **Integer** | | [optional] |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
**String**
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
No authorization required
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: Not defined
|
74
|
+
- **Accept**: text/plain
|
75
|
+
|
76
|
+
|
77
|
+
## location_area_read
|
78
|
+
|
79
|
+
> String location_area_read(id)
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
### Examples
|
84
|
+
|
85
|
+
```ruby
|
86
|
+
require 'time'
|
87
|
+
require 'pokeapi_client'
|
88
|
+
|
89
|
+
api_instance = PokeApiClient::LocationAreaApi.new
|
90
|
+
id = 56 # Integer |
|
91
|
+
|
92
|
+
begin
|
93
|
+
|
94
|
+
result = api_instance.location_area_read(id)
|
95
|
+
p result
|
96
|
+
rescue PokeApiClient::ApiError => e
|
97
|
+
puts "Error when calling LocationAreaApi->location_area_read: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
#### Using the location_area_read_with_http_info variant
|
102
|
+
|
103
|
+
This returns an Array which contains the response data, status code and headers.
|
104
|
+
|
105
|
+
> <Array(String, Integer, Hash)> location_area_read_with_http_info(id)
|
106
|
+
|
107
|
+
```ruby
|
108
|
+
begin
|
109
|
+
|
110
|
+
data, status_code, headers = api_instance.location_area_read_with_http_info(id)
|
111
|
+
p status_code # => 2xx
|
112
|
+
p headers # => { ... }
|
113
|
+
p data # => String
|
114
|
+
rescue PokeApiClient::ApiError => e
|
115
|
+
puts "Error when calling LocationAreaApi->location_area_read_with_http_info: #{e}"
|
116
|
+
end
|
117
|
+
```
|
118
|
+
|
119
|
+
### Parameters
|
120
|
+
|
121
|
+
| Name | Type | Description | Notes |
|
122
|
+
| ---- | ---- | ----------- | ----- |
|
123
|
+
| **id** | **Integer** | | |
|
124
|
+
|
125
|
+
### Return type
|
126
|
+
|
127
|
+
**String**
|
128
|
+
|
129
|
+
### Authorization
|
130
|
+
|
131
|
+
No authorization required
|
132
|
+
|
133
|
+
### HTTP request headers
|
134
|
+
|
135
|
+
- **Content-Type**: Not defined
|
136
|
+
- **Accept**: text/plain
|
137
|
+
|
data/docs/MachineApi.md
ADDED
@@ -0,0 +1,137 @@
|
|
1
|
+
# PokeApiClient::MachineApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://pokeapi.co*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**machine_list**](MachineApi.md#machine_list) | **GET** /api/v2/machine/ | |
|
8
|
+
| [**machine_read**](MachineApi.md#machine_read) | **GET** /api/v2/machine/{id}/ | |
|
9
|
+
|
10
|
+
|
11
|
+
## machine_list
|
12
|
+
|
13
|
+
> String machine_list(opts)
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
### Examples
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'time'
|
21
|
+
require 'pokeapi_client'
|
22
|
+
|
23
|
+
api_instance = PokeApiClient::MachineApi.new
|
24
|
+
opts = {
|
25
|
+
limit: 56, # Integer |
|
26
|
+
offset: 56 # Integer |
|
27
|
+
}
|
28
|
+
|
29
|
+
begin
|
30
|
+
|
31
|
+
result = api_instance.machine_list(opts)
|
32
|
+
p result
|
33
|
+
rescue PokeApiClient::ApiError => e
|
34
|
+
puts "Error when calling MachineApi->machine_list: #{e}"
|
35
|
+
end
|
36
|
+
```
|
37
|
+
|
38
|
+
#### Using the machine_list_with_http_info variant
|
39
|
+
|
40
|
+
This returns an Array which contains the response data, status code and headers.
|
41
|
+
|
42
|
+
> <Array(String, Integer, Hash)> machine_list_with_http_info(opts)
|
43
|
+
|
44
|
+
```ruby
|
45
|
+
begin
|
46
|
+
|
47
|
+
data, status_code, headers = api_instance.machine_list_with_http_info(opts)
|
48
|
+
p status_code # => 2xx
|
49
|
+
p headers # => { ... }
|
50
|
+
p data # => String
|
51
|
+
rescue PokeApiClient::ApiError => e
|
52
|
+
puts "Error when calling MachineApi->machine_list_with_http_info: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
| Name | Type | Description | Notes |
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
60
|
+
| **limit** | **Integer** | | [optional] |
|
61
|
+
| **offset** | **Integer** | | [optional] |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
**String**
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
No authorization required
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: Not defined
|
74
|
+
- **Accept**: text/plain
|
75
|
+
|
76
|
+
|
77
|
+
## machine_read
|
78
|
+
|
79
|
+
> String machine_read(id)
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
### Examples
|
84
|
+
|
85
|
+
```ruby
|
86
|
+
require 'time'
|
87
|
+
require 'pokeapi_client'
|
88
|
+
|
89
|
+
api_instance = PokeApiClient::MachineApi.new
|
90
|
+
id = 56 # Integer |
|
91
|
+
|
92
|
+
begin
|
93
|
+
|
94
|
+
result = api_instance.machine_read(id)
|
95
|
+
p result
|
96
|
+
rescue PokeApiClient::ApiError => e
|
97
|
+
puts "Error when calling MachineApi->machine_read: #{e}"
|
98
|
+
end
|
99
|
+
```
|
100
|
+
|
101
|
+
#### Using the machine_read_with_http_info variant
|
102
|
+
|
103
|
+
This returns an Array which contains the response data, status code and headers.
|
104
|
+
|
105
|
+
> <Array(String, Integer, Hash)> machine_read_with_http_info(id)
|
106
|
+
|
107
|
+
```ruby
|
108
|
+
begin
|
109
|
+
|
110
|
+
data, status_code, headers = api_instance.machine_read_with_http_info(id)
|
111
|
+
p status_code # => 2xx
|
112
|
+
p headers # => { ... }
|
113
|
+
p data # => String
|
114
|
+
rescue PokeApiClient::ApiError => e
|
115
|
+
puts "Error when calling MachineApi->machine_read_with_http_info: #{e}"
|
116
|
+
end
|
117
|
+
```
|
118
|
+
|
119
|
+
### Parameters
|
120
|
+
|
121
|
+
| Name | Type | Description | Notes |
|
122
|
+
| ---- | ---- | ----------- | ----- |
|
123
|
+
| **id** | **Integer** | | |
|
124
|
+
|
125
|
+
### Return type
|
126
|
+
|
127
|
+
**String**
|
128
|
+
|
129
|
+
### Authorization
|
130
|
+
|
131
|
+
No authorization required
|
132
|
+
|
133
|
+
### HTTP request headers
|
134
|
+
|
135
|
+
- **Content-Type**: Not defined
|
136
|
+
- **Accept**: text/plain
|
137
|
+
|