foundation_deployment_docker 0.1.3

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

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

/// `BuildPruneResponse` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct BuildPruneResponse {
    /// `CachesDeleted` property.
    #[serde(rename = "CachesDeleted")]
    pub caches_deleted: Option<Vec<String>>,
    /// `SpaceReclaimed` property.
    #[serde(rename = "SpaceReclaimed")]
    pub space_reclaimed: Option<i64>,
}

/// `ContainerPruneResponse` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct ContainerPruneResponse {
    /// `ContainersDeleted` property.
    #[serde(rename = "ContainersDeleted")]
    pub containers_deleted: Option<Vec<String>>,
    /// `SpaceReclaimed` property.
    #[serde(rename = "SpaceReclaimed")]
    pub space_reclaimed: Option<i64>,
}

/// `ImageDeleteResponseItem` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct ImageDeleteResponseItem {
    /// `Deleted` property.
    #[serde(rename = "Deleted")]
    pub deleted: Option<String>,
    /// `Untagged` property.
    #[serde(rename = "Untagged")]
    pub untagged: Option<String>,
}

/// `ImagePruneResponse` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct ImagePruneResponse {
    /// `ImagesDeleted` property.
    #[serde(rename = "ImagesDeleted")]
    pub images_deleted: Option<Vec<ImageDeleteResponseItem>>,
    /// `SpaceReclaimed` property.
    #[serde(rename = "SpaceReclaimed")]
    pub space_reclaimed: Option<i64>,
}

/// `NetworkPruneResponse` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct NetworkPruneResponse {
    /// `NetworksDeleted` property.
    #[serde(rename = "NetworksDeleted")]
    pub networks_deleted: Option<Vec<String>>,
}

/// `VolumePruneResponse` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct VolumePruneResponse {
    /// `SpaceReclaimed` property.
    #[serde(rename = "SpaceReclaimed")]
    pub space_reclaimed: Option<i64>,
    /// `VolumesDeleted` property.
    #[serde(rename = "VolumesDeleted")]
    pub volumes_deleted: Option<Vec<String>>,
}

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

/// Arguments for [`BuildPrune_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct BuildPruneArgs {
    /// Query parameter: `reserved-space`.
    pub reserved_space: Option<String>,
    /// Query parameter: `max-used-space`.
    pub max_used_space: Option<String>,
    /// Query parameter: `min-free-space`.
    pub min_free_space: Option<String>,
    /// Query parameter: `all`.
    pub all: Option<String>,
    /// Query parameter: `filters`.
    pub filters: Option<String>,
}

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

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

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

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

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

// -----------------------------------------------------------------------------
// POST /build/prune
// -----------------------------------------------------------------------------

/// POST /build/prune.
///
/// 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 = build_prune_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn build_prune_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &BuildPruneArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<BuildPruneResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/build/prune",);
    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.query("reserved-space", args.reserved_space.as_deref());
    builder = builder.query("max-used-space", args.max_used_space.as_deref());
    builder = builder.query("min-free-space", args.min_free_space.as_deref());
    builder = builder.query("all", args.all.as_deref());
    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
}

// -----------------------------------------------------------------------------
// POST /containers/prune
// -----------------------------------------------------------------------------

/// POST /containers/prune.
///
/// 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 = container_prune_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn container_prune_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &ContainerPruneArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<ContainerPruneResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/containers/prune",);
    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.query("filters", args.filters.as_deref());

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

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

// -----------------------------------------------------------------------------
// POST /images/prune
// -----------------------------------------------------------------------------

/// POST /images/prune.
///
/// 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 = image_prune_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn image_prune_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &ImagePruneArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<ImagePruneResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/images/prune",);
    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.query("filters", args.filters.as_deref());

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

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

// -----------------------------------------------------------------------------
// POST /networks/prune
// -----------------------------------------------------------------------------

/// POST /networks/prune.
///
/// 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_prune_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn network_prune_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &NetworkPruneArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<NetworkPruneResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/networks/prune",);
    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.query("filters", args.filters.as_deref());

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

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

// -----------------------------------------------------------------------------
// POST /volumes/prune
// -----------------------------------------------------------------------------

/// POST /volumes/prune.
///
/// 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 = volume_prune_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn volume_prune_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &VolumePruneArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<VolumePruneResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/volumes/prune",);
    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.query("filters", args.filters.as_deref());

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

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