pokeapi_client 1.2.0 → 2.0.0

data/lib/pokeapi_client/api/games_api.rb

@@ -0,0 +1,538 @@
+=begin
+#PokéAPI
+
+#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: 2.7.0
+Contact: blah+oapicf@cliffano.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.18.0
+
+=end
+
+require 'cgi'
+
+module PokeApiClient
+  class GamesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List genrations
+    # A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released.
+    # @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 > Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the `name` property. 
+    # @return [PaginatedGenerationSummaryList]
+    def generation_list(opts = {})
+      data, _status_code, _headers = generation_list_with_http_info(opts)
+      data
+    end
+
+    # List genrations
+    # A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released.
+    # @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 > Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the `name` property. 
+    # @return [Array<(PaginatedGenerationSummaryList, Integer, Hash)>] PaginatedGenerationSummaryList data, response status code and response headers
+    def generation_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.generation_list ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/generation/'
+
+      # 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] || 'PaginatedGenerationSummaryList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.generation_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: GamesApi#generation_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get genration
+    # A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [GenerationDetail]
+    def generation_retrieve(id, opts = {})
+      data, _status_code, _headers = generation_retrieve_with_http_info(id, opts)
+      data
+    end
+
+    # Get genration
+    # A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GenerationDetail, Integer, Hash)>] GenerationDetail data, response status code and response headers
+    def generation_retrieve_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.generation_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 GamesApi.generation_retrieve"
+      end
+      # resource path
+      local_var_path = '/api/v2/generation/{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] || 'GenerationDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.generation_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: GamesApi#generation_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List pokedex
+    # A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail.
+    # @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 [PaginatedPokedexSummaryList]
+    def pokedex_list(opts = {})
+      data, _status_code, _headers = pokedex_list_with_http_info(opts)
+      data
+    end
+
+    # List pokedex
+    # A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail.
+    # @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<(PaginatedPokedexSummaryList, Integer, Hash)>] PaginatedPokedexSummaryList data, response status code and response headers
+    def pokedex_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.pokedex_list ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/pokedex/'
+
+      # 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] || 'PaginatedPokedexSummaryList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.pokedex_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: GamesApi#pokedex_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get pokedex
+    # A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [PokedexDetail]
+    def pokedex_retrieve(id, opts = {})
+      data, _status_code, _headers = pokedex_retrieve_with_http_info(id, opts)
+      data
+    end
+
+    # Get pokedex
+    # A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Pokedex) for greater detail.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PokedexDetail, Integer, Hash)>] PokedexDetail data, response status code and response headers
+    def pokedex_retrieve_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.pokedex_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 GamesApi.pokedex_retrieve"
+      end
+      # resource path
+      local_var_path = '/api/v2/pokedex/{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] || 'PokedexDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.pokedex_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: GamesApi#pokedex_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List version groups
+    # Version groups categorize highly similar versions of the games.
+    # @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 [PaginatedVersionGroupSummaryList]
+    def version_group_list(opts = {})
+      data, _status_code, _headers = version_group_list_with_http_info(opts)
+      data
+    end
+
+    # List version groups
+    # Version groups categorize highly similar versions of the games.
+    # @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<(PaginatedVersionGroupSummaryList, Integer, Hash)>] PaginatedVersionGroupSummaryList data, response status code and response headers
+    def version_group_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.version_group_list ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/version-group/'
+
+      # 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] || 'PaginatedVersionGroupSummaryList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.version_group_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: GamesApi#version_group_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get version group
+    # Version groups categorize highly similar versions of the games.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [VersionGroupDetail]
+    def version_group_retrieve(id, opts = {})
+      data, _status_code, _headers = version_group_retrieve_with_http_info(id, opts)
+      data
+    end
+
+    # Get version group
+    # Version groups categorize highly similar versions of the games.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VersionGroupDetail, Integer, Hash)>] VersionGroupDetail data, response status code and response headers
+    def version_group_retrieve_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.version_group_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 GamesApi.version_group_retrieve"
+      end
+      # resource path
+      local_var_path = '/api/v2/version-group/{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] || 'VersionGroupDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.version_group_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: GamesApi#version_group_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List versions
+    # Versions of the games, e.g., Red, Blue or Yellow.
+    # @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 [PaginatedVersionSummaryList]
+    def version_list(opts = {})
+      data, _status_code, _headers = version_list_with_http_info(opts)
+      data
+    end
+
+    # List versions
+    # Versions of the games, e.g., Red, Blue or Yellow.
+    # @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<(PaginatedVersionSummaryList, Integer, Hash)>] PaginatedVersionSummaryList data, response status code and response headers
+    def version_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.version_list ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/version/'
+
+      # 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] || 'PaginatedVersionSummaryList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.version_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: GamesApi#version_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get version
+    # Versions of the games, e.g., Red, Blue or Yellow.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [VersionDetail]
+    def version_retrieve(id, opts = {})
+      data, _status_code, _headers = version_retrieve_with_http_info(id, opts)
+      data
+    end
+
+    # Get version
+    # Versions of the games, e.g., Red, Blue or Yellow.
+    # @param id [String] This parameter can be a string or an integer.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VersionDetail, Integer, Hash)>] VersionDetail data, response status code and response headers
+    def version_retrieve_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GamesApi.version_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 GamesApi.version_retrieve"
+      end
+      # resource path
+      local_var_path = '/api/v2/version/{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] || 'VersionDetail'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth', 'cookieAuth']
+
+      new_options = opts.merge(
+        :operation => :"GamesApi.version_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: GamesApi#version_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end