ipgeolocation_sdk 1.0.0

data/lib/ipgeolocation_sdk/api/abuse_contact_api.rb

@@ -0,0 +1,86 @@
+=begin
+#IPGeolocation.io - IP intelligence products
+
+#Ipgeolocation provides a set of APIs to make ip based decisions.
+
+The version of the OpenAPI document: 2.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'cgi'
+
+module IpgeolocationSdk
+  class AbuseContactApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # The Abuse Contact API provides essential contact information to report abusive activity associated with IP addresses. By querying an IP address (IPv4 or IPv6), users receive detailed abuse contact data, including the responsible organization, abuse handling role, contact emails, phone numbers, and registered address. This enables users to swiftly take action to report and mitigate threats such as spam, DDoS attacks, and phishing.     In addition to abuse-specific contacts, the API also includes registration metadata like the registered country and abuse handle. This empowers cybersecurity teams, hosting providers, and compliance entities to take appropriate legal or administrative action. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ip query parameter 'ip'.
+    # @option opts [String] :excludes You can exclude specific fields from the API response (except the ip field) by listing them in the excludes parameter as a comma-separated list. For example, you want to remove emails and handle from api response, you can put the keys in excludes parameter like this.
+    # @option opts [String] :fields You can customize the API response by using the fields parameter to include only the specific data you need. For example, to retrieve only the role and emails, specify these keys in the fields parameter as shown below.
+    # @return [AbuseResponse]
+    def get_abuse_contact_info(opts = {})
+      data, _status_code, _headers = get_abuse_contact_info_with_http_info(opts)
+      data
+    end
+
+    # The Abuse Contact API provides essential contact information to report abusive activity associated with IP addresses. By querying an IP address (IPv4 or IPv6), users receive detailed abuse contact data, including the responsible organization, abuse handling role, contact emails, phone numbers, and registered address. This enables users to swiftly take action to report and mitigate threats such as spam, DDoS attacks, and phishing.     In addition to abuse-specific contacts, the API also includes registration metadata like the registered country and abuse handle. This empowers cybersecurity teams, hosting providers, and compliance entities to take appropriate legal or administrative action. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ip query parameter 'ip'.
+    # @option opts [String] :excludes You can exclude specific fields from the API response (except the ip field) by listing them in the excludes parameter as a comma-separated list. For example, you want to remove emails and handle from api response, you can put the keys in excludes parameter like this.
+    # @option opts [String] :fields You can customize the API response by using the fields parameter to include only the specific data you need. For example, to retrieve only the role and emails, specify these keys in the fields parameter as shown below.
+    # @return [Array<(AbuseResponse, Integer, Hash)>] AbuseResponse data, response status code and response headers
+    def get_abuse_contact_info_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AbuseContactApi.get_abuse_contact_info ...'
+      end
+      # resource path
+      local_var_path = '/abuse'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ip'] = opts[:'ip'] if !opts[:'ip'].nil?
+      query_params[:'excludes'] = opts[:'excludes'] if !opts[:'excludes'].nil?
+      query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) 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] || 'AbuseResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"AbuseContactApi.get_abuse_contact_info",
+        :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: AbuseContactApi#get_abuse_contact_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ipgeolocation_sdk/api/asn_lookup_api.rb

