stadiamaps 3.0.0__py3-none-any.whl → 3.2.0__py3-none-any.whl

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 (116) hide show
  1. stadiamaps/__init__.py +8 -2
  2. stadiamaps/api/geocoding_api.py +389 -106
  3. stadiamaps/api/geospatial_api.py +15 -13
  4. stadiamaps/api/routing_api.py +57 -50
  5. stadiamaps/api_client.py +54 -33
  6. stadiamaps/configuration.py +19 -5
  7. stadiamaps/exceptions.py +1 -1
  8. stadiamaps/models/__init__.py +7 -1
  9. stadiamaps/models/access.py +1 -1
  10. stadiamaps/models/admin_region.py +1 -1
  11. stadiamaps/models/administrative.py +1 -1
  12. stadiamaps/models/auto_costing_options.py +1 -1
  13. stadiamaps/models/base_costing_options.py +1 -1
  14. stadiamaps/models/base_trace_request.py +5 -5
  15. stadiamaps/models/bicycle_costing_options.py +1 -1
  16. stadiamaps/models/bike_network.py +1 -1
  17. stadiamaps/models/bulk_request.py +141 -0
  18. stadiamaps/models/bulk_search_request_inner.py +141 -0
  19. stadiamaps/models/bulk_search_response.py +109 -0
  20. stadiamaps/models/contour.py +1 -1
  21. stadiamaps/models/coordinate.py +1 -1
  22. stadiamaps/models/costing_model.py +1 -1
  23. stadiamaps/models/costing_options.py +1 -1
  24. stadiamaps/models/directions_options.py +5 -5
  25. stadiamaps/models/distance_unit.py +1 -1
  26. stadiamaps/models/edge_sign.py +1 -1
  27. stadiamaps/models/edge_use.py +1 -1
  28. stadiamaps/models/end_node.py +1 -1
  29. stadiamaps/models/geo_attributes.py +1 -1
  30. stadiamaps/models/geo_json_geometry.py +3 -3
  31. stadiamaps/models/geo_json_geometry_base.py +1 -1
  32. stadiamaps/models/geo_json_line_string.py +1 -1
  33. stadiamaps/models/geo_json_point.py +1 -1
  34. stadiamaps/models/geo_json_polygon.py +1 -1
  35. stadiamaps/models/geocoding_object.py +1 -1
  36. stadiamaps/models/height_request.py +1 -1
  37. stadiamaps/models/height_response.py +1 -1
  38. stadiamaps/models/highway_classification.py +1 -1
  39. stadiamaps/models/intersecting_edge.py +1 -1
  40. stadiamaps/models/isochrone_costing_model.py +8 -1
  41. stadiamaps/models/isochrone_feature.py +1 -1
  42. stadiamaps/models/isochrone_properties.py +1 -1
  43. stadiamaps/models/isochrone_request.py +1 -1
  44. stadiamaps/models/isochrone_response.py +1 -1
  45. stadiamaps/models/locate_detailed_edge.py +1 -1
  46. stadiamaps/models/locate_edge.py +1 -1
  47. stadiamaps/models/locate_edge_info.py +1 -1
  48. stadiamaps/models/locate_node.py +1 -1
  49. stadiamaps/models/locate_object.py +1 -1
  50. stadiamaps/models/low_speed_vehicle_costing_options.py +1 -1
  51. stadiamaps/models/maneuver_sign.py +1 -1
  52. stadiamaps/models/maneuver_sign_element.py +1 -1
  53. stadiamaps/models/map_match_costing_model.py +8 -2
  54. stadiamaps/models/map_match_request.py +5 -5
  55. stadiamaps/models/map_match_route_response.py +1 -1
  56. stadiamaps/models/map_match_trace_options.py +1 -1
  57. stadiamaps/models/map_match_waypoint.py +1 -1
  58. stadiamaps/models/matched_point.py +1 -1
  59. stadiamaps/models/matrix_costing_model.py +1 -1
  60. stadiamaps/models/matrix_distance.py +1 -1
  61. stadiamaps/models/matrix_request.py +5 -5
  62. stadiamaps/models/matrix_response.py +4 -4
  63. stadiamaps/models/matrix_waypoint.py +1 -1
  64. stadiamaps/models/motor_scooter_costing_options.py +1 -1
  65. stadiamaps/models/motorcycle_costing_options.py +1 -1
  66. stadiamaps/models/nearest_roads_request.py +5 -5
  67. stadiamaps/models/node_id.py +1 -1
  68. stadiamaps/models/node_type.py +1 -1
  69. stadiamaps/models/optimized_route_request.py +5 -5
  70. stadiamaps/models/pedestrian_costing_options.py +1 -1
  71. stadiamaps/models/pelias_geo_json_feature.py +3 -5
  72. stadiamaps/models/pelias_geo_json_properties.py +2 -2
  73. stadiamaps/models/pelias_geo_json_properties_addendum.py +1 -1
  74. stadiamaps/models/pelias_geo_json_properties_addendum_osm.py +1 -1
  75. stadiamaps/models/pelias_layer.py +1 -1
  76. stadiamaps/models/pelias_response.py +1 -1
  77. stadiamaps/models/pelias_source.py +1 -1
  78. stadiamaps/models/restrictions.py +1 -1
  79. stadiamaps/models/road_class.py +1 -1
  80. stadiamaps/models/route_leg.py +9 -5
  81. stadiamaps/models/route_maneuver.py +1 -1
  82. stadiamaps/models/route_request.py +12 -8
  83. stadiamaps/models/route_response.py +1 -1
  84. stadiamaps/models/route_response_alternates_inner.py +1 -1
  85. stadiamaps/models/route_summary.py +1 -1
  86. stadiamaps/models/route_trip.py +3 -3
  87. stadiamaps/models/routing_response_waypoint.py +1 -1
  88. stadiamaps/models/routing_waypoint.py +1 -1
  89. stadiamaps/models/routing_waypoint_all_of_search_filter.py +1 -1
  90. stadiamaps/models/search_bulk_query.py +117 -0
  91. stadiamaps/models/search_bulk_request.py +141 -0
  92. stadiamaps/models/search_query.py +134 -0
  93. stadiamaps/models/search_structured_bulk_query.py +117 -0
  94. stadiamaps/models/search_structured_query.py +148 -0
  95. stadiamaps/models/simple_routing_waypoint.py +1 -1
  96. stadiamaps/models/speeds.py +1 -1
  97. stadiamaps/models/trace_attribute_filter_options.py +1 -1
  98. stadiamaps/models/trace_attribute_key.py +1 -1
  99. stadiamaps/models/trace_attributes_base_response.py +1 -1
  100. stadiamaps/models/trace_attributes_request.py +5 -5
  101. stadiamaps/models/trace_attributes_response.py +3 -3
  102. stadiamaps/models/trace_edge.py +1 -1
  103. stadiamaps/models/travel_mode.py +1 -1
  104. stadiamaps/models/traversability.py +1 -1
  105. stadiamaps/models/truck_costing_options.py +1 -1
  106. stadiamaps/models/tz_response.py +1 -1
  107. stadiamaps/models/valhalla_languages.py +1 -1
  108. stadiamaps/models/valhalla_long_units.py +1 -1
  109. stadiamaps/models/warning.py +1 -1
  110. stadiamaps/rest.py +3 -1
  111. {stadiamaps-3.0.0.dist-info → stadiamaps-3.2.0.dist-info}/METADATA +1 -1
  112. stadiamaps-3.2.0.dist-info/RECORD +138 -0
  113. {stadiamaps-3.0.0.dist-info → stadiamaps-3.2.0.dist-info}/WHEEL +1 -1
  114. stadiamaps-3.0.0.dist-info/RECORD +0 -130
  115. {stadiamaps-3.0.0.dist-info → stadiamaps-3.2.0.dist-info}/LICENSE.txt +0 -0
  116. {stadiamaps-3.0.0.dist-info → stadiamaps-3.2.0.dist-info}/top_level.txt +0 -0
