foundation_deployment_docker 0.1.3

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

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

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

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

/// Arguments for [`PutContainerArchive_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct PutContainerArchiveArgs {
    /// Path parameter: `id`.
    pub id: String,
    /// Query parameter: `path`.
    pub path: Option<String>,
    /// Query parameter: `noOverwriteDirNonDir`.
    pub no_overwrite_dir_non_dir: Option<String>,
    /// Query parameter: `copyUIDGID`.
    pub copy_uidgid: Option<String>,
}

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

// -----------------------------------------------------------------------------
// GET /containers/{id}/archive
// -----------------------------------------------------------------------------

/// GET /containers/{id}/archive.
///
/// 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)
///
/// # Response body
///
/// Returned unread, as a stream of byte chunks: read it with `.next().await`.
/// The status is checked before the body is touched.
///
/// # Example
///
/// ```ignore
/// let response = container_archive_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn container_archive_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &ContainerArchiveArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<super::shared::ByteStream>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/containers/{}/archive", 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("path", args.path.as_deref());

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

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

// -----------------------------------------------------------------------------
// PUT /containers/{id}/archive
// -----------------------------------------------------------------------------

/// PUT /containers/{id}/archive.
///
/// 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)
/// * `body` - Request body, sent as-is as `application/x-tar`
/// * `builder_mod` - Optional closure to modify the request builder (e.g., add headers)
///
/// # Example
///
/// ```ignore
/// let response = put_container_archive_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn put_container_archive_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &PutContainerArchiveArgs,
    base_url: &str,
    body: foundation_netio::shared::http::SendSafeBody,
    builder_mod: Option<F>,
) -> Result<ApiResponse<()>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/containers/{}/archive", args.id,);
    let endpoint_url = format!("{}{}", base_url, path);

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

    builder = builder.query("path", args.path.as_deref());
    builder = builder.query(
        "noOverwriteDirNonDir",
        args.no_overwrite_dir_non_dir.as_deref(),
    );
    builder = builder.query("copyUIDGID", args.copy_uidgid.as_deref());

    builder = super::shared::with_raw_body(builder, "application/x-tar", body);

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

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