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

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

/// Device : Tracks the fingerprint of a visitor's hardware/software so Linkbreakers can de-duplicate scans, enrich analytics, and power security heuristics.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct Device {
    #[serde(rename = "asn", skip_serializing_if = "Option::is_none")]
    pub asn: Option<i64>,
    #[serde(rename = "browserLanguage", skip_serializing_if = "Option::is_none")]
    pub browser_language: Option<String>,
    #[serde(rename = "browserName", skip_serializing_if = "Option::is_none")]
    pub browser_name: Option<String>,
    #[serde(rename = "browserVersion", skip_serializing_if = "Option::is_none")]
    pub browser_version: Option<String>,
    #[serde(rename = "city", skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    #[serde(rename = "country", skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    #[serde(rename = "createdAt", skip_serializing_if = "Option::is_none")]
    pub created_at: Option<String>,
    /// DeviceActor represents WHO or WHAT is operating the device. This distinguishes between a real human visitor, an automated crawler/scraper bot (e.g. Googlebot, BingBot), and an AI/LLM agent acting on behalf of a user (e.g. GPTBot, ClaudeBot, Gemini, Grok).   - DEVICE_ACTOR_UNSPECIFIED: Actor not specified or not yet detected  - DEVICE_ACTOR_HUMAN: Human visitor using a browser (covers MOBILE, TABLET, DESKTOP device types)  - DEVICE_ACTOR_BOT: Automated crawler or scraper bot (e.g. Googlebot, BingBot, Applebot)  - DEVICE_ACTOR_AGENT: AI/LLM agent browsing on behalf of a user (e.g. GPTBot, ClaudeBot, Gemini, Grok)  - DEVICE_ACTOR_UNKNOWN: Unable to classify the actor
    #[serde(rename = "deviceActor", skip_serializing_if = "Option::is_none")]
    pub device_actor: Option<DeviceActor>,
    /// Specific actor or crawler name for non-human traffic (e.g. \"Googlebot\", \"GPTBot\", \"ClaudeBot\"). Only populated when device_actor is BOT or AGENT. Null/empty for HUMAN visitors.
    #[serde(rename = "deviceActorName", skip_serializing_if = "Option::is_none")]
    pub device_actor_name: Option<String>,
    /// Company or organization behind the actor (e.g. \"Google\", \"OpenAI\", \"Anthropic\"). Only populated when device_actor is BOT or AGENT. Null/empty for HUMAN visitors.
    #[serde(rename = "deviceActorOrigin", skip_serializing_if = "Option::is_none")]
    pub device_actor_origin: Option<String>,
    #[serde(rename = "deviceBrand", skip_serializing_if = "Option::is_none")]
    pub device_brand: Option<String>,
    #[serde(rename = "deviceConcurrency", skip_serializing_if = "Option::is_none")]
    pub device_concurrency: Option<i32>,
    #[serde(rename = "deviceMemory", skip_serializing_if = "Option::is_none")]
    pub device_memory: Option<f64>,
    #[serde(rename = "deviceName", skip_serializing_if = "Option::is_none")]
    pub device_name: Option<String>,
    /// DeviceType represents the physical form factor of the device. This describes the hardware category (phone, tablet, laptop, etc.), NOT who or what is operating it — see DeviceActor for that.   - DEVICE_TYPE_UNSPECIFIED: Device type not specified or not yet detected  - DEVICE_TYPE_NATIVE: Native QR scanner (no browser capabilities reported)  - DEVICE_TYPE_MOBILE: Mobile handset browser  - DEVICE_TYPE_TABLET: Tablet browser  - DEVICE_TYPE_DESKTOP: Desktop or laptop browser  - DEVICE_TYPE_UNKNOWN: Unable to classify the device
    #[serde(rename = "deviceType", skip_serializing_if = "Option::is_none")]
    pub device_type: Option<DeviceType>,
    #[serde(rename = "gpu", skip_serializing_if = "Option::is_none")]
    pub gpu: Option<String>,
    #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(rename = "ipAddress", skip_serializing_if = "Option::is_none")]
    pub ip_address: Option<String>,
    #[serde(rename = "isp", skip_serializing_if = "Option::is_none")]
    pub isp: Option<String>,
    #[serde(rename = "lastUsedAt", skip_serializing_if = "Option::is_none")]
    pub last_used_at: Option<String>,
    #[serde(rename = "networkBandwidth", skip_serializing_if = "Option::is_none")]
    pub network_bandwidth: Option<f64>,
    #[serde(rename = "networkConnection", skip_serializing_if = "Option::is_none")]
    pub network_connection: Option<String>,
    #[serde(rename = "networkRtt", skip_serializing_if = "Option::is_none")]
    pub network_rtt: Option<f64>,
    #[serde(rename = "platformName", skip_serializing_if = "Option::is_none")]
    pub platform_name: Option<String>,
    #[serde(rename = "platformVersion", skip_serializing_if = "Option::is_none")]
    pub platform_version: Option<String>,
    #[serde(rename = "region", skip_serializing_if = "Option::is_none")]
    pub region: Option<String>,
    #[serde(rename = "screenHeight", skip_serializing_if = "Option::is_none")]
    pub screen_height: Option<f64>,
    #[serde(rename = "screenRatio", skip_serializing_if = "Option::is_none")]
    pub screen_ratio: Option<f64>,
    #[serde(rename = "screenWidth", skip_serializing_if = "Option::is_none")]
    pub screen_width: Option<f64>,
    #[serde(rename = "state", skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    #[serde(rename = "timezone", skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    #[serde(rename = "touchScreen", skip_serializing_if = "Option::is_none")]
    pub touch_screen: Option<bool>,
    #[serde(rename = "updatedAt", skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<String>,
    #[serde(rename = "userAgent", skip_serializing_if = "Option::is_none")]
    pub user_agent: Option<String>,
}

