foundation_deployment_cloudflare 0.1.3

//! Auto-generated API module for cloudflare routes.
//!
//! Generated by `cargo run --bin ewe_platform gen_api`.
//! DO NOT EDIT MANUALLY.
//!
//! Feature flag: `cloudflare_routes `

#![cfg(feature = "cloudflare_routes")]
#![allow(clippy::too_many_arguments, clippy::type_complexity)]
#![allow(
    clippy::missing_errors_doc,
    clippy::doc_markdown,
    clippy::useless_format
)]
#![allow(unused_imports)]

use foundation_macros::JsonHash;
use foundation_netio::shared::client::http_client::HttpClient;
use foundation_netio::{DynNetClient, PreparedRequestBuilder};
use serde::{Deserialize, Serialize};

use super::shared::ApiResponse;

// =============================================================================
// TYPE DECLARATIONS
// =============================================================================

/// `DiagnosticsTracerouteRequest` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct DiagnosticsTracerouteRequest {
    /// `colos` property.
    pub colos: Option<Vec<String>>,
    /// `options` property.
    pub options: Option<MagicTransitOptions>,
    /// `targets` property.
    pub targets: Vec<String>,
}

/// `MagicTransitApiResponseCommon` type.
///
/// Same shape as `super::shared::ErrorsMessagesSuccessObject`.
pub type MagicTransitApiResponseCommon = super::shared::ErrorsMessagesSuccessObject;

/// `MagicTransitAsn` type.
pub type MagicTransitAsn = String;

/// `MagicTransitColo` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct MagicTransitColo {
    /// `city` property.
    pub city: Option<String>,
    /// `name` property.
    pub name: Option<String>,
}

/// `MagicTransitColoCity` type.
pub type MagicTransitColoCity = String;

/// `MagicTransitColoName` type.
pub type MagicTransitColoName = String;

/// `MagicTransitColoResult` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct MagicTransitColoResult {
    /// `colo` property.
    pub colo: Option<MagicTransitColo>,
    /// `error` property.
    pub error: Option<String>,
    /// `hops` property.
    pub hops: Option<Vec<MagicTransitHopResult>>,
    /// `target_summary` property.
    pub target_summary: Option<serde_json::Value>,
    /// `traceroute_time_ms` property.
    pub traceroute_time_ms: Option<i64>,
}

/// `MagicTransitColos` type.
pub type MagicTransitColos = Vec<String>;

/// `MagicTransitError` type.
pub type MagicTransitError = String;

/// `MagicTransitHopResult` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct MagicTransitHopResult {
    /// `nodes` property.
    pub nodes: Option<Vec<MagicTransitNodeResult>>,
    /// `packets_lost` property.
    pub packets_lost: Option<i64>,
    /// `packets_sent` property.
    pub packets_sent: Option<i64>,
    /// `packets_ttl` property.
    pub packets_ttl: Option<i64>,
}

/// `MagicTransitIp` type.
pub type MagicTransitIp = String;

/// `MagicTransitLabels` type.
pub type MagicTransitLabels = Vec<String>;

/// `MagicTransitMaxRttMs` type.
pub type MagicTransitMaxRttMs = f64;

/// `MagicTransitMaxTtl` type.
pub type MagicTransitMaxTtl = i64;

/// `MagicTransitMeanRttMs` type.
pub type MagicTransitMeanRttMs = f64;

/// `MagicTransitMessages` type.
pub type MagicTransitMessages = Vec<std::collections::HashMap<String, serde_json::Value>>;

/// `MagicTransitMinRttMs` type.
pub type MagicTransitMinRttMs = f64;

/// `MagicTransitName` type.
pub type MagicTransitName = String;

/// `MagicTransitNodeResult` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct MagicTransitNodeResult {
    /// `asn` property.
    pub asn: Option<String>,
    /// `ip` property.
    pub ip: Option<String>,
    /// `labels` property.
    pub labels: Option<Vec<String>>,
    /// `max_rtt_ms` property.
    pub max_rtt_ms: Option<f64>,
    /// `mean_rtt_ms` property.
    pub mean_rtt_ms: Option<f64>,
    /// `min_rtt_ms` property.
    pub min_rtt_ms: Option<f64>,
    /// `name` property.
    pub name: Option<String>,
    /// `packet_count` property.
    pub packet_count: Option<i64>,
    /// `std_dev_rtt_ms` property.
    pub std_dev_rtt_ms: Option<f64>,
}

