use derive_builder::Builder;
use reqwest::Client as HttpClient;
use serde::{Deserialize, Serialize, Serializer, ser::SerializeMap};
use urlencoding::encode;
use crate::{
error::OpenRouterError,
strip_option_vec_setter,
transport::{request as transport_request, response as transport_response},
types::{ApiResponse, PaginationOptions},
};
#[derive(Serialize)]
struct ListByokKeysQuery {
#[serde(skip_serializing_if = "Option::is_none")]
offset: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none")]
limit: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none")]
workspace_id: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
provider: Option<String>,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[non_exhaustive]
pub struct ByokKey {
pub id: String,
pub provider: String,
pub workspace_id: String,
pub label: String,
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
pub disabled: bool,
pub is_fallback: bool,
#[serde(skip_serializing_if = "Option::is_none")]
pub allowed_models: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub allowed_api_key_hashes: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
pub allowed_user_ids: Option<Vec<String>>,
pub sort_order: i64,
pub created_at: String,
}
#[derive(Serialize, Deserialize, Debug, Clone)]
#[non_exhaustive]
pub struct ByokKeyListResponse {
pub data: Vec<ByokKey>,
pub total_count: u64,
}
#[derive(Serialize, Deserialize, Debug, Clone, Builder)]
#[builder(build_fn(error = "OpenRouterError"))]
#[non_exhaustive]
pub struct CreateByokKeyRequest {
#[builder(setter(into))]
pub provider: String,
#[builder(setter(into))]
pub key: String,
#[builder(setter(into, strip_option), default)]
#[serde(skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
#[builder(setter(into, strip_option), default)]
#[serde(skip_serializing_if = "Option::is_none")]
pub workspace_id: Option<String>,
#[builder(setter(custom), default)]
#[serde(skip_serializing_if = "Option::is_none")]
pub allowed_models: Option<Vec<String>>,
#[builder(setter(custom), default)]
#[serde(skip_serializing_if = "Option::is_none")]
pub allowed_user_ids: Option<Vec<String>>,
#[builder(setter(strip_option), default)]
#[serde(skip_serializing_if = "Option::is_none")]
pub disabled: Option<bool>,
#[builder(setter(strip_option), default)]
#[serde(skip_serializing_if = "Option::is_none")]
pub is_fallback: Option<bool>,
}
impl CreateByokKeyRequest {
pub fn builder() -> CreateByokKeyRequestBuilder {
CreateByokKeyRequestBuilder::default()
}
}
impl CreateByokKeyRequestBuilder {
strip_option_vec_setter!(allowed_models, String);
strip_option_vec_setter!(allowed_user_ids, String);
}
#[derive(Deserialize, Debug, Clone, Builder)]
#[builder(build_fn(error = "OpenRouterError"))]
#[non_exhaustive]
pub struct UpdateByokKeyRequest {
#[builder(setter(into, strip_option), default)]
pub key: Option<String>,
#[builder(setter(custom), default)]
pub name: Option<String>,
#[serde(skip)]
#[builder(setter(custom), default)]
clear_name: bool,
#[builder(setter(custom), default)]
pub allowed_models: Option<Vec<String>>,
#[serde(skip)]
#[builder(setter(custom), default)]
clear_allowed_models: bool,
#[builder(setter(custom), default)]
pub allowed_user_ids: Option<Vec<String>>,
#[serde(skip)]
#[builder(setter(custom), default)]
clear_allowed_user_ids: bool,
#[builder(setter(strip_option), default)]
pub disabled: Option<bool>,
#[builder(setter(strip_option), default)]
pub is_fallback: Option<bool>,
}
impl Serialize for UpdateByokKeyRequest {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
let mut map = serializer.serialize_map(None)?;
if let Some(value) = &self.key {
map.serialize_entry("key", value)?;
}
if self.clear_name {
map.serialize_entry("name", &Option::<String>::None)?;
} else if let Some(value) = &self.name {
map.serialize_entry("name", value)?;
}
if self.clear_allowed_models {
map.serialize_entry("allowed_models", &Option::<Vec<String>>::None)?;
} else if let Some(value) = &self.allowed_models {
map.serialize_entry("allowed_models", value)?;
}
if self.clear_allowed_user_ids {
map.serialize_entry("allowed_user_ids", &Option::<Vec<String>>::None)?;
} else if let Some(value) = &self.allowed_user_ids {
map.serialize_entry("allowed_user_ids", value)?;
}
if let Some(value) = &self.disabled {
map.serialize_entry("disabled", value)?;
}
if let Some(value) = &self.is_fallback {
map.serialize_entry("is_fallback", value)?;
}
map.end()
}
}
impl UpdateByokKeyRequest {
pub fn builder() -> UpdateByokKeyRequestBuilder {
UpdateByokKeyRequestBuilder::default()
}
}
impl UpdateByokKeyRequestBuilder {
pub fn name(&mut self, value: impl Into<String>) -> &mut Self {
self.name = Some(Some(value.into()));
self.clear_name = Some(false);
self
}
pub fn clear_name(&mut self) -> &mut Self {
self.name = Some(None);
self.clear_name = Some(true);
self
}
pub fn allowed_models<T, S>(&mut self, items: T) -> &mut Self
where
T: IntoIterator<Item = S>,
S: Into<String>,
{
self.allowed_models = Some(Some(items.into_iter().map(Into::into).collect()));
self.clear_allowed_models = Some(false);
self
}
pub fn allowed_user_ids<T, S>(&mut self, items: T) -> &mut Self
where
T: IntoIterator<Item = S>,
S: Into<String>,
{
self.allowed_user_ids = Some(Some(items.into_iter().map(Into::into).collect()));
self.clear_allowed_user_ids = Some(false);
self
}
pub fn clear_allowed_models(&mut self) -> &mut Self {
self.allowed_models = Some(None);
self.clear_allowed_models = Some(true);
self
}
pub fn clear_allowed_user_ids(&mut self) -> &mut Self {
self.allowed_user_ids = Some(None);
self.clear_allowed_user_ids = Some(true);
self
}
}
#[derive(Serialize, Deserialize, Debug, Clone)]
struct DeleteByokKeyResponse {
deleted: bool,
}
pub async fn list_byok_keys(
base_url: &str,
management_key: &str,
pagination: Option<PaginationOptions>,
workspace_id: Option<&str>,
provider: Option<&str>,
) -> Result<ByokKeyListResponse, OpenRouterError> {
let http_client = crate::transport::new_client()?;
list_byok_keys_with_client(
&http_client,
base_url,
management_key,
pagination,
workspace_id,
provider,
)
.await
}
pub(crate) async fn list_byok_keys_with_client(
http_client: &HttpClient,
base_url: &str,
management_key: &str,
pagination: Option<PaginationOptions>,
workspace_id: Option<&str>,
provider: Option<&str>,
) -> Result<ByokKeyListResponse, OpenRouterError> {
let url = format!("{base_url}/byok");
let query = ListByokKeysQuery {
offset: pagination.and_then(|p| p.offset),
limit: pagination.and_then(|p| p.limit),
workspace_id: workspace_id.map(ToOwned::to_owned),
provider: provider.map(ToOwned::to_owned),
};
let req = transport_request::with_bearer_auth(
transport_request::get(http_client, &url),
management_key,
);
let response = if query.offset.is_none()
&& query.limit.is_none()
&& query.workspace_id.is_none()
&& query.provider.is_none()
{
req.send().await?
} else {
req.query(&query).send().await?
};
if response.status().is_success() {
transport_response::parse_json_response(response, "BYOK key list").await
} else {
transport_response::handle_error(response).await?;
unreachable!()
}
}
pub async fn create_byok_key(
base_url: &str,
management_key: &str,
request: &CreateByokKeyRequest,
) -> Result<ByokKey, OpenRouterError> {
let http_client = crate::transport::new_client()?;
create_byok_key_with_client(&http_client, base_url, management_key, request).await
}
pub(crate) async fn create_byok_key_with_client(
http_client: &HttpClient,
base_url: &str,
management_key: &str,
request: &CreateByokKeyRequest,
) -> Result<ByokKey, OpenRouterError> {
let url = format!("{base_url}/byok");
let response = transport_request::with_bearer_auth(
transport_request::post(http_client, &url),
management_key,
)
.json(request)
.send()
.await?;
if response.status().is_success() {
let payload: ApiResponse<ByokKey> =
transport_response::parse_json_response(response, "BYOK key creation").await?;
Ok(payload.data)
} else {
transport_response::handle_error(response).await?;
unreachable!()
}
}
pub async fn get_byok_key(
base_url: &str,
management_key: &str,
id: &str,
) -> Result<ByokKey, OpenRouterError> {
let http_client = crate::transport::new_client()?;
get_byok_key_with_client(&http_client, base_url, management_key, id).await
}
pub(crate) async fn get_byok_key_with_client(
http_client: &HttpClient,
base_url: &str,
management_key: &str,
id: &str,
) -> Result<ByokKey, OpenRouterError> {
let url = format!("{base_url}/byok/{}", encode(id));
let response = transport_request::with_bearer_auth(
transport_request::get(http_client, &url),
management_key,
)
.send()
.await?;
if response.status().is_success() {
let payload: ApiResponse<ByokKey> =
transport_response::parse_json_response(response, "BYOK key lookup").await?;
Ok(payload.data)
} else {
transport_response::handle_error(response).await?;
unreachable!()
}
}
pub async fn update_byok_key(
base_url: &str,
management_key: &str,
id: &str,
request: &UpdateByokKeyRequest,
) -> Result<ByokKey, OpenRouterError> {
let http_client = crate::transport::new_client()?;
update_byok_key_with_client(&http_client, base_url, management_key, id, request).await
}
pub(crate) async fn update_byok_key_with_client(
http_client: &HttpClient,
base_url: &str,
management_key: &str,
id: &str,
request: &UpdateByokKeyRequest,
) -> Result<ByokKey, OpenRouterError> {
let url = format!("{base_url}/byok/{}", encode(id));
let response = transport_request::with_bearer_auth(
transport_request::patch(http_client, &url),
management_key,
)
.json(request)
.send()
.await?;
if response.status().is_success() {
let payload: ApiResponse<ByokKey> =
transport_response::parse_json_response(response, "BYOK key update").await?;
Ok(payload.data)
} else {
transport_response::handle_error(response).await?;
unreachable!()
}
}
pub async fn delete_byok_key(
base_url: &str,
management_key: &str,
id: &str,
) -> Result<bool, OpenRouterError> {
let http_client = crate::transport::new_client()?;
delete_byok_key_with_client(&http_client, base_url, management_key, id).await
}
pub(crate) async fn delete_byok_key_with_client(
http_client: &HttpClient,
base_url: &str,
management_key: &str,
id: &str,
) -> Result<bool, OpenRouterError> {
let url = format!("{base_url}/byok/{}", encode(id));
let response = transport_request::with_bearer_auth(
transport_request::delete(http_client, &url),
management_key,
)
.send()
.await?;
if response.status().is_success() {
let payload: DeleteByokKeyResponse =
transport_response::parse_json_response(response, "BYOK key deletion").await?;
Ok(payload.deleted)
} else {
transport_response::handle_error(response).await?;
unreachable!()
}
}