openrouter-rs 0.11.1

A type-safe OpenRouter Rust SDK
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
use derive_builder::Builder;
use reqwest::Client as HttpClient;
use serde::{Deserialize, Serialize, Serializer, ser::SerializeMap};
use serde_json::Value;
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 ListObservabilityDestinationsQuery {
    #[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>,
}

/// Structured observability routing rules.
#[derive(Serialize, Deserialize, Debug, Clone, Builder)]
#[builder(build_fn(error = "OpenRouterError"))]
#[non_exhaustive]
pub struct ObservabilityFilterRulesConfig {
    pub groups: Vec<ObservabilityFilterGroup>,
    #[builder(setter(strip_option), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
}

impl ObservabilityFilterRulesConfig {
    pub fn builder() -> ObservabilityFilterRulesConfigBuilder {
        ObservabilityFilterRulesConfigBuilder::default()
    }
}

/// One observability filter group.
#[derive(Serialize, Deserialize, Debug, Clone, Builder)]
#[builder(build_fn(error = "OpenRouterError"))]
#[non_exhaustive]
pub struct ObservabilityFilterGroup {
    pub rules: Vec<ObservabilityFilterRule>,
    #[builder(setter(into, strip_option), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub logic: Option<String>,
}

impl ObservabilityFilterGroup {
    pub fn builder() -> ObservabilityFilterGroupBuilder {
        ObservabilityFilterGroupBuilder::default()
    }
}

/// One observability filter rule.
#[derive(Serialize, Deserialize, Debug, Clone, Builder)]
#[builder(build_fn(error = "OpenRouterError"))]
#[non_exhaustive]
pub struct ObservabilityFilterRule {
    #[builder(setter(into))]
    pub field: String,
    #[builder(setter(into))]
    pub operator: String,
    #[builder(setter(strip_option), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<Value>,
}

impl ObservabilityFilterRule {
    pub fn builder() -> ObservabilityFilterRuleBuilder {
        ObservabilityFilterRuleBuilder::default()
    }
}

/// Observability destination returned by `/observability/destinations`.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[non_exhaustive]
pub struct ObservabilityDestination {
    pub id: String,
    pub workspace_id: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    pub enabled: bool,
    pub privacy_mode: bool,
    pub sampling_rate: f64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub api_key_hashes: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub filter_rules: Option<ObservabilityFilterRulesConfig>,
    pub created_at: String,
    pub updated_at: String,
    #[serde(rename = "type")]
    pub destination_type: String,
    pub config: Value,
}

/// Paginated observability destination list response.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[non_exhaustive]
pub struct ObservabilityDestinationListResponse {
    pub data: Vec<ObservabilityDestination>,
    pub total_count: u64,
}

/// Request payload for creating an observability destination.
#[derive(Serialize, Deserialize, Debug, Clone, Builder)]
#[builder(build_fn(error = "OpenRouterError"))]
#[non_exhaustive]
pub struct CreateObservabilityDestinationRequest {
    #[serde(rename = "type")]
    #[builder(setter(into))]
    pub destination_type: String,
    #[builder(setter(into))]
    pub name: String,
    pub config: Value,
    #[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 api_key_hashes: Option<Vec<String>>,
    #[builder(setter(strip_option), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub enabled: Option<bool>,
    #[builder(setter(strip_option), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub privacy_mode: Option<bool>,
    #[builder(setter(strip_option), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sampling_rate: Option<f64>,
    #[builder(setter(strip_option), default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub filter_rules: Option<ObservabilityFilterRulesConfig>,
}

impl CreateObservabilityDestinationRequest {
    pub fn builder() -> CreateObservabilityDestinationRequestBuilder {
        CreateObservabilityDestinationRequestBuilder::default()
    }
}

impl CreateObservabilityDestinationRequestBuilder {
    strip_option_vec_setter!(api_key_hashes, String);
}