@@ -5,7 +5,7 @@
5
5
 
6
6
  The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
7
 
8
- The version of the OpenAPI document: 6.3.0
8
+ The version of the OpenAPI document: 6.6.2
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -18,8 +18,8 @@ import pprint
18
18
  import re # noqa: F401
19
19
  import json
20
20
 
21
- from pydantic import BaseModel, ConfigDict, Field, StrictStr
22
- from typing import Any, ClassVar, Dict, List
21
+ from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
22
+ from typing import Any, ClassVar, Dict, List, Optional, Union
23
23
  from typing_extensions import Annotated
24
24
  from stadiamaps.models.route_maneuver import RouteManeuver
25
25
  from stadiamaps.models.route_summary import RouteSummary
@@ -33,8 +33,10 @@ class RouteLeg(BaseModel):
33
33
  maneuvers: Annotated[List[RouteManeuver], Field(min_length=1)]
34
34
  shape: StrictStr = Field(description="An encoded polyline (https://developers.google.com/maps/documentation/utilities/polylinealgorithm) with 6 digits of decimal precision.")
35
35
  summary: RouteSummary
36
+ elevation_interval: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The sampling distance between elevation values along the route. This echoes the request parameter having the same name (converted to `units` if necessary).")
37
+ elevation: Optional[List[Union[StrictFloat, StrictInt]]] = Field(default=None, description="An array of elevation values sampled every `elevation_interval`. Units are either metric or imperial depending on the value of `units`.")
36
38
  additional_properties: Dict[str, Any] = {}
