support fetching chart data, rename reports -> user_insights

Author: mrmauer

src/apis/mod.rs

@@ -75,7 +75,7 @@ pub mod auth_service_api;
 pub mod employee_service_api;
 pub mod mfa_service_api;
 pub mod org_service_api;
-pub(crate) mod report_service_api;
+pub(crate) mod user_insights_service_api;
 pub mod user_service_api;
 
 pub mod configuration;

src/apis/report_service_api.rs src/apis/user_insights_service_api.rssrc/apis/report_service_api.rs renamed to src/apis/user_insights_service_api.rs

@@ -12,15 +12,16 @@ use reqwest;
 
 use super::{configuration, Error};
 use crate::apis::ResponseContent;
-use crate::models::reports::{
-    FetchReportQuery, OrgReport, OrgReportType, UserReportPage, UserReportType,
+use crate::models::user_insights::{
+    ChartData, ChartMetric, FetchChartDataQuery, FetchReportQuery, OrgReport, OrgReportType,
+    UserReportPage, UserReportType,
 };
 use crate::propelauth::auth::AUTH_HOSTNAME_HEADER;
 
 /// struct for typed errors of methods [`fetch_user_report`] or [`fetch_org_report`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
-pub enum FetchReportRequestError {
+pub enum FetchUserInsightsDataRequestError {
     Status401(serde_json::Value),
     Status400(serde_json::Value),
     Status429(serde_json::Value),
@@ -31,7 +32,7 @@ pub(crate) async fn fetch_user_report(
     configuration: &configuration::Configuration,
     report_key: UserReportType,
     params: FetchReportQuery,
-) -> Result<UserReportPage, Error<FetchReportRequestError>> {
+) -> Result<UserReportPage, Error<FetchUserInsightsDataRequestError>> {
     let local_var_configuration = configuration;
 
     let local_var_client = &local_var_configuration.client;
@@ -67,9 +68,9 @@ pub(crate) async fn fetch_user_report(
     if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
         serde_json::from_str(&local_var_content).map_err(Error::from)
     } else {
-        let local_var_entity: Option<FetchReportRequestError> =
+        let local_var_entity: Option<FetchUserInsightsDataRequestError> =
             serde_json::from_str(&local_var_content).ok();
-        let local_var_error: crate::apis::ResponseContent<FetchReportRequestError> =
+        let local_var_error: crate::apis::ResponseContent<FetchUserInsightsDataRequestError> =
             ResponseContent {
                 status: local_var_status,
                 content: local_var_content,
@@ -83,7 +84,7 @@ pub(crate) async fn fetch_org_report(
     configuration: &configuration::Configuration,
     report_key: OrgReportType,
     params: FetchReportQuery,
-) -> Result<OrgReport, Error<FetchReportRequestError>> {
+) -> Result<OrgReport, Error<FetchUserInsightsDataRequestError>> {
     let local_var_configuration = configuration;
 
     let local_var_client = &local_var_configuration.client;
@@ -119,9 +120,61 @@ pub(crate) async fn fetch_org_report(
     if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
         serde_json::from_str(&local_var_content).map_err(Error::from)
     } else {
-        let local_var_entity: Option<FetchReportRequestError> =
+        let local_var_entity: Option<FetchUserInsightsDataRequestError> =
             serde_json::from_str(&local_var_content).ok();
-        let local_var_error: crate::apis::ResponseContent<FetchReportRequestError> =
+        let local_var_error: crate::apis::ResponseContent<FetchUserInsightsDataRequestError> =
+            ResponseContent {
+                status: local_var_status,
+                content: local_var_content,
+                entity: local_var_entity,
+            };
+        Err(Error::ResponseError(local_var_error))
+    }
+}
+
+pub(crate) async fn fetch_chart_metric_data(
+    configuration: &configuration::Configuration,
+    chart_metric: ChartMetric,
+    params: FetchChartDataQuery,
+) -> Result<ChartData, Error<FetchUserInsightsDataRequestError>> {
+    let local_var_configuration = configuration;
+
+    let local_var_client = &local_var_configuration.client;
+
+    let local_var_uri_str = format!(
+        "{}/api/backend/v1/chart_metrics/{chart_metric}",
+        local_var_configuration.base_path,
+        chart_metric = chart_metric.as_str(),
+    );
+    let mut local_var_req_builder =
+        local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
+
+    local_var_req_builder = local_var_req_builder.query(&params);
+
+    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
+        local_var_req_builder =
+            local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
+    }
+    if let Some(ref local_var_token) = local_var_configuration.bearer_access_token {
+        local_var_req_builder = local_var_req_builder.bearer_auth(local_var_token.to_owned());
+    };
+    local_var_req_builder = local_var_req_builder.header(
+        AUTH_HOSTNAME_HEADER,
+        local_var_configuration.auth_hostname.to_owned(),
+    );
+
+    let local_var_req = local_var_req_builder.build()?;
+    let local_var_resp = local_var_client.execute(local_var_req).await?;
+
+    let local_var_status = local_var_resp.status();
+    let local_var_content = local_var_resp.text().await?;
+
+    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
+        serde_json::from_str(&local_var_content).map_err(Error::from)
+    } else {
+        let local_var_entity: Option<FetchUserInsightsDataRequestError> =
+            serde_json::from_str(&local_var_content).ok();
+        let local_var_error: crate::apis::ResponseContent<FetchUserInsightsDataRequestError> =
             ResponseContent {
                 status: local_var_status,
                 content: local_var_content,

src/models/mod.rs

@@ -89,7 +89,7 @@ pub mod user_ids_query;
 pub use self::user_ids_query::UserIdsQuery;
 pub mod user_in_org;
 pub use self::user_in_org::UserInOrg;
-pub mod reports;
+pub mod user_insights;
 pub mod user_metadata;
 pub use self::user_metadata::UserMetadata;
 pub mod user_paged_response;

src/models/reports.rs src/models/user_insights.rssrc/models/reports.rs renamed to src/models/user_insights.rs

@@ -166,3 +166,57 @@ pub struct UserReportPage {
     pub has_more_results: bool,
     pub report_time: i64,
 }
+// chart metrics types
+
+#[derive(Clone, Debug, PartialEq, Deserialize)]
+pub enum ChartMetric {
+    Signups,
+    OrgsCreated,
+    ActiveUsers,
+    ActiveOrgs,
+}
+
+impl ChartMetric {
+    pub fn as_str(&self) -> &'static str {
+        match self {
+            ChartMetric::Signups => "signups",
+            ChartMetric::OrgsCreated => "orgs_created",
+            ChartMetric::ActiveUsers => "active_users",
+            ChartMetric::ActiveOrgs => "active_orgs",
+        }
+    }
+}
+
+#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
+pub enum ChartMetricCadence {
+    #[serde(rename = "Daily")]
+    Daily,
+    #[serde(rename = "Weekly")]
+    Weekly,
+    #[serde(rename = "Monthly")]
+    Monthly,
+}
+
+#[derive(Debug, Clone, Deserialize)]
+pub struct ChartDataPoint {
+    pub result: i64,
+    pub date: String, // YYYY-MM-DD format date, 24 hours in UTC timezone
+    pub cadence_completed: bool,
+}
+
+#[derive(Debug, Clone, Deserialize)]
+pub struct ChartData {
+    pub metrics: Vec<ChartDataPoint>,
+    pub chart_type: ChartMetric,
+    pub cadence: ChartMetricCadence,
+}
+
+#[derive(Clone, Debug, PartialEq, Serialize)]
+pub struct FetchChartDataQuery {
+    #[serde(skip_serializing_if = "Option::is_none", rename = "cadence")]
+    pub cadence: Option<ChartMetricCadence>,
+    #[serde(skip_serializing_if = "Option::is_none", rename = "start_date")]
+    pub start_date: Option<String>, // YYYY-MM-DD format date
+    #[serde(skip_serializing_if = "Option::is_none", rename = "end_date")]
+    pub end_date: Option<String>, // YYYY-MM-DD format date
+}

src/propelauth/auth.rs

@@ -11,9 +11,9 @@ use crate::propelauth::helpers::map_autogenerated_error;
 use crate::propelauth::mfa::MfaService;
 use crate::propelauth::options::{AuthOptions, AuthOptionsWithTokenVerification};
 use crate::propelauth::org::OrgService;
-use crate::propelauth::reports::ReportService;
 use crate::propelauth::token::TokenService;
 use crate::propelauth::user::UserService;
+use crate::propelauth::user_insights::UserInsightsService;
 
 static BACKEND_API_BASE_URL: &str = "https://propelauth-api.com";
 pub(crate) static AUTH_HOSTNAME_HEADER: &str = "X-Propelauth-url";
@@ -132,9 +132,9 @@ impl PropelAuth {
         }
     }
 
-    /// API requests related to reports.
-    pub fn reports(&self) -> ReportService {
-        ReportService {
+    /// API requests related to user insights data.
+    pub fn user_insights(&self) -> UserInsightsService {
+        UserInsightsService {
             config: &self.config,
         }
     }

src/propelauth/errors.rs

@@ -512,7 +512,7 @@ pub enum VerifySmsChallengeError {
 }
 
 #[derive(Error, Debug, PartialEq, Clone)]
-pub enum FetchReportError {
+pub enum FetchUserInsightsError {
     #[error("Invalid API Key")]
     InvalidApiKey,
 

src/propelauth/mod.rs

@@ -7,7 +7,7 @@ pub(crate) mod helpers;
 pub mod mfa;
 pub mod options;
 pub mod org;
-pub mod reports;
 pub mod token;
 pub mod token_models;
 pub mod user;
+pub mod user_insights;