/// Request payload for updating an observability destination.
#[derive(Deserialize, Debug, Clone, Builder)]
#[builder(build_fn(error = "OpenRouterError"))]
#[non_exhaustive]
pub struct UpdateObservabilityDestinationRequest {
    #[builder(setter(into, strip_option), default)]
    pub name: Option<String>,
    #[builder(setter(strip_option), default)]
    pub config: Option<Value>,
    #[builder(setter(custom), default)]
    pub api_key_hashes: Option<Vec<String>>,
    #[serde(skip)]
    #[builder(setter(custom), default)]
    clear_api_key_hashes: bool,
    #[builder(setter(strip_option), default)]
    pub enabled: Option<bool>,
    #[builder(setter(strip_option), default)]
    pub privacy_mode: Option<bool>,
    #[builder(setter(strip_option), default)]
    pub sampling_rate: Option<f64>,
    #[builder(setter(custom), default)]
    pub filter_rules: Option<ObservabilityFilterRulesConfig>,
    #[serde(skip)]
    #[builder(setter(custom), default)]
    clear_filter_rules: bool,
}

impl Serialize for UpdateObservabilityDestinationRequest {
    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.name {
            map.serialize_entry("name", value)?;
        }
        if let Some(value) = &self.config {
            map.serialize_entry("config", value)?;
        }
        if self.clear_api_key_hashes {
            map.serialize_entry("api_key_hashes", &Option::<Vec<String>>::None)?;
        } else if let Some(value) = &self.api_key_hashes {
            map.serialize_entry("api_key_hashes", value)?;
        }
        if let Some(value) = &self.enabled {
            map.serialize_entry("enabled", value)?;
        }
        if let Some(value) = &self.privacy_mode {
            map.serialize_entry("privacy_mode", value)?;
        }
        if let Some(value) = &self.sampling_rate {
            map.serialize_entry("sampling_rate", value)?;
        }
        if self.clear_filter_rules {
            map.serialize_entry(
                "filter_rules",
                &Option::<ObservabilityFilterRulesConfig>::None,
            )?;
        } else if let Some(value) = &self.filter_rules {
            map.serialize_entry("filter_rules", value)?;
        }
        map.end()
    }
}

impl UpdateObservabilityDestinationRequest {
    pub fn builder() -> UpdateObservabilityDestinationRequestBuilder {
        UpdateObservabilityDestinationRequestBuilder::default()
    }
}

impl UpdateObservabilityDestinationRequestBuilder {
    pub fn api_key_hashes<T, S>(&mut self, items: T) -> &mut Self
    where
        T: IntoIterator<Item = S>,
        S: Into<String>,
    {
        self.api_key_hashes = Some(Some(items.into_iter().map(Into::into).collect()));
        self.clear_api_key_hashes = Some(false);
        self
    }

    pub fn clear_api_key_hashes(&mut self) -> &mut Self {
        self.api_key_hashes = Some(None);
        self.clear_api_key_hashes = Some(true);
        self
    }

    pub fn filter_rules(&mut self, value: ObservabilityFilterRulesConfig) -> &mut Self {
        self.filter_rules = Some(Some(value));
        self.clear_filter_rules = Some(false);
        self
    }

    pub fn clear_filter_rules(&mut self) -> &mut Self {
        self.filter_rules = Some(None);
        self.clear_filter_rules = Some(true);
        self
    }
}

#[derive(Serialize, Deserialize, Debug, Clone)]
struct DeleteObservabilityDestinationResponse {
    deleted: bool,
}

/// List observability destinations (`GET /observability/destinations`).
pub async fn list_observability_destinations(
    base_url: &str,
    management_key: &str,
    pagination: Option<PaginationOptions>,
    workspace_id: Option<&str>,
) -> Result<ObservabilityDestinationListResponse, OpenRouterError> {
    let http_client = crate::transport::new_client()?;
    list_observability_destinations_with_client(
        &http_client,
        base_url,
        management_key,
        pagination,
        workspace_id,
    )
    .await
}

