ably_chat_openapi/apis/
message_reactions_api.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
11
12use reqwest;
13use serde::{Deserialize, Serialize, de::Error as _};
14use crate::{apis::ResponseContent, models};
15use super::{Error, configuration, ContentType};
16
17
18/// struct for typed errors of method [`delete_message_reaction`]
19#[derive(Debug, Clone, Serialize, Deserialize)]
20#[serde(untagged)]
21pub enum DeleteMessageReactionError {
22    Status400(models::ErrorResponse),
23    Status401(models::ErrorResponse),
24    Status404(models::ErrorResponse),
25    UnknownValue(serde_json::Value),
26}
27
28/// struct for typed errors of method [`get_client_reactions`]
29#[derive(Debug, Clone, Serialize, Deserialize)]
30#[serde(untagged)]
31pub enum GetClientReactionsError {
32    Status401(models::ErrorResponse),
33    Status404(models::ErrorResponse),
34    UnknownValue(serde_json::Value),
35}
36
37/// struct for typed errors of method [`send_message_reaction`]
38#[derive(Debug, Clone, Serialize, Deserialize)]
39#[serde(untagged)]
40pub enum SendMessageReactionError {
41    Status400(models::ErrorResponse),
42    Status401(models::ErrorResponse),
43    Status404(models::ErrorResponse),
44    UnknownValue(serde_json::Value),
45}
46
47
48/// Removes a reaction from a message. For `unique` reactions the `name` is not required; for `distinct` and `multiple` reactions the `name` is required. 
49pub async fn delete_message_reaction(configuration: &configuration::Configuration, room_name: &str, serial: &str, r#type: models::MessageReactionType, x_ably_version: Option<&str>, name: Option<&str>) -> Result<(), Error<DeleteMessageReactionError>> {
50    // add a prefix to parameters to efficiently prevent name collisions
51    let p_path_room_name = room_name;
52    let p_path_serial = serial;
53    let p_query_type = r#type;
54    let p_header_x_ably_version = x_ably_version;
55    let p_query_name = name;
56
57    let uri_str = format!("{}/chat/v4/rooms/{roomName}/messages/{serial}/reactions", configuration.base_path, roomName=crate::apis::urlencode(p_path_room_name), serial=crate::apis::urlencode(p_path_serial));
58    let mut req_builder = configuration.client.request(reqwest::Method::DELETE, &uri_str);
59
60    req_builder = req_builder.query(&[("type", &p_query_type.to_string())]);
61    if let Some(ref param_value) = p_query_name {
62        req_builder = req_builder.query(&[("name", &param_value.to_string())]);
63    }
64    if let Some(ref user_agent) = configuration.user_agent {
65        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
66    }
67    if let Some(param_value) = p_header_x_ably_version {
68        req_builder = req_builder.header("X-Ably-Version", param_value.to_string());
69    }
70    if let Some(ref auth_conf) = configuration.basic_auth {
71        req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
72    };
73    if let Some(ref token) = configuration.bearer_access_token {
74        req_builder = req_builder.bearer_auth(token.to_owned());
75    };
76
77    let req = req_builder.build()?;
78    let resp = configuration.client.execute(req).await?;
79
80    let status = resp.status();
81
82    if !status.is_client_error() && !status.is_server_error() {
83        Ok(())
84    } else {
85        let content = resp.text().await?;
86        let entity: Option<DeleteMessageReactionError> = serde_json::from_str(&content).ok();
87        Err(Error::ResponseError(ResponseContent { status, content, entity }))
88    }
89}
90
91/// Returns the reaction summary filtered to a single client. Useful when a message's reaction summary is clipped (too many reacting clients) and you need to determine whether a specific client has reacted. 
92pub async fn get_client_reactions(configuration: &configuration::Configuration, room_name: &str, serial: &str, x_ably_version: Option<&str>, for_client_id: Option<&str>) -> Result<models::MessageReactions, Error<GetClientReactionsError>> {
93    // add a prefix to parameters to efficiently prevent name collisions
94    let p_path_room_name = room_name;
95    let p_path_serial = serial;
96    let p_header_x_ably_version = x_ably_version;
97    let p_query_for_client_id = for_client_id;
98
99    let uri_str = format!("{}/chat/v4/rooms/{roomName}/messages/{serial}/client-reactions", configuration.base_path, roomName=crate::apis::urlencode(p_path_room_name), serial=crate::apis::urlencode(p_path_serial));
100    let mut req_builder = configuration.client.request(reqwest::Method::GET, &uri_str);
101
102    if let Some(ref param_value) = p_query_for_client_id {
103        req_builder = req_builder.query(&[("forClientId", &param_value.to_string())]);
104    }
105    if let Some(ref user_agent) = configuration.user_agent {
106        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
107    }
108    if let Some(param_value) = p_header_x_ably_version {
109        req_builder = req_builder.header("X-Ably-Version", param_value.to_string());
110    }
111    if let Some(ref auth_conf) = configuration.basic_auth {
112        req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
113    };
114    if let Some(ref token) = configuration.bearer_access_token {
115        req_builder = req_builder.bearer_auth(token.to_owned());
116    };
117
118    let req = req_builder.build()?;
119    let resp = configuration.client.execute(req).await?;
120
121    let status = resp.status();
122    let content_type = resp
123        .headers()
124        .get("content-type")
125        .and_then(|v| v.to_str().ok())
126        .unwrap_or("application/octet-stream");
127    let content_type = super::ContentType::from(content_type);
128
129    if !status.is_client_error() && !status.is_server_error() {
130        let content = resp.text().await?;
131        match content_type {
132            ContentType::Json => serde_json::from_str(&content).map_err(Error::from),
133            ContentType::Text => return Err(Error::from(serde_json::Error::custom("Received `text/plain` content type response that cannot be converted to `models::MessageReactions`"))),
134            ContentType::Unsupported(unknown_type) => return Err(Error::from(serde_json::Error::custom(format!("Received `{unknown_type}` content type response that cannot be converted to `models::MessageReactions`")))),
135        }
136    } else {
137        let content = resp.text().await?;
138        let entity: Option<GetClientReactionsError> = serde_json::from_str(&content).ok();
139        Err(Error::ResponseError(ResponseContent { status, content, entity }))
140    }
141}
142
143/// Adds a reaction to a message. Behaviour depends on the reaction `type`: `unique` (at most one reaction per client), `distinct` (at most one of each named reaction per client), `multiple` (repeatable, counted by `count`). 
144pub async fn send_message_reaction(configuration: &configuration::Configuration, room_name: &str, serial: &str, send_message_reaction_request: models::SendMessageReactionRequest, x_ably_version: Option<&str>) -> Result<(), Error<SendMessageReactionError>> {
145    // add a prefix to parameters to efficiently prevent name collisions
146    let p_path_room_name = room_name;
147    let p_path_serial = serial;
148    let p_body_send_message_reaction_request = send_message_reaction_request;
149    let p_header_x_ably_version = x_ably_version;
150
151    let uri_str = format!("{}/chat/v4/rooms/{roomName}/messages/{serial}/reactions", configuration.base_path, roomName=crate::apis::urlencode(p_path_room_name), serial=crate::apis::urlencode(p_path_serial));
152    let mut req_builder = configuration.client.request(reqwest::Method::POST, &uri_str);
153
154    if let Some(ref user_agent) = configuration.user_agent {
155        req_builder = req_builder.header(reqwest::header::USER_AGENT, user_agent.clone());
156    }
157    if let Some(param_value) = p_header_x_ably_version {
158        req_builder = req_builder.header("X-Ably-Version", param_value.to_string());
159    }
160    if let Some(ref auth_conf) = configuration.basic_auth {
161        req_builder = req_builder.basic_auth(auth_conf.0.to_owned(), auth_conf.1.to_owned());
162    };
163    if let Some(ref token) = configuration.bearer_access_token {
164        req_builder = req_builder.bearer_auth(token.to_owned());
165    };
166    req_builder = req_builder.json(&p_body_send_message_reaction_request);
167
168    let req = req_builder.build()?;
169    let resp = configuration.client.execute(req).await?;
170
171    let status = resp.status();
172
173    if !status.is_client_error() && !status.is_server_error() {
174        Ok(())
175    } else {
176        let content = resp.text().await?;
177        let entity: Option<SendMessageReactionError> = serde_json::from_str(&content).ok();
178        Err(Error::ResponseError(ResponseContent { status, content, entity }))
179    }
180}
181
ably_chat_openapi/apis/message_reactions_api.rs

ably_chat_openapi/apis/
message_reactions_api.rs