@@ -0,0 +1,92 @@
+=begin
+#IPGeolocation.io - IP intelligence products
+
+#Ipgeolocation provides a set of APIs to make ip based decisions.
+
+The version of the OpenAPI document: 2.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'cgi'
+
+module IpgeolocationSdk
+  class ASNLookupApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # ASN API provides comprehensive details for an ASN including the as name,  organization name, the country of registration, associated domain, and its  type (ISP, host provider, or business). The API also shows the allocation  date of provided ASN and if it is currently allocated or not. It also contains  the routing information including peering, upstreams, and downstreams to help  understand the relationship between different ASNs.  Example Use Cases:  - Looking up ASN information for an IP address (e.g., `GET /asn?ip=8.8.8.8`)  - Retrieving ASN information for a specific ASN number (e.g., `GET /asn?asn=12345`)  - Getting peering relationships for an ASN (e.g., `GET /asn?asn=12345&include=peers`) 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ip query parameter 'ip'.
+    # @option opts [Integer] :asn query paramter 'asn'.
+    # @option opts [String] :include This parameter can have four options: a) peers b) downstreams c) upstreams d) routes e) whois_response. You may add any of them in comma-separated way. In order to get the ASN details with peering data, pass peers string in the include parameter like mentioned below.
+    # @option opts [String] :excludes You can exclude fields from the response according to you requirement with the exception of ip field. For example, you want to remove date_allocated and allocation_status from api response, you can put the keys in excludes parameter like this.
+    # @option opts [String] :fields You can filter out only those fields which you want to see in the response by using the fields parameter. To retrieve only the AS organization, its country and downstreams in api response, you can put the keys in fields parameter like this. API will combine these fields with the default ASN response. Note: Parameters `peers, downstreams, upstreams, routes, whois_response` can be used in both `include` , and `fields`. If you use include and fields at the same time, fields parameter will be considered only.
+    # @return [ASNResponse]
+    def get_asn_info(opts = {})
+      data, _status_code, _headers = get_asn_info_with_http_info(opts)
+      data
+    end
+
+    # ASN API provides comprehensive details for an ASN including the as name,  organization name, the country of registration, associated domain, and its  type (ISP, host provider, or business). The API also shows the allocation  date of provided ASN and if it is currently allocated or not. It also contains  the routing information including peering, upstreams, and downstreams to help  understand the relationship between different ASNs.  Example Use Cases:  - Looking up ASN information for an IP address (e.g., `GET /asn?ip=8.8.8.8`)  - Retrieving ASN information for a specific ASN number (e.g., `GET /asn?asn=12345`)  - Getting peering relationships for an ASN (e.g., `GET /asn?asn=12345&include=peers`) 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ip query parameter 'ip'.
+    # @option opts [Integer] :asn query paramter 'asn'.
+    # @option opts [String] :include This parameter can have four options: a) peers b) downstreams c) upstreams d) routes e) whois_response. You may add any of them in comma-separated way. In order to get the ASN details with peering data, pass peers string in the include parameter like mentioned below.
+    # @option opts [String] :excludes You can exclude fields from the response according to you requirement with the exception of ip field. For example, you want to remove date_allocated and allocation_status from api response, you can put the keys in excludes parameter like this.
+    # @option opts [String] :fields You can filter out only those fields which you want to see in the response by using the fields parameter. To retrieve only the AS organization, its country and downstreams in api response, you can put the keys in fields parameter like this. API will combine these fields with the default ASN response. Note: Parameters `peers, downstreams, upstreams, routes, whois_response` can be used in both `include` , and `fields`. If you use include and fields at the same time, fields parameter will be considered only.
+    # @return [Array<(ASNResponse, Integer, Hash)>] ASNResponse data, response status code and response headers
+    def get_asn_info_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ASNLookupApi.get_asn_info ...'
+      end
+      # resource path
+      local_var_path = '/asn'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ip'] = opts[:'ip'] if !opts[:'ip'].nil?
+      query_params[:'asn'] = opts[:'asn'] if !opts[:'asn'].nil?
+      query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
+      query_params[:'excludes'] = opts[:'excludes'] if !opts[:'excludes'].nil?
+      query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) 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] || 'ASNResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"ASNLookupApi.get_asn_info",
+        :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: ASNLookupApi#get_asn_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ipgeolocation_sdk/api/astronomy_api.rb

