/*
* Linkbreakers API
*
* This is a documentation of all the APIs of Linkbreakers ## Entry points `GET https://api.linkbreakers.com/` and `GET https://api.linkbreakers.com/v1` answer without credentials with the API's name, version and links. This document is served at `https://api.linkbreakers.com/openapi.json`. ## Rate limits Every response describes where the caller stands in the IETF `RateLimit-Policy` and `RateLimit` header fields (draft-ietf-httpapi-ratelimit-headers), and in `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset` and `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (a Unix timestamp) for clients that read those. A request past the limit gets `429 Too Many Requests` with `Retry-After` in seconds. - Workspace API token: 600 requests per 60 seconds, per token. - Dashboard session or OAuth token: 500 requests per 60 seconds, per token. - No credentials: 300 requests per 60 seconds, per client IP. Each plan also includes a number of API calls per billing cycle. Past it, calls answer `429` with the code `MAX_PUBLIC_API_QUERIED_REACHED` until the cycle renews or the plan changes.
*
* The version of the OpenAPI document: 1.150.0
*
* Generated by: https://openapi-generator.tech
*/
use reqwest;
use serde::{Deserialize, Serialize, de::Error as _};
use crate::{apis::ResponseContent, models};
use super::{Error, configuration, ContentType};
/// struct for typed errors of method [`analytics_dashboard_service_create_dashboard`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDashboardServiceCreateDashboardError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_dashboard_service_delete_dashboard`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDashboardServiceDeleteDashboardError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_dashboard_service_generate_widget_summary`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDashboardServiceGenerateWidgetSummaryError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_dashboard_service_get_widget_summary`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDashboardServiceGetWidgetSummaryError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_dashboard_service_list_dashboards`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDashboardServiceListDashboardsError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// struct for typed errors of method [`analytics_dashboard_service_update_dashboard`]
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(untagged)]
pub enum AnalyticsDashboardServiceUpdateDashboardError {
Status429(models::ErrorResponse),
DefaultResponse(models::ErrorResponse),
UnknownValue(serde_json::Value),
}
/// Requires the `analytics:write` scope. Requires the `analytics:write` scope.
pub async fn analytics_dashboard_service_create_dashboard(configuration: &configuration::Configuration, create_dashboard_request: models::CreateDashboardRequest) -> Result<models::CreateDashboardResponse, Error<AnalyticsDashboardServiceCreateDashboardError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_body_create_dashboard_request = create_dashboard_request;
let uri_str = format!("{}/v1/analytics/dashboards", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_create_dashboard_request);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::CreateDashboardResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::CreateDashboardResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDashboardServiceCreateDashboardError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Delete a dashboard and its associated assistant conversation. Requires the `analytics:write` scope. Requires the `analytics:write` scope.
pub async fn analytics_dashboard_service_delete_dashboard(configuration: &configuration::Configuration, id: &str) -> Result<serde_json::Value, Error<AnalyticsDashboardServiceDeleteDashboardError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_path_id = id;
let uri_str = format!("{}/v1/analytics/dashboards/{id}", configuration.base_path, id=crate::apis::urlencode(p_path_id));
let mut req_builder = configuration.client.request(reqwest::Method::DELETE, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `serde_json::Value`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `serde_json::Value`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDashboardServiceDeleteDashboardError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Analyses the widget's current values and stores the result. Consumes platform credits, so it runs only when requested. Requires the `analytics:write` scope. Requires the `analytics:write` scope.
pub async fn analytics_dashboard_service_generate_widget_summary(configuration: &configuration::Configuration, dashboard_id: &str, widget_id: &str, analytics_dashboard_service_generate_widget_summary_body: models::AnalyticsDashboardServiceGenerateWidgetSummaryBody) -> Result<models::GenerateWidgetSummaryResponse, Error<AnalyticsDashboardServiceGenerateWidgetSummaryError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_path_dashboard_id = dashboard_id;
let p_path_widget_id = widget_id;
let p_body_analytics_dashboard_service_generate_widget_summary_body = analytics_dashboard_service_generate_widget_summary_body;
let uri_str = format!("{}/v1/analytics/dashboards/{dashboardId}/widgets/{widgetId}/summary", configuration.base_path, dashboardId=crate::apis::urlencode(p_path_dashboard_id), widgetId=crate::apis::urlencode(p_path_widget_id));
let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_analytics_dashboard_service_generate_widget_summary_body);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GenerateWidgetSummaryResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GenerateWidgetSummaryResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDashboardServiceGenerateWidgetSummaryError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Returns the last generated analysis, and whether the underlying values have changed since. Requires the `analytics:read` scope. Requires the `analytics:read` scope.
pub async fn analytics_dashboard_service_get_widget_summary(configuration: &configuration::Configuration, dashboard_id: &str, widget_id: &str) -> Result<models::GetWidgetSummaryResponse, Error<AnalyticsDashboardServiceGetWidgetSummaryError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_path_dashboard_id = dashboard_id;
let p_path_widget_id = widget_id;
let uri_str = format!("{}/v1/analytics/dashboards/{dashboardId}/widgets/{widgetId}/summary", configuration.base_path, dashboardId=crate::apis::urlencode(p_path_dashboard_id), widgetId=crate::apis::urlencode(p_path_widget_id));
let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::GetWidgetSummaryResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::GetWidgetSummaryResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDashboardServiceGetWidgetSummaryError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Requires the `analytics:read` scope. Requires the `analytics:read` scope.
pub async fn analytics_dashboard_service_list_dashboards(configuration: &configuration::Configuration, link_id: Option<&str>, scope: Option<&str>, page_size: Option<i64>, page_token: Option<&str>) -> Result<models::ListDashboardsResponse, Error<AnalyticsDashboardServiceListDashboardsError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_query_link_id = link_id;
let p_query_scope = scope;
let p_query_page_size = page_size;
let p_query_page_token = page_token;
let uri_str = format!("{}/v1/analytics/dashboards", configuration.base_path);
let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);
if let Some(ref param_value) = p_query_link_id {
req_builder = req_builder.query(&[("linkId", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_scope {
req_builder = req_builder.query(&[("scope", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_page_size {
req_builder = req_builder.query(&[("pageSize", ¶m_value.to_string())]);
}
if let Some(ref param_value) = p_query_page_token {
req_builder = req_builder.query(&[("pageToken", ¶m_value.to_string())]);
}
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::ListDashboardsResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::ListDashboardsResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDashboardServiceListDashboardsError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}
/// Requires the `analytics:write` scope. Requires the `analytics:write` scope.
pub async fn analytics_dashboard_service_update_dashboard(configuration: &configuration::Configuration, id: &str, analytics_dashboard_service_update_dashboard_body: models::AnalyticsDashboardServiceUpdateDashboardBody) -> Result<models::UpdateDashboardResponse, Error<AnalyticsDashboardServiceUpdateDashboardError>> {
// add a prefix to parameters to efficiently prevent name collisions
let p_path_id = id;
let p_body_analytics_dashboard_service_update_dashboard_body = analytics_dashboard_service_update_dashboard_body;
let uri_str = format!("{}/v1/analytics/dashboards/{id}", configuration.base_path, id=crate::apis::urlencode(p_path_id));
let mut req_builder = configuration.client.request(reqwest::Method::PUT, &uri_str);
if let Some(ref user_agent) = configuration.user_agent {
req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
}
if let Some(ref token) = configuration.oauth_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
if let Some(ref token) = configuration.bearer_access_token {
req_builder = req_builder.bearer_auth(token.to_owned());
};
req_builder = req_builder.json(&p_body_analytics_dashboard_service_update_dashboard_body);
let req = req_builder.build()?;
let resp = configuration.client.execute(req).await?;
let status = resp.status();
let content_type = resp
.headers()
.get("content-type")
.and_then(|v| v.to_str().ok())
.unwrap_or("application/octet-stream");
let content_type = super::ContentType::from(content_type);
if !status.is_client_error() && !status.is_server_error() {
let content = resp.text().await?;
match content_type {
ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::UpdateDashboardResponse`"))),
ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::UpdateDashboardResponse`")))),
}
} else {
let content = resp.text().await?;
let entity: Option<AnalyticsDashboardServiceUpdateDashboardError> = serde_json::from_str(&content).ok();
Err(Error::ResponseError(ResponseContent { status, content, entity }))
}
}