afinsp-rs 0.1.1

AFINSP Billing SDK for Rust
Documentation 
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

// this file is @generated
#[allow(unused_imports)]
use crate::{error::Result, models::*, Configuration};

#[derive(Default)]
pub struct UsageGetCustomerUsageOptions {
    pub start_date: String,

    pub end_date: String,

    pub metric_id: Option<BillableMetricId>,
}

#[derive(Default)]
pub struct UsageGetSubscriptionUsageOptions {
    pub start_date: Option<String>,

    pub end_date: Option<String>,

    pub metric_id: Option<BillableMetricId>,
}

#[derive(Default)]
pub struct UsageGetUsageSummaryOptions {
    pub start_date: String,

    pub end_date: String,

    pub metric_id: Option<BillableMetricId>,
}

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

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

    /// Retrieve aggregated usage data for a customer over a specified period.
    pub async fn get_customer_usage(
        &self,
        customer_id: String,
        options: UsageGetCustomerUsageOptions,
    ) -> Result<crate::models::UsageResponse> {
        let UsageGetCustomerUsageOptions {
            start_date,
            end_date,
            metric_id,
        } = options;

        crate::request::Request::new(http1::Method::GET, "/api/v1/usage/customer/{customer_id}")
            .with_path_param("customer_id", customer_id)
            .with_query_param("start_date", start_date)
            .with_query_param("end_date", end_date)
            .with_optional_query_param("metric_id", metric_id)
            .execute(self.cfg)
            .await
    }

    /// Retrieve aggregated usage data for a subscription's usage-based components.
    /// If start_date/end_date are omitted, defaults to the current billing period.
    pub async fn get_subscription_usage(
        &self,
        subscription_id: String,
        options: Option<UsageGetSubscriptionUsageOptions>,
    ) -> Result<crate::models::UsageResponse> {
        let UsageGetSubscriptionUsageOptions {
            start_date,
            end_date,
            metric_id,
        } = options.unwrap_or_default();

        crate::request::Request::new(
            http1::Method::GET,
            "/api/v1/usage/subscription/{subscription_id}",
        )
        .with_path_param("subscription_id", 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)
        .execute(self.cfg)
        .await
    }

    /// Retrieve aggregated usage data across all customers for the tenant.
    pub async fn get_usage_summary(
        &self,
        options: UsageGetUsageSummaryOptions,
    ) -> Result<crate::models::UsageResponse> {
        let UsageGetUsageSummaryOptions {
            start_date,
            end_date,
            metric_id,
        } = options;

        crate::request::Request::new(http1::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)
            .execute(self.cfg)
            .await
    }
}