ipgeolocation_sdk 1.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (228) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/README.md +288 -2003
  4. data/lib/ipgeolocation_sdk/client.rb +227 -0
  5. data/lib/ipgeolocation_sdk/client_config.rb +106 -0
  6. data/lib/ipgeolocation_sdk/enums.rb +110 -0
  7. data/lib/ipgeolocation_sdk/errors.rb +38 -0
  8. data/lib/ipgeolocation_sdk/json_output.rb +30 -0
  9. data/lib/ipgeolocation_sdk/models.rb +186 -0
  10. data/lib/ipgeolocation_sdk/request_models.rb +175 -0
  11. data/lib/ipgeolocation_sdk/serde.rb +434 -0
  12. data/lib/ipgeolocation_sdk/transport.rb +124 -0
  13. data/lib/ipgeolocation_sdk/value_object.rb +60 -0
  14. data/lib/ipgeolocation_sdk/version.rb +1 -13
  15. data/lib/ipgeolocation_sdk.rb +19 -101
  16. metadata +38 -308
  17. data/Gemfile +0 -9
  18. data/Rakefile +0 -10
  19. data/docs/ASNConnection.md +0 -22
  20. data/docs/ASNDetails.md +0 -48
  21. data/docs/ASNLookupApi.md +0 -89
  22. data/docs/ASNResponse.md +0 -20
  23. data/docs/ASNResponseXML.md +0 -20
  24. data/docs/ASNResponseXMLAsn.md +0 -48
  25. data/docs/Abuse.md +0 -40
  26. data/docs/AbuseContactApi.md +0 -85
  27. data/docs/AbuseResponse.md +0 -20
  28. data/docs/AbuseResponseXML.md +0 -20
  29. data/docs/Astronomy.md +0 -68
  30. data/docs/AstronomyApi.md +0 -97
  31. data/docs/AstronomyEvening.md +0 -36
  32. data/docs/AstronomyLocation.md +0 -50
  33. data/docs/AstronomyMorning.md +0 -36
  34. data/docs/AstronomyResponse.md +0 -22
  35. data/docs/AstronomyXMLResponse.md +0 -22
  36. data/docs/BulkIPGeolocation.md +0 -42
  37. data/docs/BulkIPSecurity.md +0 -42
  38. data/docs/CountryMetadata.md +0 -22
  39. data/docs/Currency.md +0 -22
  40. data/docs/ErrorResponse.md +0 -18
  41. data/docs/ErrorXMLResponse.md +0 -18
  42. data/docs/ErrorXMLResponseArray.md +0 -18
  43. data/docs/GeolocationResponse.md +0 -38
  44. data/docs/GeolocationXMLResponse.md +0 -38
  45. data/docs/GeolocationXMLResponseArray.md +0 -38
  46. data/docs/GetBulkIpGeolocation200ResponseInner1.md +0 -49
  47. data/docs/GetBulkIpGeolocationRequest.md +0 -18
  48. data/docs/GetBulkIpSecurityInfo200ResponseInner1.md +0 -49
  49. data/docs/IPLocationApi.md +0 -175
  50. data/docs/Location.md +0 -58
  51. data/docs/LocationMinimal.md +0 -52
  52. data/docs/Network.md +0 -22
  53. data/docs/NetworkAsn.md +0 -38
  54. data/docs/NetworkCompany.md +0 -22
  55. data/docs/NetworkMinimal.md +0 -20
  56. data/docs/NetworkMinimalAsn.md +0 -22
  57. data/docs/NetworkMinimalCompany.md +0 -18
  58. data/docs/ParseBulkUserAgentStringsRequest.md +0 -18
  59. data/docs/ParseUserAgentStringRequest.md +0 -18
  60. data/docs/Security.md +0 -38
  61. data/docs/SecurityAPIResponse.md +0 -34
  62. data/docs/SecurityAPIXMLResponse.md +0 -34
  63. data/docs/SecurityAPIXMLResponseArray.md +0 -34
  64. data/docs/SecurityApi.md +0 -175
  65. data/docs/TimeConversionApi.md +0 -109
  66. data/docs/TimeConversionResponse.md +0 -24
  67. data/docs/TimeConversionXMLResponse.md +0 -24
  68. data/docs/TimeZone.md +0 -36
  69. data/docs/TimeZoneDetailedResponse.md +0 -26
  70. data/docs/TimeZoneDetailedXMLResponse.md +0 -26
  71. data/docs/TimeZoneDstEnd.md +0 -28
  72. data/docs/TimeZoneDstStart.md +0 -28
  73. data/docs/TimezoneAirport.md +0 -40
  74. data/docs/TimezoneApi.md +0 -99
  75. data/docs/TimezoneDetail.md +0 -56
  76. data/docs/TimezoneDetailDstEnd.md +0 -28
  77. data/docs/TimezoneDetailDstStart.md +0 -28
  78. data/docs/TimezoneLocation.md +0 -48
  79. data/docs/TimezoneLocode.md +0 -32
  80. data/docs/UserAgentApi.md +0 -235
  81. data/docs/UserAgentData.md +0 -32
  82. data/docs/UserAgentDataDevice.md +0 -24
  83. data/docs/UserAgentDataEngine.md +0 -24
  84. data/docs/UserAgentDataOperatingSystem.md +0 -26
  85. data/docs/UserAgentXMLData.md +0 -32
  86. data/docs/UserAgentXMLDataArray.md +0 -32
  87. data/git_push.sh +0 -57
  88. data/ipgeolocation_sdk.gemspec +0 -29
  89. data/lib/ipgeolocation_sdk/api/abuse_contact_api.rb +0 -86
  90. data/lib/ipgeolocation_sdk/api/asn_lookup_api.rb +0 -92
  91. data/lib/ipgeolocation_sdk/api/astronomy_api.rb +0 -116
  92. data/lib/ipgeolocation_sdk/api/ip_geolocation_api.rb +0 -186
  93. data/lib/ipgeolocation_sdk/api/ip_security_api.rb +0 -184
  94. data/lib/ipgeolocation_sdk/api/time_conversion_api.rb +0 -122
  95. data/lib/ipgeolocation_sdk/api/timezone_api.rb +0 -113
  96. data/lib/ipgeolocation_sdk/api/user_agent_api.rb +0 -158
  97. data/lib/ipgeolocation_sdk/api_client.rb +0 -393
  98. data/lib/ipgeolocation_sdk/api_error.rb +0 -58
  99. data/lib/ipgeolocation_sdk/configuration.rb +0 -308
  100. data/lib/ipgeolocation_sdk/models/abuse.rb +0 -305
  101. data/lib/ipgeolocation_sdk/models/abuse_response.rb +0 -229
  102. data/lib/ipgeolocation_sdk/models/abuse_response_xml.rb +0 -229
  103. data/lib/ipgeolocation_sdk/models/asn_connection.rb +0 -238
  104. data/lib/ipgeolocation_sdk/models/asn_response.rb +0 -230
  105. data/lib/ipgeolocation_sdk/models/asn_response_asn.rb +0 -368
  106. data/lib/ipgeolocation_sdk/models/asn_response_xml.rb +0 -229
  107. data/lib/ipgeolocation_sdk/models/asn_response_xml_asn.rb +0 -364
  108. data/lib/ipgeolocation_sdk/models/astronomy.rb +0 -445
  109. data/lib/ipgeolocation_sdk/models/astronomy_evening.rb +0 -301
  110. data/lib/ipgeolocation_sdk/models/astronomy_location.rb +0 -364
  111. data/lib/ipgeolocation_sdk/models/astronomy_morning.rb +0 -301
  112. data/lib/ipgeolocation_sdk/models/astronomy_response.rb +0 -238
  113. data/lib/ipgeolocation_sdk/models/astronomy_xml_response.rb +0 -238
  114. data/lib/ipgeolocation_sdk/models/bulk_ip_geolocation.rb +0 -113
  115. data/lib/ipgeolocation_sdk/models/bulk_ip_security.rb +0 -113
  116. data/lib/ipgeolocation_sdk/models/country_metadata.rb +0 -240
  117. data/lib/ipgeolocation_sdk/models/currency.rb +0 -238
  118. data/lib/ipgeolocation_sdk/models/error_response.rb +0 -220
  119. data/lib/ipgeolocation_sdk/models/error_xml_response.rb +0 -220
  120. data/lib/ipgeolocation_sdk/models/error_xml_response_array.rb +0 -220
  121. data/lib/ipgeolocation_sdk/models/geolocation_response.rb +0 -310
  122. data/lib/ipgeolocation_sdk/models/geolocation_xml_response.rb +0 -310
  123. data/lib/ipgeolocation_sdk/models/geolocation_xml_response_array.rb +0 -310
  124. data/lib/ipgeolocation_sdk/models/get_bulk_ip_geolocation200_response_inner1.rb +0 -105
  125. data/lib/ipgeolocation_sdk/models/get_bulk_ip_geolocation_request.rb +0 -241
  126. data/lib/ipgeolocation_sdk/models/get_bulk_ip_security_info200_response_inner1.rb +0 -105
  127. data/lib/ipgeolocation_sdk/models/location.rb +0 -400
  128. data/lib/ipgeolocation_sdk/models/location_minimal.rb +0 -373
  129. data/lib/ipgeolocation_sdk/models/network.rb +0 -238
  130. data/lib/ipgeolocation_sdk/models/network_asn.rb +0 -310
  131. data/lib/ipgeolocation_sdk/models/network_company.rb +0 -238
  132. data/lib/ipgeolocation_sdk/models/network_minimal.rb +0 -229
  133. data/lib/ipgeolocation_sdk/models/network_minimal_asn.rb +0 -238
  134. data/lib/ipgeolocation_sdk/models/network_minimal_company.rb +0 -220
  135. data/lib/ipgeolocation_sdk/models/parse_bulk_user_agent_strings_request.rb +0 -222
  136. data/lib/ipgeolocation_sdk/models/parse_user_agent_string_request.rb +0 -220
  137. data/lib/ipgeolocation_sdk/models/security.rb +0 -310
  138. data/lib/ipgeolocation_sdk/models/security_api_response.rb +0 -292
  139. data/lib/ipgeolocation_sdk/models/security_apixml_response.rb +0 -292
  140. data/lib/ipgeolocation_sdk/models/security_apixml_response_array.rb +0 -292
  141. data/lib/ipgeolocation_sdk/models/time_conversion_response.rb +0 -247
  142. data/lib/ipgeolocation_sdk/models/time_conversion_xml_response.rb +0 -247
  143. data/lib/ipgeolocation_sdk/models/time_zone.rb +0 -301
  144. data/lib/ipgeolocation_sdk/models/time_zone_detailed_response.rb +0 -256
  145. data/lib/ipgeolocation_sdk/models/time_zone_detailed_xml_response.rb +0 -256
  146. data/lib/ipgeolocation_sdk/models/time_zone_dst_end.rb +0 -265
  147. data/lib/ipgeolocation_sdk/models/time_zone_dst_start.rb +0 -265
  148. data/lib/ipgeolocation_sdk/models/timezone_airport.rb +0 -319
  149. data/lib/ipgeolocation_sdk/models/timezone_detail.rb +0 -391
  150. data/lib/ipgeolocation_sdk/models/timezone_detail_dst_end.rb +0 -265
  151. data/lib/ipgeolocation_sdk/models/timezone_detail_dst_start.rb +0 -265
  152. data/lib/ipgeolocation_sdk/models/timezone_location.rb +0 -355
  153. data/lib/ipgeolocation_sdk/models/timezone_locode.rb +0 -283
  154. data/lib/ipgeolocation_sdk/models/user_agent_data.rb +0 -283
  155. data/lib/ipgeolocation_sdk/models/user_agent_data_device.rb +0 -247
  156. data/lib/ipgeolocation_sdk/models/user_agent_data_engine.rb +0 -247
  157. data/lib/ipgeolocation_sdk/models/user_agent_data_operating_system.rb +0 -256
  158. data/lib/ipgeolocation_sdk/models/user_agent_xml_data.rb +0 -283
  159. data/lib/ipgeolocation_sdk/models/user_agent_xml_data_array.rb +0 -283
  160. data/spec/api/abuse_contact_api_spec.rb +0 -48
  161. data/spec/api/asn_lookup_api_spec.rb +0 -50
  162. data/spec/api/astronomy_api_spec.rb +0 -54
  163. data/spec/api/ip_location_api_spec.rb +0 -67
  164. data/spec/api/security_api_spec.rb +0 -67
  165. data/spec/api/time_conversion_api_spec.rb +0 -60
  166. data/spec/api/timezone_api_spec.rb +0 -56
  167. data/spec/api/user_agent_api_spec.rb +0 -74
  168. data/spec/models/abuse_response_spec.rb +0 -42
  169. data/spec/models/abuse_response_xml_spec.rb +0 -42
  170. data/spec/models/abuse_spec.rb +0 -90
  171. data/spec/models/asn_connection_spec.rb +0 -48
  172. data/spec/models/asn_response_asn_spec.rb +0 -126
  173. data/spec/models/asn_response_spec.rb +0 -42
  174. data/spec/models/asn_response_xml_asn_spec.rb +0 -126
  175. data/spec/models/asn_response_xml_spec.rb +0 -42
  176. data/spec/models/astronomy_evening_spec.rb +0 -90
  177. data/spec/models/astronomy_location_spec.rb +0 -132
  178. data/spec/models/astronomy_morning_spec.rb +0 -90
  179. data/spec/models/astronomy_response_spec.rb +0 -48
  180. data/spec/models/astronomy_spec.rb +0 -186
  181. data/spec/models/astronomy_xml_response_spec.rb +0 -48
  182. data/spec/models/country_metadata_spec.rb +0 -48
  183. data/spec/models/currency_spec.rb +0 -48
  184. data/spec/models/error_response_spec.rb +0 -36
  185. data/spec/models/error_xml_response_array_spec.rb +0 -36
  186. data/spec/models/error_xml_response_spec.rb +0 -36
  187. data/spec/models/geolocation_response_spec.rb +0 -96
  188. data/spec/models/geolocation_xml_response_array_spec.rb +0 -96
  189. data/spec/models/geolocation_xml_response_spec.rb +0 -96
  190. data/spec/models/get_bulk_ip_geolocation200_response_inner1_spec.rb +0 -32
  191. data/spec/models/get_bulk_ip_geolocation200_response_inner_spec.rb +0 -32
  192. data/spec/models/get_bulk_ip_geolocation_request_spec.rb +0 -36
  193. data/spec/models/get_bulk_ip_security_info200_response_inner1_spec.rb +0 -32
  194. data/spec/models/get_bulk_ip_security_info200_response_inner_spec.rb +0 -32
  195. data/spec/models/location_minimal_spec.rb +0 -138
  196. data/spec/models/location_spec.rb +0 -156
  197. data/spec/models/network_asn_spec.rb +0 -96
  198. data/spec/models/network_company_spec.rb +0 -48
  199. data/spec/models/network_minimal_asn_spec.rb +0 -48
  200. data/spec/models/network_minimal_company_spec.rb +0 -36
  201. data/spec/models/network_minimal_spec.rb +0 -42
  202. data/spec/models/network_spec.rb +0 -48
  203. data/spec/models/parse_bulk_user_agent_strings_request_spec.rb +0 -36
  204. data/spec/models/parse_user_agent_string_request_spec.rb +0 -36
  205. data/spec/models/security_api_response_spec.rb +0 -84
  206. data/spec/models/security_apixml_response_array_spec.rb +0 -84
  207. data/spec/models/security_apixml_response_spec.rb +0 -84
  208. data/spec/models/security_spec.rb +0 -96
  209. data/spec/models/time_conversion_response_spec.rb +0 -54
  210. data/spec/models/time_conversion_xml_response_spec.rb +0 -54
  211. data/spec/models/time_zone_detailed_response_spec.rb +0 -60
  212. data/spec/models/time_zone_detailed_xml_response_spec.rb +0 -60
  213. data/spec/models/time_zone_dst_end_spec.rb +0 -66
  214. data/spec/models/time_zone_dst_start_spec.rb +0 -66
  215. data/spec/models/time_zone_spec.rb +0 -90
  216. data/spec/models/timezone_airport_spec.rb +0 -102
  217. data/spec/models/timezone_detail_dst_end_spec.rb +0 -66
  218. data/spec/models/timezone_detail_dst_start_spec.rb +0 -66
  219. data/spec/models/timezone_detail_spec.rb +0 -150
  220. data/spec/models/timezone_location_spec.rb +0 -126
  221. data/spec/models/timezone_locode_spec.rb +0 -78
  222. data/spec/models/user_agent_data_device_spec.rb +0 -54
  223. data/spec/models/user_agent_data_engine_spec.rb +0 -54
  224. data/spec/models/user_agent_data_operating_system_spec.rb +0 -60
  225. data/spec/models/user_agent_data_spec.rb +0 -78
  226. data/spec/models/user_agent_xml_data_array_spec.rb +0 -78
  227. data/spec/models/user_agent_xml_data_spec.rb +0 -78
  228. data/spec/spec_helper.rb +0 -111
