/*
* 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: 720 requests per 60 seconds, per token. - Dashboard session or OAuth token: 600 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. ## Pagination Every list pages with opaque cursors (AIP-158). Pass `pageSize`, then send the `nextPageToken` of each response back as `pageToken` (or its alias `cursor`) to get the next page. An empty or absent `nextPageToken` means the list is complete. Each list operation describes this in `x-pagination`. ## Batches and background jobs `POST /v1/links/bulk` creates up to 250 links in one transactional request; `POST /v1/links/batch` takes the same links as a bare JSON array. `POST /v1/links/bulk/jobs` accepts the same batch and answers `202 Accepted` at once with a job and a `Location` header; poll `GET /v1/jobs/{id}` until `status` is `JOB_STATUS_SUCCEEDED` (the created link ids are in `linksBulkCreate.linkIds`) or `JOB_STATUS_FAILED` (`error` says why, and nothing was created). Jobs can be read for 24 hours after they finish. ## Versioning and deprecation The version is in the path: every operation lives under `/v1`. Within a version, changes are additive only: new operations, new optional request fields, new response fields and new enum values. Clients should ignore fields and enum values they do not know. Anything that would break an existing client ships under a new path version instead. An operation is retired in two steps. First it is deprecated: it keeps working, is flagged `deprecated: true` in this document, and every response carries a `Deprecation` header field (RFC 9745) with the time it was deprecated and a `Link` with `rel=\"deprecation\"` to the policy. Then, at least 180 days later, it may be removed; that date is announced in advance in a `Sunset` header field (RFC 8594) and as `x-sunset` on the operation. The full policy: https://linkbreakers.com/help/article/api-versioning-and-deprecation-policy ## Idempotent retries Every POST, PUT and PATCH accepts an optional `Idempotency-Key` header (draft-ietf-httpapi-idempotency-key-header). Send a new unique value, such as a UUID, with each logical request and reuse it only to retry that request. A retry with the same key and the same request returns the first response, marked `Idempotent-Replayed: true`, instead of running again. Keys are scoped to the token and kept for 24 hours. The same key with a different request is refused with `422`, and a retry while the first request is still running gets `409` with `Retry-After`. Server errors (5xx) and refusals such as 401, 403 and 429 are not stored, so retrying them runs the request again. ## Identifying your client Send a `Linkbreakers-Client` request header saying which client made the call: `<client>/<version> (<details>)`, for example `my-integration/1.2.0 (python 3.12; linux)`. The official SDKs, the CLI and the MCP bridge set it for you, as `sdk-python/2.3.1 (python 3.12.4; linux)` or `cli/1.4.0 (darwin arm64)`. It is optional and changes nothing about how a request is handled; it tells us which clients and versions are in use, so we know what can be retired and what to fix first. Keep the details short and free of personal data. Browsers may send it too: it is allowed by CORS.
*
* The version of the OpenAPI document: 1.193.0
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// PageThemeTemplate : Reusable page styling presets that help teams give every link page a consistent look.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct PageThemeTemplate {
/// Signed URL for the template's badge image. Empty when the template has no badge.
#[serde(rename = "badgeSignedUrl", skip_serializing_if = "Option::is_none")]
pub badge_signed_url: Option<String>,
#[serde(rename = "builtIn", skip_serializing_if = "Option::is_none")]
pub built_in: Option<bool>,
/// Signed URL for the template's cover image. Empty when the template has no cover.
#[serde(rename = "coverSignedUrl", skip_serializing_if = "Option::is_none")]
pub cover_signed_url: Option<String>,
#[serde(rename = "createdAt", skip_serializing_if = "Option::is_none")]
pub created_at: Option<String>,
#[serde(rename = "description", skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Reference to the original public template when this template was created via import. Null for original templates.
#[serde(rename = "duplicatedFrom", skip_serializing_if = "Option::is_none")]
pub duplicated_from: Option<String>,
/// Frequently Asked Questions about this template stored as JSON
#[serde(rename = "faq", skip_serializing_if = "Option::is_none")]
pub faq: Option<String>,
/// Signed URL for the template's footer logo image. Empty when the template has no footer logo.
#[serde(rename = "footerLogoSignedUrl", skip_serializing_if = "Option::is_none")]
pub footer_logo_signed_url: Option<String>,
#[serde(rename = "id", skip_serializing_if = "Option::is_none")]
pub id: Option<String>,
/// Extended markdown-supported content providing detailed information about the template
#[serde(rename = "learnMore", skip_serializing_if = "Option::is_none")]
pub learn_more: Option<String>,
#[serde(rename = "name", skip_serializing_if = "Option::is_none")]
pub name: Option<String>,
/// True when the template belongs to the caller's workspace. False for built-in templates and for community templates published by other workspaces.
#[serde(rename = "owned", skip_serializing_if = "Option::is_none")]
pub owned: Option<bool>,
#[serde(rename = "pageTheme", skip_serializing_if = "Option::is_none")]
pub page_theme: Option<Box<models::PageTheme>>,
#[serde(rename = "pageThemeId", skip_serializing_if = "Option::is_none")]
pub page_theme_id: Option<String>,
/// When the template was published. Null means private template, only visible to creating workspace.
#[serde(rename = "publishedAt", skip_serializing_if = "Option::is_none")]
pub published_at: Option<String>,
#[serde(rename = "slug", skip_serializing_if = "Option::is_none")]
pub slug: Option<String>,
#[serde(rename = "tags", skip_serializing_if = "Option::is_none")]
pub tags: Option<String>,
#[serde(rename = "thumbnailPendingUpdateSince", skip_serializing_if = "Option::is_none")]
pub thumbnail_pending_update_since: Option<String>,
#[serde(rename = "thumbnailSignedUrl", skip_serializing_if = "Option::is_none")]
pub thumbnail_signed_url: Option<String>,
#[serde(rename = "updatedAt", skip_serializing_if = "Option::is_none")]
pub updated_at: Option<String>,
/// Number of links in the caller's workspace whose theme was applied from this template. Drives the 'most used' ordering in the template picker.
#[serde(rename = "usageCount", skip_serializing_if = "Option::is_none")]
pub usage_count: Option<i64>,
#[serde(rename = "workspaceId", skip_serializing_if = "Option::is_none")]
pub workspace_id: Option<String>,
}
impl PageThemeTemplate {
/// Reusable page styling presets that help teams give every link page a consistent look.
pub fn new() -> PageThemeTemplate {
PageThemeTemplate {
badge_signed_url: None,
built_in: None,
cover_signed_url: None,
created_at: None,
description: None,
duplicated_from: None,
faq: None,
footer_logo_signed_url: None,
id: None,
learn_more: None,
name: None,
owned: None,
page_theme: None,
page_theme_id: None,
published_at: None,
slug: None,
tags: None,
thumbnail_pending_update_since: None,
thumbnail_signed_url: None,
updated_at: None,
usage_count: None,
workspace_id: None,
}
}
}