37
- __properties: ClassVar[List[str]] = ["maneuvers", "shape", "summary"]
39
+ __properties: ClassVar[List[str]] = ["maneuvers", "shape", "summary", "elevation_interval", "elevation"]
38
40
 
39
41
  model_config = ConfigDict(
40
42
  populate_by_name=True,
@@ -106,7 +108,9 @@ class RouteLeg(BaseModel):
106
108
  _obj = cls.model_validate({
107
109
  "maneuvers": [RouteManeuver.from_dict(_item) for _item in obj["maneuvers"]] if obj.get("maneuvers") is not None else None,
108
110
  "shape": obj.get("shape"),
109
- "summary": RouteSummary.from_dict(obj["summary"]) if obj.get("summary") is not None else None
111
+ "summary": RouteSummary.from_dict(obj["summary"]) if obj.get("summary") is not None else None,
112
+ "elevation_interval": obj.get("elevation_interval"),
113
+ "elevation": obj.get("elevation")
110
114
  })
111
115
  # store additional fields in additional_properties
112
116
  for _key in obj.keys():
@@ -5,7 +5,7 @@
5
5
 
6
6
  The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
7
 
8
- The version of the OpenAPI document: 6.3.0
8
+ The version of the OpenAPI document: 6.6.2
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
7
 
8
- The version of the OpenAPI document: 6.3.0
8
+ The version of the OpenAPI document: 6.6.2
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -18,7 +18,7 @@ import pprint
18
18
  import re # noqa: F401
19
19
  import json
20
20
 
21
- from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
21
+ from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
22
22
  from typing import Any, ClassVar, Dict, List, Optional, Union
23
23
  from typing_extensions import Annotated
24
24
  from stadiamaps.models.costing_model import CostingModel
@@ -33,8 +33,8 @@ class RouteRequest(BaseModel):
33
33
  """
34
34
  RouteRequest
35
35
  """ # noqa: E501
36
- units: Optional[DistanceUnit] = None
37
- language: Optional[ValhallaLanguages] = None
36
+ units: Optional[DistanceUnit] = DistanceUnit.KM
37
+ language: Optional[ValhallaLanguages] = ValhallaLanguages.EN_MINUS_US
38
38
  directions_type: Optional[StrictStr] = Field(default='instructions', description="The level of directional narrative to include. Locations and times will always be returned, but narrative generation verbosity can be controlled with this parameter.")
39
39
  id: Optional[StrictStr] = Field(default=None, description="An identifier to disambiguate requests (echoed by the server).")
40
40
  locations: Annotated[List[RoutingWaypoint], Field(min_length=2)]
@@ -43,8 +43,10 @@ class RouteRequest(BaseModel):
43
43
  exclude_locations: Optional[List[RoutingWaypoint]] = Field(default=None, description="This has the same format as the locations list. Locations are mapped to the closed road(s), and these road(s) are excluded from the route path computation.")
44
44
  exclude_polygons: Optional[List[List[List[Union[StrictFloat, StrictInt]]]]] = Field(default=None, description="One or multiple exterior rings of polygons in the form of nested JSON arrays. Roads intersecting these rings will be avoided during path finding. Open rings will be closed automatically. If you only need to avoid a few specific roads, it's much more efficient to use `exclude_locations`.")
45
45
  alternates: Optional[StrictInt] = Field(default=None, description="How many alternate routes are desired. Note that fewer or no alternates may be returned. Alternates are not yet supported on routes with more than 2 locations or on time-dependent routes.")
46
+ elevation_interval: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.0, description="If greater than zero, attempts to include elevation along the route at regular intervals. The \"native\" internal resolution is 30m, so we recommend you use this when possible. This number is interpreted as either meters or feet depending on the unit parameter. Elevation for route sections containing a bridge or tunnel is interpolated linearly. This doesn't always match the true elevation of the bridge/tunnel, but it prevents sharp artifacts from the surrounding terrain. This functionality is unique to the route endpoint and is not available via the elevation API.")
47
+ roundabout_exits: Optional[StrictBool] = Field(default=True, description="Determines whether the output should include roundabout exit instructions.")
46
48
  additional_properties: Dict[str, Any] = {}
