svix 1.95.1

Svix webhooks API client and webhook verification library
Documentation
// this file is @generated
use crate::{error::Result, models::*, Configuration};

#[derive(Default)]
pub struct StatisticsAggregateAppStatsOptions {
    pub idempotency_key: Option<String>,
}

pub struct Statistics<'a> {
    cfg: &'a Configuration,
}

impl<'a> Statistics<'a> {
    pub(super) fn new(cfg: &'a Configuration) -> Self {
        Self { cfg }
    }

    /// Creates a background task to calculate the number of message attempts
    /// (`messageDestinations`) made for all applications in the environment.
    ///
    /// Note that this endpoint is asynchronous. You will need to poll the `Get
    /// Background Task` endpoint to retrieve the results of the operation.
    ///
    /// The completed background task will return a payload like the following:
    /// ```json
    /// {
    ///   "id": "qtask_33qe39Stble9Rn3ZxFrqL5ZSsjT",
    ///   "status": "finished",
    ///   "task": "application.stats",
    ///   "data": {
    ///     "appStats": [
    ///       {
    ///         "messageDestinations": 2,
    ///         "appId": "app_33W1An2Zz5cO9SWbhHsYyDmVC6m",
    ///         "appUid": null
    ///       }
    ///     ]
    ///   }
    /// }
    /// ```
    pub async fn aggregate_app_stats(
        &self,
        app_usage_stats_in: AppUsageStatsIn,
        options: Option<StatisticsAggregateAppStatsOptions>,
    ) -> Result<AppUsageStatsOut> {
        let StatisticsAggregateAppStatsOptions { idempotency_key } = options.unwrap_or_default();

        crate::request::Request::new(http1::Method::POST, "/api/v1/stats/usage/app")
            .with_optional_header_param("idempotency-key", idempotency_key)
            .with_body_param(app_usage_stats_in)
            .execute(self.cfg)
            .await
    }

    /// Creates a background task to calculate the listed event types for all
    /// apps in the organization.
    ///
    /// Note that this endpoint is asynchronous. You will need to poll the `Get
    /// Background Task` endpoint to retrieve the results of the operation.
    ///
    /// The completed background task will return a payload like the following:
    /// ```json
    /// {
    ///   "id": "qtask_33qe39Stble9Rn3ZxFrqL5ZSsjT",
    ///   "status": "finished",
    ///   "task": "event-type.aggregate",
    ///   "data": {
    ///     "event_types": [
    ///       {
    ///         "appId": "app_33W1An2Zz5cO9SWbhHsYyDmVC6m",
    ///         "explicitlySubscribedEventTypes": ["user.signup", "user.deleted"],
    ///         "hasCatchAllEndpoint": false
    ///       }
    ///     ]
    ///   }
    /// }
    /// ```
    pub async fn aggregate_event_types(&self) -> Result<AggregateEventTypesOut> {
        crate::request::Request::new(http1::Method::PUT, "/api/v1/stats/usage/event-types")
            .execute(self.cfg)
            .await
    }
}