/*
* 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.
*
* The version of the OpenAPI document: 1.150.0
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// SocketEventMessage : SocketEventMessage carries something that happened, to everyone on a channel. This is the frame the local-first client listens for: a change hint tells it its copy may be behind, and it answers by re-reading. It was the one frame not in this contract, sent as the broadcast layer's own JSON, and it worked only because the client hand-parses a `type` field and the two vocabularies happened not to collide. A client generated strictly from this file would have dropped every one of them. The payload stays opaque. What is in it belongs to the domain that raised the event, and naming those shapes here would make this file change every time one of them did.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct SocketEventMessage {
/// Which channel carried it, so a client on several can tell them apart.
#[serde(rename = "channel", skip_serializing_if = "Option::is_none")]
pub channel: Option<String>,
/// What happened, as the domain named it.
#[serde(rename = "event", skip_serializing_if = "Option::is_none")]
pub event: Option<String>,
/// The event's own body, as JSON.
#[serde(rename = "payload", skip_serializing_if = "Option::is_none")]
pub payload: Option<String>,
#[serde(rename = "type", skip_serializing_if = "Option::is_none")]
pub r#type: Option<models::SocketMessageType>,
}
impl SocketEventMessage {
/// SocketEventMessage carries something that happened, to everyone on a channel. This is the frame the local-first client listens for: a change hint tells it its copy may be behind, and it answers by re-reading. It was the one frame not in this contract, sent as the broadcast layer's own JSON, and it worked only because the client hand-parses a `type` field and the two vocabularies happened not to collide. A client generated strictly from this file would have dropped every one of them. The payload stays opaque. What is in it belongs to the domain that raised the event, and naming those shapes here would make this file change every time one of them did.
pub fn new() -> SocketEventMessage {
SocketEventMessage {
channel: None,
event: None,
payload: None,
r#type: None,
}
}
}