scanii 1.3.0

use serde::Deserialize;
use std::collections::HashMap;

/// Result of a synchronous file scan returned by [`crate::ScaniiClient::process`]
/// and [`crate::ScaniiClient::retrieve`].
///
/// `findings` is always populated — empty when the content is clean.
///
/// See <https://scanii.github.io/openapi/v22/>.
// #[allow(deprecated)] suppresses warnings in the serde-generated code that
// constructs this struct, which would otherwise fire on the deprecated `error` field.
#[allow(deprecated)]
#[derive(Debug, Clone, Deserialize, Default)]
pub struct ScaniiProcessingResult {
    /// Resource id assigned by the API.
    pub id: String,

    /// Detection findings, e.g. `content.malicious.local-test-file`. Empty when clean.
    #[serde(default)]
    pub findings: Vec<String>,

    /// SHA-1 checksum of the uploaded content, when reported.
    #[serde(default)]
    pub checksum: Option<String>,

    /// Size of the uploaded content in bytes, when reported.
    #[serde(default)]
    pub content_length: Option<u64>,

    /// MIME type detected by the API, when reported.
    #[serde(default)]
    pub content_type: Option<String>,

    /// Caller-supplied metadata echoed back by the API.
    #[serde(default)]
    pub metadata: HashMap<String, String>,

    /// Server-side creation timestamp (ISO 8601), when reported.
    #[serde(default)]
    pub creation_date: Option<String>,

    /// The server never populates this field on a successful response — server-side
    /// errors arrive as non-2xx responses and are surfaced via [`crate::ScaniiError`].
    /// This was a v2.1 spec artefact; v2.2 drops the field.
    #[deprecated(
        since = "1.2.0",
        note = "The server never populates this field on a successful response — \
                server-side errors arrive as non-2xx responses and are surfaced via \
                ScaniiError. Will be removed in a future major version."
    )]
    #[serde(default)]
    pub error: Option<String>,

    /// `X-Scanii-Request-Id` response header, populated by the client after deserialization.
    #[serde(skip)]
    pub request_id: Option<String>,

    /// `X-Scanii-Host-Id` response header, populated by the client after deserialization.
    #[serde(skip)]
    pub host_id: Option<String>,

    /// `Location` response header, populated by the client after deserialization.
    #[serde(skip)]
    pub resource_location: Option<String>,
}

/// Result of an asynchronous scan submission returned by
/// [`crate::ScaniiClient::process_async`] and [`crate::ScaniiClient::fetch`].
///
/// The actual scan result is fetched later via [`crate::ScaniiClient::retrieve`]
/// or delivered to the supplied `callback` URL.
///
/// See <https://scanii.github.io/openapi/v22/>.
#[derive(Debug, Clone, Deserialize, Default)]
pub struct ScaniiPendingResult {
    /// Resource id assigned by the API; pass to `retrieve` to read the result.
    pub id: String,

    /// `X-Scanii-Request-Id` response header, populated by the client.
    #[serde(skip)]
    pub request_id: Option<String>,

    /// `X-Scanii-Host-Id` response header, populated by the client.
    #[serde(skip)]
    pub host_id: Option<String>,

    /// `Location` response header, populated by the client.
    #[serde(skip)]
    pub resource_location: Option<String>,
}

/// A single processing event within a [`ScaniiTraceResult`].
///
/// See <https://scanii.github.io/openapi/v22/>.
#[derive(Debug, Clone, Deserialize, Default)]
pub struct ScaniiTraceEvent {
    /// ISO 8601 timestamp of when the event occurred.
    pub timestamp: String,

    /// Human-readable description of the processing event.
    pub message: String,
}

/// Ordered processing events for a scan, returned by
/// [`crate::ScaniiClient::retrieve_trace`].
///
/// This is preview API surface — the shape may shift before it is marked stable.
///
/// See <https://scanii.github.io/openapi/v22/>.
#[derive(Debug, Clone, Deserialize, Default)]
pub struct ScaniiTraceResult {
    /// Resource id — maps from the JSON `id` field.
    #[serde(rename = "id")]
    pub resource_id: String,

    /// Ordered list of processing events.
    #[serde(default)]
    pub events: Vec<ScaniiTraceEvent>,

    /// `X-Scanii-Request-Id` response header, populated by the client.
    #[serde(skip)]
    pub request_id: Option<String>,

    /// `X-Scanii-Host-Id` response header, populated by the client.
    #[serde(skip)]
    pub host_id: Option<String>,

    /// `Location` response header, populated by the client.
    #[serde(skip)]
    pub resource_location: Option<String>,
}

/// Short-lived auth token returned by [`crate::ScaniiClient::create_auth_token`]
/// and [`crate::ScaniiClient::retrieve_auth_token`].
///
/// Pass `id` to [`crate::ScaniiClientBuilder::token`] to authenticate using the
/// token instead of API key + secret.
///
/// See <https://scanii.github.io/openapi/v22/>.
#[derive(Debug, Clone, Deserialize, Default)]
pub struct ScaniiAuthToken {
    /// Token id — opaque string used as the auth credential.
    pub id: String,

    /// Server-side creation timestamp (ISO 8601), when reported.
    #[serde(default)]
    pub creation_date: Option<String>,

    /// Token expiry timestamp (ISO 8601), when reported.
    #[serde(default)]
    pub expiration_date: Option<String>,

    /// `X-Scanii-Request-Id` response header, populated by the client.
    #[serde(skip)]
    pub request_id: Option<String>,

    /// `X-Scanii-Host-Id` response header, populated by the client.
    #[serde(skip)]
    pub host_id: Option<String>,

    /// `Location` response header, populated by the client.
    #[serde(skip)]
    pub resource_location: Option<String>,
}