linkbreakers 1.188.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: 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.0
 * 
 * Generated by: https://openapi-generator.tech
 */

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

/// WorkspaceAllowance : One limit the workspace's plan sets, with what the workspace has used of it.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct WorkspaceAllowance {
    #[serde(rename = "cheapestActionCost", skip_serializing_if = "Option::is_none")]
    pub cheapest_action_cost: Option<i32>,
    /// The last second of the current cycle; the allowance refills one second later. Absent for totals that never refill and when nothing has been counted yet.
    #[serde(rename = "cycleEndAt", skip_serializing_if = "Option::is_none")]
    pub cycle_end_at: Option<String>,
    /// Start of the current cycle. Absent when nothing has been counted yet.
    #[serde(rename = "cycleStartAt", skip_serializing_if = "Option::is_none")]
    pub cycle_start_at: Option<String>,
    #[serde(rename = "key", skip_serializing_if = "Option::is_none")]
    pub key: Option<models::PlanLimitKey>,
    #[serde(rename = "kind", skip_serializing_if = "Option::is_none")]
    pub kind: Option<models::PlanLimitKind>,
    /// The ceiling. Absent when kind is PLAN_LIMIT_KIND_UNLIMITED or PLAN_LIMIT_KIND_METERED.
    #[serde(rename = "limit", skip_serializing_if = "Option::is_none")]
    pub limit: Option<i32>,
    /// Media storage only: the most media the workspace may hold, in bytes. Absent for other limits and when there is no ceiling.
    #[serde(rename = "limitBytes", skip_serializing_if = "Option::is_none")]
    pub limit_bytes: Option<i64>,
    /// Tracked visits only: visits recorded past the limit in the current cycle that the workspace's plan still locks. Absent for other limits.
    #[serde(rename = "lockedCount", skip_serializing_if = "Option::is_none")]
    pub locked_count: Option<i32>,
    /// Tracked visits only: every visit the workspace's plan still locks, across all cycles. Upgrading to a plan with a higher limit reveals them. Absent for other limits.
    #[serde(rename = "lockedTotalCount", skip_serializing_if = "Option::is_none")]
    pub locked_total_count: Option<i32>,
    #[serde(rename = "noticeDismissed", skip_serializing_if = "Option::is_none")]
    pub notice_dismissed: Option<bool>,
    /// Whether the limit is used up for the current cycle. Platform credits count as reached once neither the monthly credits nor the purchased top-up credits hold cheapest_action_cost, so nothing that spends credits can run. Never reached on a plan billed per unit used.
    #[serde(rename = "reached", skip_serializing_if = "Option::is_none")]
    pub reached: Option<bool>,
    /// Tracked visits only: every visit recorded in the current cycle, used plus locked_count. Absent for other limits.
    #[serde(rename = "recordedCount", skip_serializing_if = "Option::is_none")]
    pub recorded_count: Option<i32>,
    /// Units left in the current cycle. For platform credits, the monthly credits left plus the purchased top-up credits left. Absent when there is no ceiling.
    #[serde(rename = "remaining", skip_serializing_if = "Option::is_none")]
    pub remaining: Option<i32>,
    /// The day the allowance refills, which is the first day of the next cycle in the workspace's timezone. Absent for totals that never refill and when nothing has been counted yet.
    #[serde(rename = "resetsOn", skip_serializing_if = "Option::is_none")]
    pub resets_on: Option<Box<models::TypeDate>>,
    /// Units used in the current cycle. For a total such as custom domains, what the workspace holds.
    #[serde(rename = "used", skip_serializing_if = "Option::is_none")]
    pub used: Option<i32>,
    /// Media storage only: the bytes the workspace's media holds, exact. used is the same figure in megabytes, rounded up. Absent for other limits.
    #[serde(rename = "usedBytes", skip_serializing_if = "Option::is_none")]
    pub used_bytes: Option<i64>,
}

impl WorkspaceAllowance {
    /// One limit the workspace's plan sets, with what the workspace has used of it.
    pub fn new() -> WorkspaceAllowance {
        WorkspaceAllowance {
            cheapest_action_cost: None,
            cycle_end_at: None,
            cycle_start_at: None,
            key: None,
            kind: None,
            limit: None,
            limit_bytes: None,
            locked_count: None,
            locked_total_count: None,
            notice_dismissed: None,
            reached: None,
            recorded_count: None,
            remaining: None,
            resets_on: None,
            used: None,
            used_bytes: None,
        }
    }
}