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::ErrorXMLResponseArray
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **message** | **String** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'ipgeolocation_sdk'
13
-
14
- instance = IpgeolocationSdk::ErrorXMLResponseArray.new(
15
- message: The Message showing the error
16
- )
17
- ```
18
-
@@ -1,38 +0,0 @@
1
- # IpgeolocationSdk::GeolocationResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **ip** | **String** | | [optional] |
8
- | **hostname** | **String** | | [optional] |
9
- | **domain** | **String** | | [optional] |
10
- | **location** | [**Location**](Location.md) | | [optional] |
11
- | **country_metadata** | [**CountryMetadata**](CountryMetadata.md) | | [optional] |
12
- | **network** | [**Network**](Network.md) | | [optional] |
13
- | **currency** | [**Currency**](Currency.md) | | [optional] |
14
- | **security** | [**Security**](Security.md) | | [optional] |
15
- | **abuse** | [**Abuse**](Abuse.md) | | [optional] |
16
- | **time_zone** | [**TimeZone**](TimeZone.md) | | [optional] |
17
- | **user_agent** | [**UserAgentData**](UserAgentData.md) | | [optional] |
18
-
19
- ## Example
20
-
21
- ```ruby
22
- require 'ipgeolocation_sdk'
23
-
24
- instance = IpgeolocationSdk::GeolocationResponse.new(
25
- ip: 8.8.8.8,
26
- hostname: dns.google,
27
- domain: google.com,
28
- location: null,
29
- country_metadata: null,
30
- network: null,
31
- currency: null,
32
- security: null,
33
- abuse: null,
34
- time_zone: null,
35
- user_agent: null
36
- )
37
- ```
38
-
@@ -1,38 +0,0 @@
1
- # IpgeolocationSdk::GeolocationXMLResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **ip** | **String** | | [optional] |
8
- | **hostname** | **String** | | [optional] |
9
- | **domain** | **String** | | [optional] |
10
- | **location** | [**Location**](Location.md) | | [optional] |
11
- | **country_metadata** | [**CountryMetadata**](CountryMetadata.md) | | [optional] |
12
- | **network** | [**Network**](Network.md) | | [optional] |
13
- | **currency** | [**Currency**](Currency.md) | | [optional] |
14
- | **security** | [**Security**](Security.md) | | [optional] |
15
- | **abuse** | [**Abuse**](Abuse.md) | | [optional] |
16
- | **time_zone** | [**TimeZone**](TimeZone.md) | | [optional] |
17
- | **user_agent** | [**UserAgentData**](UserAgentData.md) | | [optional] |
18
-
19
- ## Example
20
-
21
- ```ruby
22
- require 'ipgeolocation_sdk'
23
-
24
- instance = IpgeolocationSdk::GeolocationXMLResponse.new(
25
- ip: 8.8.8.8,
26
- hostname: dns.google,
27
- domain: google.com,
28
- location: null,
29
- country_metadata: null,
30
- network: null,
31
- currency: null,
32
- security: null,
33
- abuse: null,
34
- time_zone: null,
35
- user_agent: null
36
- )
37
- ```
38
-
@@ -1,38 +0,0 @@
1
- # IpgeolocationSdk::GeolocationXMLResponseArray
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **ip** | **String** | | [optional] |
8
- | **hostname** | **String** | | [optional] |
9
- | **domain** | **String** | | [optional] |
10
- | **location** | [**Location**](Location.md) | | [optional] |
11
- | **country_metadata** | [**CountryMetadata**](CountryMetadata.md) | | [optional] |
12
- | **network** | [**Network**](Network.md) | | [optional] |
13
- | **currency** | [**Currency**](Currency.md) | | [optional] |
14
- | **security** | [**Security**](Security.md) | | [optional] |
15
- | **abuse** | [**Abuse**](Abuse.md) | | [optional] |
16
- | **time_zone** | [**TimeZone**](TimeZone.md) | | [optional] |
17
- | **user_agent** | [**UserAgentData**](UserAgentData.md) | | [optional] |
18
-
19
- ## Example
20
-
21
- ```ruby
22
- require 'ipgeolocation_sdk'
23
-
24
- instance = IpgeolocationSdk::GeolocationXMLResponseArray.new(
25
- ip: 8.8.8.8,
26
- hostname: dns.google,
27
- domain: google.com,
28
- location: null,
29
- country_metadata: null,
30
- network: null,
31
- currency: null,
32
- security: null,
33
- abuse: null,
34
- time_zone: null,
35
- user_agent: null
36
- )
37
- ```
38
-
@@ -1,49 +0,0 @@
1
- # IpgeolocationSdk::GetBulkIpGeolocation200ResponseInner1
2
-
3
- ## Class instance methods
4
-
5
- ### `openapi_one_of`
6
-
7
- Returns the list of classes defined in oneOf.
8
-
9
- #### Example
10
-
11
- ```ruby
12
- require 'ipgeolocation_sdk'
13
-
14
- IpgeolocationSdk::GetBulkIpGeolocation200ResponseInner1.openapi_one_of
15
- # =>
16
- # [
17
- # :'ErrorXMLResponseArray',
18
- # :'GeolocationXMLResponseArray'
19
- # ]
20
- ```
21
-
22
- ### build
23
-
24
- Find the appropriate object from the `openapi_one_of` list and casts the data into it.
25
-
26
- #### Example
27
-
28
- ```ruby
29
- require 'ipgeolocation_sdk'
30
-
31
- IpgeolocationSdk::GetBulkIpGeolocation200ResponseInner1.build(data)
32
- # => #<ErrorXMLResponseArray:0x00007fdd4aab02a0>
33
-
34
- IpgeolocationSdk::GetBulkIpGeolocation200ResponseInner1.build(data_that_doesnt_match)
35
- # => nil
36
- ```
37
-
38
- #### Parameters
39
-
40
- | Name | Type | Description |
41
- | ---- | ---- | ----------- |
42
- | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
-
44
- #### Return type
45
-
46
- - `ErrorXMLResponseArray`
47
- - `GeolocationXMLResponseArray`
48
- - `nil` (if no type matches)
49
-
@@ -1,18 +0,0 @@
1
- # IpgeolocationSdk::GetBulkIpGeolocationRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **ips** | **Array&lt;String&gt;** | | [optional] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'ipgeolocation_sdk'
13
-
14
- instance = IpgeolocationSdk::GetBulkIpGeolocationRequest.new(
15
- ips: [&quot;2.2.2.2&quot;,&quot;3.3.3.3&quot;]
16
- )
17
- ```
18
-
@@ -1,49 +0,0 @@
1
- # IpgeolocationSdk::GetBulkIpSecurityInfo200ResponseInner1
2
-
3
- ## Class instance methods
4
-
5
- ### `openapi_one_of`
6
-
7
- Returns the list of classes defined in oneOf.
8
-
9
- #### Example
10
-
11
- ```ruby
12
- require 'ipgeolocation_sdk'
13
-
14
- IpgeolocationSdk::GetBulkIpSecurityInfo200ResponseInner1.openapi_one_of
15
- # =>
16
- # [
17
- # :'ErrorXMLResponseArray',
18
- # :'SecurityAPIXMLResponseArray'
19
- # ]
20
- ```
21
-
22
- ### build
23
-
24
- Find the appropriate object from the `openapi_one_of` list and casts the data into it.
25
-
26
- #### Example
27
-
28
- ```ruby
29
- require 'ipgeolocation_sdk'
30
-
31
- IpgeolocationSdk::GetBulkIpSecurityInfo200ResponseInner1.build(data)
32
- # => #<ErrorXMLResponseArray:0x00007fdd4aab02a0>
33
-
34
- IpgeolocationSdk::GetBulkIpSecurityInfo200ResponseInner1.build(data_that_doesnt_match)
35
- # => nil
36
- ```
37
-
38
- #### Parameters
39
-
40
- | Name | Type | Description |
41
- | ---- | ---- | ----------- |
42
- | **data** | **Mixed** | data to be matched against the list of oneOf items |
43
-
44
- #### Return type
45
-
46
- - `ErrorXMLResponseArray`
47
- - `SecurityAPIXMLResponseArray`
48
- - `nil` (if no type matches)
49
-
@@ -1,175 +0,0 @@
1
- # IpgeolocationSdk::IPLocationApi
2
-
3
- All URIs are relative to *https://api.ipgeolocation.io/v2*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**get_bulk_ip_geolocation**](IPLocationApi.md#get_bulk_ip_geolocation) | **POST** /ipgeo-bulk | |
8
- | [**get_ip_geolocation**](IPLocationApi.md#get_ip_geolocation) | **GET** /ipgeo | |
9
-
10
-
11
- ## get_bulk_ip_geolocation
12
-
13
- > <Array<GetBulkIpGeolocation200ResponseInner>> get_bulk_ip_geolocation(get_bulk_ip_geolocation_request, opts)
14
-
15
-
16
-
17
- This feature is available only on our paid API subscriptions (STANDARD or ADVANCED). This endpoint allows you to perform the geolocation lookup for multiple IPv4, IPv6 addresses or domain names (maximum 50,000) at the same time. The requests count per lookup is equal to total IP addresses or domain names passed. To perform bulk IP Geolocation Lookup, send a POST request and pass the \"ips\" array as JSON data along with it.
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::IPLocationApi.new
33
- get_bulk_ip_geolocation_request = IpgeolocationSdk::GetBulkIpGeolocationRequest.new # GetBulkIpGeolocationRequest |
34
- opts = {
35
- 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`.
36
- fields: 'location, location.country_name, network.asn.organization', # String | you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the `fields` query parameter with each field represented as a dot-separated path.
37
- excludes: 'location.continent_code,currency,network', # String | you can also filter the API response by excluding specific fields (except the IP address) that you don't need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path
38
- include: 'security', # String | IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn't respond it by default. To get these information along with the geolocation information, you must pass the `include=security` or `include=abuse` or `include=dma` or `include=time_zone` or `include=user-agent` or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn't respond it by default. To get the hostname for an IP address, you can pass one of the three values `hostname, liveHostname, hostnameFallbackLive` as a URL parameter `include=`.
39
- output: 'json' # String | Desired output format(json or xml).
40
- }
41
-
42
- begin
43
-
44
- result = api_instance.get_bulk_ip_geolocation(get_bulk_ip_geolocation_request, opts)
45
- p result
46
- rescue IpgeolocationSdk::ApiError => e
47
- puts "Error when calling IPLocationApi->get_bulk_ip_geolocation: #{e}"
48
- end
49
- ```
50
-
51
- #### Using the get_bulk_ip_geolocation_with_http_info variant
52
-
53
- This returns an Array which contains the response data, status code and headers.
54
-
55
- > <Array(<Array<GetBulkIpGeolocation200ResponseInner>>, Integer, Hash)> get_bulk_ip_geolocation_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_geolocation_with_http_info(get_bulk_ip_geolocation_request, opts)
61
- p status_code # => 2xx
62
- p headers # => { ... }
63
- p data # => <Array<GetBulkIpGeolocation200ResponseInner>>
64
- rescue IpgeolocationSdk::ApiError => e
65
- puts "Error when calling IPLocationApi->get_bulk_ip_geolocation_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
- | **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] |
75
- | **fields** | **String** | you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the &#x60;fields&#x60; query parameter with each field represented as a dot-separated path. | [optional] |
76
- | **excludes** | **String** | you can also filter the API response by excluding specific fields (except the IP address) that you don&#39;t need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path | [optional] |
77
- | **include** | **String** | IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn&#39;t respond it by default. To get these information along with the geolocation information, you must pass the &#x60;include&#x3D;security&#x60; or &#x60;include&#x3D;abuse&#x60; or &#x60;include&#x3D;dma&#x60; or &#x60;include&#x3D;time_zone&#x60; or &#x60;include&#x3D;user-agent&#x60; or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn&#39;t respond it by default. To get the hostname for an IP address, you can pass one of the three values &#x60;hostname, liveHostname, hostnameFallbackLive&#x60; as a URL parameter &#x60;include&#x3D;&#x60;. | [optional] |
78
- | **output** | **String** | Desired output format(json or xml). | [optional] |
79
-
80
- ### Return type
81
-
82
- [**Array&lt;GetBulkIpGeolocation200ResponseInner&gt;**](GetBulkIpGeolocation200ResponseInner.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_geolocation
95
-
96
- > <GeolocationResponse> get_ip_geolocation(opts)
97
-
98
-
99
-
100
- IP Geolocation API provides real-time and accurate geolocation, network, abuse, and security information for any IPv4 or IPv6 address and domain name along with the user-agent detail for the provided user-agent string. You can geolocate your online visitors and provide them the customized user-experience accordingly.
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::IPLocationApi.new
116
- opts = {
117
- ip: '8.8.8.8 OR dns.google.com', # String | In order to find geolocation information about an IP (ipv4 ipv6) address or a domain name, pass it as a query parameter ip. When this endpoint is queried without an IP address, it returns the geolocation information of the device/client which is calling it
118
- 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`.
119
- fields: 'location, location.country_name, network.asn.organization', # String | you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the `fields` query parameter with each field represented as a dot-separated path.
120
- excludes: 'location.continent_code,currency,network', # String | you can also filter the API response by excluding specific fields (except the IP address) that you don't need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path
121
- include: 'security', # String | IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn't respond it by default. To get these information along with the geolocation information, you must pass the `include=security` or `include=abuse` or `include=dma` or `include=time_zone` or `include=user-agent` or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn't respond it by default. To get the hostname for an IP address, you can pass one of the three values `hostname, liveHostname, hostnameFallbackLive` as a URL parameter `include=`.
122
- output: 'json' # String | Desired output format (json or xml).
123
- }
124
-
125
- begin
126
-
127
- result = api_instance.get_ip_geolocation(opts)
128
- p result
129
- rescue IpgeolocationSdk::ApiError => e
130
- puts "Error when calling IPLocationApi->get_ip_geolocation: #{e}"
131
- end
132
- ```
133
-
134
- #### Using the get_ip_geolocation_with_http_info variant
135
-
136
- This returns an Array which contains the response data, status code and headers.
137
-
138
- > <Array(<GeolocationResponse>, Integer, Hash)> get_ip_geolocation_with_http_info(opts)
139
-
140
- ```ruby
141
- begin
142
-
143
- data, status_code, headers = api_instance.get_ip_geolocation_with_http_info(opts)
144
- p status_code # => 2xx
145
- p headers # => { ... }
146
- p data # => <GeolocationResponse>
147
- rescue IpgeolocationSdk::ApiError => e
148
- puts "Error when calling IPLocationApi->get_ip_geolocation_with_http_info: #{e}"
149
- end
150
- ```
151
-
152
- ### Parameters
153
-
154
- | Name | Type | Description | Notes |
155
- | ---- | ---- | ----------- | ----- |
156
- | **ip** | **String** | In order to find geolocation information about an IP (ipv4 ipv6) address or a domain name, pass it as a query parameter ip. When this endpoint is queried without an IP address, it returns the geolocation information of the device/client which is calling it | [optional] |
157
- | **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] |
158
- | **fields** | **String** | you can filter the API response by specifying the fields that you need, instead of getting the full response. To do this, pass the desired field names using the &#x60;fields&#x60; query parameter with each field represented as a dot-separated path. | [optional] |
159
- | **excludes** | **String** | you can also filter the API response by excluding specific fields (except the IP address) that you don&#39;t need. To do this, pass the unwanted field names using the excludes query parameter, with each field represented as a dot-separated path | [optional] |
160
- | **include** | **String** | IP Geolocation API also provides IP-Security, abuse, timezone, user-agent and DMA (Designated Market Area) code, which is specifically used in the US for marketing and regional targeting information on Advanced API subscription, but doesn&#39;t respond it by default. To get these information along with the geolocation information, you must pass the &#x60;include&#x3D;security&#x60; or &#x60;include&#x3D;abuse&#x60; or &#x60;include&#x3D;dma&#x60; or &#x60;include&#x3D;time_zone&#x60; or &#x60;include&#x3D;user-agent&#x60; or you can fetch multiples by adding values in comma-separated way. In addition to that, IPGeolocation API also provide hostname lookup for an IP address on all the paid API subscriptions (STANDARD and ADVANCED), but doesn&#39;t respond it by default. To get the hostname for an IP address, you can pass one of the three values &#x60;hostname, liveHostname, hostnameFallbackLive&#x60; as a URL parameter &#x60;include&#x3D;&#x60;. | [optional] |
161
- | **output** | **String** | Desired output format (json or xml). | [optional] |
162
-
163
- ### Return type
164
-
165
- [**GeolocationResponse**](GeolocationResponse.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
-
data/docs/Location.md DELETED
@@ -1,58 +0,0 @@
1
- # IpgeolocationSdk::Location
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **continent_code** | **String** | | [optional] |
8
- | **continent_name** | **String** | | [optional] |
9
- | **country_code2** | **String** | | [optional] |
10
- | **country_code3** | **String** | | [optional] |
11
- | **country_name** | **String** | | [optional] |
12
- | **country_name_official** | **String** | | [optional] |
13
- | **country_capital** | **String** | | [optional] |
14
- | **state_prov** | **String** | | [optional] |
15
- | **state_code** | **String** | | [optional] |
16
- | **district** | **String** | | [optional] |
17
- | **city** | **String** | | [optional] |
18
- | **zipcode** | **String** | | [optional] |
19
- | **latitude** | **String** | | [optional] |
20
- | **longitude** | **String** | | [optional] |
21
- | **is_eu** | **Boolean** | | [optional] |
22
- | **country_flag** | **String** | | [optional] |
23
- | **geoname_id** | **String** | | [optional] |
24
- | **country_emoji** | **String** | | [optional] |
25
- | **accuracy_radius** | **String** | | [optional] |
26
- | **locality** | **String** | | [optional] |
27
- | **dma_code** | **String** | | [optional] |
28
-
29
- ## Example
30
-
31
- ```ruby
32
- require 'ipgeolocation_sdk'
33
-
34
- instance = IpgeolocationSdk::Location.new(
35
- continent_code: NA,
36
- continent_name: North America,
37
- country_code2: US,
38
- country_code3: USA,
39
- country_name: United States,
40
- country_name_official: United States of America,
41
- country_capital: Washington, D.C.,
42
- state_prov: California,
43
- state_code: US-CA,
44
- district: Santa Clara,
45
- city: Mountain View,
46
- zipcode: 94043-1351,
47
- latitude: 37.42240,
48
- longitude: -122.08421,
49
- is_eu: false,
50
- country_flag: https://ipgeolocation.io/static/flags/us_64.png,
51
- geoname_id: 6301403,
52
- country_emoji: ,
53
- accuracy_radius: 1000,
54
- locality: Mountain View,
55
- dma_code: 807
56
- )
57
- ```
58
-
@@ -1,52 +0,0 @@
1
- # IpgeolocationSdk::LocationMinimal
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **continent_code** | **String** | | [optional] |
8
- | **continent_name** | **String** | | [optional] |
9
- | **country_code2** | **String** | | [optional] |
10
- | **country_code3** | **String** | | [optional] |
11
- | **country_name** | **String** | | [optional] |
12
- | **country_name_official** | **String** | | [optional] |
13
- | **country_capital** | **String** | | [optional] |
14
- | **state_prov** | **String** | | [optional] |
15
- | **state_code** | **String** | | [optional] |
16
- | **district** | **String** | | [optional] |
17
- | **city** | **String** | | [optional] |
18
- | **zipcode** | **String** | | [optional] |
19
- | **latitude** | **String** | | [optional] |
20
- | **longitude** | **String** | | [optional] |
21
- | **is_eu** | **Boolean** | | [optional] |
22
- | **country_flag** | **String** | | [optional] |
23
- | **geoname_id** | **String** | | [optional] |
24
- | **country_emoji** | **String** | | [optional] |
25
-
26
- ## Example
27
-
28
- ```ruby
29
- require 'ipgeolocation_sdk'
30
-
31
- instance = IpgeolocationSdk::LocationMinimal.new(
32
- continent_code: NA,
33
- continent_name: North America,
34
- country_code2: US,
35
- country_code3: USA,
36
- country_name: United States,
37
- country_name_official: United States of America,
38
- country_capital: Washington, D.C.,
39
- state_prov: California,
40
- state_code: US-CA,
41
- district: Santa Clara,
42
- city: Mountain View,
43
- zipcode: 94043-1351,
44
- latitude: 37.42240,
45
- longitude: -122.08421,
46
- is_eu: false,
47
- country_flag: https://ipgeolocation.io/static/flags/us_64.png,
48
- geoname_id: 6301403,
49
- country_emoji:
50
- )
51
- ```
52
-
data/docs/Network.md DELETED
@@ -1,22 +0,0 @@
1
- # IpgeolocationSdk::Network
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **asn** | [**NetworkAsn**](NetworkAsn.md) | | [optional] |
8
- | **connection_type** | **String** | | [optional] |
9
- | **company** | [**NetworkCompany**](NetworkCompany.md) | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'ipgeolocation_sdk'
15
-
16
- instance = IpgeolocationSdk::Network.new(
17
- asn: null,
18
- connection_type: wired,
19
- company: null
20
- )
21
- ```
22
-
data/docs/NetworkAsn.md DELETED
@@ -1,38 +0,0 @@
1
- # IpgeolocationSdk::NetworkAsn
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **as_number** | **String** | | [optional] |
8
- | **organization** | **String** | | [optional] |
9
- | **country** | **String** | | [optional] |
10
- | **asn_name** | **String** | | [optional] |
11
- | **type** | **String** | | [optional] |
12
- | **domain** | **String** | | [optional] |
13
- | **date_allocated** | **String** | | [optional] |
14
- | **allocation_status** | **String** | | [optional] |
15
- | **num_of_ipv4_routes** | **String** | | [optional] |
16
- | **num_of_ipv6_routes** | **String** | | [optional] |
17
- | **rir** | **String** | | [optional] |
18
-
19
- ## Example
20
-
21
- ```ruby
22
- require 'ipgeolocation_sdk'
23
-
24
- instance = IpgeolocationSdk::NetworkAsn.new(
25
- as_number: AS15169,
26
- organization: Google LLC,
27
- country: US,
28
- asn_name: GOOGLE,
29
- type: isp,
30
- domain: about.google,
31
- date_allocated: ,
32
- allocation_status: Assigned,
33
- num_of_ipv4_routes: 1099,
34
- num_of_ipv6_routes: 107,
35
- rir: ARIN
36
- )
37
- ```
38
-
@@ -1,22 +0,0 @@
1
- # IpgeolocationSdk::NetworkCompany
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **name** | **String** | | [optional] |
8
- | **type** | **String** | | [optional] |
9
- | **domain** | **String** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'ipgeolocation_sdk'
15
-
16
- instance = IpgeolocationSdk::NetworkCompany.new(
17
- name: Google LLC,
18
- type: hosting,
19
- domain: google.com
20
- )
21
- ```
22
-
@@ -1,20 +0,0 @@
1
- # IpgeolocationSdk::NetworkMinimal
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **asn** | [**NetworkMinimalAsn**](NetworkMinimalAsn.md) | | [optional] |
8
- | **company** | [**NetworkMinimalCompany**](NetworkMinimalCompany.md) | | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'ipgeolocation_sdk'
14
-
15
- instance = IpgeolocationSdk::NetworkMinimal.new(
16
- asn: null,
17
- company: null
18
- )
19
- ```
20
-
@@ -1,22 +0,0 @@
1
- # IpgeolocationSdk::NetworkMinimalAsn
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **as_number** | **String** | | [optional] |
8
- | **organization** | **String** | | [optional] |
9
- | **country** | **String** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'ipgeolocation_sdk'
15
-
16
- instance = IpgeolocationSdk::NetworkMinimalAsn.new(
17
- as_number: AS15169,
18
- organization: Google LLC,
19
- country: US
20
- )
21
- ```
22
-