/// `MagicTransitOptions` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct MagicTransitOptions {
    /// `max_ttl` property.
    pub max_ttl: Option<i64>,
    /// `packet_type` property.
    pub packet_type: Option<String>,
    /// `packets_per_ttl` property.
    pub packets_per_ttl: Option<i64>,
    /// `port` property.
    pub port: Option<i64>,
    /// `wait_time` property.
    pub wait_time: Option<i64>,
}

/// `MagicTransitPacketCount` type.
pub type MagicTransitPacketCount = i64;

/// `MagicTransitPacketType` type.
pub type MagicTransitPacketType = String;

/// `MagicTransitPacketsLost` type.
pub type MagicTransitPacketsLost = i64;

/// `MagicTransitPacketsPerTtl` type.
pub type MagicTransitPacketsPerTtl = i64;

/// `MagicTransitPacketsSent` type.
pub type MagicTransitPacketsSent = i64;

/// `MagicTransitPacketsTtl` type.
pub type MagicTransitPacketsTtl = i64;

/// `MagicTransitPort` type.
pub type MagicTransitPort = i64;

/// `MagicTransitStdDevRttMs` type.
pub type MagicTransitStdDevRttMs = f64;

/// `MagicTransitTarget` type.
pub type MagicTransitTarget = String;

/// `MagicTransitTargetResult` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct MagicTransitTargetResult {
    /// `colos` property.
    pub colos: Option<Vec<MagicTransitColoResult>>,
    /// `target` property.
    pub target: Option<String>,
}

/// `MagicTransitTargetSummary` type.
pub type MagicTransitTargetSummary = serde_json::Value;

/// `MagicTransitTargets` type.
pub type MagicTransitTargets = Vec<String>;

/// `MagicTransitTracerouteResponseCollection` type.
///
/// Same shape as `super::shared::ApiEnvelope<Option<Vec<MagicTransitTargetResult>>>`.
pub type MagicTransitTracerouteResponseCollection =
    super::shared::ApiEnvelope<Option<Vec<MagicTransitTargetResult>>>;

/// `MagicTransitTracerouteTimeMs` type.
pub type MagicTransitTracerouteTimeMs = i64;

/// `MagicTransitWaitTime` type.
pub type MagicTransitWaitTime = i64;

// =============================================================================
// ARGS TYPES (per-endpoint)
// =============================================================================

/// Arguments for [`diagnostics-traceroute_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct DiagnosticsTracerouteArgs {
    /// Path parameter: `account_id`.
    pub account_id: String,
    /// Request body.
    pub body: DiagnosticsTracerouteRequest,
}

// =============================================================================
// CLIENT FUNCTIONS (per-endpoint)
// =============================================================================

// -----------------------------------------------------------------------------
// POST /accounts/{account_id}/diagnostics/traceroute
// -----------------------------------------------------------------------------

/// POST /accounts/{account_id}/diagnostics/traceroute.
///
/// Takes a client and args, builds the request, optionally applies
/// modifications, then sends it via `send_async().await`.
///
/// # Arguments
///
/// * `client` - HTTP client for making the request: a `DynNetClient`, or an `ApiClient` carrying the `BodyLimits` the response is read under
/// * `args` - Request arguments (path params, query params, body)
/// * `builder_mod` - Optional closure to modify the request builder (e.g., add headers)
///
/// # Example
///
/// ```ignore
/// let response = diagnostics_traceroute_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn diagnostics_traceroute_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &DiagnosticsTracerouteArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<MagicTransitTracerouteResponseCollection>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/accounts/{}/diagnostics/traceroute", args.account_id,);
    let endpoint_url = format!("{}{}", base_url, path);

    let mut builder = PreparedRequestBuilder::post(&endpoint_url)
        .map_err(|e| super::shared::ApiError::RequestBuildFailed(e.to_string()))?;

    builder = builder
        .body_json(&args.body)
        .map_err(|e| super::shared::ApiError::RequestBuildFailed(e.to_string()))?;

    if let Some(f) = builder_mod {
        f(&mut builder);
    }

    super::shared::send_json(client.into(), builder.build()).await
}