/*
* Naurt API
*
* OpenAPI specification for Naurt's APIs.
*
* The version of the OpenAPI document: 0.1.2
*
* Generated by: https://openapi-generator.tech
*/
use reqwest;
use serde::{Deserialize, Serialize, de::Error as _};
use crate::{apis::ResponseContent, models};
use super::{Error, configuration, ContentType};
/// struct for typed errors of method [`finaldestination_options`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum FinaldestinationOptionsError {
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`finaldestination_post`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum FinaldestinationPostError {
Status4XX(models::ErrorResponse),
Status5XX(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
pub async fn finaldestination_options(configuration: &configuration::Configuration, ) -> Result<models::OptionsResponse, Error<FinaldestinationOptionsError>> {
let uri_str = format!("{}/final-destination/v2", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::OPTIONS, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref apikey) = configuration.api_key {
let key = apikey.key.clone();
let value = match apikey.prefix {
Some(ref prefix) => format!("{} {}", prefix, key),
None => key,
};
req_builder = req_builder.header("Authorization", value);
};
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::OptionsResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::OptionsResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<FinaldestinationOptionsError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Query the Naurt Final Destination dataset to retrieve precise destination locations for addresses, buildings, entrances, and parking locations. Each request contains one or more `queries`. A query can represent several different search types supported by the Final Destination API: • Forward geocoding — supply an `address_string` or `address_structured` • Reverse geocoding — supply a `location` with latitude and longitude • Naurt ID lookup — supply an `id` returned from a previous query • Source ID lookup — supply identifiers such as `os_uprn` The API returns a best match for each query along with optional additional matches. Results may include multiple destination geometries such as building entrances, delivery doors, or parking locations depending on available data. The geometry format returned by the API is controlled by `options.geojson_type`: • `geojson` (default) — results are returned as standard GeoJSON FeatureCollections with geometries and properties. • `key_value` — results are returned as a simplified key/value representation where each destination type contains latitude and longitude coordinates. Each query result includes a status, the best match, optional additional matches, and metadata such as distance from the search location when applicable.
pub async fn finaldestination_post(configuration: &configuration::Configuration, final_destination_request: models::FinalDestinationRequest) -> Result<models::FinalDestinationResponse, Error<FinaldestinationPostError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_final_destination_request = final_destination_request;
let uri_str = format!("{}/final-destination/v2", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref apikey) = configuration.api_key {
let key = apikey.key.clone();
let value = match apikey.prefix {
Some(ref prefix) => format!("{} {}", prefix, key),
None => key,
};
req_builder = req_builder.header("Authorization", value);
};
req_builder = req_builder.json(&p_body_final_destination_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::FinalDestinationResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::FinalDestinationResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<FinaldestinationPostError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}