meteroid-rs 0.31.4

Official Rust SDK for Meteroid, the open-source billing platform: subscriptions, invoicing, usage-based billing and webhooks.
Documentation
// this file is @generated
#![allow(clippy::doc_markdown, clippy::default_trait_access)]

#[allow(unused_imports, clippy::wildcard_imports)]
use crate::{error::Result, models::*, Configuration};

/// Query and header parameters of [`Usage::retrieve_subscription`].
#[derive(Clone, Debug, Default)]
#[non_exhaustive]
pub struct UsageRetrieveSubscriptionOptions {
    /// The `start_date` query parameter.
    pub start_date: Option<chrono::NaiveDate>,
    /// The `end_date` query parameter.
    pub end_date: Option<chrono::NaiveDate>,
    /// The `metric_id` query parameter.
    pub metric_id: Option<BillableMetricId>,
}

impl UsageRetrieveSubscriptionOptions {
    /// Options with no parameter set.
    #[must_use]
    pub fn new() -> Self {
        Self {
            start_date: None,
            end_date: None,
            metric_id: None,
        }
    }

    /// Sets the `start_date` query parameter.
    #[must_use]
    pub fn start_date(mut self, start_date: impl Into<chrono::NaiveDate>) -> Self {
        self.start_date = Some(start_date.into());
        self
    }

    /// Sets the `start_date` query parameter, or unsets it with `None`.
    #[must_use]
    pub fn maybe_start_date(mut self, start_date: Option<chrono::NaiveDate>) -> Self {
        self.start_date = start_date;
        self
    }

    /// Sets the `end_date` query parameter.
    #[must_use]
    pub fn end_date(mut self, end_date: impl Into<chrono::NaiveDate>) -> Self {
        self.end_date = Some(end_date.into());
        self
    }

    /// Sets the `end_date` query parameter, or unsets it with `None`.
    #[must_use]
    pub fn maybe_end_date(mut self, end_date: Option<chrono::NaiveDate>) -> Self {
        self.end_date = end_date;
        self
    }

    /// Sets the `metric_id` query parameter.
    #[must_use]
    pub fn metric_id(mut self, metric_id: impl Into<BillableMetricId>) -> Self {
        self.metric_id = Some(metric_id.into());
        self
    }

    /// Sets the `metric_id` query parameter, or unsets it with `None`.
    #[must_use]
    pub fn maybe_metric_id(mut self, metric_id: Option<BillableMetricId>) -> Self {
        self.metric_id = metric_id;
        self
    }
}

/// Query and header parameters of [`Usage::retrieve_summary`], built
/// with the required ones by [`new`](Self::new).
#[derive(Clone, Debug)]
#[non_exhaustive]
pub struct UsageRetrieveSummaryOptions {
    /// The `start_date` query parameter.
    pub start_date: chrono::NaiveDate,
    /// The `end_date` query parameter.
    pub end_date: chrono::NaiveDate,
    /// The `metric_id` query parameter.
    pub metric_id: Option<BillableMetricId>,
}

impl UsageRetrieveSummaryOptions {
    /// Options with the required parameters set.
    #[must_use]
    pub fn new(
        start_date: impl Into<chrono::NaiveDate>,
        end_date: impl Into<chrono::NaiveDate>,
    ) -> Self {
        Self {
            start_date: start_date.into(),
            end_date: end_date.into(),
            metric_id: None,
        }
    }

    /// Sets the `metric_id` query parameter.
    #[must_use]
    pub fn metric_id(mut self, metric_id: impl Into<BillableMetricId>) -> Self {
        self.metric_id = Some(metric_id.into());
        self
    }

    /// Sets the `metric_id` query parameter, or unsets it with `None`.
    #[must_use]
    pub fn maybe_metric_id(mut self, metric_id: Option<BillableMetricId>) -> Self {
        self.metric_id = metric_id;
        self
    }
}

/// The usage API, from the client's
/// [`usage`](crate::api::Meteroid::usage).
#[derive(Clone)]
pub struct Usage {
    cfg: std::sync::Arc<Configuration>,
    options: crate::api::RequestOptions,
}

impl std::fmt::Debug for Usage {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("Usage")
            .field("options", &self.options)
            .finish_non_exhaustive()
    }
}

impl Usage {
    pub(super) fn new(cfg: std::sync::Arc<Configuration>) -> Self {
        Self {
            cfg,
            options: crate::api::RequestOptions::default(),
        }
    }

    /// Applies `options` (headers, timeout, retries, idempotency key) to the calls made
    /// through the returned value.
    #[must_use]
    pub fn with_options(mut self, options: crate::api::RequestOptions) -> Self {
        self.options = options;
        self
    }

    /// The customer API, with the options of this one.
    #[must_use]
    pub fn customer(&self) -> super::UsageCustomer {
        super::UsageCustomer::new(self.cfg.clone()).with_options(self.options.clone())
    }

    /// Get subscription usage
    ///
    /// Retrieve aggregated usage data for a subscription's usage-based components.
    /// If start_date/end_date are omitted, defaults to the current billing period, and the response
    /// then carries the running total (beta): what each metric's usage adds so far to the next invoice,
    /// and what they add up to, before discounts and credits. That reading is shared for up to 30
    /// seconds (see `computed_at`). Counts towards the usage cost reads' rate limit.
    ///
    /// `GET /api/v1/usage/subscription/{subscription_id}`.
    ///
    /// # Errors
    ///
    /// An API error's body is [`RestErrorResponse`](crate::models::RestErrorResponse) (401, 404, 429, 500).
    pub fn retrieve_subscription(
        &self,
        subscription_id: impl Into<crate::models::SubscriptionId>,
        options: impl Into<Option<UsageRetrieveSubscriptionOptions>>,
    ) -> crate::api::Call<crate::models::UsageResponse> {
        let UsageRetrieveSubscriptionOptions {
            start_date,
            end_date,
            metric_id,
        } = options.into().unwrap_or_default();

        crate::request::Request::new(
            http::Method::GET,
            "/api/v1/usage/subscription/{subscription_id}",
        )
        .with_path_param(
            "subscription_id",
            Into::<crate::models::SubscriptionId>::into(subscription_id),
        )
        .with_optional_query_param("start_date", start_date)
        .with_optional_query_param("end_date", end_date)
        .with_optional_query_param("metric_id", metric_id)
        .with_options(&self.options)
        .json(&self.cfg)
    }

    /// Get usage summary
    ///
    /// Retrieve aggregated usage data across all customers for the tenant.
    ///
    /// `GET /api/v1/usage/summary`.
    ///
    /// # Errors
    ///
    /// An API error's body is [`RestErrorResponse`](crate::models::RestErrorResponse) (401, 429, 500).
    pub fn retrieve_summary(
        &self,
        options: UsageRetrieveSummaryOptions,
    ) -> crate::api::Call<crate::models::UsageResponse> {
        let UsageRetrieveSummaryOptions {
            start_date,
            end_date,
            metric_id,
        } = options;

        crate::request::Request::new(http::Method::GET, "/api/v1/usage/summary")
            .with_query_param("start_date", &start_date)
            .with_query_param("end_date", &end_date)
            .with_optional_query_param("metric_id", metric_id)
            .with_options(&self.options)
            .json(&self.cfg)
    }
}