Improve modeling of bulk geocoding request

stadiamaps · Aug 16, 2024 · 17d149c · 17d149c
1 parent 2b4dbad
commit 17d149c
Show file tree

Hide file tree

Showing 113 changed files with 473 additions and 228 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -10,6 +10,7 @@ docs/BaseTraceRequest.md
 docs/BicycleCostingOptions.md
 docs/BikeNetwork.md
 docs/BulkRequest.md
+docs/BulkRequestQuery.md
 docs/BulkSearchResponse.md
 docs/Contour.md
 docs/Coordinate.md
@@ -84,9 +85,7 @@ docs/RoutingApi.md
 docs/RoutingResponseWaypoint.md
 docs/RoutingWaypoint.md
 docs/RoutingWaypointAllOfSearchFilter.md
-docs/SearchBulkQuery.md
 docs/SearchQuery.md
-docs/SearchStructuredBulkQuery.md
 docs/SearchStructuredQuery.md
 docs/SimpleRoutingWaypoint.md
 docs/Speeds.md
@@ -127,6 +126,7 @@ stadiamaps/models/base_trace_request.py
 stadiamaps/models/bicycle_costing_options.py
 stadiamaps/models/bike_network.py
 stadiamaps/models/bulk_request.py
+stadiamaps/models/bulk_request_query.py
 stadiamaps/models/bulk_search_response.py
 stadiamaps/models/contour.py
 stadiamaps/models/coordinate.py
@@ -198,9 +198,7 @@ stadiamaps/models/route_trip.py
 stadiamaps/models/routing_response_waypoint.py
 stadiamaps/models/routing_waypoint.py
 stadiamaps/models/routing_waypoint_all_of_search_filter.py
-stadiamaps/models/search_bulk_query.py
 stadiamaps/models/search_query.py
-stadiamaps/models/search_structured_bulk_query.py
 stadiamaps/models/search_structured_query.py
 stadiamaps/models/simple_routing_waypoint.py
 stadiamaps/models/speeds.py
@@ -221,4 +219,5 @@ stadiamaps/py.typed
 stadiamaps/rest.py
 test-requirements.txt
 test/__init__.py
+test/test_bulk_request_query.py
 tox.ini
diff --git a/docs/BulkRequest.md b/docs/BulkRequest.md
@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **endpoint** | **str** |  | [optional] 
-**query** | [**SearchStructuredQuery**](SearchStructuredQuery.md) |  | [optional] 
+**query** | [**BulkRequestQuery**](BulkRequestQuery.md) |  | [optional] 
 
 ## Example
 

