Skip to main content

ably_chat_openapi/models/
send_message_request.rs

1/*
2 * Ably Chat REST API
3 *
4 * 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. 
5 *
6 * The version of the OpenAPI document: 4
7 * 
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct SendMessageRequest {
16    /// The text content of the message.
17    #[serde(rename = "text")]
18    pub text: String,
19    /// Arbitrary user-defined metadata. Not interpreted or validated by Ably; treat as untrusted input when reading. 
20    #[serde(rename = "metadata", skip_serializing_if = "Option::is_none")]
21    pub metadata: Option<std::collections::HashMap<String, serde_json::Value>>,
22    /// Arbitrary user-defined string headers, carried as Ably message `extras.headers`. Not interpreted or validated by Ably. 
23    #[serde(rename = "headers", skip_serializing_if = "Option::is_none")]
24    pub headers: Option<std::collections::HashMap<String, String>>,
25}
26
27impl SendMessageRequest {
28    pub fn new(text: String) -> SendMessageRequest {
29        SendMessageRequest {
30            text,
31            metadata: None,
32            headers: None,
33        }
34    }
35}
36