foundation_deployment_cloudflare 0.1.3

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

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

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

/// `MqApiV4Message` type.
pub type MqApiV4Message = Vec<String>;

/// `MqApiV4Success` type.
///
/// Same shape as `super::shared::ErrorsMessagesSuccessObject2`.
pub type MqApiV4Success = super::shared::ErrorsMessagesSuccessObject2;

/// `MqBatchSize` type.
pub type MqBatchSize = f64;

/// `MqConsumerResponse` type.
pub type MqConsumerResponse = serde_json::Value;

/// `MqHttpConsumerResponse` type.
///
/// Same shape as `super::shared::MqHttpConsumerResponseShape`.
pub type MqHttpConsumerResponse = super::shared::MqHttpConsumerResponseShape;

/// `MqIdentifier` type.
pub type MqIdentifier = String;

/// `MqMaxConcurrency` type.
pub type MqMaxConcurrency = f64;

/// `MqMaxRetries` type.
pub type MqMaxRetries = f64;

/// `MqMaxWaitTime` type.
pub type MqMaxWaitTime = f64;

/// `MqProducer` type.
pub type MqProducer = serde_json::Value;

/// `MqQueue` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct MqQueue {
    /// `consumers` property.
    pub consumers: Option<Vec<serde_json::Value>>,
    /// `consumers_total_count` property.
    pub consumers_total_count: Option<f64>,
    /// `created_on` property.
    pub created_on: Option<String>,
    /// `modified_on` property.
    pub modified_on: Option<String>,
    /// `producers` property.
    pub producers: Option<Vec<serde_json::Value>>,
    /// `producers_total_count` property.
    pub producers_total_count: Option<f64>,
    /// `queue_id` property.
    pub queue_id: Option<String>,
    /// `queue_name` property.
    pub queue_name: Option<String>,
    /// `settings` property.
    pub settings: Option<MqQueueSettings>,
}

/// `MqQueueName` type.
pub type MqQueueName = String;

/// `MqQueueSettings` type.
///
/// Same shape as `super::shared::DeliveryDelayDeliveryPausedMessageRetentionPeriodObject`.
pub type MqQueueSettings = super::shared::DeliveryDelayDeliveryPausedMessageRetentionPeriodObject;

/// `MqR2Producer` type.
///
/// Same shape as `super::shared::BucketNameTypeObject`.
pub type MqR2Producer = super::shared::BucketNameTypeObject;

/// `MqRetryDelay` type.
pub type MqRetryDelay = f64;

/// `MqScriptName` type.
pub type MqScriptName = String;

/// `MqVisibilityTimeout` type.
pub type MqVisibilityTimeout = f64;

/// `MqWorkerConsumerResponse` type.
///
/// Same shape as `super::shared::MqWorkerConsumerResponseShape`.
pub type MqWorkerConsumerResponse = super::shared::MqWorkerConsumerResponseShape;

/// `MqWorkerProducer` type.
///
/// Same shape as `super::shared::ScriptTypeObject`.
pub type MqWorkerProducer = super::shared::ScriptTypeObject;

/// `QueuesPurgeGetResponse` type.
///
/// Same shape as `super::shared::ApiEnvelope3<Option<std::collections::HashMap<String, serde_json::Value>>>`.
pub type QueuesPurgeGetResponse =
    super::shared::ApiEnvelope3<Option<std::collections::HashMap<String, serde_json::Value>>>;

/// `QueuesPurgeRequest` type.
#[derive(Debug, Clone, Default, Serialize, Deserialize, JsonHash)]
pub struct QueuesPurgeRequest {
    /// `delete_messages_permanently` property.
    pub delete_messages_permanently: Option<bool>,
}

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

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

/// Arguments for [`queues-purge-get_request`].
///
/// Same shape as `super::shared::QueueIdAccountIdArgs`.
pub type QueuesPurgeGetArgs = super::shared::QueueIdAccountIdArgs;

/// Arguments for [`queues-purge_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct QueuesPurgeArgs {
    /// Path parameter: `queue_id`.
    pub queue_id: String,
    /// Path parameter: `account_id`.
    pub account_id: String,
    /// Request body.
    pub body: QueuesPurgeRequest,
}

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

// -----------------------------------------------------------------------------
// GET /accounts/{account_id}/queues/{queue_id}/purge
// -----------------------------------------------------------------------------

/// GET /accounts/{account_id}/queues/{queue_id}/purge.
///
/// 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 = queues_purge_get_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn queues_purge_get_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &QueuesPurgeGetArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<QueuesPurgeGetResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!(
        "/accounts/{}/queues/{}/purge",
        args.account_id, args.queue_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()))?;

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

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

// -----------------------------------------------------------------------------
// POST /accounts/{account_id}/queues/{queue_id}/purge
// -----------------------------------------------------------------------------

/// POST /accounts/{account_id}/queues/{queue_id}/purge.
///
/// 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 = queues_purge_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn queues_purge_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &QueuesPurgeArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<QueuesPurgeResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!(
        "/accounts/{}/queues/{}/purge",
        args.account_id, args.queue_id,
    );
    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
        .body_json(&args.body)
        .map_err(|e| super::shared::ApiError::RequestBuildFailed(e.to_string()))?;

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

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