pub(crate) async fn list_observability_destinations_with_client(
    http_client: &HttpClient,
    base_url: &str,
    management_key: &str,
    pagination: Option<PaginationOptions>,
    workspace_id: Option<&str>,
) -> Result<ObservabilityDestinationListResponse, OpenRouterError> {
    let url = format!("{base_url}/observability/destinations");
    let query = ListObservabilityDestinationsQuery {
        offset: pagination.and_then(|p| p.offset),
        limit: pagination.and_then(|p| p.limit),
        workspace_id: workspace_id.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() {
            req.send().await?
        } else {
            req.query(&query).send().await?
        };

    if response.status().is_success() {
        transport_response::parse_json_response(response, "observability destination list").await
    } else {
        transport_response::handle_error(response).await?;
        unreachable!()
    }
}

/// Create an observability destination (`POST /observability/destinations`).
pub async fn create_observability_destination(
    base_url: &str,
    management_key: &str,
    request: &CreateObservabilityDestinationRequest,
) -> Result<ObservabilityDestination, OpenRouterError> {
    let http_client = crate::transport::new_client()?;
    create_observability_destination_with_client(&http_client, base_url, management_key, request)
        .await
}

pub(crate) async fn create_observability_destination_with_client(
    http_client: &HttpClient,
    base_url: &str,
    management_key: &str,
    request: &CreateObservabilityDestinationRequest,
) -> Result<ObservabilityDestination, OpenRouterError> {
    let url = format!("{base_url}/observability/destinations");
    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<ObservabilityDestination> =
            transport_response::parse_json_response(response, "observability destination creation")
                .await?;
        Ok(payload.data)
    } else {
        transport_response::handle_error(response).await?;
        unreachable!()
    }
}

/// Get an observability destination (`GET /observability/destinations/{id}`).
pub async fn get_observability_destination(
    base_url: &str,
    management_key: &str,
    id: &str,
) -> Result<ObservabilityDestination, OpenRouterError> {
    let http_client = crate::transport::new_client()?;
    get_observability_destination_with_client(&http_client, base_url, management_key, id).await
}

pub(crate) async fn get_observability_destination_with_client(
    http_client: &HttpClient,
    base_url: &str,
    management_key: &str,
    id: &str,
) -> Result<ObservabilityDestination, OpenRouterError> {
    let url = format!("{base_url}/observability/destinations/{}", 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<ObservabilityDestination> =
            transport_response::parse_json_response(response, "observability destination lookup")
                .await?;
        Ok(payload.data)
    } else {
        transport_response::handle_error(response).await?;
        unreachable!()
    }
}

/// Update an observability destination (`PATCH /observability/destinations/{id}`).
pub async fn update_observability_destination(
    base_url: &str,
    management_key: &str,
    id: &str,
    request: &UpdateObservabilityDestinationRequest,
) -> Result<ObservabilityDestination, OpenRouterError> {
    let http_client = crate::transport::new_client()?;
    update_observability_destination_with_client(
        &http_client,
        base_url,
        management_key,
        id,
        request,
    )
    .await
}

pub(crate) async fn update_observability_destination_with_client(
    http_client: &HttpClient,
    base_url: &str,
    management_key: &str,
    id: &str,
    request: &UpdateObservabilityDestinationRequest,
) -> Result<ObservabilityDestination, OpenRouterError> {
    let url = format!("{base_url}/observability/destinations/{}", 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<ObservabilityDestination> =
            transport_response::parse_json_response(response, "observability destination update")
                .await?;
        Ok(payload.data)
    } else {
        transport_response::handle_error(response).await?;
        unreachable!()
    }
}

/// Delete an observability destination (`DELETE /observability/destinations/{id}`).
pub async fn delete_observability_destination(
    base_url: &str,
    management_key: &str,
    id: &str,
) -> Result<bool, OpenRouterError> {
    let http_client = crate::transport::new_client()?;
    delete_observability_destination_with_client(&http_client, base_url, management_key, id).await
}

pub(crate) async fn delete_observability_destination_with_client(
    http_client: &HttpClient,
    base_url: &str,
    management_key: &str,
    id: &str,
) -> Result<bool, OpenRouterError> {
    let url = format!("{base_url}/observability/destinations/{}", 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: DeleteObservabilityDestinationResponse =
            transport_response::parse_json_response(response, "observability destination deletion")
                .await?;
        Ok(payload.deleted)
    } else {
        transport_response::handle_error(response).await?;
        unreachable!()
    }
}