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.
Files changed (118) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/Gemfile.lock +70 -0
  4. data/README.md +185 -0
  5. data/Rakefile +10 -0
  6. data/bin/bundle +114 -0
  7. data/bin/byebug +27 -0
  8. data/bin/coderay +27 -0
  9. data/bin/htmldiff +27 -0
  10. data/bin/ldiff +27 -0
  11. data/bin/pry +27 -0
  12. data/bin/rake +27 -0
  13. data/bin/rspec +27 -0
  14. data/bin/rubocop +27 -0
  15. data/bin/ruby-parse +27 -0
  16. data/bin/ruby-rewrite +27 -0
  17. data/docs/AbilityApi.md +137 -0
  18. data/docs/BerryApi.md +137 -0
  19. data/docs/BerryFirmnessApi.md +137 -0
  20. data/docs/BerryFlavorApi.md +137 -0
  21. data/docs/CharacteristicApi.md +137 -0
  22. data/docs/ContestEffectApi.md +137 -0
  23. data/docs/ContestTypeApi.md +137 -0
  24. data/docs/EggGroupApi.md +137 -0
  25. data/docs/EncounterConditionApi.md +137 -0
  26. data/docs/EncounterConditionValueApi.md +137 -0
  27. data/docs/EncounterMethodApi.md +137 -0
  28. data/docs/EvolutionChainApi.md +137 -0
  29. data/docs/EvolutionTriggerApi.md +137 -0
  30. data/docs/GenderApi.md +137 -0
  31. data/docs/GenerationApi.md +137 -0
  32. data/docs/GrowthRateApi.md +137 -0
  33. data/docs/ItemApi.md +137 -0
  34. data/docs/ItemAttributeApi.md +137 -0
  35. data/docs/ItemCategoryApi.md +137 -0
  36. data/docs/ItemFlingEffectApi.md +137 -0
  37. data/docs/ItemPocketApi.md +137 -0
  38. data/docs/LanguageApi.md +137 -0
  39. data/docs/LocationApi.md +137 -0
  40. data/docs/LocationAreaApi.md +137 -0
  41. data/docs/MachineApi.md +137 -0
  42. data/docs/MoveAilmentApi.md +137 -0
  43. data/docs/MoveApi.md +137 -0
  44. data/docs/MoveBattleStyleApi.md +137 -0
  45. data/docs/MoveCategoryApi.md +137 -0
  46. data/docs/MoveDamageClassApi.md +137 -0
  47. data/docs/MoveLearnMethodApi.md +137 -0
  48. data/docs/MoveTargetApi.md +137 -0
  49. data/docs/NatureApi.md +137 -0
  50. data/docs/PalParkAreaApi.md +137 -0
  51. data/docs/PokeathlonStatApi.md +137 -0
  52. data/docs/PokedexApi.md +137 -0
  53. data/docs/PokemonApi.md +137 -0
  54. data/docs/PokemonColorApi.md +137 -0
  55. data/docs/PokemonFormApi.md +137 -0
  56. data/docs/PokemonHabitatApi.md +137 -0
  57. data/docs/PokemonShapeApi.md +137 -0
  58. data/docs/PokemonSpeciesApi.md +137 -0
  59. data/docs/RegionApi.md +137 -0
  60. data/docs/StatApi.md +137 -0
  61. data/docs/SuperContestEffectApi.md +137 -0
  62. data/docs/TypeApi.md +137 -0
  63. data/docs/VersionApi.md +137 -0
  64. data/docs/VersionGroupApi.md +137 -0
  65. data/git_push.sh +57 -0
  66. data/pokeapi_client.gemspec +36 -0
  67. data/spec/api/ability_api_spec.rb +54 -0
  68. data/spec/api/berry_api_spec.rb +54 -0
  69. data/spec/api/berry_firmness_api_spec.rb +54 -0
  70. data/spec/api/berry_flavor_api_spec.rb +54 -0
  71. data/spec/api/characteristic_api_spec.rb +54 -0
  72. data/spec/api/contest_effect_api_spec.rb +54 -0
  73. data/spec/api/contest_type_api_spec.rb +54 -0
  74. data/spec/api/egg_group_api_spec.rb +54 -0
  75. data/spec/api/encounter_condition_api_spec.rb +54 -0
  76. data/spec/api/encounter_condition_value_api_spec.rb +54 -0
  77. data/spec/api/encounter_method_api_spec.rb +54 -0
  78. data/spec/api/evolution_chain_api_spec.rb +54 -0
  79. data/spec/api/evolution_trigger_api_spec.rb +54 -0
  80. data/spec/api/gender_api_spec.rb +54 -0
  81. data/spec/api/generation_api_spec.rb +54 -0
  82. data/spec/api/growth_rate_api_spec.rb +54 -0
  83. data/spec/api/item_api_spec.rb +54 -0
  84. data/spec/api/item_attribute_api_spec.rb +54 -0
  85. data/spec/api/item_category_api_spec.rb +54 -0
  86. data/spec/api/item_fling_effect_api_spec.rb +54 -0
  87. data/spec/api/item_pocket_api_spec.rb +54 -0
  88. data/spec/api/language_api_spec.rb +54 -0
  89. data/spec/api/location_api_spec.rb +54 -0
  90. data/spec/api/location_area_api_spec.rb +54 -0
  91. data/spec/api/machine_api_spec.rb +54 -0
  92. data/spec/api/move_ailment_api_spec.rb +54 -0
  93. data/spec/api/move_api_spec.rb +54 -0
  94. data/spec/api/move_battle_style_api_spec.rb +54 -0
  95. data/spec/api/move_category_api_spec.rb +54 -0
  96. data/spec/api/move_damage_class_api_spec.rb +54 -0
  97. data/spec/api/move_learn_method_api_spec.rb +54 -0
  98. data/spec/api/move_target_api_spec.rb +54 -0
  99. data/spec/api/nature_api_spec.rb +54 -0
  100. data/spec/api/pal_park_area_api_spec.rb +54 -0
  101. data/spec/api/pokeathlon_stat_api_spec.rb +54 -0
  102. data/spec/api/pokedex_api_spec.rb +54 -0
  103. data/spec/api/pokemon_api_spec.rb +54 -0
  104. data/spec/api/pokemon_color_api_spec.rb +54 -0
  105. data/spec/api/pokemon_form_api_spec.rb +54 -0
  106. data/spec/api/pokemon_habitat_api_spec.rb +54 -0
  107. data/spec/api/pokemon_shape_api_spec.rb +54 -0
  108. data/spec/api/pokemon_species_api_spec.rb +54 -0
  109. data/spec/api/region_api_spec.rb +54 -0
  110. data/spec/api/stat_api_spec.rb +54 -0
  111. data/spec/api/super_contest_effect_api_spec.rb +54 -0
  112. data/spec/api/type_api_spec.rb +54 -0
  113. data/spec/api/version_api_spec.rb +54 -0
  114. data/spec/api/version_group_api_spec.rb +54 -0
  115. data/spec/api_client_spec.rb +224 -0
  116. data/spec/configuration_spec.rb +40 -0
  117. data/spec/spec_helper.rb +109 -0
  118. metadata +250 -0
