/*
* 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.188.4
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// Media : A file in the workspace's media library: an image, a PDF document or an MP4 video. A media item only has a kind; where it is used is derived from its references. Any image can be used as a QR code logo, a page theme's background cover, badge or footer logo (up to 3 MB for those), and any media can be opened by an Open media workflow step. Every item counts toward the workspace's media storage allowance (PLAN_LIMIT_KEY_MEDIA_STORAGE_MB in allowances).
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct Media {
#[serde(rename = "createdAt", skip_serializing_if = "Option::is_none")]
pub created_at: Option<String>,
#[serde(rename = "fileName", skip_serializing_if = "Option::is_none")]
pub file_name: Option<String>,
#[serde(rename = "id", skip_serializing_if = "Option::is_none")]
pub id: Option<String>,
/// - KIND_UNSPECIFIED: Not set - KIND_IMAGE: A PNG, JPEG, WebP or SVG image - KIND_DOCUMENT: A PDF document - KIND_VIDEO: An MP4 video
#[serde(rename = "kind", skip_serializing_if = "Option::is_none")]
pub kind: Option<Kind>,
/// Deprecated: read uploaded_from for where the media was uploaded from and references for where it is used. Still filled with the value recorded at upload; unset for media uploaded from the media library.
#[serde(rename = "mediaType", skip_serializing_if = "Option::is_none")]
pub media_type: Option<models::MediaType>,
#[serde(rename = "mimeType", skip_serializing_if = "Option::is_none")]
pub mime_type: Option<String>,
/// Where this media is used: the Open media steps opening it, the page themes showing it and the QR code designs using it as their logo, each named by the link or the template it belongs to. Empty means it is not used anywhere. Filled by List and Get; Create, CreateUpload and CompleteUpload return it empty. Deleting media an Open media step or a page theme uses is refused with MEDIA_IN_USE; a QR code keeps its own copy of its logo, so deleting the media changes no QR code and only clears its link to it.
#[serde(rename = "references", skip_serializing_if = "Option::is_none")]
pub references: Option<Vec<models::MediaReference>>,
/// The SHA-256 of the file's bytes, 64 lowercase hexadecimal characters, computed by the server. A workspace holds each file once: uploading bytes with the same hash is refused with 409 MEDIA_ALREADY_EXISTS, naming this media in the error's existingMediaId and existingFileName metadata. Empty while pending, and for media stored before files were hashed.
#[serde(rename = "sha256", skip_serializing_if = "Option::is_none")]
pub sha256: Option<String>,
#[serde(rename = "signedUrl", skip_serializing_if = "Option::is_none")]
pub signed_url: Option<String>,
#[serde(rename = "size", skip_serializing_if = "Option::is_none")]
pub size: Option<i64>,
/// Whether the file is stored yet. Only CreateUpload and Get of a pending upload return STATUS_PENDING.
#[serde(rename = "status", skip_serializing_if = "Option::is_none")]
pub status: Option<models::MediaStatus>,
#[serde(rename = "updatedAt", skip_serializing_if = "Option::is_none")]
pub updated_at: Option<String>,
/// The member who uploaded the file If it was uploaded through the public API, or if the member was removed from the workspace, the uploaded_by will be null.
#[serde(rename = "uploadedBy", skip_serializing_if = "Option::is_none")]
pub uploaded_by: Option<String>,
/// Where the media was uploaded from, so pickers can show a section's own uploads first. It does not limit where the media can be used; see references for where it is used.
#[serde(rename = "uploadedFrom", skip_serializing_if = "Option::is_none")]
pub uploaded_from: Option<models::MediaUploadOrigin>,
/// Deprecated: read uploaded_from for where the media was uploaded from and references for where it is used. Still filled with the value recorded at upload; unset for media uploaded from the media library.
#[serde(rename = "usage", skip_serializing_if = "Option::is_none")]
pub usage: Option<models::MediaUsage>,
/// If not provided, the media file will be private to the workspace.
#[serde(rename = "visibility", skip_serializing_if = "Option::is_none")]
pub visibility: Option<models::MediaVisibility>,
#[serde(rename = "workspaceId", skip_serializing_if = "Option::is_none")]
pub workspace_id: Option<String>,
}
impl Media {
/// A file in the workspace's media library: an image, a PDF document or an MP4 video. A media item only has a kind; where it is used is derived from its references. Any image can be used as a QR code logo, a page theme's background cover, badge or footer logo (up to 3 MB for those), and any media can be opened by an Open media workflow step. Every item counts toward the workspace's media storage allowance (PLAN_LIMIT_KEY_MEDIA_STORAGE_MB in allowances).
pub fn new() -> Media {
Media {
created_at: None,
file_name: None,
id: None,
kind: None,
media_type: None,
mime_type: None,
references: None,
sha256: None,
signed_url: None,
size: None,
status: None,
updated_at: None,
uploaded_by: None,
uploaded_from: None,
usage: None,
visibility: None,
workspace_id: None,
}
}
}
/// - KIND_UNSPECIFIED: Not set - KIND_IMAGE: A PNG, JPEG, WebP or SVG image - KIND_DOCUMENT: A PDF document - KIND_VIDEO: An MP4 video
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Kind {
#[serde(rename = "KIND_UNSPECIFIED")]
KindUnspecified,
#[serde(rename = "KIND_IMAGE")]
KindImage,
#[serde(rename = "KIND_DOCUMENT")]
KindDocument,
#[serde(rename = "KIND_VIDEO")]
KindVideo,
}
impl Default for Kind {
fn default() -> Kind {
Self::KindUnspecified
}
}