foundation_deployment_docker 0.1.3

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

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

/// `ConfigReference` type.
///
/// Same shape as `super::shared::NetworkObject`.
pub type ConfigReference = super::shared::NetworkObject;

/// `IPAM` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct IPAM {
    /// `Config` property.
    #[serde(rename = "Config")]
    pub config: Option<Vec<IPAMConfig>>,
    /// `Driver` property.
    #[serde(rename = "Driver")]
    pub driver: Option<String>,
    /// `Options` property.
    #[serde(rename = "Options")]
    pub options: Option<serde_json::Value>,
}

/// `IPAMConfig` type.
///
/// Same shape as `super::shared::IPAMConfigShape`.
pub type IPAMConfig = super::shared::IPAMConfigShape;

/// `IPAMStatus` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct IPAMStatus {
    /// `Subnets` property.
    #[serde(rename = "Subnets")]
    pub subnets: Option<serde_json::Value>,
}

/// `Network` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct Network {
    /// `Attachable` property.
    #[serde(rename = "Attachable")]
    pub attachable: Option<bool>,
    /// `ConfigFrom` property.
    #[serde(rename = "ConfigFrom")]
    pub config_from: Option<ConfigReference>,
    /// `ConfigOnly` property.
    #[serde(rename = "ConfigOnly")]
    pub config_only: Option<bool>,
    /// `Created` property.
    #[serde(rename = "Created")]
    pub created: Option<String>,
    /// `Driver` property.
    #[serde(rename = "Driver")]
    pub driver: Option<String>,
    /// `EnableIPv4` property.
    #[serde(rename = "EnableIPv4")]
    pub enable_i_pv4: Option<bool>,
    /// `EnableIPv6` property.
    #[serde(rename = "EnableIPv6")]
    pub enable_i_pv6: Option<bool>,
    /// `IPAM` property.
    #[serde(rename = "IPAM")]
    pub ipam: Option<IPAM>,
    /// `Id` property.
    #[serde(rename = "Id")]
    pub id: Option<String>,
    /// `Ingress` property.
    #[serde(rename = "Ingress")]
    pub ingress: Option<bool>,
    /// `Internal` property.
    #[serde(rename = "Internal")]
    pub internal: Option<bool>,
    /// `Labels` property.
    #[serde(rename = "Labels")]
    pub labels: Option<serde_json::Value>,
    /// `Name` property.
    #[serde(rename = "Name")]
    pub name: Option<String>,
    /// `Options` property.
    #[serde(rename = "Options")]
    pub options: Option<serde_json::Value>,
    /// `Peers` property.
    #[serde(rename = "Peers")]
    pub peers: Option<Vec<PeerInfo>>,
    /// `Scope` property.
    #[serde(rename = "Scope")]
    pub scope: Option<String>,
}

/// `NetworkInspect` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct NetworkInspect {
    /// `Attachable` property.
    #[serde(rename = "Attachable")]
    pub attachable: Option<bool>,
    /// `ConfigFrom` property.
    #[serde(rename = "ConfigFrom")]
    pub config_from: Option<ConfigReference>,
    /// `ConfigOnly` property.
    #[serde(rename = "ConfigOnly")]
    pub config_only: Option<bool>,
    /// `Created` property.
    #[serde(rename = "Created")]
    pub created: Option<String>,
    /// `Driver` property.
    #[serde(rename = "Driver")]
    pub driver: Option<String>,
    /// `EnableIPv4` property.
    #[serde(rename = "EnableIPv4")]
    pub enable_i_pv4: Option<bool>,
    /// `EnableIPv6` property.
    #[serde(rename = "EnableIPv6")]
    pub enable_i_pv6: Option<bool>,
    /// `Id` property.
    #[serde(rename = "Id")]
    pub id: Option<String>,
    /// `Ingress` property.
    #[serde(rename = "Ingress")]
    pub ingress: Option<bool>,
    /// `Internal` property.
    #[serde(rename = "Internal")]
    pub internal: Option<bool>,
    /// `IPAM` property.
    #[serde(rename = "IPAM")]
    pub ipam: Option<IPAM>,
    /// `Labels` property.
    #[serde(rename = "Labels")]
    pub labels: Option<serde_json::Value>,
    /// `Name` property.
    #[serde(rename = "Name")]
    pub name: Option<String>,
    /// `Options` property.
    #[serde(rename = "Options")]
    pub options: Option<serde_json::Value>,
    /// `Peers` property.
    #[serde(rename = "Peers")]
    pub peers: Option<Vec<PeerInfo>>,
    /// `Scope` property.
    #[serde(rename = "Scope")]
    pub scope: Option<String>,
}

/// `NetworkStatus` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct NetworkStatus {
    /// `IPAM` property.
    #[serde(rename = "IPAM")]
    pub ipam: Option<IPAMStatus>,
}

/// `PeerInfo` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct PeerInfo {
    /// `IP` property.
    #[serde(rename = "IP")]
    pub ip: Option<String>,
    /// `Name` property.
    #[serde(rename = "Name")]
    pub name: Option<String>,
}

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

/// Arguments for [`NetworkList_request`].
///
/// Same shape as `super::shared::FiltersArgs`.
pub type NetworkListArgs = super::shared::FiltersArgs;

/// Arguments for [`NetworkInspect_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct NetworkInspectArgs {
    /// Path parameter: `id`.
    pub id: String,
    /// Query parameter: `verbose`.
    pub verbose: Option<String>,
    /// Query parameter: `scope`.
    pub scope: Option<String>,
}

/// Arguments for [`NetworkDelete_request`].
///
/// Same shape as `super::shared::IdArgs`.
pub type NetworkDeleteArgs = super::shared::IdArgs;

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

// -----------------------------------------------------------------------------
// GET /networks
// -----------------------------------------------------------------------------

/// GET /networks.
///
/// 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_list_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn network_list_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &NetworkListArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<serde_json::Value>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/networks",);
    let endpoint_url = format!("{}{}", base_url, path);

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

    builder = builder.query("filters", args.filters.as_deref());

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

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

// -----------------------------------------------------------------------------
// GET /networks/{id}
// -----------------------------------------------------------------------------

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

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

    builder = builder.query("verbose", args.verbose.as_deref());
    builder = builder.query("scope", args.scope.as_deref());

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

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

// -----------------------------------------------------------------------------
// DELETE /networks/{id}
// -----------------------------------------------------------------------------

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

    let mut builder = PreparedRequestBuilder::delete(&endpoint_url)
        .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
}