data/bin/ruby-rewrite ADDED
@@ -0,0 +1,27 @@
1
+ #!/usr/bin/env ruby2.7
2
+ # frozen_string_literal: true
3
+
4
+ #
5
+ # This file was generated by Bundler.
6
+ #
7
+ # The application 'ruby-rewrite' is installed as part of a gem, and
8
+ # this file is here to facilitate running it.
9
+ #
10
+
11
+ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
12
+
13
+ bundle_binstub = File.expand_path("bundle", __dir__)
14
+
15
+ if File.file?(bundle_binstub)
16
+ if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
17
+ load(bundle_binstub)
18
+ else
19
+ abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
20
+ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
21
+ end
22
+ end
23
+
24
+ require "rubygems"
25
+ require "bundler/setup"
26
+
27
+ load Gem.bin_path("parser", "ruby-rewrite")
@@ -0,0 +1,137 @@
1
+ # PokeApiClient::AbilityApi
2
+
3
+ All URIs are relative to *https://pokeapi.co*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**ability_list**](AbilityApi.md#ability_list) | **GET** /api/v2/ability/ | |
8
+ | [**ability_read**](AbilityApi.md#ability_read) | **GET** /api/v2/ability/{id}/ | |
9
+
10
+
11
+ ## ability_list
12
+
13
+ > String ability_list(opts)
14
+
15
+
16
+
17
+ ### Examples
18
+
19
+ ```ruby
20
+ require 'time'
21
+ require 'pokeapi_client'
22
+
23
+ api_instance = PokeApiClient::AbilityApi.new
24
+ opts = {
25
+ limit: 56, # Integer |
26
+ offset: 56 # Integer |
27
+ }
28
+
29
+ begin
30
+
31
+ result = api_instance.ability_list(opts)
32
+ p result
33
+ rescue PokeApiClient::ApiError => e
34
+ puts "Error when calling AbilityApi->ability_list: #{e}"
35
+ end
36
+ ```
37
+
38
+ #### Using the ability_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)> ability_list_with_http_info(opts)
43
+
44
+ ```ruby
45
+ begin
46
+
47
+ data, status_code, headers = api_instance.ability_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 AbilityApi->ability_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
+ ## ability_read
78
+
79
+ > String ability_read(id)
80
+
81
+
82
+
83
+ ### Examples
84
+
85
+ ```ruby
86
+ require 'time'
87
+ require 'pokeapi_client'
88
+
89
+ api_instance = PokeApiClient::AbilityApi.new
90
+ id = 56 # Integer |
91
+
92
+ begin
93
+
94
+ result = api_instance.ability_read(id)
95
+ p result
96
+ rescue PokeApiClient::ApiError => e
97
+ puts "Error when calling AbilityApi->ability_read: #{e}"
98
+ end
99
+ ```
100
+
101
+ #### Using the ability_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)> ability_read_with_http_info(id)
106
+
107
+ ```ruby
108
+ begin
109
+
110
+ data, status_code, headers = api_instance.ability_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 AbilityApi->ability_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/BerryApi.md ADDED
@@ -0,0 +1,137 @@
1
+ # PokeApiClient::BerryApi
2
+
3
+ All URIs are relative to *https://pokeapi.co*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**berry_list**](BerryApi.md#berry_list) | **GET** /api/v2/berry/ | |
8
+ | [**berry_read**](BerryApi.md#berry_read) | **GET** /api/v2/berry/{id}/ | |
9
+
10
+
11
+ ## berry_list
12
+
13
+ > String berry_list(opts)
14
+
15
+
16
+
17
+ ### Examples
18
+
19
+ ```ruby
20
+ require 'time'
21
+ require 'pokeapi_client'
22
+
23
+ api_instance = PokeApiClient::BerryApi.new
24
+ opts = {
25
+ limit: 56, # Integer |
26
+ offset: 56 # Integer |
27
+ }
28
+
29
+ begin
30
+
31
+ result = api_instance.berry_list(opts)
32
+ p result
33
+ rescue PokeApiClient::ApiError => e
34
+ puts "Error when calling BerryApi->berry_list: #{e}"
35
+ end
36
+ ```
37
+
38
+ #### Using the berry_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)> berry_list_with_http_info(opts)
43
+
44
+ ```ruby
45
+ begin
46
+
47
+ data, status_code, headers = api_instance.berry_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 BerryApi->berry_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
+ ## berry_read
78
+
79
+ > String berry_read(id)
80
+
81
+
82
+
83
+ ### Examples
84
+
85
+ ```ruby
86
+ require 'time'
87
+ require 'pokeapi_client'
88
+
89
+ api_instance = PokeApiClient::BerryApi.new
90
+ id = 56 # Integer |
91
+
92
+ begin
93
+
94
+ result = api_instance.berry_read(id)
95
+ p result
96
+ rescue PokeApiClient::ApiError => e
97
+ puts "Error when calling BerryApi->berry_read: #{e}"
98
+ end
99
+ ```
100
+
101
+ #### Using the berry_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)> berry_read_with_http_info(id)
106
+
107
+ ```ruby
108
+ begin
109
+
110
+ data, status_code, headers = api_instance.berry_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 BerryApi->berry_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::BerryFirmnessApi
2
+
3
+ All URIs are relative to *https://pokeapi.co*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**berry_firmness_list**](BerryFirmnessApi.md#berry_firmness_list) | **GET** /api/v2/berry-firmness/ | |
8
+ | [**berry_firmness_read**](BerryFirmnessApi.md#berry_firmness_read) | **GET** /api/v2/berry-firmness/{id}/ | |
9
+
10
+
11
+ ## berry_firmness_list
12
+
13
+ > String berry_firmness_list(opts)
14
+
15
+
16
+
17
+ ### Examples
18
+
19
+ ```ruby
20
+ require 'time'
21
+ require 'pokeapi_client'
22
+
23
+ api_instance = PokeApiClient::BerryFirmnessApi.new
24
+ opts = {
25
+ limit: 56, # Integer |
26
+ offset: 56 # Integer |
27
+ }
28
+
29
+ begin
30
+
31
+ result = api_instance.berry_firmness_list(opts)
32
+ p result
33
+ rescue PokeApiClient::ApiError => e
34
+ puts "Error when calling BerryFirmnessApi->berry_firmness_list: #{e}"
35
+ end
36
+ ```
37
+
38
+ #### Using the berry_firmness_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)> berry_firmness_list_with_http_info(opts)
43
+
44
+ ```ruby
45
+ begin
46
+
47
+ data, status_code, headers = api_instance.berry_firmness_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 BerryFirmnessApi->berry_firmness_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
+ ## berry_firmness_read
78
+
79
+ > String berry_firmness_read(id)
80
+
81
+
82
+
83
+ ### Examples
84
+
85
+ ```ruby
86
+ require 'time'
87
+ require 'pokeapi_client'
88
+
89
+ api_instance = PokeApiClient::BerryFirmnessApi.new
90
+ id = 56 # Integer |
91
+
92
+ begin
93
+
94
+ result = api_instance.berry_firmness_read(id)
95
+ p result
96
+ rescue PokeApiClient::ApiError => e
97
+ puts "Error when calling BerryFirmnessApi->berry_firmness_read: #{e}"
98
+ end
99
+ ```
100
+
101
+ #### Using the berry_firmness_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)> berry_firmness_read_with_http_info(id)
106
+
107
+ ```ruby
108
+ begin
109
+
110
+ data, status_code, headers = api_instance.berry_firmness_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 BerryFirmnessApi->berry_firmness_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::BerryFlavorApi
2
+
3
+ All URIs are relative to *https://pokeapi.co*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**berry_flavor_list**](BerryFlavorApi.md#berry_flavor_list) | **GET** /api/v2/berry-flavor/ | |
8
+ | [**berry_flavor_read**](BerryFlavorApi.md#berry_flavor_read) | **GET** /api/v2/berry-flavor/{id}/ | |
9
+
10
+
11
+ ## berry_flavor_list
12
+
13
+ > String berry_flavor_list(opts)
14
+
15
+
16
+
17
+ ### Examples
18
+
19
+ ```ruby
20
+ require 'time'
21
+ require 'pokeapi_client'
22
+
23
+ api_instance = PokeApiClient::BerryFlavorApi.new
24
+ opts = {
25
+ limit: 56, # Integer |
26
+ offset: 56 # Integer |
27
+ }
28
+
29
+ begin
30
+
31
+ result = api_instance.berry_flavor_list(opts)
32
+ p result
33
+ rescue PokeApiClient::ApiError => e
34
+ puts "Error when calling BerryFlavorApi->berry_flavor_list: #{e}"
35
+ end
36
+ ```
37
+
38
+ #### Using the berry_flavor_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)> berry_flavor_list_with_http_info(opts)
43
+
44
+ ```ruby
45
+ begin
46
+
47
+ data, status_code, headers = api_instance.berry_flavor_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 BerryFlavorApi->berry_flavor_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
+ ## berry_flavor_read
78
+
79
+ > String berry_flavor_read(id)
80
+
81
+
82
+
83
+ ### Examples
84
+
85
+ ```ruby
86
+ require 'time'
87
+ require 'pokeapi_client'
88
+
89
+ api_instance = PokeApiClient::BerryFlavorApi.new
90
+ id = 56 # Integer |
91
+
92
+ begin
93
+
94
+ result = api_instance.berry_flavor_read(id)
95
+ p result
96
+ rescue PokeApiClient::ApiError => e
97
+ puts "Error when calling BerryFlavorApi->berry_flavor_read: #{e}"
98
+ end
99
+ ```
100
+
101
+ #### Using the berry_flavor_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)> berry_flavor_read_with_http_info(id)
106
+
107
+ ```ruby
108
+ begin
109
+
110
+ data, status_code, headers = api_instance.berry_flavor_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 BerryFlavorApi->berry_flavor_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::CharacteristicApi
2
+
3
+ All URIs are relative to *https://pokeapi.co*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**characteristic_list**](CharacteristicApi.md#characteristic_list) | **GET** /api/v2/characteristic/ | |
8
+ | [**characteristic_read**](CharacteristicApi.md#characteristic_read) | **GET** /api/v2/characteristic/{id}/ | |
9
+
10
+
11
+ ## characteristic_list
12
+
13
+ > String characteristic_list(opts)
14
+
15
+
16
+
17
+ ### Examples
18
+
19
+ ```ruby
20
+ require 'time'
21
+ require 'pokeapi_client'
22
+
23
+ api_instance = PokeApiClient::CharacteristicApi.new
24
+ opts = {
25
+ limit: 56, # Integer |
26
+ offset: 56 # Integer |
27
+ }
28
+
29
+ begin
30
+
31
+ result = api_instance.characteristic_list(opts)
32
+ p result
33
+ rescue PokeApiClient::ApiError => e
34
+ puts "Error when calling CharacteristicApi->characteristic_list: #{e}"
35
+ end
36
+ ```
37
+
38
+ #### Using the characteristic_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)> characteristic_list_with_http_info(opts)
43
+
44
+ ```ruby
45
+ begin
46
+
47
+ data, status_code, headers = api_instance.characteristic_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 CharacteristicApi->characteristic_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
+ ## characteristic_read
78
+
79
+ > String characteristic_read(id)
80
+
81
+
82
+
83
+ ### Examples
84
+
85
+ ```ruby
86
+ require 'time'
87
+ require 'pokeapi_client'
88
+
89
+ api_instance = PokeApiClient::CharacteristicApi.new
90
+ id = 56 # Integer |
91
+
92
+ begin
93
+
94
+ result = api_instance.characteristic_read(id)
95
+ p result
96
+ rescue PokeApiClient::ApiError => e
97
+ puts "Error when calling CharacteristicApi->characteristic_read: #{e}"
98
+ end
99
+ ```
100
+
101
+ #### Using the characteristic_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)> characteristic_read_with_http_info(id)
106
+
107
+ ```ruby
108
+ begin
109
+
110
+ data, status_code, headers = api_instance.characteristic_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 CharacteristicApi->characteristic_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
+