foundation_deployment_cloudflare 0.1.3

Cloudflare API v4 client — DNS records, zones, certificates
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
//! Auto-generated API module for cloudflare security_center.
//!
//! Generated by `cargo run --bin ewe_platform gen_api`.
//! DO NOT EDIT MANUALLY.
//!
//! Feature flag: `cloudflare_security_center `

#![cfg(feature = "cloudflare_security_center")]
#![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};

// Import shared types used by this module
use super::shared::SecurityCenterApiResponseCommon;
use super::shared::SecurityCenterValueCountsResponse;

use super::shared::ApiResponse;

// =============================================================================
// TYPE DECLARATIONS
// =============================================================================

/// `ArchiveSecurityCenterInsightRequest` type.
///
/// Same shape as `super::shared::DismissObject`.
pub type ArchiveSecurityCenterInsightRequest = super::shared::DismissObject;

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

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

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

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

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

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

/// Arguments for [`get-security-center-insights_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct GetSecurityCenterInsightsArgs {
    /// Path parameter: `account_id`.
    pub account_id: String,
    /// Query parameter: `dismissed`.
    pub dismissed: Option<String>,
    /// Query parameter: `issue_class`.
    pub issue_class: Option<String>,
    /// Query parameter: `issue_type`.
    pub issue_type: Option<String>,
    /// Query parameter: `product`.
    pub product: Option<String>,
    /// Query parameter: `severity`.
    pub severity: Option<String>,
    /// Query parameter: `subject`.
    pub subject: Option<String>,
    /// Query parameter: `issue_class~neq`.
    pub issue_class_neq: Option<String>,
    /// Query parameter: `issue_type~neq`.
    pub issue_type_neq: Option<String>,
    /// Query parameter: `product~neq`.
    pub product_neq: Option<String>,
    /// Query parameter: `severity~neq`.
    pub severity_neq: Option<String>,
    /// Query parameter: `subject~neq`.
    pub subject_neq: Option<String>,
    /// Query parameter: `page`.
    pub page: Option<String>,
    /// Query parameter: `per_page`.
    pub per_page: Option<String>,
}

/// Arguments for [`get-security-center-insight-counts-by-class_request`].
///
/// Same shape as `super::shared::GetSecurityCenterInsightCountsByClassArgsShape`.
pub type GetSecurityCenterInsightCountsByClassArgs =
    super::shared::GetSecurityCenterInsightCountsByClassArgsShape;

/// Arguments for [`get-security-center-insight-counts-by-severity_request`].
///
/// Same shape as `super::shared::GetSecurityCenterInsightCountsByClassArgsShape`.
pub type GetSecurityCenterInsightCountsBySeverityArgs =
    super::shared::GetSecurityCenterInsightCountsByClassArgsShape;

/// Arguments for [`get-security-center-insight-counts-by-type_request`].
///
/// Same shape as `super::shared::GetSecurityCenterInsightCountsByClassArgsShape`.
pub type GetSecurityCenterInsightCountsByTypeArgs =
    super::shared::GetSecurityCenterInsightCountsByClassArgsShape;

/// Arguments for [`get-security-center-insight-context_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct GetSecurityCenterInsightContextArgs {
    /// Path parameter: `account_id`.
    pub account_id: String,
    /// Path parameter: `issue_id`.
    pub issue_id: String,
}

/// Arguments for [`archive-security-center-insight_request`].
#[derive(Debug, Clone, Default, Serialize, JsonHash)]
pub struct ArchiveSecurityCenterInsightArgs {
    /// Path parameter: `account_id`.
    pub account_id: String,
    /// Path parameter: `issue_id`.
    pub issue_id: String,
    /// Request body.
    pub body: ArchiveSecurityCenterInsightRequest,
}

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

// -----------------------------------------------------------------------------
// GET /accounts/{account_id}/security-center/insights
// -----------------------------------------------------------------------------

/// GET /accounts/{account_id}/security-center/insights.
///
/// 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 = get_security_center_insights_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn get_security_center_insights_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &GetSecurityCenterInsightsArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<GetSecurityCenterInsightsResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!("/accounts/{}/security-center/insights", args.account_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("dismissed", args.dismissed.as_deref());
    builder = builder.query("issue_class", args.issue_class.as_deref());
    builder = builder.query("issue_type", args.issue_type.as_deref());
    builder = builder.query("product", args.product.as_deref());
    builder = builder.query("severity", args.severity.as_deref());
    builder = builder.query("subject", args.subject.as_deref());
    builder = builder.query("issue_class~neq", args.issue_class_neq.as_deref());
    builder = builder.query("issue_type~neq", args.issue_type_neq.as_deref());
    builder = builder.query("product~neq", args.product_neq.as_deref());
    builder = builder.query("severity~neq", args.severity_neq.as_deref());
    builder = builder.query("subject~neq", args.subject_neq.as_deref());
    builder = builder.query("page", args.page.as_deref());
    builder = builder.query("per_page", args.per_page.as_deref());

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

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

// -----------------------------------------------------------------------------
// GET /accounts/{account_id}/security-center/insights/class
// -----------------------------------------------------------------------------