impl Device {
    /// Tracks the fingerprint of a visitor's hardware/software so Linkbreakers can de-duplicate scans, enrich analytics, and power security heuristics.
    pub fn new() -> Device {
        Device {
            asn: None,
            browser_language: None,
            browser_name: None,
            browser_version: None,
            city: None,
            country: None,
            created_at: None,
            device_actor: None,
            device_actor_name: None,
            device_actor_origin: None,
            device_brand: None,
            device_concurrency: None,
            device_memory: None,
            device_name: None,
            device_type: None,
            gpu: None,
            id: None,
            ip_address: None,
            isp: None,
            last_used_at: None,
            network_bandwidth: None,
            network_connection: None,
            network_rtt: None,
            platform_name: None,
            platform_version: None,
            region: None,
            screen_height: None,
            screen_ratio: None,
            screen_width: None,
            state: None,
            timezone: None,
            touch_screen: None,
            updated_at: None,
            user_agent: None,
        }
    }
}
/// DeviceActor represents WHO or WHAT is operating the device. This distinguishes between a real human visitor, an automated crawler/scraper bot (e.g. Googlebot, BingBot), and an AI/LLM agent acting on behalf of a user (e.g. GPTBot, ClaudeBot, Gemini, Grok).   - DEVICE_ACTOR_UNSPECIFIED: Actor not specified or not yet detected  - DEVICE_ACTOR_HUMAN: Human visitor using a browser (covers MOBILE, TABLET, DESKTOP device types)  - DEVICE_ACTOR_BOT: Automated crawler or scraper bot (e.g. Googlebot, BingBot, Applebot)  - DEVICE_ACTOR_AGENT: AI/LLM agent browsing on behalf of a user (e.g. GPTBot, ClaudeBot, Gemini, Grok)  - DEVICE_ACTOR_UNKNOWN: Unable to classify the actor
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum DeviceActor {
    #[serde(rename = "DEVICE_ACTOR_UNSPECIFIED")]
    DeviceActorUnspecified,
    #[serde(rename = "DEVICE_ACTOR_HUMAN")]
    DeviceActorHuman,
    #[serde(rename = "DEVICE_ACTOR_BOT")]
    DeviceActorBot,
    #[serde(rename = "DEVICE_ACTOR_AGENT")]
    DeviceActorAgent,
    #[serde(rename = "DEVICE_ACTOR_UNKNOWN")]
    DeviceActorUnknown,
}

impl Default for DeviceActor {
    fn default() -> DeviceActor {
        Self::DeviceActorUnspecified
    }
}
/// DeviceType represents the physical form factor of the device. This describes the hardware category (phone, tablet, laptop, etc.), NOT who or what is operating it — see DeviceActor for that.   - DEVICE_TYPE_UNSPECIFIED: Device type not specified or not yet detected  - DEVICE_TYPE_NATIVE: Native QR scanner (no browser capabilities reported)  - DEVICE_TYPE_MOBILE: Mobile handset browser  - DEVICE_TYPE_TABLET: Tablet browser  - DEVICE_TYPE_DESKTOP: Desktop or laptop browser  - DEVICE_TYPE_UNKNOWN: Unable to classify the device
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum DeviceType {
    #[serde(rename = "DEVICE_TYPE_UNSPECIFIED")]
    DeviceTypeUnspecified,
    #[serde(rename = "DEVICE_TYPE_NATIVE")]
    DeviceTypeNative,
    #[serde(rename = "DEVICE_TYPE_MOBILE")]
    DeviceTypeMobile,
    #[serde(rename = "DEVICE_TYPE_TABLET")]
    DeviceTypeTablet,
    #[serde(rename = "DEVICE_TYPE_DESKTOP")]
    DeviceTypeDesktop,
    #[serde(rename = "DEVICE_TYPE_UNKNOWN")]
    DeviceTypeUnknown,
}

impl Default for DeviceType {
    fn default() -> DeviceType {
        Self::DeviceTypeUnspecified
    }
}