linkbreakers 1.186.2

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.
 *
 * The version of the OpenAPI document: 1.186.2
 * 
 * Generated by: https://openapi-generator.tech
 */

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

/// ApiScopeInfo : ApiScopeInfo describes one scope for people and agents choosing scopes.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct ApiScopeInfo {
    /// Whether the scope reads or writes the resource.
    #[serde(rename = "access", skip_serializing_if = "Option::is_none")]
    pub access: Option<models::ApiScopeAccess>,
    /// What the scope allows.
    #[serde(rename = "description", skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// The scope string as it appears in OAuth grants and error messages (e.g. links:read).
    #[serde(rename = "name", skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// The resource the scope covers (e.g. links).
    #[serde(rename = "resource", skip_serializing_if = "Option::is_none")]
    pub resource: Option<String>,
    /// ApiScope is one permission an API token or OAuth grant can hold.  A write scope also grants the read scope of the same resource.   - API_SCOPE_UNSPECIFIED: Not a scope. Rejected wherever a scope is expected.  - API_SCOPE_LINKS_READ: Read links, their QR code images, tags, folders and link settings.  - API_SCOPE_LINKS_WRITE: Create, update and delete links, tags, folders and link settings.  - API_SCOPE_WORKFLOWS_READ: Read the workflow steps behind a link and validate them.  - API_SCOPE_WORKFLOWS_WRITE: Create, connect, update, lay out and delete workflow steps.  - API_SCOPE_QRCODES_READ: Read QR code designs and QR code templates.  - API_SCOPE_QRCODES_WRITE: Change QR code designs and create, publish and delete QR code templates.  - API_SCOPE_PAGE_THEMES_READ: Read page themes and page theme templates.  - API_SCOPE_PAGE_THEMES_WRITE: Change page themes and create, publish and delete page theme templates.  - API_SCOPE_MEDIA_READ: Read uploaded media.  - API_SCOPE_MEDIA_WRITE: Upload and delete media.  - API_SCOPE_DOMAINS_READ: Read custom domains and their DNS instructions.  - API_SCOPE_DOMAINS_WRITE: Add, verify, update and delete custom domains.  - API_SCOPE_VISITORS_READ: Read and search visitors and their attributes.  - API_SCOPE_VISITORS_WRITE: Identify, update and delete visitors and their attributes.  - API_SCOPE_ANALYTICS_READ: Read events, metrics, time series, analytics data and dashboards.  - API_SCOPE_ANALYTICS_WRITE: Create, update and delete analytics dashboards and generate widget summaries.  - API_SCOPE_WEBHOOKS_READ: Read webhooks.  - API_SCOPE_WEBHOOKS_WRITE: Create, update and delete webhooks.  - API_SCOPE_INTEGRATIONS_READ: Read the Slack and Google Forms integrations.  - API_SCOPE_INTEGRATIONS_WRITE: Connect, configure, test, sync and disconnect the Slack and Google Forms integrations.  - API_SCOPE_WORKSPACE_READ: Read the workspace and its settings.  - API_SCOPE_WORKSPACE_WRITE: Update the workspace, request enrollment and delete the workspace.  - API_SCOPE_MEMBERS_READ: Read workspace members.  - API_SCOPE_MEMBERS_WRITE: Update, revoke, sign out and remove members. Inviting a member or changing a sign-in email or password needs full access.  - API_SCOPE_TOKENS_READ: Read API tokens and their scopes, never their secrets.  - API_SCOPE_TOKENS_WRITE: Create, update and delete API tokens, limited to the scopes the calling token holds.  - API_SCOPE_BILLING_WRITE: Open checkout, credit top-up and billing portal sessions.  - API_SCOPE_ASSISTANT_READ: Read the Assistant conversation.  - API_SCOPE_ASSISTANT_WRITE: Send files to the Assistant, clear the conversation and contact support.
    #[serde(rename = "scope", skip_serializing_if = "Option::is_none")]
    pub scope: Option<Scope>,
}

