foundation_deployment_docker 0.1.3

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

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

/// `EventActor` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct EventActor {
    /// `Attributes` property.
    #[serde(rename = "Attributes")]
    pub attributes: Option<serde_json::Value>,
    /// `ID` property.
    #[serde(rename = "ID")]
    pub id: Option<String>,
}

/// `EventMessage` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct EventMessage {
    /// `Action` property.
    #[serde(rename = "Action")]
    pub action: Option<String>,
    /// `Actor` property.
    #[serde(rename = "Actor")]
    pub actor: Option<EventActor>,
    /// `Type` property.
    #[serde(rename = "Type")]
    pub r#type: Option<String>,
    /// `scope` property.
    pub scope: Option<String>,
    /// `time` property.
    pub time: Option<i64>,
    /// `timeNano` property.
    #[serde(rename = "timeNano")]
    pub time_nano: Option<i64>,
}

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

/// Arguments for [`SystemEvents_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct SystemEventsArgs {
    /// Query parameter: `since`.
    pub since: Option<String>,
    /// Query parameter: `until`.
    pub until: Option<String>,
    /// Query parameter: `filters`.
    pub filters: Option<String>,
}

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

// -----------------------------------------------------------------------------
// GET /events
// -----------------------------------------------------------------------------

/// GET /events.
///
/// 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 `EventMessage`, one per line: read it with `.next().await`.
/// The status is checked before the body is touched.
///
/// # Example
///
/// ```ignore
/// let response = system_events_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn system_events_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &SystemEventsArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<super::shared::JsonLinesStream<EventMessage>>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/events",);
    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("since", args.since.as_deref());
    builder = builder.query("until", args.until.as_deref());
    builder = builder.query("filters", args.filters.as_deref());

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

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