foundation_deployment_cloudflare 0.1.3

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

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

/// `CloudflareIpsCloudflareIpDetailsResponse` type.
///
/// Same shape as `super::shared::ApiEnvelope<Option<serde_json::Value>>`.
pub type CloudflareIpsCloudflareIpDetailsResponse =
    super::shared::ApiEnvelope<Option<serde_json::Value>>;

/// `PublicIpApiResponseCommon` type.
///
/// Same shape as `super::shared::ErrorsMessagesSuccessObject`.
pub type PublicIpApiResponseCommon = super::shared::ErrorsMessagesSuccessObject;

/// `PublicIpApiResponseSingle` type.
///
/// Same shape as `super::shared::ErrorsMessagesSuccessObject`.
pub type PublicIpApiResponseSingle = super::shared::ErrorsMessagesSuccessObject;

/// `PublicIpMessages` type.
pub type PublicIpMessages = Vec<std::collections::HashMap<String, serde_json::Value>>;

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

/// Arguments for [`cloudflare-ips-cloudflare-ip-details_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct CloudflareIpsCloudflareIpDetailsArgs {
    /// Query parameter: `networks`.
    pub networks: Option<String>,
}

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

// -----------------------------------------------------------------------------
// GET /ips
// -----------------------------------------------------------------------------

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

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

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