langfuse-client-base 0.16.1

Auto-generated Langfuse API client from OpenAPI specification
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

/*
 * server
 *
 * ## Real-time data  The only real-time path to get tracing data is to ingest via OpenTelemetry (`POST /api/public/otel/v1/traces`) and retrieve via Observations API v2 (`GET /api/public/v2/observations`) and Metrics API v2 (`GET /api/public/v2/metrics`). Other public API write and read endpoints can delay data by about 10 minutes. Direct OpenTelemetry exporters must send the `x-langfuse-ingestion-version: 4` header; current Python and JS SDKs already do. See the [Public API docs](https://langfuse.com/docs/api-and-data-platform/features/public-api) and [real-time ingestion](https://langfuse.com/integrations/native/opentelemetry.md#real-time-ingestion).  ## Authentication  Authenticate with the API using [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication), get API keys in the project settings:  - username: Langfuse Public Key - password: Langfuse Secret Key  ## Exports  - OpenAPI spec: https://cloud.langfuse.com/generated/api/openapi.yml - Self-hosted deployments: interactive API reference at `/api/docs` and OpenAPI spec at `/api/openapi.yaml`
 *
 * The version of the OpenAPI document:
 *
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

/// Deprecation : Migration signal returned by deprecated endpoints. Optional fields are omitted when they have no value.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize, bon::Builder)]
pub struct Deprecation {
    /// Human- and agent-readable summary of the deprecation and its replacement.
    #[serde(rename = "message")]
    pub message: String,
    /// The replacement endpoint, e.g. \"GET /api/public/v2/observations\". Omitted when the endpoint is being removed without a direct replacement.
    #[serde(
        rename = "replacement",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub replacement: Option<Option<String>>,
    /// Link to the migration documentation (markdown), when available.
    #[serde(
        rename = "docsUrl",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub docs_url: Option<Option<String>>,
    /// ISO date after which the endpoint may stop working, when a removal date is committed.
    #[serde(
        rename = "sunsetAt",
        default,
        with = "::serde_with::rust::double_option",
        skip_serializing_if = "Option::is_none"
    )]
    pub sunset_at: Option<Option<String>>,
}

impl Deprecation {
    /// Migration signal returned by deprecated endpoints. Optional fields are omitted when they have no value.
    pub fn new(message: String) -> Deprecation {
        Deprecation {
            message,
            replacement: None,
            docs_url: None,
            sunset_at: None,
        }
    }
}