pokeapi_client 1.1.0 → 2.0.0

data/lib/pokeapi_client/api/location_api.rb

@@ -1,12 +1,12 @@
 =begin
-#
+#PokéAPI
 
-#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+#All the Pokémon data you'll ever need in one place, easily accessible through a modern free open-source RESTful API.  ## What is this?  This is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series.  We've covered everything from Pokémon to Berry Flavors.  ## Where do I start?  We have awesome [documentation](https://pokeapi.co/docs/v2) on how to use this API. It takes minutes to get started.  This API will always be publicly available and will never require any extensive setup process to consume.  Created by [**Paul Hallett**(]https://github.com/phalt) and other [**PokéAPI contributors***](https://github.com/PokeAPI/pokeapi#contributing) around the world. Pokémon and Pokémon character names are trademarks of Nintendo.     
 
-The version of the OpenAPI document: 20220523
+The version of the OpenAPI document: 2.7.0
 Contact: blah+oapicf@cliffano.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generator version: 7.18.0
 
 =end
 
@@ -19,19 +19,151 @@ module PokeApiClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # List location areas
+    # Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [Integer] :offset 
-    # @return [String]
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @return [PaginatedLocationAreaSummaryList]
+    def location_area_list(opts = {})
+      data, _status_code, _headers = location_area_list_with_http_info(opts)
+      data
+    end
+
+    # List location areas
+    # Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @return [Array<(PaginatedLocationAreaSummaryList, Integer, Hash)>] PaginatedLocationAreaSummaryList data, response status code and response headers
+    def location_area_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LocationApi.location_area_list ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/location-area/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaginatedLocationAreaSummaryList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"LocationApi.location_area_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationApi#location_area_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get location area
+    # Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters.
+    # @param id [Integer] A unique integer value identifying this location area.
+    # @param [Hash] opts the optional parameters
+    # @return [LocationAreaDetail]
+    def location_area_retrieve(id, opts = {})
+      data, _status_code, _headers = location_area_retrieve_with_http_info(id, opts)
+      data
+    end
+
+    # Get location area
+    # Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters.
+    # @param id [Integer] A unique integer value identifying this location area.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LocationAreaDetail, Integer, Hash)>] LocationAreaDetail data, response status code and response headers
+    def location_area_retrieve_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LocationApi.location_area_retrieve ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling LocationApi.location_area_retrieve"
+      end
+      # resource path
+      local_var_path = '/api/v2/location-area/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LocationAreaDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"LocationApi.location_area_retrieve",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationApi#location_area_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List locations
+    # Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [String] :q &gt; Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the &#x60;name&#x60; property. 
+    # @return [PaginatedLocationSummaryList]
     def location_list(opts = {})
       data, _status_code, _headers = location_list_with_http_info(opts)
       data
     end
 
+    # List locations
+    # Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit 
-    # @option opts [Integer] :offset 
-    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [String] :q &gt; Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the &#x60;name&#x60; property. 
+    # @return [Array<(PaginatedLocationSummaryList, Integer, Hash)>] PaginatedLocationSummaryList data, response status code and response headers
     def location_list_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: LocationApi.location_list ...'
