/*
* 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 crate::models;
use serde::{Deserialize, Serialize};
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct CreateDashboardRequest {
/// Initial widgets. Empty means the dashboard starts with none, because its contents are normally agreed with the assistant before anything is created.
#[serde(rename = "config", skip_serializing_if = "Option::is_none")]
pub config: Option<Box<models::DashboardConfig>>,
/// Client-supplied dashboard id. Generated server-side when empty.
#[serde(rename = "id", skip_serializing_if = "Option::is_none")]
pub id: Option<String>,
/// Link to scope this dashboard to. Empty creates the workspace-wide dashboard.
#[serde(rename = "linkId", skip_serializing_if = "Option::is_none")]
pub link_id: Option<String>,
/// Display name. Defaults to \"Default Dashboard\" when empty.
#[serde(rename = "name", skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// Fill the dashboard with a starter set instead of leaving it empty, for a dashboard made in one step rather than agreed in a conversation. Without link_id it is the workspace set (scans over time, top links, geography, technology and more). With link_id it is the link set: scans over time, geography, technology, peak hours, and new versus returning visitors, which is everything any link records. The service applies it to any link; whether it suits one is the caller's judgement, since a workflow that collects answers deserves widgets for them. Ignored when config is set, and hidden from the assistant, which agrees its widgets with the user and would otherwise stack them on top of these.
#[serde(rename = "useDefaultWidgets", skip_serializing_if = "Option::is_none")]
pub use_default_widgets: Option<bool>,
}
impl CreateDashboardRequest {
pub fn new() -> CreateDashboardRequest {
CreateDashboardRequest {
config: None,
id: None,
link_id: None,
name: None,
use_default_widgets: None,
}
}
}