impl ApiScopeInfo {
    /// ApiScopeInfo describes one scope for people and agents choosing scopes.
    pub fn new() -> ApiScopeInfo {
        ApiScopeInfo {
            access: None,
            description: None,
            name: None,
            resource: None,
            scope: None,
        }
    }
}
/// ApiScope is one permission an API token or OAuth grant can hold.  A write scope also grants the read scope of the same resource.   - API_SCOPE_UNSPECIFIED: Not a scope. Rejected wherever a scope is expected.  - API_SCOPE_LINKS_READ: Read links, their QR code images, tags, folders and link settings.  - API_SCOPE_LINKS_WRITE: Create, update and delete links, tags, folders and link settings.  - API_SCOPE_WORKFLOWS_READ: Read the workflow steps behind a link and validate them.  - API_SCOPE_WORKFLOWS_WRITE: Create, connect, update, lay out and delete workflow steps.  - API_SCOPE_QRCODES_READ: Read QR code designs and QR code templates.  - API_SCOPE_QRCODES_WRITE: Change QR code designs and create, publish and delete QR code templates.  - API_SCOPE_PAGE_THEMES_READ: Read page themes and page theme templates.  - API_SCOPE_PAGE_THEMES_WRITE: Change page themes and create, publish and delete page theme templates.  - API_SCOPE_MEDIA_READ: Read uploaded media.  - API_SCOPE_MEDIA_WRITE: Upload and delete media.  - API_SCOPE_DOMAINS_READ: Read custom domains and their DNS instructions.  - API_SCOPE_DOMAINS_WRITE: Add, verify, update and delete custom domains.  - API_SCOPE_VISITORS_READ: Read and search visitors and their attributes.  - API_SCOPE_VISITORS_WRITE: Identify, update and delete visitors and their attributes.  - API_SCOPE_ANALYTICS_READ: Read events, metrics, time series, analytics data and dashboards.  - API_SCOPE_ANALYTICS_WRITE: Create, update and delete analytics dashboards and generate widget summaries.  - API_SCOPE_WEBHOOKS_READ: Read webhooks.  - API_SCOPE_WEBHOOKS_WRITE: Create, update and delete webhooks.  - API_SCOPE_INTEGRATIONS_READ: Read the Slack and Google Forms integrations.  - API_SCOPE_INTEGRATIONS_WRITE: Connect, configure, test, sync and disconnect the Slack and Google Forms integrations.  - API_SCOPE_WORKSPACE_READ: Read the workspace and its settings.  - API_SCOPE_WORKSPACE_WRITE: Update the workspace, request enrollment and delete the workspace.  - API_SCOPE_MEMBERS_READ: Read workspace members.  - API_SCOPE_MEMBERS_WRITE: Update, revoke, sign out and remove members. Inviting a member or changing a sign-in email or password needs full access.  - API_SCOPE_TOKENS_READ: Read API tokens and their scopes, never their secrets.  - API_SCOPE_TOKENS_WRITE: Create, update and delete API tokens, limited to the scopes the calling token holds.  - API_SCOPE_BILLING_WRITE: Open checkout, credit top-up and billing portal sessions.  - API_SCOPE_ASSISTANT_READ: Read the Assistant conversation.  - API_SCOPE_ASSISTANT_WRITE: Send files to the Assistant, clear the conversation and contact support.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Scope {
    #[serde(rename = "API_SCOPE_UNSPECIFIED")]
    ApiScopeUnspecified,
    #[serde(rename = "API_SCOPE_LINKS_READ")]
    ApiScopeLinksRead,
    #[serde(rename = "API_SCOPE_LINKS_WRITE")]
    ApiScopeLinksWrite,
    #[serde(rename = "API_SCOPE_WORKFLOWS_READ")]
    ApiScopeWorkflowsRead,
    #[serde(rename = "API_SCOPE_WORKFLOWS_WRITE")]
    ApiScopeWorkflowsWrite,
    #[serde(rename = "API_SCOPE_QRCODES_READ")]
    ApiScopeQrcodesRead,
    #[serde(rename = "API_SCOPE_QRCODES_WRITE")]
    ApiScopeQrcodesWrite,
    #[serde(rename = "API_SCOPE_PAGE_THEMES_READ")]
    ApiScopePageThemesRead,
    #[serde(rename = "API_SCOPE_PAGE_THEMES_WRITE")]
    ApiScopePageThemesWrite,
    #[serde(rename = "API_SCOPE_MEDIA_READ")]
    ApiScopeMediaRead,
    #[serde(rename = "API_SCOPE_MEDIA_WRITE")]
    ApiScopeMediaWrite,
    #[serde(rename = "API_SCOPE_DOMAINS_READ")]
    ApiScopeDomainsRead,
    #[serde(rename = "API_SCOPE_DOMAINS_WRITE")]
    ApiScopeDomainsWrite,
    #[serde(rename = "API_SCOPE_VISITORS_READ")]
    ApiScopeVisitorsRead,
    #[serde(rename = "API_SCOPE_VISITORS_WRITE")]
    ApiScopeVisitorsWrite,
    #[serde(rename = "API_SCOPE_ANALYTICS_READ")]
    ApiScopeAnalyticsRead,
    #[serde(rename = "API_SCOPE_ANALYTICS_WRITE")]
    ApiScopeAnalyticsWrite,
    #[serde(rename = "API_SCOPE_WEBHOOKS_READ")]
    ApiScopeWebhooksRead,
    #[serde(rename = "API_SCOPE_WEBHOOKS_WRITE")]
    ApiScopeWebhooksWrite,
    #[serde(rename = "API_SCOPE_INTEGRATIONS_READ")]
    ApiScopeIntegrationsRead,
    #[serde(rename = "API_SCOPE_INTEGRATIONS_WRITE")]
    ApiScopeIntegrationsWrite,
    #[serde(rename = "API_SCOPE_WORKSPACE_READ")]
    ApiScopeWorkspaceRead,
    #[serde(rename = "API_SCOPE_WORKSPACE_WRITE")]
    ApiScopeWorkspaceWrite,
    #[serde(rename = "API_SCOPE_MEMBERS_READ")]
    ApiScopeMembersRead,
    #[serde(rename = "API_SCOPE_MEMBERS_WRITE")]
    ApiScopeMembersWrite,
    #[serde(rename = "API_SCOPE_TOKENS_READ")]
    ApiScopeTokensRead,
    #[serde(rename = "API_SCOPE_TOKENS_WRITE")]
    ApiScopeTokensWrite,
    #[serde(rename = "API_SCOPE_BILLING_WRITE")]
    ApiScopeBillingWrite,
    #[serde(rename = "API_SCOPE_ASSISTANT_READ")]
    ApiScopeAssistantRead,
    #[serde(rename = "API_SCOPE_ASSISTANT_WRITE")]
    ApiScopeAssistantWrite,
}

impl Default for Scope {
    fn default() -> Scope {
        Self::ApiScopeUnspecified
    }
}