47
- __properties: ClassVar[List[str]] = ["units", "language", "directions_type", "id", "locations", "costing", "costing_options", "exclude_locations", "exclude_polygons", "alternates"]
49
+ __properties: ClassVar[List[str]] = ["units", "language", "directions_type", "id", "locations", "costing", "costing_options", "exclude_locations", "exclude_polygons", "alternates", "elevation_interval", "roundabout_exits"]
48
50
 
49
51
  @field_validator('directions_type')
50
52
  def directions_type_validate_enum(cls, value):
@@ -131,8 +133,8 @@ class RouteRequest(BaseModel):
131
133
  return cls.model_validate(obj)
132
134
 
133
135
  _obj = cls.model_validate({
134
- "units": obj.get("units"),
135
- "language": obj.get("language"),
136
+ "units": obj.get("units") if obj.get("units") is not None else DistanceUnit.KM,
137
+ "language": obj.get("language") if obj.get("language") is not None else ValhallaLanguages.EN_MINUS_US,
136
138
  "directions_type": obj.get("directions_type") if obj.get("directions_type") is not None else 'instructions',
137
139
  "id": obj.get("id"),
138
140
  "locations": [RoutingWaypoint.from_dict(_item) for _item in obj["locations"]] if obj.get("locations") is not None else None,
@@ -140,7 +142,9 @@ class RouteRequest(BaseModel):
140
142
  "costing_options": CostingOptions.from_dict(obj["costing_options"]) if obj.get("costing_options") is not None else None,
141
143
  "exclude_locations": [RoutingWaypoint.from_dict(_item) for _item in obj["exclude_locations"]] if obj.get("exclude_locations") is not None else None,
142
144
  "exclude_polygons": obj.get("exclude_polygons"),
143
- "alternates": obj.get("alternates")
145
+ "alternates": obj.get("alternates"),
146
+ "elevation_interval": obj.get("elevation_interval") if obj.get("elevation_interval") is not None else 0.0,
147
+ "roundabout_exits": obj.get("roundabout_exits") if obj.get("roundabout_exits") is not None else True
144
148
  })
145
149
  # store additional fields in additional_properties
146
150
  for _key in obj.keys():
@@ -5,7 +5,7 @@
5
5
 
6
6
  The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
7
 
8
- The version of the OpenAPI document: 6.3.0
8
+ The version of the OpenAPI document: 6.6.2
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
7
 
8
- The version of the OpenAPI document: 6.3.0
8
+ The version of the OpenAPI document: 6.6.2
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
7
 
8
- The version of the OpenAPI document: 6.3.0
8
+ The version of the OpenAPI document: 6.6.2
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
7
 