@@ -43,11 +175,12 @@ module PokeApiClient
       query_params = opts[:query_params] || {}
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
       query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['text/plain'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -56,10 +189,10 @@ module PokeApiClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'String'
+      return_type = opts[:debug_return_type] || 'PaginatedLocationSummaryList'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
 
       new_options = opts.merge(
         :operation => :"LocationApi.location_list",
@@ -78,24 +211,28 @@ module PokeApiClient
       return data, status_code, headers
     end
 
-    # @param id [Integer] 
+    # Get location
+    # Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.
+    # @param id [String] This parameter can be a string or an integer.
     # @param [Hash] opts the optional parameters
-    # @return [String]
-    def location_read(id, opts = {})
-      data, _status_code, _headers = location_read_with_http_info(id, opts)
+    # @return [LocationDetail]
+    def location_retrieve(id, opts = {})
+      data, _status_code, _headers = location_retrieve_with_http_info(id, opts)
       data
     end
 
-    # @param id [Integer] 
+    # Get location
+    # Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.
+    # @param id [String] This parameter can be a string or an integer.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
-    def location_read_with_http_info(id, opts = {})
+    # @return [Array<(LocationDetail, Integer, Hash)>] LocationDetail data, response status code and response headers
+    def location_retrieve_with_http_info(id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: LocationApi.location_read ...'
+        @api_client.config.logger.debug 'Calling API: LocationApi.location_retrieve ...'
       end
       # verify the required parameter 'id' is set
       if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling LocationApi.location_read"
+        fail ArgumentError, "Missing the required parameter 'id' when calling LocationApi.location_retrieve"
       end
       # resource path
       local_var_path = '/api/v2/location/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
@@ -106,7 +243,265 @@ module PokeApiClient
       # header parameters
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['text/plain'])
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LocationDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"LocationApi.location_retrieve",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationApi#location_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List pal park areas
+    # Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [String] :q &gt; Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the &#x60;name&#x60; property. 
+    # @return [PaginatedPalParkAreaSummaryList]
+    def pal_park_area_list(opts = {})
+      data, _status_code, _headers = pal_park_area_list_with_http_info(opts)
+      data
+    end
+
+    # List pal park areas
+    # Areas used for grouping Pokémon encounters in Pal Park. They&#39;re like habitats that are specific to Pal Park.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [String] :q &gt; Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the &#x60;name&#x60; property. 
+    # @return [Array<(PaginatedPalParkAreaSummaryList, Integer, Hash)>] PaginatedPalParkAreaSummaryList data, response status code and response headers
+    def pal_park_area_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LocationApi.pal_park_area_list ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/pal-park-area/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaginatedPalParkAreaSummaryList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"LocationApi.pal_park_area_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationApi#pal_park_area_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get pal park area
+    # Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [PalParkAreaDetail]
+    def pal_park_area_retrieve(id, opts = {})
+      data, _status_code, _headers = pal_park_area_retrieve_with_http_info(id, opts)
+      data
+    end
+
+    # Get pal park area
+    # Areas used for grouping Pokémon encounters in Pal Park. They&#39;re like habitats that are specific to Pal Park.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PalParkAreaDetail, Integer, Hash)>] PalParkAreaDetail data, response status code and response headers
+    def pal_park_area_retrieve_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LocationApi.pal_park_area_retrieve ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling LocationApi.pal_park_area_retrieve"
+      end
+      # resource path
+      local_var_path = '/api/v2/pal-park-area/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PalParkAreaDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"LocationApi.pal_park_area_retrieve",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationApi#pal_park_area_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List regions
+    # A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [String] :q &gt; Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the &#x60;name&#x60; property. 
+    # @return [PaginatedRegionSummaryList]
+    def region_list(opts = {})
+      data, _status_code, _headers = region_list_with_http_info(opts)
+      data
+    end
+
+    # List regions
+    # A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [String] :q &gt; Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the &#x60;name&#x60; property. 
+    # @return [Array<(PaginatedRegionSummaryList, Integer, Hash)>] PaginatedRegionSummaryList data, response status code and response headers
+    def region_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LocationApi.region_list ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/region/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaginatedRegionSummaryList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"LocationApi.region_list",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LocationApi#region_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get region
+    # A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [RegionDetail]
+    def region_retrieve(id, opts = {})
+      data, _status_code, _headers = region_retrieve_with_http_info(id, opts)
+      data
+    end
+
+    # Get region
+    # A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RegionDetail, Integer, Hash)>] RegionDetail data, response status code and response headers
+    def region_retrieve_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LocationApi.region_retrieve ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling LocationApi.region_retrieve"
+      end
+      # resource path
+      local_var_path = '/api/v2/region/{id}/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -115,13 +510,13 @@ module PokeApiClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'String'
+      return_type = opts[:debug_return_type] || 'RegionDetail'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
 
       new_options = opts.merge(
-        :operation => :"LocationApi.location_read",
+        :operation => :"LocationApi.region_retrieve",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -132,7 +527,7 @@ module PokeApiClient
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: LocationApi#location_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: LocationApi#region_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end