Skip to content

Commit 0742e73

Browse files
DaudAhmadJFDaudAhmadJF
authored
Feature/models readme updates (#7)
* deleted XML response Markdown * updated some reference URLs to the correct ones * added responses table descritions in markdowns
1 parent 79d5586 commit 0742e73

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+624
-655
lines changed

‎README.md‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -113,43 +113,43 @@ For a detailed comparison of what each plan offers, visit the [Pricing Page](htt
113113

114114
All URIs are relative to *https://api.ipgeolocation.io/v2*
115115

116-
Class | Method | HTTP request | Description
117-
------------ | ------------- | ------------- | -------------
118-
*IPGeolocationApi* | [**get_ip_geolocation**](docs/IPGeolocationApi.md#get_ip_geolocation) | **GET** /ipgeo | Get geolocation data for a single IP address
119-
*IPGeolocationApi* | [**get_bulk_ip_geolocation**](docs/IPGeolocationApi.md#get_bulk_ip_geolocation) | **POST** /ipgeo-bulk | Get geolocation data for multiple IP addresses in a single API request
120-
*IPSecurityApi* | [**get_ip_security_info**](docs/IPSecurityApi.md#get_ip_security_info) | **GET** /security | Retrieve security information (VPN, TOR, proxy, etc.) for a single IP
121-
*IPSecurityApi* | [**get_bulk_ip_security_info**](docs/IPSecurityApi.md#get_bulk_ip_security_info) | **POST** /security-bulk | Retrieve security threat intelligence for multiple IPs
122-
*ASNLookupApi* | [**get_asn_info**](docs/ASNLookupApi.md#get_asn_info) | **GET** /asn | Get details of any ASN number or associated IP address
123-
*AbuseContactApi* | [**get_abuse_contact_info**](docs/AbuseContactApi.md#get_abuse_contact_info) | **GET** /abuse | Retrieve abuse reporting contact information for a given IP address
124-
*AstronomyApi* | [**get_astronomy_details**](docs/AstronomyApi.md#get_astronomy_details) | **GET** /astronomy | Get sunrise, sunset, moonrise, moonset, and related data for a location
125-
*AstronomyApi* | [**get_time_series_lookup**](docs/AstronomyApi.md#get_time_series_lookup) | **GET** /astronomy/timeSeries | Get astronomy information for given date range at once
126-
*TimezoneApi* | [**get_timezone_info**](docs/TimezoneApi.md#get_timezone_info) | **GET** /timezone | Timezone information details
127-
*TimeConversionApi* | [**convert_time_between_timezones**](docs/TimeConversionApi.md#convert_time_between_timezones) | **GET** /timezone/convert | Convert time between two specified timezones
128-
*UserAgentApi* | [**get_user_agent_details**](docs/UserAgentApi.md#get_user_agent_details) | **GET** /user-agent | Get details of user-agent
129-
*UserAgentApi* | [**parse_user_agent_string**](docs/UserAgentApi.md#parse_user_agent_string) | **POST** /user-agent | Handle single User-Agent string
130-
*UserAgentApi* | [**parse_bulk_user_agent_strings**](docs/UserAgentApi.md#parse_bulk_user_agent_strings) | **POST** /user-agent-bulk | Handle multiple user-agent string lookups
116+
| Class | Method | HTTP request | Description |
117+
|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|-------------------------------------------------------------------------|
118+
| *IPGeolocationApi* | [**get_ip_geolocation**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/IPGeolocationApi.md#get_ip_geolocation) | **GET** /ipgeo | Get geolocation data for a single IP address |
119+
| *IPGeolocationApi* | [**get_bulk_ip_geolocation**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/IPGeolocationApi.md#get_bulk_ip_geolocation) | **POST** /ipgeo-bulk | Get geolocation data for multiple IP addresses in a single API request |
120+
| *IPSecurityApi* | [**get_ip_security_info**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/IPSecurityApi.md#get_ip_security_info) | **GET** /security | Retrieve security information (VPN, TOR, proxy, etc.) for a single IP |
121+
| *IPSecurityApi* | [**get_bulk_ip_security_info**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/IPSecurityApi.md#get_bulk_ip_security_info) | **POST** /security-bulk | Retrieve security threat intelligence for multiple IPs |
122+
| *ASNLookupApi* | [**get_asn_info**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/ASNLookupApi.md#get_asn_info) | **GET** /asn | Get details of any ASN number or associated IP address |
123+
| *AbuseContactApi* | [**get_abuse_contact_info**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/AbuseContactApi.md#get_abuse_contact_info) | **GET** /abuse | Retrieve abuse reporting contact information for a given IP address |
124+
| *AstronomyApi* | [**get_astronomy_details**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/AstronomyApi.md#get_astronomy_details) | **GET** /astronomy | Get sunrise, sunset, moonrise, moonset, and related data for a location |
125+
| *AstronomyApi* | [**get_time_series_lookup**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/AstronomyApi.md#get_time_series_lookup) | **GET** /astronomy/timeSeries | Get astronomy information for given date range at once |
126+
| *TimezoneApi* | [**get_timezone_info**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/TimezoneApi.md#get_timezone_info) | **GET** /timezone | Timezone information details |
127+
| *TimeConversionApi* | [**convert_time_between_timezones**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/TimeConversionApi.md#convert_time_between_timezones) | **GET** /timezone/convert | Convert time between two specified timezones |
128+
| *UserAgentApi* | [**get_user_agent_details**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/UserAgentApi.md#get_user_agent_details) | **GET** /user-agent | Get details of user-agent |
129+
| *UserAgentApi* | [**parse_user_agent_string**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/UserAgentApi.md#parse_user_agent_string) | **POST** /user-agent | Handle single User-Agent string |
130+
| *UserAgentApi* | [**parse_bulk_user_agent_strings**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/UserAgentApi.md#parse_bulk_user_agent_strings) | **POST** /user-agent-bulk | Handle multiple user-agent string lookups |
131131

132132
## Fields and Methods Availability
133133
IP Geolocation offers four plans from billing point of view: **Free, Standard, Security, Advance**. The availability of each method calling from the respective class, over all plans are presented below.
134134

135-
| Class | Method | Free | Standard | Security | Advance |
136-
|---------------------|------------------------------------------------------------------------------------------------|:----:|:--------:|:--------:|:-------:|
137-
| *IPGeolocationApi* | [**get_ip_geolocation**](docs/IPGeolocationApi.md#get_ip_geolocation) | ✔ | ✔ | ✖ | ✔ |
138-
| *IPGeolocationApi* | [**get_bulk_ip_geolocation**](docs/IPGeolocationApi.md#get_bulk_ip_geolocation) | ✖ | ✔ | ✖ | ✔ |
139-
| *IPSecurityApi* | [**get_ip_security_info**](docs/IPSecurityApi.md#get_ip_security_info) | ✖ | ✖ | ✔ | ✖ |
140-
| *IPSecurityApi* | [**get_bulk_ip_security_info**](docs/IPSecurityApi.md#get_bulk_ip_security_info) | ✖ | ✖ | ✔ | ✖ |
141-
| *ASNLookupApi* | [**get_asn_info**](docs/ASNLookupApi.md#get_asn_info) | ✖ | ✖ | ✖ | ✔ |
142-
| *AbuseContactApi* | [**get_abuse_contact_info**](docs/AbuseContactApi.md#get_abuse_contact_info) | ✖ | ✖ | ✖ | ✔ |
143-
| *AstronomyApi* | [**get_astronomy_details**](docs/AstronomyApi.md#get_astronomy_details) | ✔ | ✔ | ✔ | ✔ |
144-
| *AstronomyApi* | [**get_time_series_lookup**](docs/AstronomyApi.md#get_time_series_lookup) | ✔ | ✔ | ✔ | ✔ |
145-
| *TimezoneApi* | [**get_timezone_info**](docs/TimezoneApi.md#get_timezone_info) | ✔ | ✔ | ✔ | ✔ |
146-
| *TimeConversionApi* | [**convert_time_between_timezones**](docs/TimeConversionApi.md#convert_time_between_timezones) | ✔ | ✔ | ✔ | ✔ |
147-
| *UserAgentApi* | [**get_user_agent_details**](docs/UserAgentApi.md#get_user_agent_details) | ✔ | ✔ | ✔ | ✔ |
148-
| *UserAgentApi* | [**parse_user_agent_string**](docs/UserAgentApi.md#parse_user_agent_string) | ✔ | ✔ | ✔ | ✔ |
149-
| *UserAgentApi* | [**parse_bulk_user_agent_strings**](docs/UserAgentApi.md#parse_bulk_user_agent_strings) | ✖ | ✔ | ✔ | ✔ |
135+
| Class | Method | Free | Standard | Security | Advance |
136+
|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----:|:--------:|:--------:|:-------:|
137+
| *IPGeolocationApi* | [**get_ip_geolocation**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/IPGeolocationApi.md#get_ip_geolocation) | ✔ | ✔ | ✖ | ✔ |
138+
| *IPGeolocationApi* | [**get_bulk_ip_geolocation**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/IPGeolocationApi.md#get_bulk_ip_geolocation) | ✖ | ✔ | ✖ | ✔ |
139+
| *IPSecurityApi* | [**get_ip_security_info**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/IPSecurityApi.md#get_ip_security_info) | ✖ | ✖ | ✔ | ✖ |
140+
| *IPSecurityApi* | [**get_bulk_ip_security_info**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/IPSecurityApi.md#get_bulk_ip_security_info) | ✖ | ✖ | ✔ | ✖ |
141+
| *ASNLookupApi* | [**get_asn_info**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/ASNLookupApi.md#get_asn_info) | ✖ | ✖ | ✖ | ✔ |
142+
| *AbuseContactApi* | [**get_abuse_contact_info**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/AbuseContactApi.md#get_abuse_contact_info) | ✖ | ✖ | ✖ | ✔ |
143+
| *AstronomyApi* | [**get_astronomy_details**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/AstronomyApi.md#get_astronomy_details) | ✔ | ✔ | ✔ | ✔ |
144+
| *AstronomyApi* | [**get_time_series_lookup**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/AstronomyApi.md#get_time_series_lookup) | ✔ | ✔ | ✔ | ✔ |
145+
| *TimezoneApi* | [**get_timezone_info**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/TimezoneApi.md#get_timezone_info) | ✔ | ✔ | ✔ | ✔ |
146+
| *TimeConversionApi* | [**convert_time_between_timezones**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/TimeConversionApi.md#convert_time_between_timezones) | ✔ | ✔ | ✔ | ✔ |
147+
| *UserAgentApi* | [**get_user_agent_details**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/UserAgentApi.md#get_user_agent_details) | ✔ | ✔ | ✔ | ✔ |
148+
| *UserAgentApi* | [**parse_user_agent_string**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/UserAgentApi.md#parse_user_agent_string) | ✔ | ✔ | ✔ | ✔ |
149+
| *UserAgentApi* | [**parse_bulk_user_agent_strings**](https://github.com/IPGeolocation/ip-geolocation-api-python-sdk/blob/master/docs/UserAgentApi.md#parse_bulk_user_agent_strings) | ✖ | ✔ | ✔ | ✔ |
150150

151151
> [!TIP]
152-
> The availability of fields in every API endpoint across all API plans is provided in the **_Reference Table_** within each respective API Documentation. e.g., for IPGeolocationApi, please visit [https://ipgeolocation.io/ip-location-api.html#fields-reference](https://ipgeolocation.io/ip-location-api.html#fields-reference).
152+
> The availability of fields in every API endpoint across all API plans is provided in the **_Reference Table_** within each respective API Documentation. e.g., for IPGeolocationApi, please visit [https://ipgeolocation.io/ip-location-api.html#reference-to-ipgeolocation-api-response](https://ipgeolocation.io/ip-location-api.html#reference-to-ipgeolocation-api-response).
153153
154154
## Authentication Setup
155155
To authenticate API requests, you need to get an API key from [ipgeolocation.io](https://ipgeolocation.io/).
@@ -1242,7 +1242,7 @@ Sample Response:
12421242

12431243
This section provides usage examples of the `convert_time_between_timezones()` method from the SDK. The Timezone Converter API allows you to convert a specific time from one timezone to another using timezone identifiers and optional date/time inputs.
12441244

1245-
For more details, refer to official documentation: [Timezone Converter API](https://ipgeolocation.io/timezone-api.html#convert-time-bw-time-zones).
1245+
For more details, refer to official documentation: [Timezone Converter API](https://ipgeolocation.io/timezone-api.html#convert-time-between-time-zones).
12461246

12471247
### Convert Current Time from One Timezone to Another
12481248
```python

‎docs/ASNConnection.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33

44
## Properties
55

6-
Name | Type | Description | Notes
7-
------------ | ------------- | ------------- | -------------
8-
**as_number** | **str** | | [optional]
9-
**description** | **str** | | [optional]
10-
**country** | **str** | | [optional]
6+
| Name | Type | Description | Notes |
7+
|-----------------|---------------|-------------------------------------------------------|------------|
8+
| **as_number** | **str** | Autonomous System Number | [optional] |
9+
| **description** | **str** | The name of the organization | [optional] |
10+
| **country** | **str** | Two letter country code, in which the ASN is assigned | [optional] |
1111

1212
## Example
1313

0 commit comments

Comments
 (0)