/*
* 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.1
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct CreateMediaUploadRequest {
#[serde(rename = "fileName")]
pub file_name: String,
/// The file's MIME type: image/png, image/jpeg, image/webp, image/svg+xml, application/pdf or video/mp4. The uploaded bytes must be this format.
#[serde(rename = "mimeType")]
pub mime_type: String,
/// Optional: the file's SHA-256 digest, 64 hexadecimal characters. When given, a file the workspace already holds is refused at once with 409 MEDIA_ALREADY_EXISTS (metadata existingMediaId and existingFileName), and storage refuses a PUT whose bytes do not match it, so the PUT must carry the x-amz-checksum-sha256 header from upload_headers. When omitted, the server hashes the file on completion instead.
#[serde(rename = "sha256", skip_serializing_if = "Option::is_none")]
pub sha256: Option<String>,
/// The file's exact size in bytes. The PUT must send exactly this many bytes.
#[serde(rename = "size")]
pub size: i64,
/// Where the media was uploaded from, so pickers can show a section's own uploads first. It does not limit where the media can be used; see references for where it is used. Unset means UPLOAD_ORIGIN_MEDIA_LIBRARY.
#[serde(rename = "uploadedFrom", skip_serializing_if = "Option::is_none")]
pub uploaded_from: Option<models::MediaUploadOrigin>,
/// Deprecated: an upload no longer needs to say what the media is for, and this no longer limits the kinds or sizes accepted. Optional, accepted for compatibility and recorded as uploaded_from when uploaded_from is not set.
#[serde(rename = "usage", skip_serializing_if = "Option::is_none")]
pub usage: Option<models::MediaUsage>,
/// The visibility of the media. If not provided, the media file will be private.
#[serde(rename = "visibility", skip_serializing_if = "Option::is_none")]
pub visibility: Option<models::MediaVisibility>,
}
impl CreateMediaUploadRequest {
pub fn new(file_name: String, mime_type: String, size: i64) -> CreateMediaUploadRequest {
CreateMediaUploadRequest {
file_name,
mime_type,
sha256: None,
size,
uploaded_from: None,
usage: None,
visibility: None,
}
}
}