/*
* Ably Chat REST API
*
* REST API for [Ably Chat](https://ably.com/docs/chat). This specification describes the HTTP surface of the Ably Chat REST API (path prefix `/chat/v4`) that the official Chat client SDKs use for request/response operations such as sending, editing, deleting and querying messages, message reactions and room occupancy. ## Scope & provenance Ably does **not** publish an official OpenAPI document for the Chat REST API (the official `ably/open-specs` `platform-v1.yaml` covers only the generic pub/sub REST API: `/channels`, `/push`, `/keys`, `/stats`, `/time`). This document was reconstructed from the `@ably/chat` JavaScript SDK v1.4.0 REST layer (`src/core/chat-api.ts`, `src/core/rest-types.ts`) together with Ably's documented REST conventions (host, authentication, versioning, pagination, error envelope). It therefore covers the endpoints the client SDK exercises. It is **not** an exhaustive description of every server capability, and there are intentionally no endpoints for creating or deleting rooms: Chat rooms are channel-backed and implicit — they are not provisioned via REST. ## Realtime vs REST Many Chat features (presence, typing indicators, room reactions, subscribing to live messages and reaction summaries) are delivered over Ably's realtime/pub-sub transport, not this REST API, and are out of scope here.
*
* The version of the OpenAPI document: 4
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// Message : A chat message in the V4 REST representation.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct Message {
/// The unique identifier of the message.
#[serde(rename = "serial")]
pub serial: String,
#[serde(rename = "version")]
pub version: Box<models::MessageVersion>,
/// The text content of the message.
#[serde(rename = "text")]
pub text: String,
/// The client ID of the user who created the message.
#[serde(rename = "clientId")]
pub client_id: String,
#[serde(rename = "action")]
pub action: models::MessageAction,
/// Arbitrary user-defined metadata. Not interpreted or validated by Ably; treat as untrusted input when reading.
#[serde(rename = "metadata")]
pub metadata: std::collections::HashMap<String, serde_json::Value>,
/// Arbitrary user-defined string headers, carried as Ably message `extras.headers`. Not interpreted or validated by Ably.
#[serde(rename = "headers")]
pub headers: std::collections::HashMap<String, String>,
/// Milliseconds since the Unix epoch at which the message was created.
#[serde(rename = "timestamp")]
pub timestamp: i64,
/// User claim attached by the server when the publishing token contained a matching `ably.room.<roomName>` claim. Present only in that case.
#[serde(rename = "userClaim", skip_serializing_if = "Option::is_none")]
pub user_claim: Option<String>,
#[serde(rename = "reactions", skip_serializing_if = "Option::is_none")]
pub reactions: Option<Box<models::MessageReactions>>,
}
impl Message {
/// A chat message in the V4 REST representation.
pub fn new(serial: String, version: models::MessageVersion, text: String, client_id: String, action: models::MessageAction, metadata: std::collections::HashMap<String, serde_json::Value>, headers: std::collections::HashMap<String, String>, timestamp: i64) -> Message {
Message {
serial,
version: Box::new(version),
text,
client_id,
action,
metadata,
headers,
timestamp,
user_claim: None,
reactions: None,
}
}
}