/*
* 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.195.5
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// MediaReference : MediaReference is one place a media item is used. A media item's references are where it is used; none means it is not used anywhere.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct MediaReference {
/// The link that uses the media (UUID): the Open media step's link, a link whose page theme shows it, or a link whose QR code uses it as its logo. Empty when the use is not tied to a link, as for a template's own theme or QR code design.
#[serde(rename = "linkId", skip_serializing_if = "Option::is_none")]
pub link_id: Option<String>,
/// The link's name, or its shortlink when it has no name. Empty when link_id is empty.
#[serde(rename = "linkName", skip_serializing_if = "Option::is_none")]
pub link_name: Option<String>,
/// The page theme template whose theme shows the media (UUID). Set only for page theme uses that belong to a template rather than a link.
#[serde(rename = "pageThemeTemplateId", skip_serializing_if = "Option::is_none")]
pub page_theme_template_id: Option<String>,
/// The page theme template's name. Set with page_theme_template_id.
#[serde(rename = "pageThemeTemplateName", skip_serializing_if = "Option::is_none")]
pub page_theme_template_name: Option<String>,
/// The QR code template whose QR code design uses the media as its logo (UUID). Set only for TYPE_QR_CODE_LOGO uses that belong to a QR code template rather than a link.
#[serde(rename = "qrcodeTemplateId", skip_serializing_if = "Option::is_none")]
pub qrcode_template_id: Option<String>,
/// The QR code template's name. Set with qrcode_template_id.
#[serde(rename = "qrcodeTemplateName", skip_serializing_if = "Option::is_none")]
pub qrcode_template_name: Option<String>,
#[serde(rename = "type", skip_serializing_if = "Option::is_none")]
pub r#type: Option<models::MediaReferenceType>,
/// The Open media workflow step handing out the media (UUID). Set only for TYPE_OPEN_MEDIA_STEP.
#[serde(rename = "workflowStepId", skip_serializing_if = "Option::is_none")]
pub workflow_step_id: Option<String>,
}
impl MediaReference {
/// MediaReference is one place a media item is used. A media item's references are where it is used; none means it is not used anywhere.
pub fn new() -> MediaReference {
MediaReference {
link_id: None,
link_name: None,
page_theme_template_id: None,
page_theme_template_name: None,
qrcode_template_id: None,
qrcode_template_name: None,
r#type: None,
workflow_step_id: None,
}
}
}