Skip to main content

ably_chat_openapi/models/
client_id_counts.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/// ClientIdCounts : Aggregated per-client counts for a `multiple` reaction.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct ClientIdCounts {
17    /// Total count across all clients (sum of per-client counts).
18    #[serde(rename = "total")]
19    pub total: i32,
20    /// Map of client ID to that client's reaction count.
21    #[serde(rename = "clientIds")]
22    pub client_ids: std::collections::HashMap<String, i32>,
23    /// Total count contributed by unidentified clients.
24    #[serde(rename = "totalUnidentified")]
25    pub total_unidentified: i32,
26    /// Whether the `clientIds` map was truncated.
27    #[serde(rename = "clipped", skip_serializing_if = "Option::is_none")]
28    pub clipped: Option<bool>,
29    /// Total number of distinct client IDs that reacted.
30    #[serde(rename = "totalClientIds", skip_serializing_if = "Option::is_none")]
31    pub total_client_ids: Option<i32>,
32}
33
34impl ClientIdCounts {
35    /// Aggregated per-client counts for a `multiple` reaction.
36    pub fn new(total: i32, client_ids: std::collections::HashMap<String, i32>, total_unidentified: i32) -> ClientIdCounts {
37        ClientIdCounts {
38            total,
39            client_ids,
40            total_unidentified,
41            clipped: None,
42            total_client_ids: None,
43        }
44    }
45}
46