linkbreakers 1.200.1

Official Rust SDK for the Linkbreakers API
Documentation
/*
 * Linkbreakers API
 *
 * The Linkbreakers REST API: links, QR codes, workflows, visitors and analytics, as JSON over HTTPS. Send a workspace API token as `Authorization: Bearer <token>`.  ## 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.  ## Paused workspaces  A free workspace whose members have not verified any email address is paused 7 days after sign-up. Its calls then answer `403` with the code `WORKSPACE_UNVERIFIED` and change nothing; QR codes and links keep working for visitors. To lift the pause, ask the workspace owner to verify their email: `POST /v1/members/email-verification` sends the verification email again, and works while the workspace is paused. `unverifiedPauseAt` on the workspace says when the pause starts.  ## 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  A renamed operation keeps answering its former path while clients still call it, until that path's sunset at the latest: a former path no client calls for 14 days is removed. Responses on a former path carry the same `Deprecation`, `Sunset` and `Link` header fields; this document lists only the current path, and the policy lists the former paths that still answer.  ## 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.200.1
 * 
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

/// Link : A shortlink and its QR code, with the workflow that runs when someone scans or clicks it. Holds its destination, settings and analytics metadata.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct Link {
    /// When the link was created.
    #[serde(rename = "createdAt", skip_serializing_if = "Option::is_none")]
    pub created_at: Option<String>,
    /// The custom domain that is used to access the link. Use the include parameter when available to include the custom domain in the response.
    #[serde(rename = "customDomain", skip_serializing_if = "Option::is_none")]
    pub custom_domain: Option<Box<models::CustomDomain>>,
    /// The ID of the custom domain (UUID). This is the custom domain that is used to access the link. If not defined, the link will be accessed using the default domain.
    #[serde(rename = "customDomainId", skip_serializing_if = "Option::is_none")]
    pub custom_domain_id: Option<String>,
    /// The ID of the directory this link belongs to (UUID). If not set, the link is at the root level (not in any directory).
    #[serde(rename = "directoryId", skip_serializing_if = "Option::is_none")]
    pub directory_id: Option<String>,
    /// The entrypoint URL This is the URL that is available to be redirected to the destination.
    #[serde(rename = "entrypoint", skip_serializing_if = "Option::is_none")]
    pub entrypoint: Option<String>,
    /// The number of time the link has been scanned. This number is counted in the background: a new scan can take up to about two minutes to show here.
    #[serde(rename = "eventCount", skip_serializing_if = "Option::is_none")]
    pub event_count: Option<i64>,
    /// Where visitors are sent once the link has expired. Empty serves the built-in expired page instead.
    #[serde(rename = "expiredDestination", skip_serializing_if = "Option::is_none")]
    pub expired_destination: Option<String>,
    /// When the link stops resolving. Empty means it never expires. Must be in the future. Once it passes the link is removed from the workspace and only the expired destination is served.
    #[serde(rename = "expiresAt", skip_serializing_if = "Option::is_none")]
    pub expires_at: Option<String>,
    #[serde(rename = "fallbackDestination", skip_serializing_if = "Option::is_none")]
    pub fallback_destination: Option<String>,
    #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// A map of string key-value pairs. All values must be strings. Nested objects or arrays are not supported. Maximum of 50 keys.
    #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")]
    pub metadata: Option<std::collections::HashMap<String, String>>,
    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// The page theme configuration for this link. Use the include parameter with \"pageTheme\" to include page theme data in the response.
    #[serde(rename = "pageTheme", skip_serializing_if = "Option::is_none")]
    pub page_theme: Option<Box<models::PageTheme>>,
    /// The ID of the page theme for this link (UUID).
    #[serde(rename = "pageThemeId", skip_serializing_if = "Option::is_none")]
    pub page_theme_id: Option<String>,
    /// The page theme template this link's styling was applied from (UUID).  Empty when the theme was styled by hand rather than taken from a template. Set when a template is applied, and unchanged by later edits, so it records where the look came from rather than what it is now.
    #[serde(rename = "pageThemeTemplateId", skip_serializing_if = "Option::is_none")]
    pub page_theme_template_id: Option<String>,
    /// What the user is trying to achieve with this link, in one or two sentences.
    #[serde(rename = "purpose", skip_serializing_if = "Option::is_none")]
    pub purpose: Option<String>,
    /// The custom domain that is used to access the link. Use the include parameter when available to include the custom domain in the response.
    #[serde(rename = "qrcodeDesign", skip_serializing_if = "Option::is_none")]
    pub qrcode_design: Option<Box<models::QrcodeDesign>>,
    /// The ID of the link design (UUID). This is the ID of the design that is used to generate the QR Code. If not defined, the design from the QR Code template will be used.
    #[serde(rename = "qrcodeDesignId", skip_serializing_if = "Option::is_none")]
    pub qrcode_design_id: Option<String>,
    /// Whether the link has a QR code. When false the link has no QR code at all: qrcodeDesignId, qrcodeDesign and qrcodeSignedUrl are empty, and the QR code design endpoints refuse the link until it is turned back on with UpdateLink.
    #[serde(rename = "qrcodeEnabled", skip_serializing_if = "Option::is_none")]
    pub qrcode_enabled: Option<bool>,
    /// When the link is pending QR Code update. This happens when the QR Code Design is updated and the QR Code image is still being processed.
    #[serde(rename = "qrcodePendingUpdateSince", skip_serializing_if = "Option::is_none")]
    pub qrcode_pending_update_since: Option<String>,
    /// The signed URL for the QR Code image. This URL eventually expires.
    #[serde(rename = "qrcodeSignedUrl", skip_serializing_if = "Option::is_none")]
    pub qrcode_signed_url: Option<String>,
    /// The ID of the design template (UUID). This is the template that is used to generate the first QR Code Design assigned to the link. If not defined, a default QR Code Design will be generated.
    #[serde(rename = "qrcodeTemplateId", skip_serializing_if = "Option::is_none")]
    pub qrcode_template_id: Option<String>,
    /// The short link for the link. This is the path attached to the URL, one segment or several (\"menu/lunch\"). It can be defined by the client or generated by the system but is never null. It is unique within a custom domain or Linkbreakers default domain. On a custom domain it can be dynamic, with {name} segments that match any value and save it on the visitor (\"01/09506000134352/10/{batch}\"); see CreateLinkRequest.shortlink for the rules.
    #[serde(rename = "shortlink", skip_serializing_if = "Option::is_none")]
    pub shortlink: Option<String>,
    /// The tags associated with the link.
    #[serde(rename = "tags", skip_serializing_if = "Option::is_none")]
    pub tags: Option<Vec<models::ApiTag>>,
    /// When the link was last updated.
    #[serde(rename = "updatedAt", skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<String>,
    #[serde(rename = "workspaceId", skip_serializing_if = "Option::is_none")]
    pub workspace_id: Option<String>,
}

impl Link {
    /// A shortlink and its QR code, with the workflow that runs when someone scans or clicks it. Holds its destination, settings and analytics metadata.
    pub fn new() -> Link {
        Link {
            created_at: None,
            custom_domain: None,
            custom_domain_id: None,
            directory_id: None,
            entrypoint: None,
            event_count: None,
            expired_destination: None,
            expires_at: None,
            fallback_destination: None,
            id: None,
            metadata: None,
            name: None,
            page_theme: None,
            page_theme_id: None,
            page_theme_template_id: None,
            purpose: None,
            qrcode_design: None,
            qrcode_design_id: None,
            qrcode_enabled: None,
            qrcode_pending_update_since: None,
            qrcode_signed_url: None,
            qrcode_template_id: None,
            shortlink: None,
            tags: None,
            updated_at: None,
            workspace_id: None,
        }
    }
}