8
- The version of the OpenAPI document: 6.3.0
8
+ The version of the OpenAPI document: 6.6.2
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -119,8 +119,8 @@ class RouteTrip(BaseModel):
119
119
  _obj = cls.model_validate({
120
120
  "status": obj.get("status"),
121
121
  "status_message": obj.get("status_message"),
122
- "units": obj.get("units"),
123
- "language": obj.get("language"),
122
+ "units": obj.get("units") if obj.get("units") is not None else ValhallaLongUnits.KILOMETERS,
123
+ "language": obj.get("language") if obj.get("language") is not None else ValhallaLanguages.EN_MINUS_US,
124
124
  "locations": [RoutingResponseWaypoint.from_dict(_item) for _item in obj["locations"]] if obj.get("locations") is not None else None,
125
125
  "legs": [RouteLeg.from_dict(_item) for _item in obj["legs"]] if obj.get("legs") is not None else None,
126
126
  "summary": RouteSummary.from_dict(obj["summary"]) if obj.get("summary") is not None else None
@@ -5,7 +5,7 @@
5
5
 
6
6
  The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
7
 
8
- The version of the OpenAPI document: 6.3.0
8
+ The version of the OpenAPI document: 6.6.2
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
7
 
8
- The version of the OpenAPI document: 6.3.0
8
+ The version of the OpenAPI document: 6.6.2
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
7
 
8
- The version of the OpenAPI document: 6.3.0
8
+ The version of the OpenAPI document: 6.6.2
9
9
  Contact: support@stadiamaps.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -0,0 +1,117 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Stadia Maps Geospatial APIs
5
+
6
+ The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
+
8
+ The version of the OpenAPI document: 6.6.2
9
+ Contact: support@stadiamaps.com
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+
16
+ from __future__ import annotations
17
+ import pprint
18
+ import re # noqa: F401
19
+ import json
20
+
21
+ from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
22
+ from typing import Any, ClassVar, Dict, List, Optional
23
+ from stadiamaps.models.search_query import SearchQuery
24
+ from typing import Optional, Set
25
+ from typing_extensions import Self
26
+
27
+ class SearchBulkQuery(BaseModel):
28
+ """
29
+ SearchBulkQuery
30
+ """ # noqa: E501
31
+ endpoint: Optional[StrictStr] = None
32
+ query: Optional[SearchQuery] = None
33
+ additional_properties: Dict[str, Any] = {}
34
+ __properties: ClassVar[List[str]] = ["endpoint", "query"]
35
+
36
+ @field_validator('endpoint')
37
+ def endpoint_validate_enum(cls, value):
38
+ """Validates the enum"""
39
+ if value is None:
40
+ return value
41
+
42
+ if value not in set(['/v1/search']):
43
+ raise ValueError("must be one of enum values ('/v1/search')")
44
+ return value
45
+
46
+ model_config = ConfigDict(
47
+ populate_by_name=True,
48
+ validate_assignment=True,
49
+ protected_namespaces=(),
50
+ )
51
+
52
+
53
+ def to_str(self) -> str:
54
+ """Returns the string representation of the model using alias"""
55
+ return pprint.pformat(self.model_dump(by_alias=True))
56
+
57
+ def to_json(self) -> str:
58
+ """Returns the JSON representation of the model using alias"""
59
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
60
+ return json.dumps(self.to_dict())
61
+
62
+ @classmethod
63
+ def from_json(cls, json_str: str) -> Optional[Self]:
64
+ """Create an instance of SearchBulkQuery from a JSON string"""
65
+ return cls.from_dict(json.loads(json_str))
66
+
67
+ def to_dict(self) -> Dict[str, Any]:
68
+ """Return the dictionary representation of the model using alias.
69
+
70
+ This has the following differences from calling pydantic's
71
+ `self.model_dump(by_alias=True)`:
72
+
73
+ * `None` is only added to the output dict for nullable fields that
74
+ were set at model initialization. Other fields with value `None`
75
+ are ignored.
76
+ * Fields in `self.additional_properties` are added to the output dict.
77
+ """
78
+ excluded_fields: Set[str] = set([
79
+ "additional_properties",
80
+ ])
81
+
82
+ _dict = self.model_dump(
83
+ by_alias=True,
84
+ exclude=excluded_fields,
85
+ exclude_none=True,
86
+ )
87
+ # override the default output from pydantic by calling `to_dict()` of query
88
+ if self.query:
89
+ _dict['query'] = self.query.to_dict()
90
+ # puts key-value pairs in additional_properties in the top level
91
+ if self.additional_properties is not None:
92
+ for _key, _value in self.additional_properties.items():
93
+ _dict[_key] = _value
94
+
95
+ return _dict
96
+
97
+ @classmethod
98
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
99
+ """Create an instance of SearchBulkQuery from a dict"""
100
+ if obj is None:
101
+ return None
102
+
103
+ if not isinstance(obj, dict):
104
+ return cls.model_validate(obj)
105
+
106
+ _obj = cls.model_validate({
107
+ "endpoint": obj.get("endpoint"),
108
+ "query": SearchQuery.from_dict(obj["query"]) if obj.get("query") is not None else None
109
+ })
110
+ # store additional fields in additional_properties
111
+ for _key in obj.keys():
112
+ if _key not in cls.__properties:
113
+ _obj.additional_properties[_key] = obj.get(_key)
114
+
115
+ return _obj
116
+
117
+
@@ -0,0 +1,141 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Stadia Maps Geospatial APIs
5
+
6
+ The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
+
8
+ The version of the OpenAPI document: 6.6.2
9
+ Contact: support@stadiamaps.com
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+
16
+ from __future__ import annotations
17
+ import json
18
+ import pprint
19
+ from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
20
+ from typing import Any, List, Optional
21
+ from stadiamaps.models.search_bulk_query import SearchBulkQuery
22
+ from stadiamaps.models.search_structured_bulk_query import SearchStructuredBulkQuery
23
+ from pydantic import StrictStr, Field
24
+ from typing import Union, List, Set, Optional, Dict
25
+ from typing_extensions import Literal, Self
26
+
27
+ SEARCHBULKREQUEST_ONE_OF_SCHEMAS = ["SearchBulkQuery", "SearchStructuredBulkQuery"]
28
+
29
+ class SearchBulkRequest(BaseModel):
30
+ """
31
+ SearchBulkRequest
32
+ """
33
+ # data type: SearchBulkQuery
34
+ oneof_schema_1_validator: Optional[SearchBulkQuery] = None
35
+ # data type: SearchStructuredBulkQuery
36
+ oneof_schema_2_validator: Optional[SearchStructuredBulkQuery] = None
37
+ actual_instance: Optional[Union[SearchBulkQuery, SearchStructuredBulkQuery]] = None
38
+ one_of_schemas: Set[str] = { "SearchBulkQuery", "SearchStructuredBulkQuery" }
39
+
40
+ model_config = ConfigDict(
41
+ validate_assignment=True,
42
+ protected_namespaces=(),
43
+ )
44
+
45
+
46
+ discriminator_value_class_map: Dict[str, str] = {
47
+ }
48
+
49
+ def __init__(self, *args, **kwargs) -> None:
50
+ if args:
51
+ if len(args) > 1:
52
+ raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
53
+ if kwargs:
54
+ raise ValueError("If a position argument is used, keyword arguments cannot be used.")
55
+ super().__init__(actual_instance=args[0])
56
+ else:
57
+ super().__init__(**kwargs)
58
+
59
+ @field_validator('actual_instance')
60
+ def actual_instance_must_validate_oneof(cls, v):
61
+ instance = SearchBulkRequest.model_construct()
62
+ error_messages = []
63
+ match = 0
64
+ # validate data type: SearchBulkQuery
65
+ if not isinstance(v, SearchBulkQuery):
66
+ error_messages.append(f"Error! Input type `{type(v)}` is not `SearchBulkQuery`")
67
+ else:
68
+ match += 1
69
+ # validate data type: SearchStructuredBulkQuery
70
+ if not isinstance(v, SearchStructuredBulkQuery):
71
+ error_messages.append(f"Error! Input type `{type(v)}` is not `SearchStructuredBulkQuery`")
72
+ else:
73
+ match += 1
74
+ if match > 1:
75
+ # more than 1 match
76
+ raise ValueError("Multiple matches found when setting `actual_instance` in SearchBulkRequest with oneOf schemas: SearchBulkQuery, SearchStructuredBulkQuery. Details: " + ", ".join(error_messages))
77
+ elif match == 0:
78
+ # no match
79
+ raise ValueError("No match found when setting `actual_instance` in SearchBulkRequest with oneOf schemas: SearchBulkQuery, SearchStructuredBulkQuery. Details: " + ", ".join(error_messages))
80
+ else:
81
+ return v
82
+
83
+ @classmethod
84
+ def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
85
+ return cls.from_json(json.dumps(obj))
86
+
87
+ @classmethod
88
+ def from_json(cls, json_str: str) -> Self:
89
+ """Returns the object represented by the json string"""
90
+ instance = cls.model_construct()
91
+ error_messages = []
92
+ match = 0
93
+
94
+ # deserialize data into SearchBulkQuery
95
+ try:
96
+ instance.actual_instance = SearchBulkQuery.from_json(json_str)
97
+ match += 1
98
+ except (ValidationError, ValueError) as e:
99
+ error_messages.append(str(e))
100
+ # deserialize data into SearchStructuredBulkQuery
101
+ try:
102
+ instance.actual_instance = SearchStructuredBulkQuery.from_json(json_str)
103
+ match += 1
104
+ except (ValidationError, ValueError) as e:
105
+ error_messages.append(str(e))
106
+
107
+ if match > 1:
108
+ # more than 1 match
109
+ raise ValueError("Multiple matches found when deserializing the JSON string into SearchBulkRequest with oneOf schemas: SearchBulkQuery, SearchStructuredBulkQuery. Details: " + ", ".join(error_messages))
110
+ elif match == 0:
111
+ # no match
112
+ raise ValueError("No match found when deserializing the JSON string into SearchBulkRequest with oneOf schemas: SearchBulkQuery, SearchStructuredBulkQuery. Details: " + ", ".join(error_messages))
113
+ else:
114
+ return instance
115
+
116
+ def to_json(self) -> str:
117
+ """Returns the JSON representation of the actual instance"""
118
+ if self.actual_instance is None:
119
+ return "null"
120
+
121
+ if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
122
+ return self.actual_instance.to_json()
123
+ else:
124
+ return json.dumps(self.actual_instance)
125
+
126
+ def to_dict(self) -> Optional[Union[Dict[str, Any], SearchBulkQuery, SearchStructuredBulkQuery]]:
127
+ """Returns the dict representation of the actual instance"""
128
+ if self.actual_instance is None:
129
+ return None
130
+
131
+ if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
132
+ return self.actual_instance.to_dict()
133
+ else:
134
+ # primitive type
135
+ return self.actual_instance
136
+
137
+ def to_str(self) -> str:
138
+ """Returns the string representation of the actual instance"""
139
+ return pprint.pformat(self.model_dump())
140
+
141
+
@@ -0,0 +1,134 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Stadia Maps Geospatial APIs
5
+
6
+ The Stadia Maps Geospatial APIs provide you with the data you need to build awesome applications.
7
+
8
+ The version of the OpenAPI document: 6.6.2
9
+ Contact: support@stadiamaps.com
10
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
11
+
12
+ Do not edit the class manually.
13
+ """ # noqa: E501
14
+
15
+
16
+ from __future__ import annotations
17
+ import pprint
18
+ import re # noqa: F401
19
+ import json
20
+
21
+ from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
22
+ from typing import Any, ClassVar, Dict, List, Optional, Union
23
+ from typing_extensions import Annotated
24
+ from stadiamaps.models.pelias_layer import PeliasLayer
25
+ from stadiamaps.models.pelias_source import PeliasSource
26
+ from typing import Optional, Set
27
+ from typing_extensions import Self
28
+
29
+ class SearchQuery(BaseModel):
30
+ """
31
+ SearchQuery
32
+ """ # noqa: E501
33
+ text: Optional[StrictStr] = Field(default=None, description="The place name (address, venue name, etc.) to search for.")
34
+ focus_point_lat: Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]] = Field(default=None, description="The latitude of the point to focus the search on. This will bias results toward the focus point. Requires `focus.point.lon`.", alias="focus.point.lat")
35
+ focus_point_lon: Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]] = Field(default=None, description="The longitude of the point to focus the search on. This will bias results toward the focus point. Requires `focus.point.lat`.", alias="focus.point.lon")
36
+ boundary_rect_min_lat: Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]] = Field(default=None, description="Defines the min latitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.", alias="boundary.rect.min_lat")
37
+ boundary_rect_max_lat: Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]] = Field(default=None, description="Defines the max latitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.", alias="boundary.rect.max_lat")
38
+ boundary_rect_min_lon: Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]] = Field(default=None, description="Defines the min longitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.", alias="boundary.rect.min_lon")
39
+ boundary_rect_max_lon: Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]] = Field(default=None, description="Defines the max longitude component of a bounding box to limit the search to. Requires all other `boundary.rect` parameters to be specified.", alias="boundary.rect.max_lon")
40
+ boundary_circle_lat: Optional[Union[Annotated[float, Field(le=90, strict=True, ge=-90)], Annotated[int, Field(le=90, strict=True, ge=-90)]]] = Field(default=None, description="The latitude of the center of a circle to limit the search to. Requires `boundary.circle.lon`.", alias="boundary.circle.lat")
41
+ boundary_circle_lon: Optional[Union[Annotated[float, Field(le=180, strict=True, ge=-180)], Annotated[int, Field(le=180, strict=True, ge=-180)]]] = Field(default=None, description="The longitude of the center of a circle to limit the search to. Requires `boundary.circle.lat`.", alias="boundary.circle.lon")
42
+ boundary_circle_radius: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The radius of the circle (in kilometers) to limit the search to. Defaults to 50km if unspecified.", alias="boundary.circle.radius")
43
+ boundary_country: Optional[List[StrictStr]] = Field(default=None, description="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.", alias="boundary.country")
44
+ boundary_gid: Optional[StrictStr] = Field(default=None, description="The Pelias GID of an area to limit the search to.", alias="boundary.gid")
45
+ layers: Optional[List[PeliasLayer]] = Field(default=None, description="A list of layers to limit the search to.")
46
+ sources: Optional[List[PeliasSource]] = Field(default=None, description="A list of sources to limit the search to.")
47
+ size: Optional[StrictInt] = Field(default=None, description="The maximum number of results to return.")
48
+ lang: Optional[StrictStr] = Field(default=None, description="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 `langtag` (in RFC 5646 terms) can contain script, region, etc., only the `language` portion, an ISO 639 code, will be considered. So `en-US` and `en-GB` will both be treated as English.")
49
+ additional_properties: Dict[str, Any] = {}
50
+ __properties: ClassVar[List[str]] = ["text", "focus.point.lat", "focus.point.lon", "boundary.rect.min_lat", "boundary.rect.max_lat", "boundary.rect.min_lon", "boundary.rect.max_lon", "boundary.circle.lat", "boundary.circle.lon", "boundary.circle.radius", "boundary.country", "boundary.gid", "layers", "sources", "size", "lang"]
51
+
52
+ model_config = ConfigDict(
53
+ populate_by_name=True,
54
+ validate_assignment=True,
55
+ protected_namespaces=(),
56
+ )
57
+
58
+
59
+ def to_str(self) -> str:
60
+ """Returns the string representation of the model using alias"""
61
+ return pprint.pformat(self.model_dump(by_alias=True))
62
+
63
+ def to_json(self) -> str:
64
+ """Returns the JSON representation of the model using alias"""
65
+ # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
66
+ return json.dumps(self.to_dict())
67
+
68
+ @classmethod
69
+ def from_json(cls, json_str: str) -> Optional[Self]:
70
+ """Create an instance of SearchQuery from a JSON string"""
71
+ return cls.from_dict(json.loads(json_str))
72
+
73
+ def to_dict(self) -> Dict[str, Any]:
74
+ """Return the dictionary representation of the model using alias.
75
+
76
+ This has the following differences from calling pydantic's
77
+ `self.model_dump(by_alias=True)`:
78
+
79
+ * `None` is only added to the output dict for nullable fields that
80
+ were set at model initialization. Other fields with value `None`
81
+ are ignored.
82
+ * Fields in `self.additional_properties` are added to the output dict.
83
+ """
84
+ excluded_fields: Set[str] = set([
85
+ "additional_properties",
86
+ ])
87
+
88
+ _dict = self.model_dump(
89
+ by_alias=True,
90
+ exclude=excluded_fields,
91
+ exclude_none=True,
92
+ )
93
+ # puts key-value pairs in additional_properties in the top level
94
+ if self.additional_properties is not None:
95
+ for _key, _value in self.additional_properties.items():
96
+ _dict[_key] = _value
97
+
98
+ return _dict
99
+
100
+ @classmethod
101
+ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
102
+ """Create an instance of SearchQuery from a dict"""
103
+ if obj is None:
104
+ return None
105
+
106
+ if not isinstance(obj, dict):
107
+ return cls.model_validate(obj)
108
+
109
+ _obj = cls.model_validate({
110
+ "text": obj.get("text"),
111
+ "focus.point.lat": obj.get("focus.point.lat"),
112
+ "focus.point.lon": obj.get("focus.point.lon"),
113
+ "boundary.rect.min_lat": obj.get("boundary.rect.min_lat"),
114
+ "boundary.rect.max_lat": obj.get("boundary.rect.max_lat"),
115
+ "boundary.rect.min_lon": obj.get("boundary.rect.min_lon"),
116
+ "boundary.rect.max_lon": obj.get("boundary.rect.max_lon"),
117
+ "boundary.circle.lat": obj.get("boundary.circle.lat"),
118
+ "boundary.circle.lon": obj.get("boundary.circle.lon"),
119
+ "boundary.circle.radius": obj.get("boundary.circle.radius"),
120
+ "boundary.country": obj.get("boundary.country"),
121
+ "boundary.gid": obj.get("boundary.gid"),
122
+ "layers": obj.get("layers"),
123
+ "sources": obj.get("sources"),
124
+ "size": obj.get("size"),
125
+ "lang": obj.get("lang")
126
+ })
127
+ # store additional fields in additional_properties
128
+ for _key in obj.keys():
129
+ if _key not in cls.__properties:
130
+ _obj.additional_properties[_key] = obj.get(_key)
131
+
132
+ return _obj
133
+
134
+