/*
* 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};
/// Job : A long-running operation.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct Job {
/// When the job finished, once it has.
#[serde(rename = "completedAt", skip_serializing_if = "Option::is_none")]
pub completed_at: Option<String>,
/// When the job was accepted.
#[serde(rename = "createdAt", skip_serializing_if = "Option::is_none")]
pub created_at: Option<String>,
/// Set when status is JOB_STATUS_FAILED.
#[serde(rename = "error", skip_serializing_if = "Option::is_none")]
pub error: Option<Box<models::JobError>>,
/// Job ID (UUID).
#[serde(rename = "id", skip_serializing_if = "Option::is_none")]
pub id: Option<String>,
/// How many items the job was submitted with.
#[serde(rename = "itemCount", skip_serializing_if = "Option::is_none")]
pub item_count: Option<i32>,
/// Set when a JOB_TYPE_LINKS_BULK_CREATE job succeeded.
#[serde(rename = "linksBulkCreate", skip_serializing_if = "Option::is_none")]
pub links_bulk_create: Option<Box<models::LinksBulkCreateResult>>,
/// Where a job stands. - JOB_STATUS_UNSPECIFIED: Not set. - JOB_STATUS_PENDING: Accepted and waiting to run. - JOB_STATUS_RUNNING: Running now. - JOB_STATUS_SUCCEEDED: Finished; the result is set. - JOB_STATUS_FAILED: Finished without doing its work; error says why. Nothing was created.
#[serde(rename = "status", skip_serializing_if = "Option::is_none")]
pub status: Option<Status>,
/// Path to poll for this job's status.
#[serde(rename = "statusUrl", skip_serializing_if = "Option::is_none")]
pub status_url: Option<String>,
/// What a job does. - JOB_TYPE_UNSPECIFIED: Not set. - JOB_TYPE_LINKS_BULK_CREATE: Creates a batch of links (POST /v1/links/bulk/jobs).
#[serde(rename = "type", skip_serializing_if = "Option::is_none")]
pub r#type: Option<Type>,
}
impl Job {
/// A long-running operation.
pub fn new() -> Job {
Job {
completed_at: None,
created_at: None,
error: None,
id: None,
item_count: None,
links_bulk_create: None,
status: None,
status_url: None,
r#type: None,
}
}
}
/// Where a job stands. - JOB_STATUS_UNSPECIFIED: Not set. - JOB_STATUS_PENDING: Accepted and waiting to run. - JOB_STATUS_RUNNING: Running now. - JOB_STATUS_SUCCEEDED: Finished; the result is set. - JOB_STATUS_FAILED: Finished without doing its work; error says why. Nothing was created.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Status {
#[serde(rename = "JOB_STATUS_UNSPECIFIED")]
JobStatusUnspecified,
#[serde(rename = "JOB_STATUS_PENDING")]
JobStatusPending,
#[serde(rename = "JOB_STATUS_RUNNING")]
JobStatusRunning,
#[serde(rename = "JOB_STATUS_SUCCEEDED")]
JobStatusSucceeded,
#[serde(rename = "JOB_STATUS_FAILED")]
JobStatusFailed,
}
impl Default for Status {
fn default() -> Status {
Self::JobStatusUnspecified
}
}
/// What a job does. - JOB_TYPE_UNSPECIFIED: Not set. - JOB_TYPE_LINKS_BULK_CREATE: Creates a batch of links (POST /v1/links/bulk/jobs).
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Type {
#[serde(rename = "JOB_TYPE_UNSPECIFIED")]
JobTypeUnspecified,
#[serde(rename = "JOB_TYPE_LINKS_BULK_CREATE")]
JobTypeLinksBulkCreate,
}
impl Default for Type {
fn default() -> Type {
Self::JobTypeUnspecified
}
}