linkbreakers 1.181.0

Official Rust SDK for the Linkbreakers API
Documentation
/*
 * 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.  ## 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.
 *
 * The version of the OpenAPI document: 1.181.0
 * 
 * Generated by: https://openapi-generator.tech
 */

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

/// QrcodeDesignServiceUpdateBody : UpdateQrcodeDesignRequest updates colors, shapes, and media used when regenerating QR assets.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct QrcodeDesignServiceUpdateBody {
    #[serde(rename = "backgroundOptions", skip_serializing_if = "Option::is_none")]
    pub background_options: Option<Box<models::BackgroundOptions>>,
    /// The image to use as the central image of the QR Code. The file size limit is 3MB. It must be transmitted in a base64 string format when sending it through HTTP.
    #[serde(rename = "centralImageData", skip_serializing_if = "Option::is_none")]
    pub central_image_data: Option<String>,
    /// Set this to true to delete the central image. It can't be used at the same time as transmitting a central image.
    #[serde(rename = "centralImageDelete", skip_serializing_if = "Option::is_none")]
    pub central_image_delete: Option<bool>,
    #[serde(rename = "centralImageMargin", skip_serializing_if = "Option::is_none")]
    pub central_image_margin: Option<i32>,
    /// An image from the workspace's media library to use as the central image (UUID). Any READY image of at most 3 MB can be a QR code logo; anything else is refused with MEDIA_NOT_ALLOWED_HERE. The design keeps its own copy of the image: without central_image_data the server reads it from the media itself, with it the bytes sent are used and the media is recorded as where they came from. The media then lists this QR code among its references. Cannot be combined with central_image_delete. Sending central_image_data without it, or central_image_delete, clears the recorded media.
    #[serde(rename = "centralImageMediaId", skip_serializing_if = "Option::is_none")]
    pub central_image_media_id: Option<String>,
    #[serde(rename = "centralImageSize", skip_serializing_if = "Option::is_none")]
    pub central_image_size: Option<f64>,
    #[serde(rename = "cornersDotOptions", skip_serializing_if = "Option::is_none")]
    pub corners_dot_options: Option<Box<models::CornersDotOptions>>,
    #[serde(rename = "cornersSquareOptions", skip_serializing_if = "Option::is_none")]
    pub corners_square_options: Option<Box<models::CornersSquareOptions>>,
    #[serde(rename = "dotsOptions", skip_serializing_if = "Option::is_none")]
    pub dots_options: Option<Box<models::DotsOptions>>,
    #[serde(rename = "errorCorrectionLevel", skip_serializing_if = "Option::is_none")]
    pub error_correction_level: Option<String>,
    #[serde(rename = "height", skip_serializing_if = "Option::is_none")]
    pub height: Option<i32>,
    #[serde(rename = "hideBackgroundDots", skip_serializing_if = "Option::is_none")]
    pub hide_background_dots: Option<bool>,
    /// - OUTPUT_FILE_FORMAT_UNSPECIFIED: Output format not specified (defaults to PNG server-side)  - OUTPUT_FILE_FORMAT_SVG: Scalable Vector Graphics format for infinite resolution  - OUTPUT_FILE_FORMAT_PNG: Portable Network Graphics format with transparency support  - OUTPUT_FILE_FORMAT_JPEG: Joint Photographic Experts Group format for compressed images  - OUTPUT_FILE_FORMAT_WEBP: WebP format for modern web-optimized compression
    #[serde(rename = "outputFileFormat", skip_serializing_if = "Option::is_none")]
    pub output_file_format: Option<OutputFileFormat>,
    /// - SHAPE_UNSPECIFIED: Shape not specified (defaults to square modules)  - SHAPE_SQUARE: Traditional square modules for QR code data points  - SHAPE_CIRCLE: Circular modules for a rounded visual appearance
    #[serde(rename = "shape", skip_serializing_if = "Option::is_none")]
    pub shape: Option<Shape>,
    #[serde(rename = "width", skip_serializing_if = "Option::is_none")]
    pub width: Option<i32>,
}

impl QrcodeDesignServiceUpdateBody {
    /// UpdateQrcodeDesignRequest updates colors, shapes, and media used when regenerating QR assets.
    pub fn new() -> QrcodeDesignServiceUpdateBody {
        QrcodeDesignServiceUpdateBody {
            background_options: None,
            central_image_data: None,
            central_image_delete: None,
            central_image_margin: None,
            central_image_media_id: None,
            central_image_size: None,
            corners_dot_options: None,
            corners_square_options: None,
            dots_options: None,
            error_correction_level: None,
            height: None,
            hide_background_dots: None,
            output_file_format: None,
            shape: None,
            width: None,
        }
    }
}
/// - OUTPUT_FILE_FORMAT_UNSPECIFIED: Output format not specified (defaults to PNG server-side)  - OUTPUT_FILE_FORMAT_SVG: Scalable Vector Graphics format for infinite resolution  - OUTPUT_FILE_FORMAT_PNG: Portable Network Graphics format with transparency support  - OUTPUT_FILE_FORMAT_JPEG: Joint Photographic Experts Group format for compressed images  - OUTPUT_FILE_FORMAT_WEBP: WebP format for modern web-optimized compression
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum OutputFileFormat {
    #[serde(rename = "OUTPUT_FILE_FORMAT_UNSPECIFIED")]
    OutputFileFormatUnspecified,
    #[serde(rename = "OUTPUT_FILE_FORMAT_SVG")]
    OutputFileFormatSvg,
    #[serde(rename = "OUTPUT_FILE_FORMAT_PNG")]
    OutputFileFormatPng,
    #[serde(rename = "OUTPUT_FILE_FORMAT_JPEG")]
    OutputFileFormatJpeg,
    #[serde(rename = "OUTPUT_FILE_FORMAT_WEBP")]
    OutputFileFormatWebp,
}

impl Default for OutputFileFormat {
    fn default() -> OutputFileFormat {
        Self::OutputFileFormatUnspecified
    }
}
/// - SHAPE_UNSPECIFIED: Shape not specified (defaults to square modules)  - SHAPE_SQUARE: Traditional square modules for QR code data points  - SHAPE_CIRCLE: Circular modules for a rounded visual appearance
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Shape {
    #[serde(rename = "SHAPE_UNSPECIFIED")]
    ShapeUnspecified,
    #[serde(rename = "SHAPE_SQUARE")]
    ShapeSquare,
    #[serde(rename = "SHAPE_CIRCLE")]
    ShapeCircle,
}

impl Default for Shape {
    fn default() -> Shape {
        Self::ShapeUnspecified
    }
}