/// GET /accounts/{account_id}/security-center/insights/class.
///
/// 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 = get_security_center_insight_counts_by_class_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn get_security_center_insight_counts_by_class_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &GetSecurityCenterInsightCountsByClassArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<SecurityCenterValueCountsResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!(
        "/accounts/{}/security-center/insights/class",
        args.account_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("dismissed", args.dismissed.as_deref());
    builder = builder.query("issue_class", args.issue_class.as_deref());
    builder = builder.query("issue_type", args.issue_type.as_deref());
    builder = builder.query("product", args.product.as_deref());
    builder = builder.query("severity", args.severity.as_deref());
    builder = builder.query("subject", args.subject.as_deref());
    builder = builder.query("issue_class~neq", args.issue_class_neq.as_deref());
    builder = builder.query("issue_type~neq", args.issue_type_neq.as_deref());
    builder = builder.query("product~neq", args.product_neq.as_deref());
    builder = builder.query("severity~neq", args.severity_neq.as_deref());
    builder = builder.query("subject~neq", args.subject_neq.as_deref());

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

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

// -----------------------------------------------------------------------------
// GET /accounts/{account_id}/security-center/insights/severity
// -----------------------------------------------------------------------------

/// GET /accounts/{account_id}/security-center/insights/severity.
///
/// 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 = get_security_center_insight_counts_by_severity_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn get_security_center_insight_counts_by_severity_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &GetSecurityCenterInsightCountsBySeverityArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<SecurityCenterValueCountsResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!(
        "/accounts/{}/security-center/insights/severity",
        args.account_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("dismissed", args.dismissed.as_deref());
    builder = builder.query("issue_class", args.issue_class.as_deref());
    builder = builder.query("issue_type", args.issue_type.as_deref());
    builder = builder.query("product", args.product.as_deref());
    builder = builder.query("severity", args.severity.as_deref());
    builder = builder.query("subject", args.subject.as_deref());
    builder = builder.query("issue_class~neq", args.issue_class_neq.as_deref());
    builder = builder.query("issue_type~neq", args.issue_type_neq.as_deref());
    builder = builder.query("product~neq", args.product_neq.as_deref());
    builder = builder.query("severity~neq", args.severity_neq.as_deref());
    builder = builder.query("subject~neq", args.subject_neq.as_deref());

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

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

// -----------------------------------------------------------------------------
// GET /accounts/{account_id}/security-center/insights/type
// -----------------------------------------------------------------------------

/// GET /accounts/{account_id}/security-center/insights/type.
///
/// 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 = get_security_center_insight_counts_by_type_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn get_security_center_insight_counts_by_type_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &GetSecurityCenterInsightCountsByTypeArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<SecurityCenterValueCountsResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!(
        "/accounts/{}/security-center/insights/type",
        args.account_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("dismissed", args.dismissed.as_deref());
    builder = builder.query("issue_class", args.issue_class.as_deref());
    builder = builder.query("issue_type", args.issue_type.as_deref());
    builder = builder.query("product", args.product.as_deref());
    builder = builder.query("severity", args.severity.as_deref());
    builder = builder.query("subject", args.subject.as_deref());
    builder = builder.query("issue_class~neq", args.issue_class_neq.as_deref());
    builder = builder.query("issue_type~neq", args.issue_type_neq.as_deref());
    builder = builder.query("product~neq", args.product_neq.as_deref());
    builder = builder.query("severity~neq", args.severity_neq.as_deref());
    builder = builder.query("subject~neq", args.subject_neq.as_deref());

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

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

// -----------------------------------------------------------------------------
// GET /accounts/{account_id}/security-center/insights/{issue_id}/context
// -----------------------------------------------------------------------------

/// GET /accounts/{account_id}/security-center/insights/{issue_id}/context.
///
/// 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 = get_security_center_insight_context_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn get_security_center_insight_context_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &GetSecurityCenterInsightContextArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<GetSecurityCenterInsightContextResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!(
        "/accounts/{}/security-center/insights/{}/context",
        args.account_id, args.issue_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
}

// -----------------------------------------------------------------------------
// PUT /accounts/{account_id}/security-center/insights/{issue_id}/dismiss
// -----------------------------------------------------------------------------

/// PUT /accounts/{account_id}/security-center/insights/{issue_id}/dismiss.
///
/// 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 = archive_security_center_insight_request(client.clone(), &args, Some(|b: &mut PreparedRequestBuilder| {
///     b.header("X-Custom-Header", "value");
/// })).await?;
/// ```
pub async fn archive_security_center_insight_request<F>(
    client: impl Into<super::shared::ApiClient>,
    args: &ArchiveSecurityCenterInsightArgs,
    base_url: &str,
    builder_mod: Option<F>,
) -> Result<ApiResponse<ArchiveSecurityCenterInsightResponse>, super::shared::ApiError>
where
    F: FnOnce(&mut PreparedRequestBuilder),
{
    let path = format!(
        "/accounts/{}/security-center/insights/{}/dismiss",
        args.account_id, args.issue_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
        .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
}