ipgeolocation_sdk 1.0.0 → 2.0.0

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 +8 -0
  3. data/README.md +288 -2003
  4. data/lib/ipgeolocation_sdk/client.rb +223 -0
  5. data/lib/ipgeolocation_sdk/client_config.rb +102 -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 +433 -0
  12. data/lib/ipgeolocation_sdk/transport.rb +109 -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 +29 -310
  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,18 +0,0 @@
1
- # IpgeolocationSdk::NetworkMinimalCompany
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'ipgeolocation_sdk'
13
-
14
- instance = IpgeolocationSdk::NetworkMinimalCompany.new(
15
- name: Google LLC
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # IpgeolocationSdk::ParseBulkUserAgentStringsRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **ua_strings** | **Array<String>** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'ipgeolocation_sdk'
13
-
14
- instance = IpgeolocationSdk::ParseBulkUserAgentStringsRequest.new(
15
- ua_strings: ["Mozilla/5.0 (Linux; Android 8.0.0; SM-G960F Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.84 Mobile Safari/537.36","Mozilla/5.0 (X11; U; Linux armv7l like Android; en-us) AppleWebKit/531.2+ (KHTML, like Gecko) Version/5.0 Safari/533.2+ Kindle/3.0+","Mozilla/5.0 (Linux; U; en-US) AppleWebKit/528.5+ (KHTML, like Gecko, Safari/528.5+) Version/4.0 Kindle/3.0 (screen 600x800; rotate)"]
16
- )
17
- ```
18
-
@@ -1,18 +0,0 @@
1
- # IpgeolocationSdk::ParseUserAgentStringRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **ua_string** | **String** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'ipgeolocation_sdk'
13
-
14
- instance = IpgeolocationSdk::ParseUserAgentStringRequest.new(
15
- ua_string: 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
16
- )
17
- ```
18
-
data/docs/Security.md DELETED
@@ -1,38 +0,0 @@
1
- # IpgeolocationSdk::Security
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **threat_score** | **Integer** | | [optional] |
8
- | **is_tor** | **Boolean** | | [optional] |
9
- | **is_proxy** | **Boolean** | | [optional] |
10
- | **proxy_type** | **String** | | [optional] |
11
- | **proxy_provider** | **String** | | [optional] |
12
- | **is_anonymous** | **Boolean** | | [optional] |
13
- | **is_known_attacker** | **Boolean** | | [optional] |
14
- | **is_spam** | **Boolean** | | [optional] |
15
- | **is_bot** | **Boolean** | | [optional] |
16
- | **is_cloud_provider** | **Boolean** | | [optional] |
17
- | **cloud_provider** | **String** | | [optional] |
18
-
19
- ## Example
20
-
21
- ```ruby
22
- require 'ipgeolocation_sdk'
23
-
24
- instance = IpgeolocationSdk::Security.new(
25
- threat_score: 80,
26
- is_tor: false,
27
- is_proxy: true,
28
- proxy_type: VPN,
29
- proxy_provider: ,
30
- is_anonymous: true,
31
- is_known_attacker: true,
32
- is_spam: false,
33
- is_bot: false,
34
- is_cloud_provider: false,
35
- cloud_provider:
36
- )
37
- ```
38
-
@@ -1,34 +0,0 @@
1
- # IpgeolocationSdk::SecurityAPIResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **ip** | **String** | | [optional] |
8
- | **hostname** | **String** | | [optional] |
9
- | **security** | [**Security**](Security.md) | | [optional] |
10
- | **location** | [**LocationMinimal**](LocationMinimal.md) | | [optional] |
11
- | **network** | [**NetworkMinimal**](NetworkMinimal.md) | | [optional] |
12
- | **time_zone** | [**TimeZone**](TimeZone.md) | | [optional] |
13
- | **user_agent** | [**UserAgentData**](UserAgentData.md) | | [optional] |
14
- | **country_metadata** | [**CountryMetadata**](CountryMetadata.md) | | [optional] |
15
- | **currency** | [**Currency**](Currency.md) | | [optional] |
16
-
17
- ## Example
18
-
19
- ```ruby
20
- require 'ipgeolocation_sdk'
21
-
22
- instance = IpgeolocationSdk::SecurityAPIResponse.new(
23
- ip: 8.8.8.8,
24
- hostname: 195-154-221-54.rev.poneytelecom.eu,
25
- security: null,
26
- location: null,
27
- network: null,
28
- time_zone: null,
29
- user_agent: null,
30
- country_metadata: null,
31
- currency: null
32
- )
33
- ```
34
-
@@ -1,34 +0,0 @@
1
- # IpgeolocationSdk::SecurityAPIXMLResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **ip** | **String** | | [optional] |
8
- | **hostname** | **String** | | [optional] |
9
- | **security** | [**Security**](Security.md) | | [optional] |
10
- | **location** | [**LocationMinimal**](LocationMinimal.md) | | [optional] |
11
- | **network** | [**NetworkMinimal**](NetworkMinimal.md) | | [optional] |
12
- | **time_zone** | [**TimeZone**](TimeZone.md) | | [optional] |
13
- | **user_agent** | [**UserAgentData**](UserAgentData.md) | | [optional] |
14
- | **country_metadata** | [**CountryMetadata**](CountryMetadata.md) | | [optional] |
15
- | **currency** | [**Currency**](Currency.md) | | [optional] |
16
-
17
- ## Example
18
-
19
- ```ruby
20
- require 'ipgeolocation_sdk'
21
-
22
- instance = IpgeolocationSdk::SecurityAPIXMLResponse.new(
23
- ip: 8.8.8.8,
24
- hostname: 195-154-221-54.rev.poneytelecom.eu,
25
- security: null,
26
- location: null,
27
- network: null,
28
- time_zone: null,
29
- user_agent: null,
30
- country_metadata: null,
31
- currency: null
32
- )
33
- ```
34
-
@@ -1,34 +0,0 @@
1
- # IpgeolocationSdk::SecurityAPIXMLResponseArray
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **ip** | **String** | | [optional] |
8
- | **hostname** | **String** | | [optional] |
9
- | **security** | [**Security**](Security.md) | | [optional] |
10
- | **location** | [**LocationMinimal**](LocationMinimal.md) | | [optional] |
11
- | **network** | [**NetworkMinimal**](NetworkMinimal.md) | | [optional] |
12
- | **time_zone** | [**TimeZone**](TimeZone.md) | | [optional] |
13
- | **user_agent** | [**UserAgentData**](UserAgentData.md) | | [optional] |
14
- | **country_metadata** | [**CountryMetadata**](CountryMetadata.md) | | [optional] |
15
- | **currency** | [**Currency**](Currency.md) | | [optional] |
16
-
17
- ## Example
18
-
19
- ```ruby
20
- require 'ipgeolocation_sdk'
21
-
22
- instance = IpgeolocationSdk::SecurityAPIXMLResponseArray.new(
23
- ip: 8.8.8.8,
24
- hostname: 195-154-221-54.rev.poneytelecom.eu,
25
- security: null,
26
- location: null,
27
- network: null,
28
- time_zone: null,
29
- user_agent: null,
30
- country_metadata: null,
31
- currency: null
32
- )
33
- ```
34
-
data/docs/SecurityApi.md DELETED
@@ -1,175 +0,0 @@
1
- # IpgeolocationSdk::SecurityApi
2
-
3
- All URIs are relative to *https://api.ipgeolocation.io/v2*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**get_bulk_ip_security_info**](SecurityApi.md#get_bulk_ip_security_info) | **POST** /security-bulk | |
8
- | [**get_ip_security_info**](SecurityApi.md#get_ip_security_info) | **GET** /security | |
9
-
10
-
11
- ## get_bulk_ip_security_info
12
-
13
- > <Array<GetBulkIpSecurityInfo200ResponseInner>> get_bulk_ip_security_info(get_bulk_ip_geolocation_request, opts)
14
-
15
-
16
-
17
- 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.
18
-
19
- ### Examples
20
-
21
- ```ruby
22
- require 'time'
23
- require 'ipgeolocation_sdk'
24
- # setup authorization
25
- IpgeolocationSdk.configure do |config|
26
- # Configure API key authorization: ApiKeyAuth
27
- config.api_key['apiKey'] = 'YOUR API KEY'
28
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
- # config.api_key_prefix['apiKey'] = 'Bearer'
30
- end
31
-
32
- api_instance = IpgeolocationSdk::SecurityApi.new
33
- get_bulk_ip_geolocation_request = IpgeolocationSdk::GetBulkIpGeolocationRequest.new # GetBulkIpGeolocationRequest |
34
- opts = {
35
- 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
36
- fields: 'security.is_tor, location,', # String | Get specific fields, objects from the response.
37
- excludes: 'security.is_cloud_provider', # String | Exclude specific fields, objects from the response.
38
- output: 'json', # String | Desired output format.
39
- 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`.
40
- }
41
-
42
- begin
43
-
44
- result = api_instance.get_bulk_ip_security_info(get_bulk_ip_geolocation_request, opts)
45
- p result
46
- rescue IpgeolocationSdk::ApiError => e
47
- puts "Error when calling SecurityApi->get_bulk_ip_security_info: #{e}"
48
- end
49
- ```
50
-
51
- #### Using the get_bulk_ip_security_info_with_http_info variant
52
-
53
- This returns an Array which contains the response data, status code and headers.
54
-
55
- > <Array(<Array<GetBulkIpSecurityInfo200ResponseInner>>, Integer, Hash)> get_bulk_ip_security_info_with_http_info(get_bulk_ip_geolocation_request, opts)
56
-
57
- ```ruby
58
- begin
59
-
60
- data, status_code, headers = api_instance.get_bulk_ip_security_info_with_http_info(get_bulk_ip_geolocation_request, opts)
61
- p status_code # => 2xx
62
- p headers # => { ... }
63
- p data # => <Array<GetBulkIpSecurityInfo200ResponseInner>>
64
- rescue IpgeolocationSdk::ApiError => e
65
- puts "Error when calling SecurityApi->get_bulk_ip_security_info_with_http_info: #{e}"
66
- end
67
- ```
68
-
69
- ### Parameters
70
-
71
- | Name | Type | Description | Notes |
72
- | ---- | ---- | ----------- | ----- |
73
- | **get_bulk_ip_geolocation_request** | [**GetBulkIpGeolocationRequest**](GetBulkIpGeolocationRequest.md) | | |
74
- | **include** | **String** | Include optional objects like &#x60;location&#x60;, &#x60;network&#x60;. Use comma-separated values. Example: include&#x3D;location,network | [optional] |
75
- | **fields** | **String** | Get specific fields, objects from the response. | [optional] |
76
- | **excludes** | **String** | Exclude specific fields, objects from the response. | [optional] |
77
- | **output** | **String** | Desired output format. | [optional] |
78
- | **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] |
79
-
80
- ### Return type
81
-
82
- [**Array&lt;GetBulkIpSecurityInfo200ResponseInner&gt;**](GetBulkIpSecurityInfo200ResponseInner.md)
83
-
84
- ### Authorization
85
-
86
- [ApiKeyAuth](../README.md#ApiKeyAuth)
87
-
88
- ### HTTP request headers
89
-
90
- - **Content-Type**: application/json
91
- - **Accept**: application/json, application/xml
92
-
93
-
94
- ## get_ip_security_info
95
-
96
- > <SecurityAPIResponse> get_ip_security_info(opts)
97
-
98
-
99
-
100
- 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.
101
-
102
- ### Examples
103
-
104
- ```ruby
105
- require 'time'
106
- require 'ipgeolocation_sdk'
107
- # setup authorization
108
- IpgeolocationSdk.configure do |config|
109
- # Configure API key authorization: ApiKeyAuth
110
- config.api_key['apiKey'] = 'YOUR API KEY'
111
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
112
- # config.api_key_prefix['apiKey'] = 'Bearer'
113
- end
114
-
115
- api_instance = IpgeolocationSdk::SecurityApi.new
116
- opts = {
117
- ip: '8.8.8.8', # String | query parameter 'ip'. If not provided, will be your network IP
118
- include: 'location,network,currency,time_zone,user_agent,country_metadata,hostname', # String | Include optional details like location and/or network.
119
- fields: 'security.is_tor, location,', # String | Get specific fields, objects from the response.
120
- excludes: 'security.is_cloud_provider', # String | Exclude specific fields, objects from the response.
121
- output: 'json', # String | Desired output format (json or xml).
122
- 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`.
123
- }
124
-
125
- begin
126
-
127
- result = api_instance.get_ip_security_info(opts)
128
- p result
129
- rescue IpgeolocationSdk::ApiError => e
130
- puts "Error when calling SecurityApi->get_ip_security_info: #{e}"
131
- end
132
- ```
133
-
134
- #### Using the get_ip_security_info_with_http_info variant
135
-
136
- This returns an Array which contains the response data, status code and headers.
137
-
138
- > <Array(<SecurityAPIResponse>, Integer, Hash)> get_ip_security_info_with_http_info(opts)
139
-
140
- ```ruby
141
- begin
142
-
143
- data, status_code, headers = api_instance.get_ip_security_info_with_http_info(opts)
144
- p status_code # => 2xx
145
- p headers # => { ... }
146
- p data # => <SecurityAPIResponse>
147
- rescue IpgeolocationSdk::ApiError => e
148
- puts "Error when calling SecurityApi->get_ip_security_info_with_http_info: #{e}"
149
- end
150
- ```
151
-
152
- ### Parameters
153
-
154
- | Name | Type | Description | Notes |
155
- | ---- | ---- | ----------- | ----- |
156
- | **ip** | **String** | query parameter &#39;ip&#39;. If not provided, will be your network IP | [optional] |
157
- | **include** | **String** | Include optional details like location and/or network. | [optional] |
158
- | **fields** | **String** | Get specific fields, objects from the response. | [optional] |
159
- | **excludes** | **String** | Exclude specific fields, objects from the response. | [optional] |
160
- | **output** | **String** | Desired output format (json or xml). | [optional] |
161
- | **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] |
162
-
163
- ### Return type
164
-
165
- [**SecurityAPIResponse**](SecurityAPIResponse.md)
166
-
167
- ### Authorization
168
-
169
- [ApiKeyAuth](../README.md#ApiKeyAuth)
170
-
171
- ### HTTP request headers
172
-
173
- - **Content-Type**: Not defined
174
- - **Accept**: application/json, application/xml
175
-
@@ -1,109 +0,0 @@
1
- # IpgeolocationSdk::TimeConversionApi
2
-
3
- All URIs are relative to *https://api.ipgeolocation.io/v2*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**convert_time_between_timezones**](TimeConversionApi.md#convert_time_between_timezones) | **GET** /timezone/convert | |
8
-
9
-
10
- ## convert_time_between_timezones
11
-
12
- > <TimeConversionResponse> convert_time_between_timezones(opts)
13
-
14
-
15
-
16
- You can convert a timestamp provided as a query paramter time from one time zone to another time zone.
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::TimeConversionApi.new
32
- opts = {
33
- 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.
34
- tz_from: 'America/Argentina/Catamarca', # String | timezone to convert from
35
- tz_to: 'Asia/Kabul', # String | timezone to convert to
36
- lat_from: 34.0207305, # Float | latitude to convert from
37
- long_from: -118.691916, # Float | longitude to convert from
38
- lat_to: 53.473682, # Float | latitude to convert to
39
- long_to: -77.397706, # Float | longitude to convert to
40
- location_from: 'New York, USA', # String | location to convert from
41
- location_to: 'Lahore, Pakistan', # String | location to convert to
42
- icao_from: 'YSSY', # String | location to convert from
43
- icao_to: 'ZBAA', # String | location to convert to
44
- iata_from: 'DXB', # String | location to convert from
45
- iata_to: 'LHR', # String | location to convert to
46
- locode_from: 'PKISB', # String | location to convert from
47
- locode_to: 'USNYC' # String | location to convert to
48
- }
49
-
50
- begin
51
-
52
- result = api_instance.convert_time_between_timezones(opts)
53
- p result
54
- rescue IpgeolocationSdk::ApiError => e
55
- puts "Error when calling TimeConversionApi->convert_time_between_timezones: #{e}"
56
- end
57
- ```
58
-
59
- #### Using the convert_time_between_timezones_with_http_info variant
60
-
61
- This returns an Array which contains the response data, status code and headers.
62
-
63
- > <Array(<TimeConversionResponse>, Integer, Hash)> convert_time_between_timezones_with_http_info(opts)
64
-
65
- ```ruby
66
- begin
67
-
68
- data, status_code, headers = api_instance.convert_time_between_timezones_with_http_info(opts)
69
- p status_code # => 2xx
70
- p headers # => { ... }
71
- p data # => <TimeConversionResponse>
72
- rescue IpgeolocationSdk::ApiError => e
73
- puts "Error when calling TimeConversionApi->convert_time_between_timezones_with_http_info: #{e}"
74
- end
75
- ```
76
-
77
- ### Parameters
78
-
79
- | Name | Type | Description | Notes |
80
- | ---- | ---- | ----------- | ----- |
81
- | **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] |
82
- | **tz_from** | **String** | timezone to convert from | [optional] |
83
- | **tz_to** | **String** | timezone to convert to | [optional] |
84
- | **lat_from** | **Float** | latitude to convert from | [optional] |
85
- | **long_from** | **Float** | longitude to convert from | [optional] |
86
- | **lat_to** | **Float** | latitude to convert to | [optional] |
87
- | **long_to** | **Float** | longitude to convert to | [optional] |
88
- | **location_from** | **String** | location to convert from | [optional] |
89
- | **location_to** | **String** | location to convert to | [optional] |
90
- | **icao_from** | **String** | location to convert from | [optional] |
91
- | **icao_to** | **String** | location to convert to | [optional] |
92
- | **iata_from** | **String** | location to convert from | [optional] |
93
- | **iata_to** | **String** | location to convert to | [optional] |
94
- | **locode_from** | **String** | location to convert from | [optional] |
95
- | **locode_to** | **String** | location to convert to | [optional] |
96
-
97
- ### Return type
98
-
99
- [**TimeConversionResponse**](TimeConversionResponse.md)
100
-
101
- ### Authorization
102
-
103
- [ApiKeyAuth](../README.md#ApiKeyAuth)
104
-
105
- ### HTTP request headers
106
-
107
- - **Content-Type**: Not defined
108
- - **Accept**: application/json, application/xml
109
-
@@ -1,24 +0,0 @@
1
- # IpgeolocationSdk::TimeConversionResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **original_time** | **Time** | | [optional] |
8
- | **converted_time** | **Time** | | [optional] |
9
- | **diff_hour** | **Float** | | [optional] |
10
- | **diff_min** | **Integer** | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'ipgeolocation_sdk'
16
-
17
- instance = IpgeolocationSdk::TimeConversionResponse.new(
18
- original_time: null,
19
- converted_time: null,
20
- diff_hour: 7.5,
21
- diff_min: 450
22
- )
23
- ```
24
-
@@ -1,24 +0,0 @@
1
- # IpgeolocationSdk::TimeConversionXMLResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **original_time** | **String** | | [optional] |
8
- | **converted_time** | **String** | | [optional] |
9
- | **diff_hour** | **Float** | | [optional] |
10
- | **diff_min** | **Integer** | | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'ipgeolocation_sdk'
16
-
17
- instance = IpgeolocationSdk::TimeConversionXMLResponse.new(
18
- original_time: 2024-12-08 11:00,
19
- converted_time: 2024-12-08 18:30:00,
20
- diff_hour: 7.5,
21
- diff_min: 450
22
- )
23
- ```
24
-
data/docs/TimeZone.md DELETED
@@ -1,36 +0,0 @@
1
- # IpgeolocationSdk::TimeZone
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
- | **current_time** | **String** | | [optional] |
11
- | **current_time_unix** | **Float** | | [optional] |
12
- | **is_dst** | **Boolean** | | [optional] |
13
- | **dst_savings** | **Integer** | | [optional] |
14
- | **dst_exists** | **Boolean** | | [optional] |
15
- | **dst_start** | [**TimeZoneDstStart**](TimeZoneDstStart.md) | | [optional] |
16
- | **dst_end** | [**TimeZoneDstEnd**](TimeZoneDstEnd.md) | | [optional] |
17
-
18
- ## Example
19
-
20
- ```ruby
21
- require 'ipgeolocation_sdk'
22
-
23
- instance = IpgeolocationSdk::TimeZone.new(
24
- name: America/Los_Angeles,
25
- offset: -8,
26
- offset_with_dst: -7,
27
- current_time: 2025-04-22 06:19:40.951-0700,
28
- current_time_unix: 1745327980.951,
29
- is_dst: true,
30
- dst_savings: 1,
31
- dst_exists: true,
32
- dst_start: null,
33
- dst_end: null
34
- )
35
- ```
36
-
@@ -1,26 +0,0 @@
1
- # IpgeolocationSdk::TimeZoneDetailedResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **ip** | **String** | | [optional] |
8
- | **airport_details** | [**TimezoneAirport**](TimezoneAirport.md) | | [optional] |
9
- | **lo_code_details** | [**TimezoneLocode**](TimezoneLocode.md) | | [optional] |
10
- | **location** | [**TimezoneLocation**](TimezoneLocation.md) | | [optional] |
11
- | **time_zone** | [**TimezoneDetail**](TimezoneDetail.md) | | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'ipgeolocation_sdk'
17
-
18
- instance = IpgeolocationSdk::TimeZoneDetailedResponse.new(
19
- ip: 8.8.8.8,
20
- airport_details: null,
21
- lo_code_details: null,
22
- location: null,
23
- time_zone: null
24
- )
25
- ```
26
-
@@ -1,26 +0,0 @@
1
- # IpgeolocationSdk::TimeZoneDetailedXMLResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **ip** | **String** | | [optional] |
8
- | **airport_details** | [**TimezoneAirport**](TimezoneAirport.md) | | [optional] |
9
- | **lo_code_details** | [**TimezoneLocode**](TimezoneLocode.md) | | [optional] |
10
- | **location** | [**TimezoneLocation**](TimezoneLocation.md) | | [optional] |
11
- | **time_zone** | [**TimezoneDetail**](TimezoneDetail.md) | | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'ipgeolocation_sdk'
17
-
18
- instance = IpgeolocationSdk::TimeZoneDetailedXMLResponse.new(
19
- ip: 8.8.8.8,
20
- airport_details: null,
21
- lo_code_details: null,
22
- location: null,
23
- time_zone: null
24
- )
25
- ```
26
-
@@ -1,28 +0,0 @@
1
- # IpgeolocationSdk::TimeZoneDstEnd
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::TimeZoneDstEnd.new(
20
- utc_time: 2025-11-02 TIME 09,
21
- duration: -1H,
22
- gap: false,
23
- date_time_after: 2025-11-02 TIME 01,
24
- date_time_before: 2025-11-02 TIME 02,
25
- overlap: true
26
- )
27
- ```
28
-
@@ -1,28 +0,0 @@
1
- # IpgeolocationSdk::TimeZoneDstStart
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::TimeZoneDstStart.new(
20
- utc_time: 2025-03-09 TIME 10,
21
- duration: +1H,
22
- gap: true,
23
- date_time_after: 2025-03-09 TIME 03,
24
- date_time_before: 2025-03-09 TIME 02,
25
- overlap: false
26
- )
27
- ```
28
-