ipgeolocation_sdk 1.0.0

data/docs/SecurityApi.md

@@ -0,0 +1,175 @@
+# IpgeolocationSdk::SecurityApi
+
+All URIs are relative to *https://api.ipgeolocation.io/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_bulk_ip_security_info**](SecurityApi.md#get_bulk_ip_security_info) | **POST** /security-bulk |  |
+| [**get_ip_security_info**](SecurityApi.md#get_ip_security_info) | **GET** /security |  |
+
+
+## get_bulk_ip_security_info
+
+> <Array<GetBulkIpSecurityInfo200ResponseInner>> get_bulk_ip_security_info(get_bulk_ip_geolocation_request, opts)
+
+
+
+The Bulk IP Security Lookup API can provide security details for up to `50,000` bulk IPs. This API also has parameters to customize the response, just like the single IP Security Lookup API.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ipgeolocation_sdk'
+# setup authorization
+IpgeolocationSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['apiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKey'] = 'Bearer'
+end
+
+api_instance = IpgeolocationSdk::SecurityApi.new
+get_bulk_ip_geolocation_request = IpgeolocationSdk::GetBulkIpGeolocationRequest.new # GetBulkIpGeolocationRequest | 
+opts = {
+  include: 'location,network,currency,time_zone,user_agent,country_metadata,hostname', # String | Include optional objects like `location`, `network`.  Use comma-separated values. Example: include=location,network 
+  fields: 'security.is_tor, location,', # String | Get specific fields, objects from the response.
+  excludes: 'security.is_cloud_provider', # String | Exclude specific fields, objects from the response.
+  output: 'json', # String | Desired output format.
+  lang: 'en' # String | 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`.
+}
+
+begin
+  
+  result = api_instance.get_bulk_ip_security_info(get_bulk_ip_geolocation_request, opts)
+  p result
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling SecurityApi->get_bulk_ip_security_info: #{e}"
+end
+```
+
+#### Using the get_bulk_ip_security_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<GetBulkIpSecurityInfo200ResponseInner>>, Integer, Hash)> get_bulk_ip_security_info_with_http_info(get_bulk_ip_geolocation_request, opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_bulk_ip_security_info_with_http_info(get_bulk_ip_geolocation_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<GetBulkIpSecurityInfo200ResponseInner>>
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling SecurityApi->get_bulk_ip_security_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **get_bulk_ip_geolocation_request** | [**GetBulkIpGeolocationRequest**](GetBulkIpGeolocationRequest.md) |  |  |
+| **include** | **String** | Include optional objects like &#x60;location&#x60;, &#x60;network&#x60;.  Use comma-separated values. Example: include&#x3D;location,network  | [optional] |
+| **fields** | **String** | Get specific fields, objects from the response. | [optional] |
+| **excludes** | **String** | Exclude specific fields, objects from the response. | [optional] |
+| **output** | **String** | Desired output format. | [optional] |
+| **lang** | **String** | 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;. | [optional] |
+
+### Return type
+
+[**Array&lt;GetBulkIpSecurityInfo200ResponseInner&gt;**](GetBulkIpSecurityInfo200ResponseInner.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/xml
+
+
+## get_ip_security_info
+
+> <SecurityAPIResponse> get_ip_security_info(opts)
+
+
+
+IP Security API provides security details of a given IP. It detects whether the IP is proxy, tor or bot. It also shows the proxy types of the IP (like VPN, PROXY, RELAY etc.) with it's VPN/proxy service provider making our API powerful VPN checker. It finds the IPs that are involved in spam activities. It also checks whether the IP links to a cloud provider and includes the provider's name.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ipgeolocation_sdk'
+# setup authorization
+IpgeolocationSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['apiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKey'] = 'Bearer'
+end
+
+api_instance = IpgeolocationSdk::SecurityApi.new
+opts = {
+  ip: '8.8.8.8', # String | query parameter 'ip'. If not provided, will be your network IP
+  include: 'location,network,currency,time_zone,user_agent,country_metadata,hostname', # String | Include optional details like location and/or network.
+  fields: 'security.is_tor, location,', # String | Get specific fields, objects from the response.
+  excludes: 'security.is_cloud_provider', # String | Exclude specific fields, objects from the response.
+  output: 'json', # String | Desired output format (json or xml).
+  lang: 'en' # String | 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`.
+}
+
+begin
+  
+  result = api_instance.get_ip_security_info(opts)
+  p result
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling SecurityApi->get_ip_security_info: #{e}"
+end
+```
+
+#### Using the get_ip_security_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SecurityAPIResponse>, Integer, Hash)> get_ip_security_info_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.get_ip_security_info_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SecurityAPIResponse>
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling SecurityApi->get_ip_security_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** | query parameter &#39;ip&#39;. If not provided, will be your network IP | [optional] |
+| **include** | **String** | Include optional details like location and/or network. | [optional] |
+| **fields** | **String** | Get specific fields, objects from the response. | [optional] |
+| **excludes** | **String** | Exclude specific fields, objects from the response. | [optional] |
+| **output** | **String** | Desired output format (json or xml). | [optional] |
+| **lang** | **String** | 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;. | [optional] |
+
+### Return type
+
+[**SecurityAPIResponse**](SecurityAPIResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+

data/docs/TimeConversionApi.md

@@ -0,0 +1,109 @@
+# IpgeolocationSdk::TimeConversionApi
+
+All URIs are relative to *https://api.ipgeolocation.io/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**convert_time_between_timezones**](TimeConversionApi.md#convert_time_between_timezones) | **GET** /timezone/convert |  |
+
+
+## convert_time_between_timezones
+
+> <TimeConversionResponse> convert_time_between_timezones(opts)
+
+
+
+You can convert a timestamp provided as a query paramter time from one time zone to another time zone.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ipgeolocation_sdk'
+# setup authorization
+IpgeolocationSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['apiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKey'] = 'Bearer'
+end
+
+api_instance = IpgeolocationSdk::TimeConversionApi.new
+opts = {
+  time: '2025-02-28 9:00:00', # String | time parameter takes the input in the following two formats: i) 'yyyy-MM-dd HH:mm', and ii) 'yyyy-MM-dd HH:mm:ss'. This parameter is optional and you can omit it to convert the current time between two coordinates, time zones or locations.
+  tz_from: 'America/Argentina/Catamarca', # String | timezone to convert from
+  tz_to: 'Asia/Kabul', # String | timezone to convert to
+  lat_from: 34.0207305, # Float | latitude to convert from
+  long_from: -118.691916, # Float | longitude to convert from
+  lat_to: 53.473682, # Float | latitude to convert to
+  long_to: -77.397706, # Float | longitude to convert to
+  location_from: 'New York, USA', # String | location to convert from
+  location_to: 'Lahore, Pakistan', # String | location to convert to
+  icao_from: 'YSSY', # String | location to convert from
+  icao_to: 'ZBAA', # String | location to convert to
+  iata_from: 'DXB', # String | location to convert from
+  iata_to: 'LHR', # String | location to convert to
+  locode_from: 'PKISB', # String | location to convert from
+  locode_to: 'USNYC' # String | location to convert to
+}
+
+begin
+  
+  result = api_instance.convert_time_between_timezones(opts)
+  p result
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling TimeConversionApi->convert_time_between_timezones: #{e}"
+end
+```
+
+#### Using the convert_time_between_timezones_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TimeConversionResponse>, Integer, Hash)> convert_time_between_timezones_with_http_info(opts)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.convert_time_between_timezones_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TimeConversionResponse>
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling TimeConversionApi->convert_time_between_timezones_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **time** | **String** | time parameter takes the input in the following two formats: i) &#39;yyyy-MM-dd HH:mm&#39;, and ii) &#39;yyyy-MM-dd HH:mm:ss&#39;. This parameter is optional and you can omit it to convert the current time between two coordinates, time zones or locations. | [optional] |
+| **tz_from** | **String** | timezone to convert from | [optional] |
+| **tz_to** | **String** | timezone to convert to | [optional] |
+| **lat_from** | **Float** | latitude to convert from | [optional] |
+| **long_from** | **Float** | longitude to convert from | [optional] |
+| **lat_to** | **Float** | latitude to convert to | [optional] |
+| **long_to** | **Float** | longitude to convert to | [optional] |
+| **location_from** | **String** | location to convert from | [optional] |
+| **location_to** | **String** | location to convert to | [optional] |
+| **icao_from** | **String** | location to convert from | [optional] |
+| **icao_to** | **String** | location to convert to | [optional] |
+| **iata_from** | **String** | location to convert from | [optional] |
+| **iata_to** | **String** | location to convert to | [optional] |
+| **locode_from** | **String** | location to convert from | [optional] |
+| **locode_to** | **String** | location to convert to | [optional] |
+
+### Return type
+
+[**TimeConversionResponse**](TimeConversionResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+

data/docs/TimeConversionResponse.md

@@ -0,0 +1,24 @@
+# IpgeolocationSdk::TimeConversionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **original_time** | **Time** |  | [optional] |
+| **converted_time** | **Time** |  | [optional] |
+| **diff_hour** | **Float** |  | [optional] |
+| **diff_min** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimeConversionResponse.new(
+  original_time: null,
+  converted_time: null,
+  diff_hour: 7.5,
+  diff_min: 450
+)
+```
+

data/docs/TimeConversionXMLResponse.md

@@ -0,0 +1,24 @@
+# IpgeolocationSdk::TimeConversionXMLResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **original_time** | **String** |  | [optional] |
+| **converted_time** | **String** |  | [optional] |
+| **diff_hour** | **Float** |  | [optional] |
+| **diff_min** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimeConversionXMLResponse.new(
+  original_time: 2024-12-08 11:00,
+  converted_time: 2024-12-08 18:30:00,
+  diff_hour: 7.5,
+  diff_min: 450
+)
+```
+

data/docs/TimeZone.md

@@ -0,0 +1,36 @@
+# IpgeolocationSdk::TimeZone
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+| **offset_with_dst** | **Integer** |  | [optional] |
+| **current_time** | **String** |  | [optional] |
+| **current_time_unix** | **Float** |  | [optional] |
+| **is_dst** | **Boolean** |  | [optional] |
+| **dst_savings** | **Integer** |  | [optional] |
+| **dst_exists** | **Boolean** |  | [optional] |
+| **dst_start** | [**TimeZoneDstStart**](TimeZoneDstStart.md) |  | [optional] |
+| **dst_end** | [**TimeZoneDstEnd**](TimeZoneDstEnd.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimeZone.new(
+  name: America/Los_Angeles,
+  offset: -8,
+  offset_with_dst: -7,
+  current_time: 2025-04-22 06:19:40.951-0700,
+  current_time_unix: 1745327980.951,
+  is_dst: true,
+  dst_savings: 1,
+  dst_exists: true,
+  dst_start: null,
+  dst_end: null
+)
+```
+

data/docs/TimeZoneDetailedResponse.md

@@ -0,0 +1,26 @@
+# IpgeolocationSdk::TimeZoneDetailedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **airport_details** | [**TimezoneAirport**](TimezoneAirport.md) |  | [optional] |
+| **lo_code_details** | [**TimezoneLocode**](TimezoneLocode.md) |  | [optional] |
+| **location** | [**TimezoneLocation**](TimezoneLocation.md) |  | [optional] |
+| **time_zone** | [**TimezoneDetail**](TimezoneDetail.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimeZoneDetailedResponse.new(
+  ip: 8.8.8.8,
+  airport_details: null,
+  lo_code_details: null,
+  location: null,
+  time_zone: null
+)
+```
+

data/docs/TimeZoneDetailedXMLResponse.md

@@ -0,0 +1,26 @@
+# IpgeolocationSdk::TimeZoneDetailedXMLResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ip** | **String** |  | [optional] |
+| **airport_details** | [**TimezoneAirport**](TimezoneAirport.md) |  | [optional] |
+| **lo_code_details** | [**TimezoneLocode**](TimezoneLocode.md) |  | [optional] |
+| **location** | [**TimezoneLocation**](TimezoneLocation.md) |  | [optional] |
+| **time_zone** | [**TimezoneDetail**](TimezoneDetail.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimeZoneDetailedXMLResponse.new(
+  ip: 8.8.8.8,
+  airport_details: null,
+  lo_code_details: null,
+  location: null,
+  time_zone: null
+)
+```
+

data/docs/TimeZoneDstEnd.md

@@ -0,0 +1,28 @@
+# IpgeolocationSdk::TimeZoneDstEnd
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **utc_time** | **String** |  | [optional] |
+| **duration** | **String** |  | [optional] |
+| **gap** | **Boolean** |  | [optional] |
+| **date_time_after** | **String** |  | [optional] |
+| **date_time_before** | **String** |  | [optional] |
+| **overlap** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimeZoneDstEnd.new(
+  utc_time: 2025-11-02 TIME 09,
+  duration: -1H,
+  gap: false,
+  date_time_after: 2025-11-02 TIME 01,
+  date_time_before: 2025-11-02 TIME 02,
+  overlap: true
+)
+```
+

data/docs/TimeZoneDstStart.md

@@ -0,0 +1,28 @@
+# IpgeolocationSdk::TimeZoneDstStart
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **utc_time** | **String** |  | [optional] |
+| **duration** | **String** |  | [optional] |
+| **gap** | **Boolean** |  | [optional] |
+| **date_time_after** | **String** |  | [optional] |
+| **date_time_before** | **String** |  | [optional] |
+| **overlap** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimeZoneDstStart.new(
+  utc_time: 2025-03-09 TIME 10,
+  duration: +1H,
+  gap: true,
+  date_time_after: 2025-03-09 TIME 03,
+  date_time_before: 2025-03-09 TIME 02,
+  overlap: false
+)
+```
+

data/docs/TimezoneAirport.md

@@ -0,0 +1,40 @@
+# IpgeolocationSdk::TimezoneAirport
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **latitude** | **String** |  | [optional] |
+| **longitude** | **String** |  | [optional] |
+| **elevation_ft** | **Integer** |  | [optional] |
+| **continent_code** | **String** |  | [optional] |
+| **country_code** | **String** |  | [optional] |
+| **state_code** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **iata_code** | **String** |  | [optional] |
+| **icao_code** | **String** |  | [optional] |
+| **faa_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimezoneAirport.new(
+  type: large_airport,
+  name: Hartsfield Jackson Atlanta International Airport,
+  latitude: 33.63670,
+  longitude: -84.42810,
+  elevation_ft: 1026,
+  continent_code: NA,
+  country_code: US,
+  state_code: US-GA,
+  city: Atlanta,
+  iata_code: ATL,
+  icao_code: KATL,
+  faa_code: 
+)
+```
+

data/docs/TimezoneApi.md

@@ -0,0 +1,99 @@
+# IpgeolocationSdk::TimezoneApi
+
+All URIs are relative to *https://api.ipgeolocation.io/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_timezone_info**](TimezoneApi.md#get_timezone_info) | **GET** /timezone | Timezone information details |
+
+
+## get_timezone_info
+
+> <TimeZoneDetailedResponse> get_timezone_info(opts)
+
+Timezone information details
+
+The Time Zone API provides current time, date, and time zone-related information. It supports various input types including time zone name, geographic coordinates, addresses, IPs, and location codes.  The API determines the time zone based on the following priority order if multiple parameters are provided:   1. Time Zone Name   2. Geographic Coordinates (latitude & longitude)   3. Location Address   4. IP Address   5. IATA Code   6. ICAO Code   7. UN/LOCODE  Enriched response data is returned based on the type of input: - IP: includes geolocation info - Address: includes location metadata - IATA/ICAO: includes airport info - UN/LOCODE: includes city details  You can call the time zone API without passing any time zone, coordinates, IATA, ICAO, LO code or IP address as well. It will use the calling machine's IP address to return the regional time zone information. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ipgeolocation_sdk'
+# setup authorization
+IpgeolocationSdk.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['apiKey'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKey'] = 'Bearer'
+end
+
+api_instance = IpgeolocationSdk::TimezoneApi.new
+opts = {
+  tz: 'America/Los_Angeles', # String | pass a valid time zone name as a query parameter tz to get the time zone information.
+  location: 'London, UK', # String | pass any address of a location as the query parameter location to get the time zone information.
+  lat: -27.4748, # Float | pass the latitude of a location as query parameters to get the time zone information.
+  long: 153.017, # Float | pass the longitude of a location as query parameters to get the time zone information.
+  ip: '1.1.1.1', # String | You can pass any IPv4 or IPv6 address as a query parameter ip to get the regional timezone information.
+  iata_code: 'DXB', # String | pass any 3 letter IATA code as a query paramter iata_code to get the comprehensive airport details along with the time zone information, in which that airport exists.
+  icao_code: 'KATL', # String | pass any 4 letter ICAO code as a query paramter icao_code to get the comprehensive airport details along with the time zone information, in which that airport exists.
+  lo_code: 'DEBER', # String | pass any 5 letter UNLOCODE as a query paramter lo_code to get the comprehensive lo code/city details along with the time zone information of the concerned city.
+  output: 'json', # String | Desired output format (json or xml).
+  lang: 'en' # String | 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`.
+}
+
+begin
+  # Timezone information details
+  result = api_instance.get_timezone_info(opts)
+  p result
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling TimezoneApi->get_timezone_info: #{e}"
+end
+```
+
+#### Using the get_timezone_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TimeZoneDetailedResponse>, Integer, Hash)> get_timezone_info_with_http_info(opts)
+
+```ruby
+begin
+  # Timezone information details
+  data, status_code, headers = api_instance.get_timezone_info_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TimeZoneDetailedResponse>
+rescue IpgeolocationSdk::ApiError => e
+  puts "Error when calling TimezoneApi->get_timezone_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tz** | **String** | pass a valid time zone name as a query parameter tz to get the time zone information. | [optional] |
+| **location** | **String** | pass any address of a location as the query parameter location to get the time zone information. | [optional] |
+| **lat** | **Float** | pass the latitude of a location as query parameters to get the time zone information. | [optional] |
+| **long** | **Float** | pass the longitude of a location as query parameters to get the time zone information. | [optional] |
+| **ip** | **String** | You can pass any IPv4 or IPv6 address as a query parameter ip to get the regional timezone information. | [optional] |
+| **iata_code** | **String** | pass any 3 letter IATA code as a query paramter iata_code to get the comprehensive airport details along with the time zone information, in which that airport exists. | [optional] |
+| **icao_code** | **String** | pass any 4 letter ICAO code as a query paramter icao_code to get the comprehensive airport details along with the time zone information, in which that airport exists. | [optional] |
+| **lo_code** | **String** | pass any 5 letter UNLOCODE as a query paramter lo_code to get the comprehensive lo code/city details along with the time zone information of the concerned city. | [optional] |
+| **output** | **String** | Desired output format (json or xml). | [optional] |
+| **lang** | **String** | 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;. | [optional] |
+
+### Return type
+
+[**TimeZoneDetailedResponse**](TimeZoneDetailedResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+

data/docs/TimezoneDetail.md

@@ -0,0 +1,56 @@
+# IpgeolocationSdk::TimezoneDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+| **offset_with_dst** | **Integer** |  | [optional] |
+| **date** | **Date** |  | [optional] |
+| **date_time** | **String** |  | [optional] |
+| **date_time_txt** | **String** |  | [optional] |
+| **date_time_wti** | **String** |  | [optional] |
+| **date_time_ymd** | **Time** |  | [optional] |
+| **date_time_unix** | **Float** |  | [optional] |
+| **time_24** | **String** |  | [optional] |
+| **time_12** | **String** |  | [optional] |
+| **week** | **Integer** |  | [optional] |
+| **month** | **Integer** |  | [optional] |
+| **year** | **Integer** |  | [optional] |
+| **year_abbr** | **String** |  | [optional] |
+| **is_dst** | **Boolean** |  | [optional] |
+| **dst_savings** | **Integer** |  | [optional] |
+| **dst_exists** | **Boolean** |  | [optional] |
+| **dst_start** | [**TimezoneDetailDstStart**](TimezoneDetailDstStart.md) |  | [optional] |
+| **dst_end** | [**TimezoneDetailDstEnd**](TimezoneDetailDstEnd.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ipgeolocation_sdk'
+
+instance = IpgeolocationSdk::TimezoneDetail.new(
+  name: America/Los_Angeles,
+  offset: -8,
+  offset_with_dst: -7,
+  date: Thu Apr 24 05:00:00 PKT 2025,
+  date_time: 2025-04-24 11:30:12,
+  date_time_txt: Thursday, April 24, 2025 11:30:12,
+  date_time_wti: Thu, 24 Apr 2025 11:30:12 -0700,
+  date_time_ymd: null,
+  date_time_unix: 1745519412.353,
+  time_24: 41412,
+  time_12: 11:30:12 AM,
+  week: 17,
+  month: 4,
+  year: 2025,
+  year_abbr: 25,
+  is_dst: null,
+  dst_savings: null,
+  dst_exists: null,
+  dst_start: null,
+  dst_end: null
+)
+```
+