@@ -1,40 +0,0 @@
1
- # IpgeolocationSdk::TimezoneAirport
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **type** | **String** | | [optional] |
8
- | **name** | **String** | | [optional] |
9
- | **latitude** | **String** | | [optional] |
10
- | **longitude** | **String** | | [optional] |
11
- | **elevation_ft** | **Integer** | | [optional] |
12
- | **continent_code** | **String** | | [optional] |
13
- | **country_code** | **String** | | [optional] |
14
- | **state_code** | **String** | | [optional] |
15
- | **city** | **String** | | [optional] |
16
- | **iata_code** | **String** | | [optional] |
17
- | **icao_code** | **String** | | [optional] |
18
- | **faa_code** | **String** | | [optional] |
19
-
20
- ## Example
21
-
22
- ```ruby
23
- require 'ipgeolocation_sdk'
24
-
25
- instance = IpgeolocationSdk::TimezoneAirport.new(
26
- type: large_airport,
27
- name: Hartsfield Jackson Atlanta International Airport,
28
- latitude: 33.63670,
29
- longitude: -84.42810,
30
- elevation_ft: 1026,
31
- continent_code: NA,
32
- country_code: US,
33
- state_code: US-GA,
34
- city: Atlanta,
35
- iata_code: ATL,
36
- icao_code: KATL,
37
- faa_code:
38
- )
39
- ```
40
-
data/docs/TimezoneApi.md DELETED
@@ -1,99 +0,0 @@
1
- # IpgeolocationSdk::TimezoneApi
2
-
3
- All URIs are relative to *https://api.ipgeolocation.io/v2*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**get_timezone_info**](TimezoneApi.md#get_timezone_info) | **GET** /timezone | Timezone information details |
8
-
9
-
10
- ## get_timezone_info
11
-
12
- > <TimeZoneDetailedResponse> get_timezone_info(opts)
13
-
14
- Timezone information details
15
-
16
- 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.
17
-
18
- ### Examples
19
-
20
- ```ruby
21
- require 'time'
22
- require 'ipgeolocation_sdk'
23
- # setup authorization
24
- IpgeolocationSdk.configure do |config|
25
- # Configure API key authorization: ApiKeyAuth
26
- config.api_key['apiKey'] = 'YOUR API KEY'
27
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
- # config.api_key_prefix['apiKey'] = 'Bearer'
29
- end
30
-
31
- api_instance = IpgeolocationSdk::TimezoneApi.new
32
- opts = {
33
- tz: 'America/Los_Angeles', # String | pass a valid time zone name as a query parameter tz to get the time zone information.
34
- location: 'London, UK', # String | pass any address of a location as the query parameter location to get the time zone information.
35
- lat: -27.4748, # Float | pass the latitude of a location as query parameters to get the time zone information.
36
- long: 153.017, # Float | pass the longitude of a location as query parameters to get the time zone information.
37
- 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.
38
- 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.
39
- 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.
40
- 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.
41
- output: 'json', # String | Desired output format (json or xml).
42
- 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`.
43
- }
44
-
45
- begin
46
- # Timezone information details
47
- result = api_instance.get_timezone_info(opts)
48
- p result
49
- rescue IpgeolocationSdk::ApiError => e
50
- puts "Error when calling TimezoneApi->get_timezone_info: #{e}"
51
- end
52
- ```
53
-
54
- #### Using the get_timezone_info_with_http_info variant
55
-
56
- This returns an Array which contains the response data, status code and headers.
57
-
58
- > <Array(<TimeZoneDetailedResponse>, Integer, Hash)> get_timezone_info_with_http_info(opts)
59
-
60
- ```ruby
61
- begin
62
- # Timezone information details
63
- data, status_code, headers = api_instance.get_timezone_info_with_http_info(opts)
64
- p status_code # => 2xx
65
- p headers # => { ... }
66
- p data # => <TimeZoneDetailedResponse>
67
- rescue IpgeolocationSdk::ApiError => e
68
- puts "Error when calling TimezoneApi->get_timezone_info_with_http_info: #{e}"
69
- end
70
- ```
71
-
72
- ### Parameters
73
-
74
- | Name | Type | Description | Notes |
75
- | ---- | ---- | ----------- | ----- |
76
- | **tz** | **String** | pass a valid time zone name as a query parameter tz to get the time zone information. | [optional] |
77
- | **location** | **String** | pass any address of a location as the query parameter location to get the time zone information. | [optional] |
78
- | **lat** | **Float** | pass the latitude of a location as query parameters to get the time zone information. | [optional] |
79
- | **long** | **Float** | pass the longitude of a location as query parameters to get the time zone information. | [optional] |
80
- | **ip** | **String** | You can pass any IPv4 or IPv6 address as a query parameter ip to get the regional timezone information. | [optional] |
81
- | **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] |
82
- | **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] |
83
- | **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] |
84
- | **output** | **String** | Desired output format (json or xml). | [optional] |
85
- | **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] |
86
-
87
- ### Return type
88
-
89
- [**TimeZoneDetailedResponse**](TimeZoneDetailedResponse.md)
90
-
91
- ### Authorization
92
-
93
- [ApiKeyAuth](../README.md#ApiKeyAuth)
94
-
95
- ### HTTP request headers
96
-
97
- - **Content-Type**: Not defined
98
- - **Accept**: application/json, application/xml
99
-
@@ -1,56 +0,0 @@
1
- # IpgeolocationSdk::TimezoneDetail
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **offset** | **Integer** | | [optional] |
9
- | **offset_with_dst** | **Integer** | | [optional] |
10
- | **date** | **Date** | | [optional] |
11
- | **date_time** | **String** | | [optional] |
12
- | **date_time_txt** | **String** | | [optional] |
13
- | **date_time_wti** | **String** | | [optional] |
14
- | **date_time_ymd** | **Time** | | [optional] |
15
- | **date_time_unix** | **Float** | | [optional] |
16
- | **time_24** | **String** | | [optional] |
17
- | **time_12** | **String** | | [optional] |
18
- | **week** | **Integer** | | [optional] |
19
- | **month** | **Integer** | | [optional] |
20
- | **year** | **Integer** | | [optional] |
21
- | **year_abbr** | **String** | | [optional] |
22
- | **is_dst** | **Boolean** | | [optional] |
23
- | **dst_savings** | **Integer** | | [optional] |
24
- | **dst_exists** | **Boolean** | | [optional] |
25
- | **dst_start** | [**TimezoneDetailDstStart**](TimezoneDetailDstStart.md) | | [optional] |
26
- | **dst_end** | [**TimezoneDetailDstEnd**](TimezoneDetailDstEnd.md) | | [optional] |
27
-
28
- ## Example
29
-
30
- ```ruby
31
- require 'ipgeolocation_sdk'
32
-
33
- instance = IpgeolocationSdk::TimezoneDetail.new(
34
- name: America/Los_Angeles,
35
- offset: -8,
36
- offset_with_dst: -7,
37
- date: Thu Apr 24 05:00:00 PKT 2025,
38
- date_time: 2025-04-24 11:30:12,
39
- date_time_txt: Thursday, April 24, 2025 11:30:12,
40
- date_time_wti: Thu, 24 Apr 2025 11:30:12 -0700,
41
- date_time_ymd: null,
42
- date_time_unix: 1745519412.353,
43
- time_24: 41412,
44
- time_12: 11:30:12 AM,
45
- week: 17,
46
- month: 4,
47
- year: 2025,
48
- year_abbr: 25,
49
- is_dst: null,
50
- dst_savings: null,
51
- dst_exists: null,
52
- dst_start: null,
53
- dst_end: null
54
- )
55
- ```
56
-
@@ -1,28 +0,0 @@
1
- # IpgeolocationSdk::TimezoneDetailDstEnd
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **utc_time** | **String** | | [optional] |
8
- | **duration** | **String** | | [optional] |
9
- | **gap** | **Boolean** | | [optional] |
10
- | **date_time_after** | **String** | | [optional] |
11
- | **date_time_before** | **String** | | [optional] |
12
- | **overlap** | **Boolean** | | [optional] |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'ipgeolocation_sdk'
18
-
19
- instance = IpgeolocationSdk::TimezoneDetailDstEnd.new(
20
- utc_time: 2025-11-02 TIME 09,
21
- duration: -1H,
22
- gap: null,
23
- date_time_after: 2025-11-02 TIME 01,
24
- date_time_before: 2025-11-02 TIME 02,
25
- overlap: null
26
- )
27
- ```
28
-
@@ -1,28 +0,0 @@
1
- # IpgeolocationSdk::TimezoneDetailDstStart
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **utc_time** | **String** | | [optional] |
8
- | **duration** | **String** | | [optional] |
9
- | **gap** | **Boolean** | | [optional] |
10
- | **date_time_after** | **String** | | [optional] |
11
- | **date_time_before** | **String** | | [optional] |
12
- | **overlap** | **Boolean** | | [optional] |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'ipgeolocation_sdk'
18
-
19
- instance = IpgeolocationSdk::TimezoneDetailDstStart.new(
20
- utc_time: 2025-03-09 TIME 10,
21
- duration: +1H,
22
- gap: null,
23
- date_time_after: 2025-03-09 TIME 03,
24
- date_time_before: 2025-03-09 TIME 02,
25
- overlap: null
26
- )
27
- ```
28
-
@@ -1,48 +0,0 @@
1
- # IpgeolocationSdk::TimezoneLocation
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **location_string** | **String** | | [optional] |
8
- | **continent_code** | **String** | | [optional] |
9
- | **continent_name** | **String** | | [optional] |
10
- | **country_code2** | **String** | | [optional] |
11
- | **country_code3** | **String** | | [optional] |
12
- | **country_name** | **String** | | [optional] |
13
- | **country_name_official** | **String** | | [optional] |
14
- | **is_eu** | **Boolean** | | [optional] |
15
- | **state_prov** | **String** | | [optional] |
16
- | **state_code** | **String** | | [optional] |
17
- | **district** | **String** | | [optional] |
18
- | **city** | **String** | | [optional] |
19
- | **locality** | **String** | | [optional] |
20
- | **zipcode** | **String** | | [optional] |
21
- | **latitude** | **String** | | [optional] |
22
- | **longitude** | **String** | | [optional] |
23
-
24
- ## Example
25
-
26
- ```ruby
27
- require 'ipgeolocation_sdk'
28
-
29
- instance = IpgeolocationSdk::TimezoneLocation.new(
30
- location_string: Londong, UK,
31
- continent_code: OC,
32
- continent_name: Oceania,
33
- country_code2: AU,
34
- country_code3: AUS,
35
- country_name: Australia,
36
- country_name_official: Commonwealth of Australia,
37
- is_eu: false,
38
- state_prov: Queensland,
39
- state_code: AU-QLD,
40
- district: South Brisbane,
41
- city: Brisbane,
42
- locality: ,
43
- zipcode: 4101,
44
- latitude: -27.47306,
45
- longitude: 153.01421
46
- )
47
- ```
48
-
@@ -1,32 +0,0 @@
1
- # IpgeolocationSdk::TimezoneLocode
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **lo_code** | **String** | | [optional] |
8
- | **city** | **String** | | [optional] |
9
- | **state_code** | **String** | | [optional] |
10
- | **country_code** | **String** | | [optional] |
11
- | **country_name** | **String** | | [optional] |
12
- | **location_type** | **String** | | [optional] |
13
- | **latitude** | **String** | | [optional] |
14
- | **longitude** | **String** | | [optional] |
15
-
16
- ## Example
17
-
18
- ```ruby
19
- require 'ipgeolocation_sdk'
20
-
21
- instance = IpgeolocationSdk::TimezoneLocode.new(
22
- lo_code: DEBER,
23
- city: Berlin,
24
- state_code: BE,
25
- country_code: DE,
26
- country_name: ,
27
- location_type: Port, Rail Terminal, Road Terminal, Airport, Postal Exchange,
28
- latitude: 52.51667,
29
- longitude: 13.38333
30
- )
31
- ```
32
-
data/docs/UserAgentApi.md DELETED
@@ -1,235 +0,0 @@
1
- # IpgeolocationSdk::UserAgentApi
2
-
3
- All URIs are relative to *https://api.ipgeolocation.io/v2*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**get_user_agent_details**](UserAgentApi.md#get_user_agent_details) | **GET** /user-agent | Get details of user-agent |
8
- | [**parse_bulk_user_agent_strings**](UserAgentApi.md#parse_bulk_user_agent_strings) | **POST** /user-agent-bulk | Handle multiple user-agent string lookups |
9
- | [**parse_user_agent_string**](UserAgentApi.md#parse_user_agent_string) | **POST** /user-agent | Handle single User-Agent string |
10
-
11
-
12
- ## get_user_agent_details
13
-
14
- > <UserAgentData> get_user_agent_details(opts)
15
-
16
- Get details of user-agent
17
-
18
- User Agent Parser API provides the accurate browser, device, and operating system details from a User Agent String. It also provides information about crawlers and attack sources. You can use these details to customize user experience, prevent crawlers and attackers from accessing your website.
19
-
20
- ### Examples
21
-
22
- ```ruby
23
- require 'time'
24
- require 'ipgeolocation_sdk'
25
- # setup authorization
26
- IpgeolocationSdk.configure do |config|
27
- # Configure API key authorization: ApiKeyAuth
28
- config.api_key['apiKey'] = 'YOUR API KEY'
29
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
30
- # config.api_key_prefix['apiKey'] = 'Bearer'
31
- end
32
-
33
- api_instance = IpgeolocationSdk::UserAgentApi.new
34
- opts = {
35
- user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_2) AppleWebKit/601.3.9 (KHTML, like Gecko) Version/9.0.2 Safari/601.3.9', # String |
36
- output: 'json' # String | Desired output format (json or xml).
37
- }
38
-
39
- begin
40
- # Get details of user-agent
41
- result = api_instance.get_user_agent_details(opts)
42
- p result
43
- rescue IpgeolocationSdk::ApiError => e
44
- puts "Error when calling UserAgentApi->get_user_agent_details: #{e}"
45
- end
46
- ```
47
-
48
- #### Using the get_user_agent_details_with_http_info variant
49
-
50
- This returns an Array which contains the response data, status code and headers.
51
-
52
- > <Array(<UserAgentData>, Integer, Hash)> get_user_agent_details_with_http_info(opts)
53
-
54
- ```ruby
55
- begin
56
- # Get details of user-agent
57
- data, status_code, headers = api_instance.get_user_agent_details_with_http_info(opts)
58
- p status_code # => 2xx
59
- p headers # => { ... }
60
- p data # => <UserAgentData>
61
- rescue IpgeolocationSdk::ApiError => e
62
- puts "Error when calling UserAgentApi->get_user_agent_details_with_http_info: #{e}"
63
- end
64
- ```
65
-
66
- ### Parameters
67
-
68
- | Name | Type | Description | Notes |
69
- | ---- | ---- | ----------- | ----- |
70
- | **user_agent** | **String** | | [optional] |
71
- | **output** | **String** | Desired output format (json or xml). | [optional] |
72
-
73
- ### Return type
74
-
75
- [**UserAgentData**](UserAgentData.md)
76
-
77
- ### Authorization
78
-
79
- [ApiKeyAuth](../README.md#ApiKeyAuth)
80
-
81
- ### HTTP request headers
82
-
83
- - **Content-Type**: Not defined
84
- - **Accept**: application/json, application/xml
85
-
86
-
87
- ## parse_bulk_user_agent_strings
88
-
89
- > <Array<UserAgentData>> parse_bulk_user_agent_strings(opts)
90
-
91
- Handle multiple user-agent string lookups
92
-
93
- This endpoint allows you to perform the parsing of multiple User-Angent strings (max. 50,000) at the same time. The requests count per round is equal to total User-Agent strings passed. This feature is `only available for paid plans`.
94
-
95
- ### Examples
96
-
97
- ```ruby
98
- require 'time'
99
- require 'ipgeolocation_sdk'
100
- # setup authorization
101
- IpgeolocationSdk.configure do |config|
102
- # Configure API key authorization: ApiKeyAuth
103
- config.api_key['apiKey'] = 'YOUR API KEY'
104
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
105
- # config.api_key_prefix['apiKey'] = 'Bearer'
106
- end
107
-
108
- api_instance = IpgeolocationSdk::UserAgentApi.new
109
- opts = {
110
- output: 'json', # String | Desired output format (json or xml).
111
- parse_bulk_user_agent_strings_request: IpgeolocationSdk::ParseBulkUserAgentStringsRequest.new # ParseBulkUserAgentStringsRequest |
112
- }
113
-
114
- begin
115
- # Handle multiple user-agent string lookups
116
- result = api_instance.parse_bulk_user_agent_strings(opts)
117
- p result
118
- rescue IpgeolocationSdk::ApiError => e
119
- puts "Error when calling UserAgentApi->parse_bulk_user_agent_strings: #{e}"
120
- end
121
- ```
122
-
123
- #### Using the parse_bulk_user_agent_strings_with_http_info variant
124
-
125
- This returns an Array which contains the response data, status code and headers.
126
-
127
- > <Array(<Array<UserAgentData>>, Integer, Hash)> parse_bulk_user_agent_strings_with_http_info(opts)
128
-
129
- ```ruby
130
- begin
131
- # Handle multiple user-agent string lookups
132
- data, status_code, headers = api_instance.parse_bulk_user_agent_strings_with_http_info(opts)
133
- p status_code # => 2xx
134
- p headers # => { ... }
135
- p data # => <Array<UserAgentData>>
136
- rescue IpgeolocationSdk::ApiError => e
137
- puts "Error when calling UserAgentApi->parse_bulk_user_agent_strings_with_http_info: #{e}"
138
- end
139
- ```
140
-
141
- ### Parameters
142
-
143
- | Name | Type | Description | Notes |
144
- | ---- | ---- | ----------- | ----- |
145
- | **output** | **String** | Desired output format (json or xml). | [optional] |
146
- | **parse_bulk_user_agent_strings_request** | [**ParseBulkUserAgentStringsRequest**](ParseBulkUserAgentStringsRequest.md) | | [optional] |
147
-
148
- ### Return type
149
-
150
- [**Array&lt;UserAgentData&gt;**](UserAgentData.md)
151
-
152
- ### Authorization
153
-
154
- [ApiKeyAuth](../README.md#ApiKeyAuth)
155
-
156
- ### HTTP request headers
157
-
158
- - **Content-Type**: application/json
159
- - **Accept**: application/json, application/xml
160
-
161
-
162
- ## parse_user_agent_string
163
-
164
- > <UserAgentData> parse_user_agent_string(opts)
165
-
166
- Handle single User-Agent string
167
-
168
- You can also provide custom User-Agent string to parse in JSON payload. This endpoint is meant to be called from server-side and is available for paid subscriptions only.
169
-
170
- ### Examples
171
-
172
- ```ruby
173
- require 'time'
174
- require 'ipgeolocation_sdk'
175
- # setup authorization
176
- IpgeolocationSdk.configure do |config|
177
- # Configure API key authorization: ApiKeyAuth
178
- config.api_key['apiKey'] = 'YOUR API KEY'
179
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
180
- # config.api_key_prefix['apiKey'] = 'Bearer'
181
- end
182
-
183
- api_instance = IpgeolocationSdk::UserAgentApi.new
184
- opts = {
185
- output: 'json', # String | Desired output format (json or xml).
186
- parse_user_agent_string_request: IpgeolocationSdk::ParseUserAgentStringRequest.new # ParseUserAgentStringRequest |
187
- }
188
-
189
- begin
190
- # Handle single User-Agent string
191
- result = api_instance.parse_user_agent_string(opts)
192
- p result
193
- rescue IpgeolocationSdk::ApiError => e
194
- puts "Error when calling UserAgentApi->parse_user_agent_string: #{e}"
195
- end
196
- ```
197
-
198
- #### Using the parse_user_agent_string_with_http_info variant
199
-
200
- This returns an Array which contains the response data, status code and headers.
201
-
202
- > <Array(<UserAgentData>, Integer, Hash)> parse_user_agent_string_with_http_info(opts)
203
-
204
- ```ruby
205
- begin
206
- # Handle single User-Agent string
207
- data, status_code, headers = api_instance.parse_user_agent_string_with_http_info(opts)
208
- p status_code # => 2xx
209
- p headers # => { ... }
210
- p data # => <UserAgentData>
211
- rescue IpgeolocationSdk::ApiError => e
212
- puts "Error when calling UserAgentApi->parse_user_agent_string_with_http_info: #{e}"
213
- end
214
- ```
215
-
216
- ### Parameters
217
-
218
- | Name | Type | Description | Notes |
219
- | ---- | ---- | ----------- | ----- |
220
- | **output** | **String** | Desired output format (json or xml). | [optional] |
221
- | **parse_user_agent_string_request** | [**ParseUserAgentStringRequest**](ParseUserAgentStringRequest.md) | | [optional] |
222
-
223
- ### Return type
224
-
225
- [**UserAgentData**](UserAgentData.md)
226
-
227
- ### Authorization
228
-
229
- [ApiKeyAuth](../README.md#ApiKeyAuth)
230
-
231
- ### HTTP request headers
232
-
233
- - **Content-Type**: application/json
234
- - **Accept**: application/json, application/xml
235
-
@@ -1,32 +0,0 @@
1
- # IpgeolocationSdk::UserAgentData
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **user_agent_string** | **String** | | [optional] |
8
- | **name** | **String** | | [optional] |
9
- | **type** | **String** | | [optional] |
10
- | **version** | **String** | | [optional] |
11
- | **version_major** | **String** | | [optional] |
12
- | **device** | [**UserAgentDataDevice**](UserAgentDataDevice.md) | | [optional] |
13
- | **engine** | [**UserAgentDataEngine**](UserAgentDataEngine.md) | | [optional] |
14
- | **operating_system** | [**UserAgentDataOperatingSystem**](UserAgentDataOperatingSystem.md) | | [optional] |
15
-
16
- ## Example
17
-
18
- ```ruby
19
- require 'ipgeolocation_sdk'
20
-
21
- instance = IpgeolocationSdk::UserAgentData.new(
22
- user_agent_string: null,
23
- name: null,
24
- type: null,
25
- version: null,
26
- version_major: null,
27
- device: null,
28
- engine: null,
29
- operating_system: null
30
- )
31
- ```
32
-
@@ -1,24 +0,0 @@
1
- # IpgeolocationSdk::UserAgentDataDevice
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **type** | **String** | | [optional] |
9
- | **brand** | **String** | | [optional] |
10
- | **cpu** | **String** | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'ipgeolocation_sdk'
16
-
17
- instance = IpgeolocationSdk::UserAgentDataDevice.new(
18
- name: null,
19
- type: null,
20
- brand: null,
21
- cpu: null
22
- )
23
- ```
24
-
@@ -1,24 +0,0 @@
1
- # IpgeolocationSdk::UserAgentDataEngine
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **type** | **String** | | [optional] |
9
- | **version** | **String** | | [optional] |
10
- | **version_major** | **String** | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'ipgeolocation_sdk'
16
-
17
- instance = IpgeolocationSdk::UserAgentDataEngine.new(
18
- name: null,
19
- type: null,
20
- version: null,
21
- version_major: null
22
- )
23
- ```
24
-
@@ -1,26 +0,0 @@
1
- # IpgeolocationSdk::UserAgentDataOperatingSystem
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **type** | **String** | | [optional] |
9
- | **version** | **String** | | [optional] |
10
- | **version_major** | **String** | | [optional] |
11
- | **build** | **String** | | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'ipgeolocation_sdk'
17
-
18
- instance = IpgeolocationSdk::UserAgentDataOperatingSystem.new(
19
- name: null,
20
- type: null,
21
- version: null,
22
- version_major: null,
23
- build: null
24
- )
25
- ```
26
-