@@ -0,0 +1,116 @@
+=begin
+#IPGeolocation.io - IP intelligence products
+
+#Ipgeolocation provides a set of APIs to make ip based decisions.
+
+The version of the OpenAPI document: 2.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'cgi'
+
+module IpgeolocationSdk
+  class AstronomyApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # The Astronomy API provides the location-based rise and set times for the Sun and Moon along with the current position, distance from earth, and azimuth of the Sun and the Moon for a specific date at the queried time. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ip query paramter 'ip'. If not provided, will be your network IP
+    # @option opts [String] :location query paramter 'location'. If not provided, will be your ip location
+    # @option opts [String] :lat query paramter 'lat'.
+    # @option opts [String] :long query paramter 'long'.
+    # @option opts [String] :time_zone 
+    # @option opts [String] :date The date (YYYY-MM-DD) to lookup for. default will be the current date
+    # @option opts [Float] :elevation query parameter 'elevation'
+    # @option opts [String] :output Desired output format.
+    # @option opts [String] :lang By default, the API responds in English. You can change the response language by passing the language code as a query parameter `lang`. Multi language feature is available only for `paid users`.
+    # @return [AstronomyResponse]
+    def get_astronomy_details(opts = {})
+      data, _status_code, _headers = get_astronomy_details_with_http_info(opts)
+      data
+    end
+
+    # The Astronomy API provides the location-based rise and set times for the Sun and Moon along with the current position, distance from earth, and azimuth of the Sun and the Moon for a specific date at the queried time. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ip query paramter 'ip'. If not provided, will be your network IP
+    # @option opts [String] :location query paramter 'location'. If not provided, will be your ip location
+    # @option opts [String] :lat query paramter 'lat'.
+    # @option opts [String] :long query paramter 'long'.
+    # @option opts [String] :time_zone 
+    # @option opts [String] :date The date (YYYY-MM-DD) to lookup for. default will be the current date
+    # @option opts [Float] :elevation query parameter 'elevation'
+    # @option opts [String] :output Desired output format.
+    # @option opts [String] :lang By default, the API responds in English. You can change the response language by passing the language code as a query parameter `lang`. Multi language feature is available only for `paid users`.
+    # @return [Array<(AstronomyResponse, Integer, Hash)>] AstronomyResponse data, response status code and response headers
+    def get_astronomy_details_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AstronomyApi.get_astronomy_details ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'elevation'].nil? && opts[:'elevation'] > 10000
+        fail ArgumentError, 'invalid value for "opts[:"elevation"]" when calling AstronomyApi.get_astronomy_details, must be smaller than or equal to 10000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'elevation'].nil? && opts[:'elevation'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"elevation"]" when calling AstronomyApi.get_astronomy_details, must be greater than or equal to 0.'
+      end
+
+      allowable_values = ["en", "de", "ru", "ja", "fr", "cn", "es", "cs", "it", "ko", "fa", "pt"]
+      if @api_client.config.client_side_validation && opts[:'lang'] && !allowable_values.include?(opts[:'lang'])
+        fail ArgumentError, "invalid value for \"lang\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/astronomy'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ip'] = opts[:'ip'] if !opts[:'ip'].nil?
+      query_params[:'location'] = opts[:'location'] if !opts[:'location'].nil?
+      query_params[:'lat'] = opts[:'lat'] if !opts[:'lat'].nil?
+      query_params[:'long'] = opts[:'long'] if !opts[:'long'].nil?
+      query_params[:'time_zone'] = opts[:'time_zone'] if !opts[:'time_zone'].nil?
+      query_params[:'date'] = opts[:'date'] if !opts[:'date'].nil?
+      query_params[:'elevation'] = opts[:'elevation'] if !opts[:'elevation'].nil?
+      query_params[:'output'] = opts[:'output'] if !opts[:'output'].nil?
+      query_params[:'lang'] = opts[:'lang'] if !opts[:'lang'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) 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] || 'AstronomyResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"AstronomyApi.get_astronomy_details",
+        :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: AstronomyApi#get_astronomy_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ipgeolocation_sdk/api/ip_geolocation_api.rb