diff --git a/docs/BulkRequestQuery.md b/docs/BulkRequestQuery.md
@@ -0,0 +1,52 @@
+# BulkRequestQuery
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **str** | The place name (address, venue name, etc.) to search for. | [optional] 
+**focus_point_lat** | **float** | The latitude of the point to focus the search on. This will bias results toward the focus point. Requires &#x60;focus.point.lon&#x60;. | [optional] 
+**focus_point_lon** | **float** | The longitude of the point to focus the search on. This will bias results toward the focus point. Requires &#x60;focus.point.lat&#x60;. | [optional] 
+**boundary_rect_min_lat** | **float** | Defines the min latitude component of a bounding box to limit the search to. Requires all other &#x60;boundary.rect&#x60; parameters to be specified. | [optional] 
+**boundary_rect_max_lat** | **float** | Defines the max latitude component of a bounding box to limit the search to. Requires all other &#x60;boundary.rect&#x60; parameters to be specified. | [optional] 
+**boundary_rect_min_lon** | **float** | Defines the min longitude component of a bounding box to limit the search to. Requires all other &#x60;boundary.rect&#x60; parameters to be specified. | [optional] 
+**boundary_rect_max_lon** | **float** | Defines the max longitude component of a bounding box to limit the search to. Requires all other &#x60;boundary.rect&#x60; parameters to be specified. | [optional] 
+**boundary_circle_lat** | **float** | The latitude of the center of a circle to limit the search to. Requires &#x60;boundary.circle.lon&#x60;. | [optional] 
+**boundary_circle_lon** | **float** | The longitude of the center of a circle to limit the search to. Requires &#x60;boundary.circle.lat&#x60;. | [optional] 
+**boundary_circle_radius** | **float** | The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified. | [optional] 
+**boundary_country** | **List[str]** | A list of countries to limit the search to. These may be either full names (ex: Canada), or an ISO 3116-1 alpha-2 or alpha-3 code. Prefer ISO codes when possible. | [optional] 
+**boundary_gid** | **str** | The Pelias GID of an area to limit the search to. | [optional] 
+**layers** | [**List[PeliasLayer]**](PeliasLayer.md) | A list of layers to limit the search to. | [optional] 
+**sources** | [**List[PeliasSource]**](PeliasSource.md) | A list of sources to limit the search to. | [optional] 
+**size** | **int** | The maximum number of results to return. | [optional] 
+**lang** | **str** | A BCP47 language tag which specifies a preference for localization of results. By default, results are in the default locale of the source data, but specifying a language will attempt to localize the results. Note that while a &#x60;langtag&#x60; (in RFC 5646 terms) can contain script, region, etc., only the &#x60;language&#x60; portion, an ISO 639 code, will be considered. So &#x60;en-US&#x60; and &#x60;en-GB&#x60; will both be treated as English. | [optional] 
+**address** | **str** | A street name, optionally with a house number. | [optional] 
+**neighbourhood** | **str** | Varies by area, but has a locally specific meaning (NOT always an official administrative unit). | [optional] 
+**borough** | **str** | A unit within a city (not widely used, but present in places like NYC and Mexico City). | [optional] 
+**locality** | **str** | The city, village, town, etc. that the place/address is part of. | [optional] 
+**county** | **str** | Administrative divisions between localities and regions. Not commonly used as input to structured geocoding. | [optional] 
+**region** | **str** | Typically the first administrative division within a country. For example, a US state or a Canadian province. | [optional] 
+**postal_code** | **str** | A mail sorting code. | [optional] 
+**country** | **str** | A full name (ex: Canada), or a 2 or 3 character ISO code. Prefer ISO codes when possible. | [optional] 
+
+## Example
+
+```python
+from stadiamaps.models.bulk_request_query import BulkRequestQuery
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BulkRequestQuery from a JSON string
+bulk_request_query_instance = BulkRequestQuery.from_json(json)
+# print the JSON string representation of the object
+print(BulkRequestQuery.to_json())
+
+# convert the object into a dict
+bulk_request_query_dict = bulk_request_query_instance.to_dict()
+# create an instance of BulkRequestQuery from a dict
+bulk_request_query_from_dict = BulkRequestQuery.from_dict(bulk_request_query_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/__init__.py b/stadiamaps/__init__.py
@@ -7,7 +7,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -43,6 +43,7 @@
 from stadiamaps.models.bicycle_costing_options import BicycleCostingOptions
 from stadiamaps.models.bike_network import BikeNetwork
 from stadiamaps.models.bulk_request import BulkRequest
+from stadiamaps.models.bulk_request_query import BulkRequestQuery
 from stadiamaps.models.bulk_search_response import BulkSearchResponse
 from stadiamaps.models.contour import Contour
 from stadiamaps.models.coordinate import Coordinate
@@ -114,9 +115,7 @@
 from stadiamaps.models.routing_response_waypoint import RoutingResponseWaypoint
 from stadiamaps.models.routing_waypoint import RoutingWaypoint
 from stadiamaps.models.routing_waypoint_all_of_search_filter import RoutingWaypointAllOfSearchFilter
-from stadiamaps.models.search_bulk_query import SearchBulkQuery
 from stadiamaps.models.search_query import SearchQuery
-from stadiamaps.models.search_structured_bulk_query import SearchStructuredBulkQuery
 from stadiamaps.models.search_structured_query import SearchStructuredQuery
 from stadiamaps.models.simple_routing_waypoint import SimpleRoutingWaypoint
 from stadiamaps.models.speeds import Speeds

diff --git a/stadiamaps/api/geocoding_api.py b/stadiamaps/api/geocoding_api.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/api/geospatial_api.py b/stadiamaps/api/geospatial_api.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/api/routing_api.py b/stadiamaps/api/routing_api.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/api_client.py b/stadiamaps/api_client.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/configuration.py b/stadiamaps/configuration.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -413,7 +413,7 @@ def to_debug_report(self):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 6.6.2\n"\
+               "Version of the API: 6.6.3\n"\
                "SDK Package Version: 3.2.1".\
                format(env=sys.platform, pyversion=sys.version)
 

diff --git a/stadiamaps/exceptions.py b/stadiamaps/exceptions.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/models/__init__.py b/stadiamaps/models/__init__.py
@@ -6,7 +6,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 
@@ -24,6 +24,7 @@
 from stadiamaps.models.bicycle_costing_options import BicycleCostingOptions
 from stadiamaps.models.bike_network import BikeNetwork
 from stadiamaps.models.bulk_request import BulkRequest
+from stadiamaps.models.bulk_request_query import BulkRequestQuery
 from stadiamaps.models.bulk_search_response import BulkSearchResponse
 from stadiamaps.models.contour import Contour
 from stadiamaps.models.coordinate import Coordinate
@@ -95,9 +96,7 @@
 from stadiamaps.models.routing_response_waypoint import RoutingResponseWaypoint
 from stadiamaps.models.routing_waypoint import RoutingWaypoint
 from stadiamaps.models.routing_waypoint_all_of_search_filter import RoutingWaypointAllOfSearchFilter
-from stadiamaps.models.search_bulk_query import SearchBulkQuery
 from stadiamaps.models.search_query import SearchQuery
-from stadiamaps.models.search_structured_bulk_query import SearchStructuredBulkQuery
 from stadiamaps.models.search_structured_query import SearchStructuredQuery
 from stadiamaps.models.simple_routing_waypoint import SimpleRoutingWaypoint
 from stadiamaps.models.speeds import Speeds

diff --git a/stadiamaps/models/access.py b/stadiamaps/models/access.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/models/admin_region.py b/stadiamaps/models/admin_region.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/models/administrative.py b/stadiamaps/models/administrative.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/models/auto_costing_options.py b/stadiamaps/models/auto_costing_options.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/models/base_costing_options.py b/stadiamaps/models/base_costing_options.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/models/base_trace_request.py b/stadiamaps/models/base_trace_request.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/models/bicycle_costing_options.py b/stadiamaps/models/bicycle_costing_options.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)
 

diff --git a/stadiamaps/models/bike_network.py b/stadiamaps/models/bike_network.py
@@ -5,7 +5,7 @@
 
     The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
 
-    The version of the OpenAPI document: 6.6.2
+    The version of the OpenAPI document: 6.6.3
     Contact: support@stadiamaps.com
     Generated by OpenAPI Generator (https://openapi-generator.tech)