foundation_deployment_docker 0.1.3

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

#![cfg(feature = "docker_connect")]
#![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
// =============================================================================

/// `EndpointIPAMConfig` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct EndpointIPAMConfig {
    /// `IPv4Address` property.
    #[serde(rename = "IPv4Address")]
    pub i_pv4_address: Option<String>,
    /// `IPv6Address` property.
    #[serde(rename = "IPv6Address")]
    pub i_pv6_address: Option<String>,
    /// `LinkLocalIPs` property.
    #[serde(rename = "LinkLocalIPs")]
    pub link_local_i_ps: Option<Vec<String>>,
}

/// `EndpointSettings` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct EndpointSettings {
    /// `Aliases` property.
    #[serde(rename = "Aliases")]
    pub aliases: Option<Vec<String>>,
    /// `DNSNames` property.
    #[serde(rename = "DNSNames")]
    pub dns_names: Option<Vec<String>>,
    /// `DriverOpts` property.
    #[serde(rename = "DriverOpts")]
    pub driver_opts: Option<serde_json::Value>,
    /// `EndpointID` property.
    #[serde(rename = "EndpointID")]
    pub endpoint_id: Option<String>,
    /// `Gateway` property.
    #[serde(rename = "Gateway")]
    pub gateway: Option<String>,
    /// `GlobalIPv6Address` property.
    #[serde(rename = "GlobalIPv6Address")]
    pub global_i_pv6_address: Option<String>,
    /// `GlobalIPv6PrefixLen` property.
    #[serde(rename = "GlobalIPv6PrefixLen")]
    pub global_i_pv6_prefix_len: Option<i64>,
    /// `GwPriority` property.
    #[serde(rename = "GwPriority")]
    pub gw_priority: Option<i64>,
    /// `IPAMConfig` property.
    #[serde(rename = "IPAMConfig")]
    pub ipam_config: Option<EndpointIPAMConfig>,
    /// `IPAddress` property.
    #[serde(rename = "IPAddress")]
    pub ip_address: Option<String>,
    /// `IPPrefixLen` property.
    #[serde(rename = "IPPrefixLen")]
    pub ip_prefix_len: Option<i64>,
    /// `IPv6Gateway` property.
    #[serde(rename = "IPv6Gateway")]
    pub i_pv6_gateway: Option<String>,
    /// `Links` property.
    #[serde(rename = "Links")]
    pub links: Option<Vec<String>>,
    /// `MacAddress` property.
    #[serde(rename = "MacAddress")]
    pub mac_address: Option<String>,
    /// `NetworkID` property.
    #[serde(rename = "NetworkID")]
    pub network_id: Option<String>,
}

/// `NetworkConnectRequest` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct NetworkConnectRequest {
    /// `Container` property.
    #[serde(rename = "Container")]
    pub container: String,
    /// `EndpointConfig` property.
    #[serde(rename = "EndpointConfig")]
    pub endpoint_config: Option<EndpointSettings>,
}

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

/// Arguments for [`NetworkConnect_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct NetworkConnectArgs {
    /// Path parameter: `id`.
    pub id: String,
    /// Request body.
    pub body: NetworkConnectRequest,
}

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

// -----------------------------------------------------------------------------
// POST /networks/{id}/connect
// -----------------------------------------------------------------------------

/// POST /networks/{id}/connect.
///
/// 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 = network_connect_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn network_connect_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &NetworkConnectArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<()>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/networks/{}/connect", args.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_without_body(client.into(), builder.build()).await
}