@@ -0,0 +1,186 @@
+=begin
+#IPGeolocation.io - IP intelligence products
+
+#Ipgeolocation provides a set of APIs to make ip based decisions.
+
+The version of the OpenAPI document: 2.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'cgi'
+
+module IpgeolocationSdk
+  class IPGeolocationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # This feature is available only on our paid API subscriptions (STANDARD or ADVANCED). This endpoint allows you to perform the geolocation lookup for multiple IPv4, IPv6 addresses or domain names (maximum 50,000) at the same time. The requests count per lookup is equal to total IP addresses or domain names passed. To perform bulk IP Geolocation Lookup, send a POST request and pass the \"ips\" array as JSON data along with it.  
+    # @param get_bulk_ip_geolocation_request [GetBulkIpGeolocationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :lang By default, the API responds in English. You can change the response language by passing the language code as a query parameter `lang`. Multi language feature is available only for `paid users`.
+    # @option opts [String] :fields you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the `fields` query parameter with each field represented as a dot-separated path.
+    # @option opts [String] :excludes you can also filter the API response by excluding specific fields (except the IP address) that you don't need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path
+    # @option opts [String] :include IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn't respond it by default. To get these information along with the geolocation information, you must pass the `include=security` or `include=abuse` or `include=dma` or `include=time_zone` or `include=user-agent` or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn't respond it by default. To get the hostname for an IP address, you can pass one of the three values `hostname, liveHostname, hostnameFallbackLive` as a URL parameter `include=`.
+    # @option opts [String] :output Desired output format(json or xml).
+    # @return [Array<GetBulkIpGeolocation200ResponseInner>]
+    def get_bulk_ip_geolocation(opts = {})
+      data, _status_code, _headers = get_bulk_ip_geolocation_with_http_info(opts)
+      data
+    end
+
+    # This feature is available only on our paid API subscriptions (STANDARD or ADVANCED). This endpoint allows you to perform the geolocation lookup for multiple IPv4, IPv6 addresses or domain names (maximum 50,000) at the same time. The requests count per lookup is equal to total IP addresses or domain names passed. To perform bulk IP Geolocation Lookup, send a POST request and pass the \&quot;ips\&quot; array as JSON data along with it.  
+    # @param get_bulk_ip_geolocation_request [GetBulkIpGeolocationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :lang By default, the API responds in English. You can change the response language by passing the language code as a query parameter &#x60;lang&#x60;. Multi language feature is available only for &#x60;paid users&#x60;.
+    # @option opts [String] :fields you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the &#x60;fields&#x60; query parameter with each field represented as a dot-separated path.
+    # @option opts [String] :excludes you can also filter the API response by excluding specific fields (except the IP address) that you don&#39;t need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path
+    # @option opts [String] :include IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn&#39;t respond it by default. To get these information along with the geolocation information, you must pass the &#x60;include&#x3D;security&#x60; or &#x60;include&#x3D;abuse&#x60; or &#x60;include&#x3D;dma&#x60; or &#x60;include&#x3D;time_zone&#x60; or &#x60;include&#x3D;user-agent&#x60; or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn&#39;t respond it by default. To get the hostname for an IP address, you can pass one of the three values &#x60;hostname, liveHostname, hostnameFallbackLive&#x60; as a URL parameter &#x60;include&#x3D;&#x60;.
+    # @option opts [String] :output Desired output format(json or xml).
+    # @return [Array<(Array<GetBulkIpGeolocation200ResponseInner>, Integer, Hash)>] Array<GetBulkIpGeolocation200ResponseInner> data, response status code and response headers
+    def get_bulk_ip_geolocation_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IPGeolocationApi.get_bulk_ip_geolocation ...'
+      end
+      # verify the required parameter 'ips' in opts is set
+    
+      if @api_client.config.client_side_validation && (!opts[:ips].is_a?(Array) || opts[:ips].empty?)
+        fail ArgumentError, "Missing the required parameter 'ips' (non-empty Array) when calling IPGeolocationApi.get_bulk_ip_geolocation"
+      end
+            
+      allowable_values = ["en", "de", "ru", "ja", "fr", "cn", "es", "cs", "it", "ko", "fa", "pt"]
+      if @api_client.config.client_side_validation && opts[:'lang'] && !allowable_values.include?(opts[:'lang'])
+        fail ArgumentError, "invalid value for \"lang\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/ipgeo-bulk'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'lang'] = opts[:'lang'] if !opts[:'lang'].nil?
+      query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
+      query_params[:'excludes'] = opts[:'excludes'] if !opts[:'excludes'].nil?
+      query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
+      query_params[:'output'] = opts[:'output'] if !opts[:'output'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body({ ips: opts[:ips] })
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<BulkIPGeolocation>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"IPLocationApi.get_bulk_ip_geolocation",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IPGeolocationApi#get_bulk_ip_geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # IP Geolocation API provides real-time and accurate geolocation, network, abuse, and security information for any IPv4 or IPv6 address and domain name along with the user-agent detail for the provided user-agent string. You can geolocate your online visitors and provide them the customized user-experience accordingly.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ip In order to find geolocation information about an IP (ipv4 ipv6) address or a domain name, pass it as a query parameter ip. When this endpoint is queried without an IP address, it returns the geolocation information of the device/client which is calling it
+    # @option opts [String] :lang By default, the API responds in English. You can change the response language by passing the language code as a query parameter &#x60;lang&#x60;. Multi language feature is available only for &#x60;paid users&#x60;.
+    # @option opts [String] :fields you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the &#x60;fields&#x60; query parameter with each field represented as a dot-separated path.
+    # @option opts [String] :excludes you can also filter the API response by excluding specific fields (except the IP address) that you don&#39;t need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path
+    # @option opts [String] :include IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn&#39;t respond it by default. To get these information along with the geolocation information, you must pass the &#x60;include&#x3D;security&#x60; or &#x60;include&#x3D;abuse&#x60; or &#x60;include&#x3D;dma&#x60; or &#x60;include&#x3D;time_zone&#x60; or &#x60;include&#x3D;user-agent&#x60; or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn&#39;t respond it by default. To get the hostname for an IP address, you can pass one of the three values &#x60;hostname, liveHostname, hostnameFallbackLive&#x60; as a URL parameter &#x60;include&#x3D;&#x60;.
+    # @option opts [String] :output Desired output format (json or xml).
+    # @return [GeolocationResponse]
+    def get_ip_geolocation(opts = {})
+      data, _status_code, _headers = get_ip_geolocation_with_http_info(opts)
+      data
+    end
+
+    # IP Geolocation API provides real-time and accurate geolocation, network, abuse, and security information for any IPv4 or IPv6 address and domain name along with the user-agent detail for the provided user-agent string. You can geolocate your online visitors and provide them the customized user-experience accordingly.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ip In order to find geolocation information about an IP (ipv4 ipv6) address or a domain name, pass it as a query parameter ip. When this endpoint is queried without an IP address, it returns the geolocation information of the device/client which is calling it
+    # @option opts [String] :lang By default, the API responds in English. You can change the response language by passing the language code as a query parameter &#x60;lang&#x60;. Multi language feature is available only for &#x60;paid users&#x60;.
+    # @option opts [String] :fields you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the &#x60;fields&#x60; query parameter with each field represented as a dot-separated path.
+    # @option opts [String] :excludes you can also filter the API response by excluding specific fields (except the IP address) that you don&#39;t need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path
+    # @option opts [String] :include IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn&#39;t respond it by default. To get these information along with the geolocation information, you must pass the &#x60;include&#x3D;security&#x60; or &#x60;include&#x3D;abuse&#x60; or &#x60;include&#x3D;dma&#x60; or &#x60;include&#x3D;time_zone&#x60; or &#x60;include&#x3D;user-agent&#x60; or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn&#39;t respond it by default. To get the hostname for an IP address, you can pass one of the three values &#x60;hostname, liveHostname, hostnameFallbackLive&#x60; as a URL parameter &#x60;include&#x3D;&#x60;.
+    # @option opts [String] :output Desired output format (json or xml).
+    # @return [Array<(GeolocationResponse, Integer, Hash)>] GeolocationResponse data, response status code and response headers
+    def get_ip_geolocation_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IPGeolocationApi.get_ip_geolocation ...'
+      end
+      allowable_values = ["en", "de", "ru", "ja", "fr", "cn", "es", "cs", "it", "ko", "fa", "pt"]
+      if @api_client.config.client_side_validation && opts[:'lang'] && !allowable_values.include?(opts[:'lang'])
+        fail ArgumentError, "invalid value for \"lang\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/ipgeo'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ip'] = opts[:'ip'] if !opts[:'ip'].nil?
+      query_params[:'lang'] = opts[:'lang'] if !opts[:'lang'].nil?
+      query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
+      query_params[:'excludes'] = opts[:'excludes'] if !opts[:'excludes'].nil?
+      query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
+      query_params[:'output'] = opts[:'output'] if !opts[:'output'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) 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] || 'GeolocationResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"IPLocationApi.get_ip_geolocation",
+        :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: IPGeolocationApi#get_ip_geolocation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end