/*
* 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};
/// ApiScope : ApiScope is one permission an API token or OAuth grant can hold. A write scope also grants the read scope of the same resource. - API_SCOPE_UNSPECIFIED: Not a scope. Rejected wherever a scope is expected. - API_SCOPE_LINKS_READ: Read links, their QR code images, tags, folders and link settings. - API_SCOPE_LINKS_WRITE: Create, update and delete links, tags, folders and link settings. - API_SCOPE_WORKFLOWS_READ: Read the workflow steps behind a link and validate them. - API_SCOPE_WORKFLOWS_WRITE: Create, connect, update, lay out and delete workflow steps. - API_SCOPE_QRCODES_READ: Read QR code designs and QR code templates. - API_SCOPE_QRCODES_WRITE: Change QR code designs and create, publish and delete QR code templates. - API_SCOPE_PAGE_THEMES_READ: Read page themes and page theme templates. - API_SCOPE_PAGE_THEMES_WRITE: Change page themes and create, publish and delete page theme templates. - API_SCOPE_MEDIA_READ: Read uploaded media. - API_SCOPE_MEDIA_WRITE: Upload and delete media. - API_SCOPE_DOMAINS_READ: Read custom domains and their DNS instructions. - API_SCOPE_DOMAINS_WRITE: Add, verify, update and delete custom domains. - API_SCOPE_VISITORS_READ: Read and search visitors and their attributes. - API_SCOPE_VISITORS_WRITE: Identify, update and delete visitors and their attributes. - API_SCOPE_ANALYTICS_READ: Read events, metrics, time series, analytics data and dashboards. - API_SCOPE_ANALYTICS_WRITE: Create, update and delete analytics dashboards and generate widget summaries. - API_SCOPE_WEBHOOKS_READ: Read webhooks. - API_SCOPE_WEBHOOKS_WRITE: Create, update and delete webhooks. - API_SCOPE_INTEGRATIONS_READ: Read the Slack and Google Forms integrations. - API_SCOPE_INTEGRATIONS_WRITE: Connect, configure, test, sync and disconnect the Slack and Google Forms integrations. - API_SCOPE_WORKSPACE_READ: Read the workspace and its settings. - API_SCOPE_WORKSPACE_WRITE: Update the workspace, request enrollment and delete the workspace. - API_SCOPE_MEMBERS_READ: Read workspace members. - API_SCOPE_MEMBERS_WRITE: Update, revoke, sign out and remove members. Inviting a member or changing a sign-in email or password needs full access. - API_SCOPE_TOKENS_READ: Read API tokens and their scopes, never their secrets. - API_SCOPE_TOKENS_WRITE: Create, update and delete API tokens, limited to the scopes the calling token holds. - API_SCOPE_BILLING_WRITE: Open checkout, credit top-up and billing portal sessions. - API_SCOPE_ASSISTANT_READ: Read the Assistant conversation. - API_SCOPE_ASSISTANT_WRITE: Send files to the Assistant, clear the conversation and contact support.
/// ApiScope is one permission an API token or OAuth grant can hold. A write scope also grants the read scope of the same resource. - API_SCOPE_UNSPECIFIED: Not a scope. Rejected wherever a scope is expected. - API_SCOPE_LINKS_READ: Read links, their QR code images, tags, folders and link settings. - API_SCOPE_LINKS_WRITE: Create, update and delete links, tags, folders and link settings. - API_SCOPE_WORKFLOWS_READ: Read the workflow steps behind a link and validate them. - API_SCOPE_WORKFLOWS_WRITE: Create, connect, update, lay out and delete workflow steps. - API_SCOPE_QRCODES_READ: Read QR code designs and QR code templates. - API_SCOPE_QRCODES_WRITE: Change QR code designs and create, publish and delete QR code templates. - API_SCOPE_PAGE_THEMES_READ: Read page themes and page theme templates. - API_SCOPE_PAGE_THEMES_WRITE: Change page themes and create, publish and delete page theme templates. - API_SCOPE_MEDIA_READ: Read uploaded media. - API_SCOPE_MEDIA_WRITE: Upload and delete media. - API_SCOPE_DOMAINS_READ: Read custom domains and their DNS instructions. - API_SCOPE_DOMAINS_WRITE: Add, verify, update and delete custom domains. - API_SCOPE_VISITORS_READ: Read and search visitors and their attributes. - API_SCOPE_VISITORS_WRITE: Identify, update and delete visitors and their attributes. - API_SCOPE_ANALYTICS_READ: Read events, metrics, time series, analytics data and dashboards. - API_SCOPE_ANALYTICS_WRITE: Create, update and delete analytics dashboards and generate widget summaries. - API_SCOPE_WEBHOOKS_READ: Read webhooks. - API_SCOPE_WEBHOOKS_WRITE: Create, update and delete webhooks. - API_SCOPE_INTEGRATIONS_READ: Read the Slack and Google Forms integrations. - API_SCOPE_INTEGRATIONS_WRITE: Connect, configure, test, sync and disconnect the Slack and Google Forms integrations. - API_SCOPE_WORKSPACE_READ: Read the workspace and its settings. - API_SCOPE_WORKSPACE_WRITE: Update the workspace, request enrollment and delete the workspace. - API_SCOPE_MEMBERS_READ: Read workspace members. - API_SCOPE_MEMBERS_WRITE: Update, revoke, sign out and remove members. Inviting a member or changing a sign-in email or password needs full access. - API_SCOPE_TOKENS_READ: Read API tokens and their scopes, never their secrets. - API_SCOPE_TOKENS_WRITE: Create, update and delete API tokens, limited to the scopes the calling token holds. - API_SCOPE_BILLING_WRITE: Open checkout, credit top-up and billing portal sessions. - API_SCOPE_ASSISTANT_READ: Read the Assistant conversation. - API_SCOPE_ASSISTANT_WRITE: Send files to the Assistant, clear the conversation and contact support.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum ApiScope {
#[serde(rename = "API_SCOPE_UNSPECIFIED")]
ApiScopeUnspecified,
#[serde(rename = "API_SCOPE_LINKS_READ")]
ApiScopeLinksRead,
#[serde(rename = "API_SCOPE_LINKS_WRITE")]
ApiScopeLinksWrite,
#[serde(rename = "API_SCOPE_WORKFLOWS_READ")]
ApiScopeWorkflowsRead,
#[serde(rename = "API_SCOPE_WORKFLOWS_WRITE")]
ApiScopeWorkflowsWrite,
#[serde(rename = "API_SCOPE_QRCODES_READ")]
ApiScopeQrcodesRead,
#[serde(rename = "API_SCOPE_QRCODES_WRITE")]
ApiScopeQrcodesWrite,
#[serde(rename = "API_SCOPE_PAGE_THEMES_READ")]
ApiScopePageThemesRead,
#[serde(rename = "API_SCOPE_PAGE_THEMES_WRITE")]
ApiScopePageThemesWrite,
#[serde(rename = "API_SCOPE_MEDIA_READ")]
ApiScopeMediaRead,
#[serde(rename = "API_SCOPE_MEDIA_WRITE")]
ApiScopeMediaWrite,
#[serde(rename = "API_SCOPE_DOMAINS_READ")]
ApiScopeDomainsRead,
#[serde(rename = "API_SCOPE_DOMAINS_WRITE")]
ApiScopeDomainsWrite,
#[serde(rename = "API_SCOPE_VISITORS_READ")]
ApiScopeVisitorsRead,
#[serde(rename = "API_SCOPE_VISITORS_WRITE")]
ApiScopeVisitorsWrite,
#[serde(rename = "API_SCOPE_ANALYTICS_READ")]
ApiScopeAnalyticsRead,
#[serde(rename = "API_SCOPE_ANALYTICS_WRITE")]
ApiScopeAnalyticsWrite,
#[serde(rename = "API_SCOPE_WEBHOOKS_READ")]
ApiScopeWebhooksRead,
#[serde(rename = "API_SCOPE_WEBHOOKS_WRITE")]
ApiScopeWebhooksWrite,
#[serde(rename = "API_SCOPE_INTEGRATIONS_READ")]
ApiScopeIntegrationsRead,
#[serde(rename = "API_SCOPE_INTEGRATIONS_WRITE")]
ApiScopeIntegrationsWrite,
#[serde(rename = "API_SCOPE_WORKSPACE_READ")]
ApiScopeWorkspaceRead,
#[serde(rename = "API_SCOPE_WORKSPACE_WRITE")]
ApiScopeWorkspaceWrite,
#[serde(rename = "API_SCOPE_MEMBERS_READ")]
ApiScopeMembersRead,
#[serde(rename = "API_SCOPE_MEMBERS_WRITE")]
ApiScopeMembersWrite,
#[serde(rename = "API_SCOPE_TOKENS_READ")]
ApiScopeTokensRead,
#[serde(rename = "API_SCOPE_TOKENS_WRITE")]
ApiScopeTokensWrite,
#[serde(rename = "API_SCOPE_BILLING_WRITE")]
ApiScopeBillingWrite,
#[serde(rename = "API_SCOPE_ASSISTANT_READ")]
ApiScopeAssistantRead,
#[serde(rename = "API_SCOPE_ASSISTANT_WRITE")]
ApiScopeAssistantWrite,
}
impl std::fmt::Display for ApiScope {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
Self::ApiScopeUnspecified => write!(f, "API_SCOPE_UNSPECIFIED"),
Self::ApiScopeLinksRead => write!(f, "API_SCOPE_LINKS_READ"),
Self::ApiScopeLinksWrite => write!(f, "API_SCOPE_LINKS_WRITE"),
Self::ApiScopeWorkflowsRead => write!(f, "API_SCOPE_WORKFLOWS_READ"),
Self::ApiScopeWorkflowsWrite => write!(f, "API_SCOPE_WORKFLOWS_WRITE"),
Self::ApiScopeQrcodesRead => write!(f, "API_SCOPE_QRCODES_READ"),
Self::ApiScopeQrcodesWrite => write!(f, "API_SCOPE_QRCODES_WRITE"),
Self::ApiScopePageThemesRead => write!(f, "API_SCOPE_PAGE_THEMES_READ"),
Self::ApiScopePageThemesWrite => write!(f, "API_SCOPE_PAGE_THEMES_WRITE"),
Self::ApiScopeMediaRead => write!(f, "API_SCOPE_MEDIA_READ"),
Self::ApiScopeMediaWrite => write!(f, "API_SCOPE_MEDIA_WRITE"),
Self::ApiScopeDomainsRead => write!(f, "API_SCOPE_DOMAINS_READ"),
Self::ApiScopeDomainsWrite => write!(f, "API_SCOPE_DOMAINS_WRITE"),
Self::ApiScopeVisitorsRead => write!(f, "API_SCOPE_VISITORS_READ"),
Self::ApiScopeVisitorsWrite => write!(f, "API_SCOPE_VISITORS_WRITE"),
Self::ApiScopeAnalyticsRead => write!(f, "API_SCOPE_ANALYTICS_READ"),
Self::ApiScopeAnalyticsWrite => write!(f, "API_SCOPE_ANALYTICS_WRITE"),
Self::ApiScopeWebhooksRead => write!(f, "API_SCOPE_WEBHOOKS_READ"),
Self::ApiScopeWebhooksWrite => write!(f, "API_SCOPE_WEBHOOKS_WRITE"),
Self::ApiScopeIntegrationsRead => write!(f, "API_SCOPE_INTEGRATIONS_READ"),
Self::ApiScopeIntegrationsWrite => write!(f, "API_SCOPE_INTEGRATIONS_WRITE"),
Self::ApiScopeWorkspaceRead => write!(f, "API_SCOPE_WORKSPACE_READ"),
Self::ApiScopeWorkspaceWrite => write!(f, "API_SCOPE_WORKSPACE_WRITE"),
Self::ApiScopeMembersRead => write!(f, "API_SCOPE_MEMBERS_READ"),
Self::ApiScopeMembersWrite => write!(f, "API_SCOPE_MEMBERS_WRITE"),
Self::ApiScopeTokensRead => write!(f, "API_SCOPE_TOKENS_READ"),
Self::ApiScopeTokensWrite => write!(f, "API_SCOPE_TOKENS_WRITE"),
Self::ApiScopeBillingWrite => write!(f, "API_SCOPE_BILLING_WRITE"),
Self::ApiScopeAssistantRead => write!(f, "API_SCOPE_ASSISTANT_READ"),
Self::ApiScopeAssistantWrite => write!(f, "API_SCOPE_ASSISTANT_WRITE"),
}
}
}
impl Default for ApiScope {
fn default() -> ApiScope {
Self::ApiScopeUnspecified
}
}