Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

Document generated GraphQL schema (#4837)

Sean Aye6f02b7260b9e
diff --git a/Cargo.lock b/Cargo.lock
index 7c875dafde..7a95ff6a24 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -2848,6 +2848,7 @@ name = "complete_graph"
version = "0.1.0"
dependencies = [
"anyhow",
+ "apollo-compiler",
"async-graphql",
"axum",
"axum-extra",
@@ -16161,6 +16162,7 @@ dependencies = [
"tower-http",
"tracing",
"tracing-core",
+ "triomphe",
"tungstenite 0.28.0",
"typenum",
"url",
diff --git a/crates/complete_graph/Cargo.toml b/crates/complete_graph/Cargo.toml
index 08553d5a16..539a910bfb 100644
--- a/crates/complete_graph/Cargo.toml
+++ b/crates/complete_graph/Cargo.toml
@@ -28,6 +28,7 @@ soup = { path = "../soup", default-features = false, features = ["ports"] }
workspace-hack = { version = "0.1", path = "../workspace-hack" }
[dev-dependencies]
+apollo-compiler = { workspace = true }
macro_user_id = { path = "../macro_user_id" }
models_pagination = { path = "../models_pagination" }
models_properties = { path = "../models_properties" }
diff --git a/crates/complete_graph/src/edges.rs b/crates/complete_graph/src/edges.rs
index d169408f9a..2685ab23cc 100644
--- a/crates/complete_graph/src/edges.rs
+++ b/crates/complete_graph/src/edges.rs
@@ -10,6 +10,7 @@ use graphql_notification::{
use graphql_properties::{EntityPropertyReader, GraphqlProperty, load_entity_properties};
use graphql_soup::SoupEntityEdges;
+/// Zero-sized marker tying an edge to its configured reader types.
type EdgeReaders<NR, PR, ER> = PhantomData<fn() -> (NR, PR, ER)>;
/// Notification, property, and email-content fields attached to Soup entities.
@@ -17,7 +18,9 @@ type EdgeReaders<NR, PR, ER> = PhantomData<fn() -> (NR, PR, ER)>;
/// This concrete edge shape lives in the composition crate so `graphql_soup`
/// does not know which cross-domain fields are attached to its objects.
pub struct SoupEdges<NR, PR, ER> {
+ /// Entity whose cross-domain fields are being resolved.
entity: model_entity::Entity<'static>,
+ /// Associates the edge with its configured reader types.
_readers: EdgeReaders<NR, PR, ER>,
}
@@ -53,6 +56,7 @@ where
}
}
+/// Cross-domain fields attached to a property-bearing Soup entity.
#[Object(name = "SoupEdges")]
impl<NR, PR, ER> SoupEdges<NR, PR, ER>
where
@@ -60,10 +64,12 @@ where
PR: EntityPropertyReader,
ER: SoupEmailContentEdgeReader,
{
+ /// Properties assigned to this entity that the authenticated user may view.
async fn properties(&self, ctx: &Context<'_>) -> async_graphql::Result<Vec<GraphqlProperty>> {
load_entity_properties::<PR>(ctx, self.entity.clone()).await
}
+ /// Notifications associated with this entity for the authenticated user.
async fn notifications(
&self,
ctx: &Context<'_>,
@@ -74,7 +80,9 @@ where
/// Email-content fields attached only to Soup email-thread entities.
pub struct SoupEmailThreadEdges<ER> {
+ /// Identifier of the email thread whose content is being resolved.
thread_id: String,
+ /// Associates the edge with its configured email-content reader.
_reader: PhantomData<fn() -> ER>,
}
@@ -87,11 +95,13 @@ impl<ER> Clone for SoupEmailThreadEdges<ER> {
}
}
+/// Email-content fields attached to a Soup email thread.
#[Object]
impl<ER> SoupEmailThreadEdges<ER>
where
ER: SoupEmailContentEdgeReader,
{
+ /// The newest non-draft content message in this thread.
async fn latest_content_message(
&self,
ctx: &Context<'_>,
diff --git a/crates/complete_graph/src/lib.rs b/crates/complete_graph/src/lib.rs
index becf18a9b2..31de6292c5 100644
--- a/crates/complete_graph/src/lib.rs
+++ b/crates/complete_graph/src/lib.rs
@@ -2,8 +2,11 @@
//! `graphql_properties`, `graphql_notification`, `graphql_email`) into the complete schema
//! served by `document_storage_service` and exported as SDL.
#![deny(missing_docs)]
+#![deny(clippy::missing_docs_in_private_items)]
+/// Cross-domain fields composed onto Soup entities.
mod edges;
+/// Complete schema types and construction helpers.
mod schema;
#[cfg(test)]
mod sdl_test;
diff --git a/crates/complete_graph/src/schema.rs b/crates/complete_graph/src/schema.rs
index 382d8fb607..5042a131fb 100644
--- a/crates/complete_graph/src/schema.rs
+++ b/crates/complete_graph/src/schema.rs
@@ -72,7 +72,9 @@ type ServicesMarker<E, EAS, St, NR, PR, ER> = PhantomData<fn() -> (E, EAS, St, N
/// Root GraphQL query object for Soup.
pub struct SoupQueryRoot<S, E, EAS, St, NR, PR, ER> {
+ /// Soup domain service used by user-scoped query resolvers.
service: S,
+ /// Associates the root with its adapter and reader types.
_marker: ServicesMarker<E, EAS, St, NR, PR, ER>,
}
@@ -90,7 +92,9 @@ impl<S, E, EAS, St, NR, PR, ER> SoupQueryRoot<S, E, EAS, St, NR, PR, ER> {
/// object so clients (and their normalized caches) observe data ownership
/// structurally rather than implicitly through the session.
pub struct GraphqlUser<S, E, EAS, St, NR, PR, ER> {
+ /// Soup domain service used by this user's resolvers.
service: S,
+ /// Associates the user object with its adapter and reader types.
_marker: ServicesMarker<E, EAS, St, NR, PR, ER>,
}
@@ -142,6 +146,7 @@ where
build_schema_with_service(service)
}
+/// Root entry point for the complete GraphQL API.
#[Object]
impl<S, E, EAS, St, NR, PR, ER> SoupQueryRoot<S, E, EAS, St, NR, PR, ER>
where
@@ -164,6 +169,7 @@ where
}
}
+/// The authenticated user and their user-scoped data.
#[Object(name = "GraphqlUser")]
impl<S, E, EAS, St, NR, PR, ER> GraphqlUser<S, E, EAS, St, NR, PR, ER>
where
diff --git a/crates/complete_graph/src/sdl_test.rs b/crates/complete_graph/src/sdl_test.rs
index 0ac69b5a4a..ed4e31a191 100644
--- a/crates/complete_graph/src/sdl_test.rs
+++ b/crates/complete_graph/src/sdl_test.rs
@@ -38,6 +38,75 @@ fn soup_response_schema_exposes_frontend_fields() {
}
}
+#[test]
+fn schema_types_and_fields_have_descriptions() {
+ use apollo_compiler::schema::ExtendedType;
+
+ let schema =
+ apollo_compiler::Schema::parse_and_validate(crate::build_schema().sdl(), "schema.graphql")
+ .expect("generated SDL is valid");
+
+ let mut missing = Vec::new();
+ for (name, graphql_type) in &schema.types {
+ if graphql_type.is_built_in() {
+ continue;
+ }
+ if graphql_type.description().is_none() {
+ missing.push(format!("type {name}"));
+ }
+
+ match graphql_type {
+ ExtendedType::Object(ty) => collect_undocumented(
+ &mut missing,
+ name,
+ ty.fields
+ .iter()
+ .map(|(name, field)| (name, field.description.is_none())),
+ ),
+ ExtendedType::Interface(ty) => collect_undocumented(
+ &mut missing,
+ name,
+ ty.fields
+ .iter()
+ .map(|(name, field)| (name, field.description.is_none())),
+ ),
+ ExtendedType::InputObject(ty) => collect_undocumented(
+ &mut missing,
+ name,
+ ty.fields
+ .iter()
+ .map(|(name, field)| (name, field.description.is_none())),
+ ),
+ ExtendedType::Enum(ty) => collect_undocumented(
+ &mut missing,
+ name,
+ ty.values
+ .iter()
+ .map(|(name, value)| (name, value.description.is_none())),
+ ),
+ ExtendedType::Scalar(_) | ExtendedType::Union(_) => {}
+ }
+ }
+
+ assert!(
+ missing.is_empty(),
+ "GraphQL schema items missing descriptions: {}",
+ missing.join(", ")
+ );
+}
+
+fn collect_undocumented<'a>(
+ missing: &mut Vec<String>,
+ type_name: &str,
+ items: impl Iterator<Item = (&'a apollo_compiler::Name, bool)>,
+) {
+ for (name, is_undocumented) in items {
+ if is_undocumented {
+ missing.push(format!("{type_name}.{name}"));
+ }
+ }
+}
+
#[test]
fn property_values_are_a_typed_union_without_soup_names() {
let sdl = crate::build_schema().sdl();
diff --git a/crates/graphql_common/src/filter_input.rs b/crates/graphql_common/src/filter_input.rs
index a9372ff06b..ea181c22f0 100644
--- a/crates/graphql_common/src/filter_input.rs
+++ b/crates/graphql_common/src/filter_input.rs
@@ -48,25 +48,30 @@ pub fn parse_macro_user_id(
/// `Literal`) plus its binary node struct, and an [`IntoFilterExpr`] impl
/// converting it into a `filter_ast` expression over the target literal.
///
-/// The generated types deliberately carry no doc comments: doc comments on
-/// GraphQL input types are emitted as SDL descriptions, and the exported
-/// `schema.graphql` must not change.
+/// The generated types and fields carry documentation that is emitted as SDL
+/// descriptions, keeping the exported schema self-documenting.
#[macro_export]
macro_rules! filter_expr_input {
($name:ident, $binary_name:ident, $literal:ty, $target:ty, $type_name:literal) => {
- #[allow(missing_docs)]
+ #[doc = concat!("The two operands of a recursive `", $type_name, "` binary expression.")]
#[derive(async_graphql::InputObject)]
pub struct $binary_name {
+ /// The left-hand expression.
pub left: Box<$name>,
+ /// The right-hand expression.
pub right: Box<$name>,
}
- #[allow(missing_docs)]
+ #[doc = concat!("A recursive `", $type_name, "` filter expression.")]
#[derive(async_graphql::OneofObject)]
pub enum $name {
+ /// Matches when both expressions match.
And($binary_name),
+ /// Matches when either expression matches.
Or($binary_name),
+ /// Negates an expression.
Not(Box<$name>),
+ /// Matches a domain-specific literal condition.
Literal($literal),
}
diff --git a/crates/graphql_common/src/lib.rs b/crates/graphql_common/src/lib.rs
index 38c0eaf703..fad4c6beaf 100644
--- a/crates/graphql_common/src/lib.rs
+++ b/crates/graphql_common/src/lib.rs
@@ -2,14 +2,20 @@
//! extractor context, filter-input conversion helpers, and cross-domain
//! schema types.
#![deny(missing_docs)]
+#![deny(clippy::missing_docs_in_private_items)]
// Re-exported for use by the `filter_expr_input!` macro expansion.
pub use filter_ast;
+/// Shared GraphQL entity-type mappings.
mod entity_type;
+/// Axum request-parts extraction helpers for GraphQL resolvers.
mod extract;
+/// GraphQL filter-input conversion helpers.
mod filter_input;
+/// Property-filter GraphQL input types.
mod property_filter;
+/// Request-scoped context used by GraphQL resolvers.
mod request_context;
pub use entity_type::GraphqlSoupEntityType;
diff --git a/crates/graphql_common/src/property_filter.rs b/crates/graphql_common/src/property_filter.rs
index 34d607e52e..c1f0317889 100644
--- a/crates/graphql_common/src/property_filter.rs
+++ b/crates/graphql_common/src/property_filter.rs
@@ -53,6 +53,7 @@ pub enum GraphqlPropertyMatchValue {
}
impl GraphqlPropertyMatchValue {
+ /// Convert the GraphQL property match value into its domain representation.
fn into_ast(self) -> async_graphql::Result<PropertyMatchValue> {
Ok(match self {
Self::SelectOption(id) => {
diff --git a/crates/graphql_common/src/request_context.rs b/crates/graphql_common/src/request_context.rs
index a35bf0404c..1ebfe0093e 100644
--- a/crates/graphql_common/src/request_context.rs
+++ b/crates/graphql_common/src/request_context.rs
@@ -11,6 +11,7 @@ use axum::{extract::FromRequestParts, http::request::Parts};
/// wrapped in `axum_extra::extract::Cached`, which memoizes inside the parts'
/// extensions exactly like the REST routes do.
pub struct GraphqlSoupRequestParts {
+ /// Mutable HTTP request parts shared by lazy resolver extractors.
parts: tokio::sync::Mutex<Parts>,
}
diff --git a/crates/graphql_email/src/objects.rs b/crates/graphql_email/src/objects.rs
index e7b4757d69..3cca56a02c 100644
--- a/crates/graphql_email/src/objects.rs
+++ b/crates/graphql_email/src/objects.rs
@@ -8,56 +8,70 @@ use crate::loaders::{
/// A lightweight email content projection for Soup queries.
pub struct GraphqlSoupEmailMessage(ParsedMessage);
+/// A lightweight email content projection for Soup queries.
#[Object]
impl GraphqlSoupEmailMessage {
+ /// The unique message identifier.
async fn id(&self) -> ID {
ID(self.0.db_id.to_string())
}
+ /// The identifier of the containing thread.
async fn thread_id(&self) -> ID {
ID(self.0.thread_db_id.to_string())
}
+ /// The identifier of the linked email account.
async fn link_id(&self) -> ID {
ID(self.0.link_id.to_string())
}
+ /// The message subject.
async fn subject(&self) -> Option<&str> {
self.0.subject.as_deref()
}
+ /// A short preview of the message content.
async fn snippet(&self) -> Option<&str> {
self.0.snippet.as_deref()
}
+ /// The provider's internal timestamp in RFC 3339 format.
async fn internal_date_ts(&self) -> Option<String> {
self.0.internal_date_ts.map(|value| value.to_rfc3339())
}
+ /// The sent timestamp in RFC 3339 format.
async fn sent_at(&self) -> Option<String> {
self.0.sent_at.map(|value| value.to_rfc3339())
}
+ /// Whether the message has been read.
async fn is_read(&self) -> bool {
self.0.is_read
}
+ /// Whether the message is starred.
async fn is_starred(&self) -> bool {
self.0.is_starred
}
+ /// Whether the message was sent by the linked account.
async fn is_sent(&self) -> bool {
self.0.is_sent
}
+ /// Whether the message has attachments.
async fn has_attachments(&self) -> bool {
self.0.has_attachments
}
+ /// The sender of the message.
async fn from(&self) -> Option<GraphqlSoupEmailContact> {
self.0.from.clone().map(GraphqlSoupEmailContact)
}
+ /// The primary recipients of the message.
async fn to(&self) -> Vec<GraphqlSoupEmailContact> {
self.0
.to
@@ -67,6 +81,7 @@ impl GraphqlSoupEmailMessage {
.collect()
}
+ /// The carbon-copy recipients of the message.
async fn cc(&self) -> Vec<GraphqlSoupEmailContact> {
self.0
.cc
@@ -76,6 +91,7 @@ impl GraphqlSoupEmailMessage {
.collect()
}
+ /// The blind-carbon-copy recipients of the message.
async fn bcc(&self) -> Vec<GraphqlSoupEmailContact> {
self.0
.bcc
@@ -85,6 +101,7 @@ impl GraphqlSoupEmailMessage {
.collect()
}
+ /// Labels assigned to the message.
async fn labels(&self) -> Vec<GraphqlSoupEmailMessageLabel> {
self.0
.labels
@@ -94,30 +111,37 @@ impl GraphqlSoupEmailMessage {
.collect()
}
+ /// The parsed message body.
async fn body_parsed(&self) -> Option<&str> {
self.0.body_parsed.as_deref()
}
+ /// The plain-text message body.
async fn body_text(&self) -> Option<&str> {
self.0.body_text.as_deref()
}
+ /// The sanitized HTML message body.
async fn body_html_sanitized(&self) -> Option<&str> {
self.0.body_html_sanitized.as_deref()
}
+ /// The message body in Macro's rich-text format.
async fn body_macro(&self) -> Option<&str> {
self.0.body_macro.as_deref()
}
+ /// The message body with quoted replies removed.
async fn body_replyless(&self) -> Option<&str> {
self.0.body_replyless.as_deref()
}
+ /// The creation timestamp in RFC 3339 format.
async fn created_at(&self) -> String {
self.0.created_at.to_rfc3339()
}
+ /// The last-updated timestamp in RFC 3339 format.
async fn updated_at(&self) -> String {
self.0.updated_at.to_rfc3339()
}
@@ -126,16 +150,20 @@ impl GraphqlSoupEmailMessage {
/// An email sender or recipient embedded in a message.
pub struct GraphqlSoupEmailContact(ContactInfo);
+/// An email sender or recipient embedded in a message.
#[Object]
impl GraphqlSoupEmailContact {
+ /// The contact's email address.
async fn email(&self) -> &str {
&self.0.email
}
+ /// The contact's display name.
async fn name(&self) -> Option<&str> {
self.0.name.as_deref()
}
+ /// The contact's profile photo URL.
async fn photo_url(&self) -> Option<&str> {
self.0.photo_url.as_deref()
}
@@ -144,12 +172,15 @@ impl GraphqlSoupEmailContact {
/// A lightweight label embedded in an email message.
pub struct GraphqlSoupEmailMessageLabel(ParsedLabel);
+/// A lightweight label embedded in an email message.
#[Object]
impl GraphqlSoupEmailMessageLabel {
+ /// The label identifier assigned by the email provider.
async fn provider_label_id(&self) -> &str {
&self.0.provider_id
}
+ /// The label name.
async fn name(&self) -> &str {
&self.0.name
}
diff --git a/crates/graphql_notification/src/lib.rs b/crates/graphql_notification/src/lib.rs
index 57286e4641..1c89cadd4a 100644
--- a/crates/graphql_notification/src/lib.rs
+++ b/crates/graphql_notification/src/lib.rs
@@ -1,8 +1,11 @@
//! GraphQL inbound adapter for the notification domain: the notification
//! object type and the DataLoader-backed entity notification edge.
#![deny(missing_docs)]
+#![deny(clippy::missing_docs_in_private_items)]
+/// DataLoader implementations for notification edges.
mod loaders;
+/// GraphQL notification object and edge resolver.
mod objects;
pub use loaders::{
diff --git a/crates/graphql_notification/src/loaders.rs b/crates/graphql_notification/src/loaders.rs
index ea34e2677c..f931f773b5 100644
--- a/crates/graphql_notification/src/loaders.rs
+++ b/crates/graphql_notification/src/loaders.rs
@@ -8,6 +8,7 @@ use notification::domain::models::{
};
use rootcause::markers::{Cloneable, Dynamic};
+/// Map a shared entity type to the notification domain's item type.
fn notification_item_type(
entity_type: model_entity::EntityType,
) -> Result<NotificationItemType, rootcause::Report> {
@@ -113,7 +114,9 @@ impl SoupNotificationEdgeReader for NoOpSoupNotificationEdgeReader {
/// DataLoader for entity notification edges.
pub struct EntityNotificationsLoader<R> {
+ /// User whose notifications are loaded.
user_id: MacroUserIdStr<'static>,
+ /// Notification reader used to fulfill batches.
reader: R,
}
diff --git a/crates/graphql_notification/src/objects.rs b/crates/graphql_notification/src/objects.rs
index 6ff88f54b7..e5787d2d45 100644
--- a/crates/graphql_notification/src/objects.rs
+++ b/crates/graphql_notification/src/objects.rs
@@ -8,52 +8,65 @@ use crate::loaders::{EntityNotificationsLoader, SoupNotificationEdgeReader};
/// GraphQL notification attached to a Soup entity.
pub struct GraphqlSoupNotification(UserNotificationRow<serde_json::Value>);
+/// A notification associated with a Soup entity.
#[Object]
impl GraphqlSoupNotification {
+ /// The notification identifier.
async fn id(&self) -> ID {
ID(self.0.notification_id.to_string())
}
+ /// The event that produced the notification.
async fn event_type(&self) -> &str {
&self.0.notification_event_type
}
+ /// The type of the associated entity.
async fn entity_type(&self) -> GraphqlSoupEntityType {
GraphqlSoupEntityType::from(self.0.entity.entity_type)
}
+ /// The identifier of the associated entity.
async fn entity_id(&self) -> &str {
&self.0.entity.entity_id
}
+ /// Whether the notification has been sent.
async fn sent(&self) -> bool {
self.0.sent
}
+ /// Whether notification processing is complete.
async fn done(&self) -> bool {
self.0.done
}
+ /// Whether the recipient has seen the notification.
async fn seen(&self) -> bool {
self.0.viewed_at.is_some()
}
+ /// The notification creation time in RFC 3339 format.
async fn created_at(&self) -> String {
self.0.created_at.to_rfc3339()
}
+ /// The time the notification was viewed, in RFC 3339 format.
async fn viewed_at(&self) -> Option<String> {
self.0.viewed_at.map(|ts| ts.to_rfc3339())
}
+ /// The notification's last update time in RFC 3339 format.
async fn updated_at(&self) -> String {
self.0.updated_at.to_rfc3339()
}
+ /// The identifier of the user who triggered the notification.
async fn sender_id(&self) -> Option<String> {
self.0.sender_id.as_ref().map(|sender| sender.to_string())
}
+ /// Event-specific notification metadata.
async fn metadata(&self) -> Json<Value> {
Json(self.0.notification_metadata.clone())
}
diff --git a/crates/graphql_properties/src/lib.rs b/crates/graphql_properties/src/lib.rs
index 5219e69779..76253f76bb 100644
--- a/crates/graphql_properties/src/lib.rs
+++ b/crates/graphql_properties/src/lib.rs
@@ -1,9 +1,13 @@
//! GraphQL inbound adapter for the properties domain: property object types,
//! property filter inputs, and the DataLoader-backed entity property edge.
#![deny(missing_docs)]
+#![deny(clippy::missing_docs_in_private_items)]
+/// DataLoader implementations for entity property edges.
mod loaders;
+/// GraphQL mutations for assigning entity properties.
mod mutations;
+/// GraphQL property objects, values, and edge resolver.
mod objects;
pub use graphql_common::{
diff --git a/crates/graphql_properties/src/loaders.rs b/crates/graphql_properties/src/loaders.rs
index 5057da799d..7f8036815a 100644
--- a/crates/graphql_properties/src/loaders.rs
+++ b/crates/graphql_properties/src/loaders.rs
@@ -7,6 +7,7 @@ use macro_user_id::user_id::MacroUserIdStr;
use models_properties::service::entity_property_with_definition::EntityPropertyWithDefinition;
use rootcause::markers::{Cloneable, Dynamic};
+/// Map a shared entity type to its properties-domain representation.
fn property_entity_type(
entity_type: model_entity::EntityType,
) -> Option<models_properties::EntityType> {
@@ -55,7 +56,9 @@ impl EntityPropertyReader for NoOpEntityPropertyReader {
/// GraphQL property reader backed by the properties domain service and the
/// canonical entity access service.
pub struct PropertiesEntityPropertyReader<P, A> {
+ /// Domain service used to load properties.
properties_service: Arc<P>,
+ /// Access service used to authorize each requested entity.
entity_access_service: Arc<A>,
}
@@ -155,7 +158,9 @@ where
/// DataLoader for entity property edges.
pub struct EntityPropertiesLoader<R> {
+ /// User on whose behalf properties are loaded.
user_id: MacroUserIdStr<'static>,
+ /// Property reader used to fulfill batches.
reader: R,
}
diff --git a/crates/graphql_properties/src/mutations.rs b/crates/graphql_properties/src/mutations.rs
index f2f2791f73..6f0c1da6cd 100644
--- a/crates/graphql_properties/src/mutations.rs
+++ b/crates/graphql_properties/src/mutations.rs
@@ -53,8 +53,11 @@ impl EntityPropertyWriter for NoOpEntityPropertyWriter {
/// Entity property writer backed by the properties and entity access services.
pub struct PropertiesEntityPropertyWriter<P, A> {
+ /// Domain service used to write properties.
properties_service: Arc<P>,
+ /// Access service used to authorize writes.
entity_access_service: Arc<A>,
+ /// Authenticated user performing the write.
user_id: MacroUserIdStr<'static>,
}
@@ -109,23 +112,32 @@ where
}
}
+/// Input for assigning or updating an entity property.
#[derive(async_graphql::InputObject)]
struct SetEntityPropertyInput {
+ /// Type of entity receiving the property.
entity_type: GraphqlPropertyEntityType,
+ /// Identifier of the entity receiving the property.
entity_id: String,
+ /// Identifier of the property definition to assign.
property_definition_id: ID,
/// Omit or pass null to attach the property without a value.
value: Option<GraphqlSetPropertyValue>,
}
+/// Input identifying an entity referenced by a property value.
#[derive(async_graphql::InputObject)]
struct GraphqlEntityReferenceInput {
+ /// Type of the referenced entity.
entity_type: GraphqlPropertyEntityType,
+ /// Identifier of the referenced entity.
entity_id: String,
+ /// Specific message when the reference targets a thread message.
specific_message_id: Option<ID>,
}
impl GraphqlEntityReferenceInput {
+ /// Convert the GraphQL reference into its properties-domain model.
fn try_into_model(self) -> async_graphql::Result<EntityReference> {
Ok(EntityReference {
entity_type: self.entity_type.into(),
@@ -138,21 +150,33 @@ impl GraphqlEntityReferenceInput {
}
}
+/// A typed value accepted when setting an entity property.
#[derive(async_graphql::OneofObject)]
enum GraphqlSetPropertyValue {
+ /// A Boolean value.
Boolean(bool),
+ /// An RFC 3339 date-time value.
Date(String),
+ /// A numeric value.
Number(f64),
+ /// A string value.
String(String),
+ /// A single selected option identifier.
SelectOption(ID),
+ /// Multiple selected option identifiers.
MultiSelectOption(Vec<ID>),
+ /// A single entity reference.
EntityReference(GraphqlEntityReferenceInput),
+ /// Multiple entity references.
MultiEntityReference(Vec<GraphqlEntityReferenceInput>),
+ /// A single URL value.
Link(String),
+ /// Multiple URL values.
MultiLink(Vec<String>),
}
impl GraphqlSetPropertyValue {
+ /// Convert the GraphQL value into its properties-domain request model.
fn try_into_model(self) -> async_graphql::Result<SetPropertyValue> {
Ok(match self {
Self::Boolean(value) => SetPropertyValue::Boolean { value },
@@ -191,6 +215,7 @@ impl GraphqlSetPropertyValue {
}
}
+/// Mutations for assigning and updating entity properties.
#[Object]
impl<T> PropertiesMutationRoot<T>
where
diff --git a/crates/graphql_properties/src/objects.rs b/crates/graphql_properties/src/objects.rs
index 4a7963966a..576c69e28f 100644
--- a/crates/graphql_properties/src/objects.rs
+++ b/crates/graphql_properties/src/objects.rs
@@ -71,6 +71,7 @@ impl From<EntityPropertyWithDefinition> for GraphqlProperty {
}
}
+/// A property assignment and its current value.
#[Object]
impl GraphqlProperty {
/// The globally unique identifier of this entity-property assignment.
diff --git a/crates/graphql_soup/src/inputs.rs b/crates/graphql_soup/src/inputs.rs
index 9229f7c37b..8084eba35a 100644
--- a/crates/graphql_soup/src/inputs.rs
+++ b/crates/graphql_soup/src/inputs.rs
@@ -48,6 +48,7 @@ pub struct SoupInput {
}
impl SoupInput {
+ /// Convert this value into the request representation.
pub(crate) fn into_request(
self,
macro_user_id: MacroUserIdStr<'static>,
@@ -94,18 +95,27 @@ impl SoupInput {
}
}
+/// GraphQL input representing the email view.
#[derive(Enum, Copy, Clone, Eq, PartialEq)]
enum GraphqlEmailView {
+ /// The inbox option.
Inbox,
+ /// The drafts option.
Drafts,
+ /// The sent option.
Sent,
+ /// The all option.
All,
+ /// The starred option.
Starred,
+ /// The important option.
Important,
+ /// The other option.
Other,
}
impl GraphqlEmailView {
+ /// Return the corresponding email preview view name.
fn as_preview_view_str(self) -> &'static str {
match self {
Self::Inbox => "inbox",
@@ -122,19 +132,30 @@ impl GraphqlEmailView {
/// GraphQL input mirroring `item_filters::ast::EntityFilterAst`.
#[derive(async_graphql::InputObject)]
struct GraphqlEntityFilterAst {
+ /// The document filter to apply.
document_filter: Option<GraphqlDocumentExpr>,
+ /// The project filter to apply.
project_filter: Option<GraphqlProjectExpr>,
+ /// The chat filter to apply.
chat_filter: Option<GraphqlChatExpr>,
+ /// The email filter to apply.
email_filter: Option<GraphqlEmailFilterAst>,
+ /// The channel filter to apply.
channel_filter: Option<GraphqlChannelExpr>,
+ /// The channel thread filter to apply.
channel_thread_filter: Option<GraphqlChannelThreadExpr>,
+ /// The call filter to apply.
call_filter: Option<GraphqlCallExpr>,
+ /// The crm company filter to apply.
crm_company_filter: Option<GraphqlCrmCompanyExpr>,
+ /// The foreign entity filter to apply.
foreign_entity_filter: Option<GraphqlForeignEntityExpr>,
+ /// The properties filter to apply.
properties_filter: Option<GraphqlPropertiesExpr>,
}
impl GraphqlEntityFilterAst {
+ /// Convert this value into the ast representation.
fn into_ast(self) -> async_graphql::Result<EntityFilterAst> {
Ok(EntityFilterAst {
document_filter: optional_tree(self.document_filter)?,
@@ -218,13 +239,17 @@ filter_expr_input!(
ForeignEntityLiteral,
"ForeignEntityFilterExpr"
);
+/// GraphQL input representing the email filter ast.
#[derive(async_graphql::InputObject)]
struct GraphqlEmailFilterAst {
+ /// The tree.
tree: Option<GraphqlEmailExpr>,
+ /// The crm scope.
crm_scope: Option<GraphqlCrmScope>,
}
impl GraphqlEmailFilterAst {
+ /// Convert this value into the ast representation.
fn into_ast(self) -> async_graphql::Result<EmailFilterAst> {
Ok(EmailFilterAst {
tree: optional_tree(self.tree)?,
@@ -233,13 +258,17 @@ impl GraphqlEmailFilterAst {
}
}
+/// GraphQL input representing the crm scope.
#[derive(async_graphql::OneofObject)]
enum GraphqlCrmScope {
+ /// The domains option.
Domains(Vec<String>),
+ /// The addresses option.
Addresses(Vec<String>),
}
impl GraphqlCrmScope {
+ /// Convert this value into the ast representation.
fn into_ast(self) -> async_graphql::Result<CrmScope> {
match self {
Self::Domains(domains) if domains.is_empty() => Err(async_graphql::Error::new(
@@ -254,15 +283,21 @@ impl GraphqlCrmScope {
}
}
+/// GraphQL input representing the date literal.
#[derive(async_graphql::OneofObject)]
enum GraphqlDateLiteral {
+ /// The gt option.
Gt(String),
+ /// The lt option.
Lt(String),
+ /// The gte option.
Gte(String),
+ /// The lte option.
Lte(String),
}
impl GraphqlDateLiteral {
+ /// Parse an email address from a GraphQL string value.
fn parse(value: String) -> async_graphql::Result<DateTime<Utc>> {
DateTime::parse_from_rfc3339(&value)
.map(|dt| dt.with_timezone(&Utc))
@@ -271,6 +306,7 @@ impl GraphqlDateLiteral {
})
}
+ /// Convert this value into the ast representation.
fn into_ast(self) -> async_graphql::Result<DateLiteral> {
Ok(match self {
Self::Gt(value) => DateLiteral::GreaterThan(Self::parse(value)?),
@@ -281,24 +317,39 @@ impl GraphqlDateLiteral {
}
}
+/// GraphQL input representing the document literal.
#[derive(async_graphql::OneofObject)]
enum GraphqlDocumentLiteral {
+ /// The file type option.
FileType(String),
+ /// The id option.
Id(ID),
+ /// The project id option.
ProjectId(ID),
+ /// The owner option.
Owner(String),
+ /// The importance option.
Importance(bool),
+ /// The notification done option.
NotificationDone(bool),
+ /// The notification seen option.
NotificationSeen(bool),
+ /// The include cbm atm nc option.
IncludeCbmAtmNc(bool),
+ /// The sub type option.
SubType(GraphqlDocumentSubType),
+ /// The file assoc option.
FileAssoc(String),
+ /// The is email attachment option.
IsEmailAttachment(bool),
+ /// The created at option.
CreatedAt(GraphqlDateLiteral),
+ /// The updated at option.
UpdatedAt(GraphqlDateLiteral),
}
impl IntoFilterExpr<DocumentLiteral> for GraphqlDocumentLiteral {
+ /// Convert this value into the expr representation.
fn into_expr(self) -> async_graphql::Result<Expr<DocumentLiteral>> {
let literal = match self {
Self::FileAssoc(value) => {
@@ -332,9 +383,12 @@ impl IntoFilterExpr<DocumentLiteral> for GraphqlDocumentLiteral {
}
}
+/// GraphQL input representing the document sub type.
#[derive(Enum, Copy, Clone, Eq, PartialEq)]
enum GraphqlDocumentSubType {
+ /// The task option.
Task,
+ /// The snippet option.
Snippet,
}
@@ -347,19 +401,29 @@ impl From<GraphqlDocumentSubType> for DocumentSubType {
}
}
+/// GraphQL input representing the project literal.
#[derive(async_graphql::OneofObject)]
enum GraphqlProjectLiteral {
+ /// The project id option.
ProjectId(ID),
+ /// The project id self option.
ProjectIdSelf(ID),
+ /// The owner option.
Owner(String),
+ /// The importance option.
Importance(bool),
+ /// The notification done option.
NotificationDone(bool),
+ /// The notification seen option.
NotificationSeen(bool),
+ /// The created at option.
CreatedAt(GraphqlDateLiteral),
+ /// The updated at option.
UpdatedAt(GraphqlDateLiteral),
}
impl IntoFilterExpr<ProjectLiteral> for GraphqlProjectLiteral {
+ /// Convert this value into the expr representation.
fn into_expr(self) -> async_graphql::Result<Expr<ProjectLiteral>> {
let literal = match self {
Self::ProjectId(id) => ProjectLiteral::ProjectId(parse_id(id, "projectId")?),
@@ -377,20 +441,31 @@ impl IntoFilterExpr<ProjectLiteral> for GraphqlProjectLiteral {
}
}
+/// GraphQL input representing the chat literal.
#[derive(async_graphql::OneofObject)]
enum GraphqlChatLiteral {
+ /// The project id option.
ProjectId(ID),
+ /// The role option.
Role(GraphqlChatRole),
+ /// The chat id option.
ChatId(ID),
+ /// The owner option.
Owner(String),
+ /// The importance option.
Importance(bool),
+ /// The notification done option.
NotificationDone(bool),
+ /// The notification seen option.
NotificationSeen(bool),
+ /// The created at option.
CreatedAt(GraphqlDateLiteral),
+ /// The updated at option.
UpdatedAt(GraphqlDateLiteral),
}
impl IntoFilterExpr<ChatLiteral> for GraphqlChatLiteral {
+ /// Convert this value into the expr representation.
fn into_expr(self) -> async_graphql::Result<Expr<ChatLiteral>> {
let literal = match self {
Self::ProjectId(id) => ChatLiteral::ProjectId(parse_id(id, "projectId")?),
@@ -407,10 +482,14 @@ impl IntoFilterExpr<ChatLiteral> for GraphqlChatLiteral {
}
}
+/// GraphQL input representing the chat role.
#[derive(Enum, Copy, Clone, Eq, PartialEq)]
enum GraphqlChatRole {
+ /// The user option.
User,
+ /// The system option.
System,
+ /// The assistant option.
Assistant,
}
@@ -424,25 +503,41 @@ impl From<GraphqlChatRole> for ChatRole {
}
}
+/// GraphQL input representing the email literal.
#[derive(async_graphql::OneofObject)]
enum GraphqlEmailLiteral {
+ /// The sender option.
Sender(GraphqlEmailValue),
+ /// The cc option.
Cc(GraphqlEmailValue),
+ /// The bcc option.
Bcc(GraphqlEmailValue),
+ /// The recipient option.
Recipient(GraphqlEmailValue),
+ /// The thread id option.
ThreadId(ID),
+ /// The owner option.
Owner(ID),
+ /// The project id option.
ProjectId(String),
+ /// The importance option.
Importance(bool),
+ /// The notification done option.
NotificationDone(bool),
+ /// The notification seen option.
NotificationSeen(bool),
+ /// The shared option.
Shared(GraphqlSharedEmailFilter),
+ /// The calendar only option.
CalendarOnly(bool),
+ /// The created at option.
CreatedAt(GraphqlDateLiteral),
+ /// The updated at option.
UpdatedAt(GraphqlDateLiteral),
}
impl IntoFilterExpr<EmailLiteral> for GraphqlEmailLiteral {
+ /// Convert this value into the expr representation.
fn into_expr(self) -> async_graphql::Result<Expr<EmailLiteral>> {
let literal = match self {
Self::Sender(value) => EmailLiteral::Sender(value.into_ast()?),
@@ -464,14 +559,19 @@ impl IntoFilterExpr<EmailLiteral> for GraphqlEmailLiteral {
}
}
+/// GraphQL input representing the email value.
#[derive(async_graphql::OneofObject)]
enum GraphqlEmailValue {
+ /// The partial option.
Partial(String),
+ /// The complete option.
Complete(String),
+ /// The domain option.
Domain(String),
}
impl GraphqlEmailValue {
+ /// Convert this value into the ast representation.
fn into_ast(self) -> async_graphql::Result<Email> {
Ok(match self {
Self::Partial(value) => Email::Partial(value),
@@ -489,10 +589,14 @@ impl GraphqlEmailValue {
}
}
+/// GraphQL input representing the shared email filter.
#[derive(Enum, Copy, Clone, Eq, PartialEq)]
enum GraphqlSharedEmailFilter {
+ /// The exclude option.
Exclude,
+ /// The include option.
Include,
+ /// The only option.
Only,
}
@@ -506,21 +610,33 @@ impl From<GraphqlSharedEmailFilter> for SharedEmailFilter {
}
}
+/// GraphQL input representing the channel literal.
#[derive(async_graphql::OneofObject)]
enum GraphqlChannelLiteral {
+ /// The thread id option.
ThreadId(ID),
+ /// The mention option.
Mention(String),
+ /// The organization id option.
OrganizationId(i64),
+ /// The team id option.
TeamId(ID),
+ /// The channel id option.
ChannelId(ID),
+ /// The sender option.
Sender(String),
+ /// The channel type option.
ChannelType(GraphqlChannelTypeFilter),
+ /// The importance option.
Importance(bool),
+ /// The notification done option.
NotificationDone(bool),
+ /// The notification seen option.
NotificationSeen(bool),
}
impl IntoFilterExpr<ChannelLiteral> for GraphqlChannelLiteral {
+ /// Convert this value into the expr representation.
fn into_expr(self) -> async_graphql::Result<Expr<ChannelLiteral>> {
let literal = match self {
Self::ThreadId(id) => ChannelLiteral::ThreadId(parse_id(id, "threadId")?),
@@ -540,11 +656,16 @@ impl IntoFilterExpr<ChannelLiteral> for GraphqlChannelLiteral {
}
}
+/// GraphQL input representing the channel type filter.
#[derive(Enum, Copy, Clone, Eq, PartialEq)]
enum GraphqlChannelTypeFilter {
+ /// The public option.
Public,
+ /// The private option.
Private,
+ /// The direct message option.
DirectMessage,
+ /// The team option.
Team,
}
@@ -559,17 +680,25 @@ impl From<GraphqlChannelTypeFilter> for ChannelTypeFilter {
}
}
+/// GraphQL input representing the channel thread literal.
#[derive(async_graphql::OneofObject)]
enum GraphqlChannelThreadLiteral {
+ /// The thread id option.
ThreadId(ID),
+ /// The channel id option.
ChannelId(ID),
+ /// The root sender option.
RootSender(String),
+ /// The participant option.
Participant(String),
+ /// The notification done option.
NotificationDone(bool),
+ /// The notification seen option.
NotificationSeen(bool),
}
impl IntoFilterExpr<ChannelThreadLiteral> for GraphqlChannelThreadLiteral {
+ /// Convert this value into the expr representation.
fn into_expr(self) -> async_graphql::Result<Expr<ChannelThreadLiteral>> {
let literal = match self {
Self::ThreadId(id) => ChannelThreadLiteral::ThreadId(parse_id(id, "threadId")?),
@@ -587,16 +716,23 @@ impl IntoFilterExpr<ChannelThreadLiteral> for GraphqlChannelThreadLiteral {
}
}
+/// GraphQL input representing the call literal.
#[derive(async_graphql::OneofObject)]
enum GraphqlCallLiteral {
+ /// The call id option.
CallId(ID),
+ /// The channel id option.
ChannelId(ID),
+ /// The speaker option.
Speaker(String),
+ /// The status option.
Status(GraphqlCallStatus),
+ /// The attended option.
Attended(bool),
}
impl IntoFilterExpr<CallLiteral> for GraphqlCallLiteral {
+ /// Convert this value into the expr representation.
fn into_expr(self) -> async_graphql::Result<Expr<CallLiteral>> {
let literal = match self {
Self::CallId(id) => CallLiteral::CallId(parse_id(id, "callId")?),
@@ -611,10 +747,14 @@ impl IntoFilterExpr<CallLiteral> for GraphqlCallLiteral {
}
}
+/// GraphQL input representing the call status.
#[derive(Enum, Copy, Clone, Eq, PartialEq)]
enum GraphqlCallStatus {
+ /// The attended option.
Attended,
+ /// The missed option.
Missed,
+ /// The unattended option.
Unattended,
}
@@ -628,13 +768,17 @@ impl From<GraphqlCallStatus> for CallStatus {
}
}
+/// GraphQL input representing the crm company literal.
#[derive(async_graphql::OneofObject)]
enum GraphqlCrmCompanyLiteral {
+ /// The id option.
Id(ID),
+ /// The hidden option.
Hidden(bool),
}
impl IntoFilterExpr<CrmCompanyLiteral> for GraphqlCrmCompanyLiteral {
+ /// Convert this value into the expr representation.
fn into_expr(self) -> async_graphql::Result<Expr<CrmCompanyLiteral>> {
let literal = match self {
Self::Id(id) => CrmCompanyLiteral::Id(parse_id(id, "id")?),
@@ -644,17 +788,25 @@ impl IntoFilterExpr<CrmCompanyLiteral> for GraphqlCrmCompanyLiteral {
}
}
+/// GraphQL input representing the foreign entity literal.
#[derive(async_graphql::OneofObject)]
enum GraphqlForeignEntityLiteral {
+ /// The id option.
Id(ID),
+ /// The foreign entity id option.
ForeignEntityId(String),
+ /// The foreign entity source option.
ForeignEntitySource(String),
+ /// The includes me option.
IncludesMe(bool),
+ /// The notification done option.
NotificationDone(bool),
+ /// The notification seen option.
NotificationSeen(bool),
}
impl IntoFilterExpr<ForeignEntityLiteral> for GraphqlForeignEntityLiteral {
+ /// Convert this value into the expr representation.
fn into_expr(self) -> async_graphql::Result<Expr<ForeignEntityLiteral>> {
let literal = match self {
Self::Id(id) => ForeignEntityLiteral::Id(parse_id(id, "id")?),
diff --git a/crates/graphql_soup/src/lib.rs b/crates/graphql_soup/src/lib.rs
index 0199cb821f..055411f3d5 100644
--- a/crates/graphql_soup/src/lib.rs
+++ b/crates/graphql_soup/src/lib.rs
@@ -4,9 +4,13 @@
//! existing `soup` domain service without changing the existing REST API.
//! The schema itself is composed and served by the `complete_graph` crate.
#![deny(missing_docs)]
+#![deny(clippy::missing_docs_in_private_items)]
+/// GraphQL inputs and conversion into Soup domain requests.
mod inputs;
+/// GraphQL objects representing Soup pages and entities.
mod objects;
+/// Top-level Soup query resolver.
mod resolvers;
pub use graphql_common::{GraphqlSoupEntityType, GraphqlSoupRequestParts};
diff --git a/crates/graphql_soup/src/objects.rs b/crates/graphql_soup/src/objects.rs
index fe3a159056..12b50d6d2a 100644
--- a/crates/graphql_soup/src/objects.rs
+++ b/crates/graphql_soup/src/objects.rs
@@ -35,8 +35,11 @@ pub trait SoupEntityEdges: ObjectType + Clone + Send + Sync + 'static {
/// Page returned by `Query.soup`.
pub struct SoupPage<E: SoupEntityEdges> {
+ /// The items.
items: Vec<GraphqlSoupItem<E>>,
+ /// The next cursor.
next_cursor: Option<String>,
+ /// Whether the result has more.
has_more: bool,
}
@@ -86,29 +89,38 @@ impl<E: SoupEntityEdges> From<PaginatedOpaqueCursor<EnrichedSoupItem>> for SoupP
/// GraphQL Soup item envelope.
pub struct GraphqlSoupItem<E: SoupEntityEdges> {
+ /// The unique identifier.
id: String,
+ /// The entity type.
entity_type: GraphqlSoupEntityType,
+ /// The frecency score.
frecency_score: f64,
+ /// The expanded Soup entity.
entity: GraphqlSoupEntity<E>,
}
+/// GraphQL representation of the soup item.
#[Object(name = "GraphqlSoupItem")]
impl<E> GraphqlSoupItem<E>
where
E: SoupEntityEdges,
{
+ /// The unique identifier.
async fn id(&self) -> ID {
ID(self.id.clone())
}
+ /// The entity type.
async fn entity_type(&self) -> GraphqlSoupEntityType {
self.entity_type
}
+ /// The frecency score.
async fn frecency_score(&self) -> f64 {
self.frecency_score
}
+ /// The expanded Soup entity.
async fn entity(&self) -> &GraphqlSoupEntity<E> {
&self.entity
}
@@ -240,47 +252,58 @@ where
/// GraphQL document entity.
pub struct GraphqlSoupDocument<E: SoupEntityEdges>(SoupDocument<()>, E);
+/// GraphQL representation of the soup document.
#[Object(name = "GraphqlSoupDocument")]
impl<E> GraphqlSoupDocument<E>
where
E: SoupEntityEdges,
{
+ /// The unique identifier.
async fn id(&self) -> ID {
ID(self.0.id.to_string())
}
+ /// The name.
async fn name(&self) -> &str {
&self.0.name
}
+ /// The identifier of the owner.
async fn owner_id(&self) -> String {
self.0.owner_id.as_ref().to_owned()
}
+ /// The file type.
async fn file_type(&self) -> Option<&str> {
self.0.file_type.as_deref()
}
+ /// The identifier of the project.
async fn project_id(&self) -> Option<ID> {
self.0.project_id.map(|id| ID(id.to_string()))
}
+ /// The created timestamp in RFC 3339 format.
async fn created_at(&self) -> String {
self.0.created_at.to_rfc3339()
}
+ /// The updated timestamp in RFC 3339 format.
async fn updated_at(&self) -> String {
self.0.updated_at.to_rfc3339()
}
+ /// The viewed timestamp in RFC 3339 format.
async fn viewed_at(&self) -> Option<String> {
self.0.viewed_at.map(|ts| ts.to_rfc3339())
}
+ /// The deleted timestamp in RFC 3339 format.
async fn deleted_at(&self) -> Option<String> {
self.0.deleted_at.map(|ts| ts.to_rfc3339())
}
+ /// The sub type.
async fn sub_type(&self) -> Option<GraphqlSoupDocumentSubType> {
self.0
.sub_type
@@ -289,6 +312,7 @@ where
}
#[graphql(flatten)]
+ /// The edges.
async fn edges(&self) -> E {
self.1.clone()
}
@@ -296,7 +320,9 @@ where
/// GraphQL document subtype details.
pub struct GraphqlSoupDocumentSubType {
+ /// The kind.
kind: &'static str,
+ /// Whether the task is completed.
is_completed: Option<bool>,
}
@@ -315,12 +341,15 @@ impl From<&SoupDocumentSubType> for GraphqlSoupDocumentSubType {
}
}
+/// GraphQL representation of the soup document sub type.
#[Object]
impl GraphqlSoupDocumentSubType {
+ /// The kind.
async fn kind(&self) -> &str {
self.kind
}
+ /// Whether the task is completed.
async fn is_completed(&self) -> Option<bool> {
self.is_completed
}
@@ -329,48 +358,59 @@ impl GraphqlSoupDocumentSubType {
/// GraphQL chat entity.
pub struct GraphqlSoupChat<E: SoupEntityEdges>(SoupChat<()>, E);
+/// GraphQL representation of the soup chat.
#[Object(name = "GraphqlSoupChat")]
impl<E> GraphqlSoupChat<E>
where
E: SoupEntityEdges,
{
+ /// The unique identifier.
async fn id(&self) -> ID {
ID(self.0.id.to_string())
}
+ /// The name.
async fn name(&self) -> &str {
&self.0.name
}
+ /// The identifier of the owner.
async fn owner_id(&self) -> String {
self.0.owner_id.as_ref().to_owned()
}
+ /// The identifier of the project.
async fn project_id(&self) -> Option<ID> {
self.0.project_id.map(|id| ID(id.to_string()))
}
+ /// Whether the chat is persistent.
async fn is_persistent(&self) -> bool {
self.0.is_persistent
}
+ /// The created timestamp in RFC 3339 format.
async fn created_at(&self) -> String {
self.0.created_at.to_rfc3339()
}
+ /// The updated timestamp in RFC 3339 format.
async fn updated_at(&self) -> String {
self.0.updated_at.to_rfc3339()
}
+ /// The viewed timestamp in RFC 3339 format.
async fn viewed_at(&self) -> Option<String> {
self.0.viewed_at.map(|ts| ts.to_rfc3339())
}
+ /// The deleted timestamp in RFC 3339 format.
async fn deleted_at(&self) -> Option<String> {
self.0.deleted_at.map(|ts| ts.to_rfc3339())
}
#[graphql(flatten)]
+ /// The edges.
async fn edges(&self) -> E {
self.1.clone()
}
@@ -379,44 +419,54 @@ where
/// GraphQL project entity.
pub struct GraphqlSoupProject<E: SoupEntityEdges>(SoupProject<()>, E);
+/// GraphQL representation of the soup project.
#[Object(name = "GraphqlSoupProject")]
impl<E> GraphqlSoupProject<E>
where
E: SoupEntityEdges,
{
+ /// The unique identifier.
async fn id(&self) -> ID {
ID(self.0.id.to_string())
}
+ /// The name.
async fn name(&self) -> &str {
&self.0.name
}
+ /// The identifier of the owner.
async fn owner_id(&self) -> String {
self.0.owner_id.as_ref().to_owned()
}
+ /// The identifier of the parent.
async fn parent_id(&self) -> Option<ID> {
self.0.parent_id.map(|id| ID(id.to_string()))
}
+ /// The created timestamp in RFC 3339 format.
async fn created_at(&self) -> String {
self.0.created_at.to_rfc3339()
}
+ /// The updated timestamp in RFC 3339 format.
async fn updated_at(&self) -> String {
self.0.updated_at.to_rfc3339()
}
+ /// The viewed timestamp in RFC 3339 format.
async fn viewed_at(&self) -> Option<String> {
self.0.viewed_at.map(|ts| ts.to_rfc3339())
}
+ /// The deleted timestamp in RFC 3339 format.
async fn deleted_at(&self) -> Option<String> {
self.0.deleted_at.map(|ts| ts.to_rfc3339())
}
#[graphql(flatten)]
+ /// The edges.
async fn edges(&self) -> E {
self.1.clone()
}
@@ -424,10 +474,15 @@ where
/// GraphQL email participant/contact.
pub struct GraphqlSoupEmailParticipant {
+ /// The unique identifier.
id: ID,
+ /// The identifier of the link.
link_id: ID,
+ /// The name.
name: Option<String>,
+ /// The email.
email: Option<String>,
+ /// The sfs photo url.
sfs_photo_url: Option<String>,
}
@@ -443,24 +498,30 @@ impl From<&SoupContact> for GraphqlSoupEmailParticipant {
}
}
+/// GraphQL representation of the soup email participant.
#[Object]
impl GraphqlSoupEmailParticipant {
+ /// The unique identifier.
async fn id(&self) -> &ID {
&self.id
}
+ /// The identifier of the link.
async fn link_id(&self) -> &ID {
&self.link_id
}
+ /// The name.
async fn name(&self) -> Option<&str> {
self.name.as_deref()
}
+ /// The email.
async fn email(&self) -> Option<&str> {
self.email.as_deref()
}
+ /// The sfs photo url.
async fn sfs_photo_url(&self) -> Option<&str> {
self.sfs_photo_url.as_deref()
}
@@ -468,13 +529,21 @@ impl GraphqlSoupEmailParticipant {
/// GraphQL email label.
pub struct GraphqlSoupEmailLabel {
+ /// The unique identifier.
id: ID,
+ /// The identifier of the link.
link_id: ID,
+ /// The identifier of the provider label.
provider_label_id: String,
+ /// The name.
name: String,
+ /// The created timestamp in RFC 3339 format.
created_at: String,
+ /// The message list visibility.
message_list_visibility: &'static str,
+ /// The label list visibility.
label_list_visibility: &'static str,
+ /// The type.
type_: &'static str,
}
@@ -503,36 +572,45 @@ impl From<&SoupLabel> for GraphqlSoupEmailLabel {
}
}
+/// GraphQL representation of the soup email label.
#[Object]
impl GraphqlSoupEmailLabel {
+ /// The unique identifier.
async fn id(&self) -> &ID {
&self.id
}
+ /// The identifier of the link.
async fn link_id(&self) -> &ID {
&self.link_id
}
+ /// The identifier of the provider label.
async fn provider_label_id(&self) -> &str {
&self.provider_label_id
}
+ /// The name.
async fn name(&self) -> &str {
&self.name
}
+ /// The created timestamp in RFC 3339 format.
async fn created_at(&self) -> &str {
&self.created_at
}
+ /// The message list visibility.
async fn message_list_visibility(&self) -> &'static str {
self.message_list_visibility
}
+ /// The label list visibility.
async fn label_list_visibility(&self) -> &'static str {
self.label_list_visibility
}
+ /// The type.
async fn type_(&self) -> &'static str {
self.type_
}
@@ -540,13 +618,21 @@ impl GraphqlSoupEmailLabel {
/// GraphQL email attachment.
pub struct GraphqlSoupEmailAttachment {
+ /// The unique identifier.
id: ID,
+ /// The identifier of the message.
message_id: ID,
+ /// The identifier of the provider attachment.
provider_attachment_id: Option<String>,
+ /// The filename.
filename: Option<String>,
+ /// The mime type.
mime_type: Option<String>,
+ /// The size bytes.
size_bytes: Option<i64>,
+ /// The identifier of the content.
content_id: Option<String>,
+ /// The created timestamp in RFC 3339 format.
created_at: String,
}
@@ -565,36 +651,45 @@ impl From<&SoupAttachment> for GraphqlSoupEmailAttachment {
}
}
+/// GraphQL representation of the soup email attachment.
#[Object]
impl GraphqlSoupEmailAttachment {
+ /// The unique identifier.
async fn id(&self) -> &ID {
&self.id
}
+ /// The identifier of the message.
async fn message_id(&self) -> &ID {
&self.message_id
}
+ /// The identifier of the provider attachment.
async fn provider_attachment_id(&self) -> Option<&str> {
self.provider_attachment_id.as_deref()
}
+ /// The filename.
async fn filename(&self) -> Option<&str> {
self.filename.as_deref()
}
+ /// The mime type.
async fn mime_type(&self) -> Option<&str> {
self.mime_type.as_deref()
}
+ /// The size bytes.
async fn size_bytes(&self) -> Option<i64> {
self.size_bytes
}
+ /// The identifier of the content.
async fn content_id(&self) -> Option<&str> {
self.content_id.as_deref()
}
+ /// The created timestamp in RFC 3339 format.
async fn created_at(&self) -> &str {
&self.created_at
}
@@ -603,27 +698,33 @@ impl GraphqlSoupEmailAttachment {
/// GraphQL email thread entity.
pub struct GraphqlSoupEmailThread<E: SoupEntityEdges>(SoupEnrichedEmailThreadPreview<()>, E);
+/// GraphQL representation of the soup email thread.
#[Object(name = "GraphqlSoupEmailThread")]
impl<E> GraphqlSoupEmailThread<E>
where
E: SoupEntityEdges,
{
+ /// The unique identifier.
async fn id(&self) -> ID {
ID(self.0.thread.id.to_string())
}
+ /// The identifier of the provider.
async fn provider_id(&self) -> Option<&str> {
self.0.thread.provider_id.as_deref()
}
+ /// The identifier of the owner.
async fn owner_id(&self) -> String {
self.0.thread.owner_id.as_ref().to_owned()
}
+ /// Whether the thread should appear in the inbox.
async fn inbox_visible(&self) -> bool {
self.0.thread.inbox_visible
}
+ /// The identifier of the link.
async fn link_id(&self) -> Option<ID> {
self.0
.participants
@@ -633,66 +734,82 @@ where
.map(|id| ID(id.to_string()))
}
+ /// The name.
async fn name(&self) -> Option<&str> {
self.0.thread.name.as_deref()
}
+ /// The snippet.
async fn snippet(&self) -> Option<&str> {
self.0.thread.snippet.as_deref()
}
+ /// The sender email.
async fn sender_email(&self) -> Option<&str> {
self.0.thread.sender_email.as_deref()
}
+ /// The sender name.
async fn sender_name(&self) -> Option<&str> {
self.0.thread.sender_name.as_deref()
}
+ /// The sender photo url.
async fn sender_photo_url(&self) -> Option<&str> {
self.0.thread.sender_photo_url.as_deref()
}
+ /// Whether the thread has been read.
async fn is_read(&self) -> bool {
self.0.thread.is_read
}
+ /// Whether the thread contains a draft.
async fn is_draft(&self) -> bool {
self.0.thread.is_draft
}
+ /// Whether the thread is marked important.
async fn is_important(&self) -> bool {
self.0.thread.is_important
}
+ /// The identifier of the project.
async fn project_id(&self) -> Option<ID> {
self.0.thread.project_id.as_ref().map(|id| ID(id.clone()))
}
+ /// Timestamp used for email thread sorting, in RFC 3339 format.
async fn sort_ts(&self) -> String {
self.0.thread.sort_ts.to_rfc3339()
}
+ /// The created timestamp in RFC 3339 format.
async fn created_at(&self) -> String {
self.0.thread.created_at.to_rfc3339()
}
+ /// The updated timestamp in RFC 3339 format.
async fn updated_at(&self) -> String {
self.0.thread.updated_at.to_rfc3339()
}
+ /// The viewed timestamp in RFC 3339 format.
async fn viewed_at(&self) -> Option<String> {
self.0.thread.viewed_at.map(|ts| ts.to_rfc3339())
}
+ /// The attachment count.
async fn attachment_count(&self) -> usize {
self.0.attachments.len()
}
+ /// The participant count.
async fn participant_count(&self) -> usize {
self.0.participants.len()
}
+ /// The participants.
async fn participants(&self) -> Vec<GraphqlSoupEmailParticipant> {
self.0
.participants
@@ -701,6 +818,7 @@ where
.collect()
}
+ /// The attachments.
async fn attachments(&self) -> Vec<GraphqlSoupEmailAttachment> {
self.0
.attachments
@@ -709,6 +827,7 @@ where
.collect()
}
+ /// The labels.
async fn labels(&self) -> Vec<GraphqlSoupEmailLabel> {
self.0
.labels
@@ -718,10 +837,12 @@ where
}
#[graphql(flatten)]
+ /// The edges.
async fn edges(&self) -> E {
self.1.clone()
}
+ /// the email thread edge
#[graphql(flatten)]
async fn email_thread_edges(&self) -> E::EmailThreadEdges {
self.1.email_thread_edges()
@@ -731,16 +852,20 @@ where
/// GraphQL channel participant.
pub struct GraphqlSoupChannelParticipant(ChannelParticipant);
+/// GraphQL representation of the soup channel participant.
#[Object]
impl GraphqlSoupChannelParticipant {
+ /// The identifier of the channel.
async fn channel_id(&self) -> ID {
ID(self.0.channel_id.0.to_string())
}
+ /// The identifier of the user.
async fn user_id(&self) -> String {
self.0.user_id.as_ref().to_owned()
}
+ /// The role.
async fn role(&self) -> &'static str {
match self.0.role {
models_soup::comms::ParticipantRole::Owner => "owner",
@@ -749,10 +874,12 @@ impl GraphqlSoupChannelParticipant {
}
}
+ /// The joined timestamp in RFC 3339 format.
async fn joined_at(&self) -> String {
self.0.joined_at.to_rfc3339()
}
+ /// The left timestamp in RFC 3339 format.
async fn left_at(&self) -> Option<String> {
self.0.left_at.map(|ts| ts.to_rfc3339())
}
@@ -764,36 +891,45 @@ pub struct GraphqlSoupChannelMessage(ChannelMessage);
// NOTE: `id` (not `messageId`) — objects exposing `id: ID!` are treated as
// normalized entities by clients' caches (presence-of-id convention).
+/// GraphQL representation of the soup channel message.
#[Object]
impl GraphqlSoupChannelMessage {
+ /// The unique identifier.
async fn id(&self) -> ID {
ID(self.0.message_id.to_string())
}
+ /// The identifier of the thread.
async fn thread_id(&self) -> Option<ID> {
self.0.thread_id.map(|id| ID(id.to_string()))
}
+ /// The identifier of the sender.
async fn sender_id(&self) -> &str {
&self.0.sender_id
}
+ /// The content.
async fn content(&self) -> &str {
&self.0.content
}
+ /// The created timestamp in RFC 3339 format.
async fn created_at(&self) -> String {
self.0.created_at.to_rfc3339()
}
+ /// The updated timestamp in RFC 3339 format.
async fn updated_at(&self) -> String {
self.0.updated_at.to_rfc3339()
}
+ /// The deleted timestamp in RFC 3339 format.
async fn deleted_at(&self) -> Option<String> {
self.0.deleted_at.map(|ts| ts.to_rfc3339())
}
+ /// The mentions.
async fn mentions(&self) -> &[String] {
&self.0.mentions
}
@@ -803,6 +939,7 @@ impl GraphqlSoupChannelMessage {
pub struct GraphqlSoupChannel<E: SoupEntityEdges>(SoupChannel, E);
impl<E: SoupEntityEdges> GraphqlSoupChannel<E> {
+ /// Return the stable GraphQL name for a channel type.
fn channel_type_name(channel_type: ChannelType) -> &'static str {
match channel_type {
ChannelType::Public => "public",
@@ -813,27 +950,33 @@ impl<E: SoupEntityEdges> GraphqlSoupChannel<E> {
}
}
+/// GraphQL representation of the soup channel.
#[Object(name = "GraphqlSoupChannel")]
impl<E> GraphqlSoupChannel<E>
where
E: SoupEntityEdges,
{
+ /// The unique identifier.
async fn id(&self) -> ID {
ID(self.0.channel.channel.id.0.to_string())
}
+ /// The name.
async fn name(&self) -> Option<&str> {
self.0.channel.channel.name.as_deref()
}
+ /// The channel type.
async fn channel_type(&self) -> &'static str {
Self::channel_type_name(self.0.channel.channel.channel_type)
}
+ /// The identifier of the owner.
async fn owner_id(&self) -> String {
self.0.channel.channel.owner_id.as_ref().to_owned()
}
+ /// The identifier of the organization.
async fn organization_id(&self) -> Option<ID> {
self.0
.channel
@@ -843,30 +986,37 @@ where
.map(|id| ID(id.0.to_string()))
}
+ /// The identifier of the team.
async fn team_id(&self) -> Option<ID> {
self.0.channel.channel.team_id.map(|id| ID(id.to_string()))
}
+ /// The created timestamp in RFC 3339 format.
async fn created_at(&self) -> String {
self.0.channel.channel.created_at.to_rfc3339()
}
+ /// The updated timestamp in RFC 3339 format.
async fn updated_at(&self) -> String {
self.0.channel.channel.updated_at.to_rfc3339()
}
+ /// The viewed timestamp in RFC 3339 format.
async fn viewed_at(&self) -> Option<String> {
self.0.viewed_at.map(|ts| ts.to_rfc3339())
}
+ /// The interacted timestamp in RFC 3339 format.
async fn interacted_at(&self) -> Option<String> {
self.0.interacted_at.map(|ts| ts.to_rfc3339())
}
+ /// The participant count.
async fn participant_count(&self) -> usize {
self.0.channel.participants.len()
}
+ /// The identifiers of the participants.
async fn participant_ids(&self) -> Vec<String> {
self.0
.channel
@@ -876,6 +1026,7 @@ where
.collect()
}
+ /// The participants.
async fn participants(&self) -> Vec<GraphqlSoupChannelParticipant> {
self.0
.channel
@@ -886,6 +1037,7 @@ where
.collect()
}
+ /// The latest message.
async fn latest_message(&self) -> Option<GraphqlSoupChannelMessage> {
self.0
.latest_message
@@ -894,6 +1046,7 @@ where
.map(GraphqlSoupChannelMessage)
}
+ /// The latest non thread message.
async fn latest_non_thread_message(&self) -> Option<GraphqlSoupChannelMessage> {
self.0
.latest_message
@@ -903,6 +1056,7 @@ where
}
#[graphql(flatten)]
+ /// The edges.
async fn edges(&self) -> E {
self.1.clone()
}
@@ -911,44 +1065,54 @@ where
/// GraphQL channel thread entity.
pub struct GraphqlSoupChannelThread<E: SoupEntityEdges>(SoupChannelThread, E);
+/// GraphQL representation of the soup channel thread.
#[Object(name = "GraphqlSoupChannelThread")]
impl<E> GraphqlSoupChannelThread<E>
where
E: SoupEntityEdges,
{
+ /// The unique identifier.
async fn id(&self) -> ID {
ID(self.0.id.to_string())
}
+ /// The identifier of the channel.
async fn channel_id(&self) -> ID {
ID(self.0.channel_id.to_string())
}
+ /// The identifier of the sender.
async fn sender_id(&self) -> &str {
&self.0.sender_id
}
+ /// The content.
async fn content(&self) -> &str {
&self.0.content
}
+ /// The created timestamp in RFC 3339 format.
async fn created_at(&self) -> String {
self.0.created_at.to_rfc3339()
}
+ /// The updated timestamp in RFC 3339 format.
async fn updated_at(&self) -> String {
self.0.updated_at.to_rfc3339()
}
+ /// The effective updated timestamp in RFC 3339 format.
async fn effective_updated_at(&self) -> String {
self.0.effective_updated_at().to_rfc3339()
}
+ /// The reply count.
async fn reply_count(&self) -> i64 {
self.0.thread.reply_count
}
#[graphql(flatten)]
+ /// The edges.
async fn edges(&self) -> E {
self.1.clone()
}
@@ -956,8 +1120,11 @@ where
/// GraphQL call participant.
pub struct GraphqlSoupCallParticipant {
+ /// The identifier of the user.
user_id: String,
+ /// The joined timestamp in RFC 3339 format.
joined_at: String,
+ /// The left timestamp in RFC 3339 format.
left_at: Option<String>,
}
@@ -971,16 +1138,20 @@ impl From<&SoupCallRecordParticipant> for GraphqlSoupCallParticipant {
}
}
+/// GraphQL representation of the soup call participant.
#[Object]
impl GraphqlSoupCallParticipant {
+ /// The identifier of the user.
async fn user_id(&self) -> &str {
&self.user_id
}
+ /// The joined timestamp in RFC 3339 format.
async fn joined_at(&self) -> &str {
&self.joined_at
}
+ /// The left timestamp in RFC 3339 format.
async fn left_at(&self) -> Option<&str> {
self.left_at.as_deref()
}
@@ -989,31 +1160,38 @@ impl GraphqlSoupCallParticipant {
/// GraphQL call entity.
pub struct GraphqlSoupCall<E: SoupEntityEdges>(SoupCallRecord<()>, E);
+/// GraphQL representation of the soup call.
#[Object(name = "GraphqlSoupCall")]
impl<E> GraphqlSoupCall<E>
where
E: SoupEntityEdges,
{
+ /// The unique identifier.
async fn id(&self) -> ID {
ID(self.0.call_id.to_string())
}
+ /// The identifier of the channel.
async fn channel_id(&self) -> ID {
ID(self.0.channel_id.to_string())
}
+ /// The channel name.
async fn channel_name(&self) -> Option<&str> {
self.0.channel_name.as_deref()
}
+ /// The user who created the call.
async fn created_by(&self) -> &str {
&self.0.created_by
}
+ /// The custom name.
async fn custom_name(&self) -> Option<&str> {
self.0.custom_name.as_deref()
}
+ /// The name.
async fn name(&self) -> Option<&str> {
self.0
.custom_name
@@ -1021,26 +1199,32 @@ where
.or(self.0.channel_name.as_deref())
}
+ /// The summary.
async fn summary(&self) -> Option<&str> {
self.0.summary.as_deref()
}
+ /// The started timestamp in RFC 3339 format.
async fn started_at(&self) -> String {
self.0.started_at.to_rfc3339()
}
+ /// The ended timestamp in RFC 3339 format.
async fn ended_at(&self) -> Option<String> {
self.0.ended_at.map(|ts| ts.to_rfc3339())
}
+ /// The duration ms.
async fn duration_ms(&self) -> Option<i64> {
self.0.duration_ms
}
+ /// Whether the call is currently active.
async fn is_active(&self) -> bool {
self.0.is_active
}
+ /// The status.
async fn status(&self) -> &'static str {
match self.0.status {
item_filters::CallStatus::Attended => "ATTENDED",
@@ -1049,14 +1233,17 @@ where
}
}
+ /// Whether the requesting user attended this call.
async fn attended(&self) -> bool {
self.0.attended
}
+ /// The participant count.
async fn participant_count(&self) -> usize {
self.0.participants.len()
}
+ /// The identifiers of the participants.
async fn participant_ids(&self) -> Vec<String> {
self.0
.participants
@@ -1065,6 +1252,7 @@ where
.collect()
}
+ /// The participants.
async fn participants(&self) -> Vec<GraphqlSoupCallParticipant> {
self.0
.participants
@@ -1074,6 +1262,7 @@ where
}
#[graphql(flatten)]
+ /// The edges.
async fn edges(&self) -> E {
self.1.clone()
}
@@ -1082,47 +1271,58 @@ where
/// GraphQL CRM company entity.
pub struct GraphqlSoupCrmCompany<E: SoupEntityEdges>(SoupCrmCompany<()>, E);
+/// GraphQL representation of the soup crm company.
#[Object(name = "GraphqlSoupCrmCompany")]
impl<E> GraphqlSoupCrmCompany<E>
where
E: SoupEntityEdges,
{
+ /// The unique identifier.
async fn id(&self) -> ID {
ID(self.0.id.to_string())
}
+ /// The identifier of the team.
async fn team_id(&self) -> ID {
ID(self.0.team_id.to_string())
}
+ /// The name.
async fn name(&self) -> Option<&str> {
self.0.name.as_deref()
}
+ /// The description.
async fn description(&self) -> Option<&str> {
self.0.description.as_deref()
}
+ /// Whether email sync is enabled for this company.
async fn email_sync(&self) -> bool {
self.0.email_sync
}
+ /// Whether the company is hidden from CRM listings.
async fn hidden(&self) -> bool {
self.0.hidden
}
+ /// The created timestamp in RFC 3339 format.
async fn created_at(&self) -> String {
self.0.created_at.to_rfc3339()
}
+ /// The updated timestamp in RFC 3339 format.
async fn updated_at(&self) -> String {
self.0.updated_at.to_rfc3339()
}
+ /// The viewed timestamp in RFC 3339 format.
async fn viewed_at(&self) -> Option<String> {
self.0.viewed_at.map(|ts| ts.to_rfc3339())
}
+ /// The domains.
async fn domains(&self) -> Vec<String> {
self.0
.domains
@@ -1132,6 +1332,7 @@ where
}
#[graphql(flatten)]
+ /// The edges.
async fn edges(&self) -> E {
self.1.clone()
}
@@ -1140,44 +1341,54 @@ where
/// GraphQL foreign entity.
pub struct GraphqlSoupForeignEntity<E: SoupEntityEdges>(SoupForeignEntity, E);
+/// GraphQL representation of the soup foreign entity.
#[Object(name = "GraphqlSoupForeignEntity")]
impl<E> GraphqlSoupForeignEntity<E>
where
E: SoupEntityEdges,
{
+ /// The unique identifier.
async fn id(&self) -> ID {
ID(self.0.id.to_string())
}
+ /// The identifier of the foreign entity.
async fn foreign_entity_id(&self) -> &str {
&self.0.foreign_entity_id
}
+ /// The foreign entity source.
async fn foreign_entity_source(&self) -> &str {
&self.0.foreign_entity_source
}
+ /// The identifier of the stored for.
async fn stored_for_id(&self) -> &str {
&self.0.stored_for_id
}
+ /// The stored for auth entity.
async fn stored_for_auth_entity(&self) -> &str {
&self.0.stored_for_auth_entity
}
+ /// The metadata.
async fn metadata(&self) -> Json<Value> {
Json(self.0.metadata.clone())
}
+ /// The created timestamp in RFC 3339 format.
async fn created_at(&self) -> String {
self.0.created_at.to_rfc3339()
}
+ /// The updated timestamp in RFC 3339 format.
async fn updated_at(&self) -> String {
self.0.updated_at.to_rfc3339()
}
#[graphql(flatten)]
+ /// The edges.
async fn edges(&self) -> E {
self.1.clone()
}
diff --git a/crates/workspace-hack/Cargo.toml b/crates/workspace-hack/Cargo.toml
index 280277d763..7b3e38a035 100644
--- a/crates/workspace-hack/Cargo.toml
+++ b/crates/workspace-hack/Cargo.toml
@@ -127,6 +127,7 @@ tower = { version = "0.5", default-features = false, features = ["balance", "buf
tower-http = { version = "0.6", features = ["compression-gzip", "cors", "fs", "limit", "request-id", "timeout", "trace", "util"] }
tracing = { version = "0.1", features = ["log"] }
tracing-core = { version = "0.1" }
+triomphe = { version = "0.1" }
tungstenite = { version = "0.28", features = ["__rustls-tls", "url"] }
typenum = { version = "1", default-features = false, features = ["const-generics"] }
url = { version = "2", features = ["serde"] }
@@ -253,6 +254,7 @@ tower = { version = "0.5", default-features = false, features = ["balance", "buf
tower-http = { version = "0.6", features = ["compression-gzip", "cors", "fs", "limit", "request-id", "timeout", "trace", "util"] }
tracing = { version = "0.1", features = ["log"] }
tracing-core = { version = "0.1" }
+triomphe = { version = "0.1" }
tungstenite = { version = "0.28", features = ["__rustls-tls", "url"] }
typenum = { version = "1", default-features = false, features = ["const-generics"] }
url = { version = "2", features = ["serde"] }
diff --git a/static_assets/schema.graphql b/static_assets/schema.graphql
index 7aa6d92a4c..5cecd4bd21 100644
--- a/static_assets/schema.graphql
+++ b/static_assets/schema.graphql
@@ -8,141 +8,435 @@ type GraphqlBooleanPropertyValue {
value: Boolean!
}
+"""
+The two operands of a recursive `CallFilterExpr` binary expression.
+"""
input GraphqlCallBinaryExpr {
+ """
+ The left-hand expression.
+ """
left: GraphqlCallExpr!
+ """
+ The right-hand expression.
+ """
right: GraphqlCallExpr!
}
+"""
+A recursive `CallFilterExpr` filter expression.
+"""
input GraphqlCallExpr @oneOf {
+ """
+ Matches when both expressions match.
+ """
and: GraphqlCallBinaryExpr
+ """
+ Matches when either expression matches.
+ """
or: GraphqlCallBinaryExpr
+ """
+ Negates an expression.
+ """
not: GraphqlCallExpr
+ """
+ Matches a domain-specific literal condition.
+ """
literal: GraphqlCallLiteral
}
+"""
+GraphQL input representing the call literal.
+"""
input GraphqlCallLiteral @oneOf {
+ """
+ The call id option.
+ """
callId: ID
+ """
+ The channel id option.
+ """
channelId: ID
+ """
+ The speaker option.
+ """
speaker: String
+ """
+ The status option.
+ """
status: GraphqlCallStatus
+ """
+ The attended option.
+ """
attended: Boolean
}
+"""
+GraphQL input representing the call status.
+"""
enum GraphqlCallStatus {
+ """
+ The attended option.
+ """
ATTENDED
+ """
+ The missed option.
+ """
MISSED
+ """
+ The unattended option.
+ """
UNATTENDED
}
+"""
+The two operands of a recursive `ChannelFilterExpr` binary expression.
+"""
input GraphqlChannelBinaryExpr {
+ """
+ The left-hand expression.
+ """
left: GraphqlChannelExpr!
+ """
+ The right-hand expression.
+ """
right: GraphqlChannelExpr!
}
+"""
+A recursive `ChannelFilterExpr` filter expression.
+"""
input GraphqlChannelExpr @oneOf {
+ """
+ Matches when both expressions match.
+ """
and: GraphqlChannelBinaryExpr
+ """
+ Matches when either expression matches.
+ """
or: GraphqlChannelBinaryExpr
+ """
+ Negates an expression.
+ """
not: GraphqlChannelExpr
+ """
+ Matches a domain-specific literal condition.
+ """
literal: GraphqlChannelLiteral
}
+"""
+GraphQL input representing the channel literal.
+"""
input GraphqlChannelLiteral @oneOf {
+ """
+ The thread id option.
+ """
threadId: ID
+ """
+ The mention option.
+ """
mention: String
+ """
+ The organization id option.
+ """
organizationId: Int
+ """
+ The team id option.
+ """
teamId: ID
+ """
+ The channel id option.
+ """
channelId: ID
+ """
+ The sender option.
+ """
sender: String
+ """
+ The channel type option.
+ """
channelType: GraphqlChannelTypeFilter
+ """
+ The importance option.
+ """
importance: Boolean
+ """
+ The notification done option.
+ """
notificationDone: Boolean
+ """
+ The notification seen option.
+ """
notificationSeen: Boolean
}
+"""
+The two operands of a recursive `ChannelThreadFilterExpr` binary expression.
+"""
input GraphqlChannelThreadBinaryExpr {
+ """
+ The left-hand expression.
+ """
left: GraphqlChannelThreadExpr!
+ """
+ The right-hand expression.
+ """
right: GraphqlChannelThreadExpr!
}
+"""
+A recursive `ChannelThreadFilterExpr` filter expression.
+"""
input GraphqlChannelThreadExpr @oneOf {
+ """
+ Matches when both expressions match.
+ """
and: GraphqlChannelThreadBinaryExpr
+ """
+ Matches when either expression matches.
+ """
or: GraphqlChannelThreadBinaryExpr
+ """
+ Negates an expression.
+ """
not: GraphqlChannelThreadExpr
+ """
+ Matches a domain-specific literal condition.
+ """
literal: GraphqlChannelThreadLiteral
}
+"""
+GraphQL input representing the channel thread literal.
+"""
input GraphqlChannelThreadLiteral @oneOf {
+ """
+ The thread id option.
+ """
threadId: ID
+ """
+ The channel id option.
+ """
channelId: ID
+ """
+ The root sender option.
+ """
rootSender: String
+ """
+ The participant option.
+ """
participant: String
+ """
+ The notification done option.
+ """
notificationDone: Boolean
+ """
+ The notification seen option.
+ """
notificationSeen: Boolean
}
+"""
+GraphQL input representing the channel type filter.
+"""
enum GraphqlChannelTypeFilter {
+ """
+ The public option.
+ """
PUBLIC
+ """
+ The private option.
+ """
PRIVATE
+ """
+ The direct message option.
+ """
DIRECT_MESSAGE
+ """
+ The team option.
+ """
TEAM
}
+"""
+The two operands of a recursive `ChatFilterExpr` binary expression.
+"""
input GraphqlChatBinaryExpr {
+ """
+ The left-hand expression.
+ """
left: GraphqlChatExpr!
+ """
+ The right-hand expression.
+ """
right: GraphqlChatExpr!
}
+"""
+A recursive `ChatFilterExpr` filter expression.
+"""
input GraphqlChatExpr @oneOf {
+ """
+ Matches when both expressions match.
+ """
and: GraphqlChatBinaryExpr
+ """
+ Matches when either expression matches.
+ """
or: GraphqlChatBinaryExpr
+ """
+ Negates an expression.
+ """
not: GraphqlChatExpr
+ """
+ Matches a domain-specific literal condition.
+ """
literal: GraphqlChatLiteral
}
+"""
+GraphQL input representing the chat literal.
+"""
input GraphqlChatLiteral @oneOf {
+ """
+ The project id option.
+ """
projectId: ID
+ """
+ The role option.
+ """
role: GraphqlChatRole
+ """
+ The chat id option.
+ """
chatId: ID
+ """
+ The owner option.
+ """
owner: String
+ """
+ The importance option.
+ """
importance: Boolean
+ """
+ The notification done option.
+ """
notificationDone: Boolean
+ """
+ The notification seen option.
+ """
notificationSeen: Boolean
+ """
+ The created at option.
+ """
createdAt: GraphqlDateLiteral
+ """
+ The updated at option.
+ """
updatedAt: GraphqlDateLiteral
}
+"""
+GraphQL input representing the chat role.
+"""
enum GraphqlChatRole {
+ """
+ The user option.
+ """
USER
+ """
+ The system option.
+ """
SYSTEM
+ """
+ The assistant option.
+ """
ASSISTANT
}
+"""
+The two operands of a recursive `CrmCompanyFilterExpr` binary expression.
+"""
input GraphqlCrmCompanyBinaryExpr {
+ """
+ The left-hand expression.
+ """
left: GraphqlCrmCompanyExpr!
+ """
+ The right-hand expression.
+ """
right: GraphqlCrmCompanyExpr!
}
+"""
+A recursive `CrmCompanyFilterExpr` filter expression.
+"""
input GraphqlCrmCompanyExpr @oneOf {
+ """
+ Matches when both expressions match.
+ """
and: GraphqlCrmCompanyBinaryExpr
+ """
+ Matches when either expression matches.
+ """
or: GraphqlCrmCompanyBinaryExpr
+ """
+ Negates an expression.
+ """
not: GraphqlCrmCompanyExpr
+ """
+ Matches a domain-specific literal condition.
+ """
literal: GraphqlCrmCompanyLiteral
}
+"""
+GraphQL input representing the crm company literal.
+"""
input GraphqlCrmCompanyLiteral @oneOf {
+ """
+ The id option.
+ """
id: ID
+ """
+ The hidden option.
+ """
hidden: Boolean
}
+"""
+GraphQL input representing the crm scope.
+"""
input GraphqlCrmScope @oneOf {
+ """
+ The domains option.
+ """
domains: [String!]
+ """
+ The addresses option.
+ """
addresses: [String!]
}
+"""
+GraphQL input representing the date literal.
+"""
input GraphqlDateLiteral @oneOf {
+ """
+ The gt option.
+ """
gt: String
+ """
+ The lt option.
+ """
lt: String
+ """
+ The gte option.
+ """
gte: String
+ """
+ The lte option.
+ """
lte: String
}
@@ -156,86 +450,275 @@ type GraphqlDatePropertyValue {
value: String!
}
+"""
+The two operands of a recursive `DocumentFilterExpr` binary expression.
+"""
input GraphqlDocumentBinaryExpr {
+ """
+ The left-hand expression.
+ """
left: GraphqlDocumentExpr!
+ """
+ The right-hand expression.
+ """
right: GraphqlDocumentExpr!
}
+"""
+A recursive `DocumentFilterExpr` filter expression.
+"""
input GraphqlDocumentExpr @oneOf {
+ """
+ Matches when both expressions match.
+ """
and: GraphqlDocumentBinaryExpr
+ """
+ Matches when either expression matches.
+ """
or: GraphqlDocumentBinaryExpr
+ """
+ Negates an expression.
+ """
not: GraphqlDocumentExpr
+ """
+ Matches a domain-specific literal condition.
+ """
literal: GraphqlDocumentLiteral
}
+"""
+GraphQL input representing the document literal.
+"""
input GraphqlDocumentLiteral @oneOf {
+ """
+ The file type option.
+ """
fileType: String
+ """
+ The id option.
+ """
id: ID
+ """
+ The project id option.
+ """
projectId: ID
+ """
+ The owner option.
+ """
owner: String
+ """
+ The importance option.
+ """
importance: Boolean
+ """
+ The notification done option.
+ """
notificationDone: Boolean
+ """
+ The notification seen option.
+ """
notificationSeen: Boolean
+ """
+ The include cbm atm nc option.
+ """
includeCbmAtmNc: Boolean
+ """
+ The sub type option.
+ """
subType: GraphqlDocumentSubType
+ """
+ The file assoc option.
+ """
fileAssoc: String
+ """
+ The is email attachment option.
+ """
isEmailAttachment: Boolean
+ """
+ The created at option.
+ """
createdAt: GraphqlDateLiteral
+ """
+ The updated at option.
+ """
updatedAt: GraphqlDateLiteral
}
+"""
+GraphQL input representing the document sub type.
+"""
enum GraphqlDocumentSubType {
+ """
+ The task option.
+ """
TASK
+ """
+ The snippet option.
+ """
SNIPPET
}
+"""
+The two operands of a recursive `EmailFilterExpr` binary expression.
+"""
input GraphqlEmailBinaryExpr {
+ """
+ The left-hand expression.
+ """
left: GraphqlEmailExpr!
+ """
+ The right-hand expression.
+ """
right: GraphqlEmailExpr!
}
+"""
+A recursive `EmailFilterExpr` filter expression.
+"""
input GraphqlEmailExpr @oneOf {
+ """
+ Matches when both expressions match.
+ """
and: GraphqlEmailBinaryExpr
+ """
+ Matches when either expression matches.
+ """
or: GraphqlEmailBinaryExpr
+ """
+ Negates an expression.
+ """
not: GraphqlEmailExpr
+ """
+ Matches a domain-specific literal condition.
+ """
literal: GraphqlEmailLiteral
}
+"""
+GraphQL input representing the email filter ast.
+"""
input GraphqlEmailFilterAst {
+ """
+ The tree.
+ """
tree: GraphqlEmailExpr
+ """
+ The crm scope.
+ """
crmScope: GraphqlCrmScope
}
+"""
+GraphQL input representing the email literal.
+"""
input GraphqlEmailLiteral @oneOf {
+ """
+ The sender option.
+ """
sender: GraphqlEmailValue
+ """
+ The cc option.
+ """
cc: GraphqlEmailValue
+ """
+ The bcc option.
+ """
bcc: GraphqlEmailValue
+ """
+ The recipient option.
+ """
recipient: GraphqlEmailValue
+ """
+ The thread id option.
+ """
threadId: ID
+ """
+ The owner option.
+ """
owner: ID
+ """
+ The project id option.
+ """
projectId: String
+ """
+ The importance option.
+ """
importance: Boolean
+ """
+ The notification done option.
+ """
notificationDone: Boolean
+ """
+ The notification seen option.
+ """
notificationSeen: Boolean
+ """
+ The shared option.
+ """
shared: GraphqlSharedEmailFilter
+ """
+ The calendar only option.
+ """
calendarOnly: Boolean
+ """
+ The created at option.
+ """
createdAt: GraphqlDateLiteral
+ """
+ The updated at option.
+ """
updatedAt: GraphqlDateLiteral
}
+"""
+GraphQL input representing the email value.
+"""
input GraphqlEmailValue @oneOf {
+ """
+ The partial option.
+ """
partial: String
+ """
+ The complete option.
+ """
complete: String
+ """
+ The domain option.
+ """
domain: String
}
+"""
+GraphQL input representing the email view.
+"""
enum GraphqlEmailView {
+ """
+ The inbox option.
+ """
INBOX
+ """
+ The drafts option.
+ """
DRAFTS
+ """
+ The sent option.
+ """
SENT
+ """
+ The all option.
+ """
ALL
+ """
+ The starred option.
+ """
STARRED
+ """
+ The important option.
+ """
IMPORTANT
+ """
+ The other option.
+ """
OTHER
}
@@ -243,21 +726,63 @@ enum GraphqlEmailView {
GraphQL input mirroring `item_filters::ast::EntityFilterAst`.
"""
input GraphqlEntityFilterAst {
+ """
+ The document filter to apply.
+ """
documentFilter: GraphqlDocumentExpr
+ """
+ The project filter to apply.
+ """
projectFilter: GraphqlProjectExpr
+ """
+ The chat filter to apply.
+ """
chatFilter: GraphqlChatExpr
+ """
+ The email filter to apply.
+ """
emailFilter: GraphqlEmailFilterAst
+ """
+ The channel filter to apply.
+ """
channelFilter: GraphqlChannelExpr
+ """
+ The channel thread filter to apply.
+ """
channelThreadFilter: GraphqlChannelThreadExpr
+ """
+ The call filter to apply.
+ """
callFilter: GraphqlCallExpr
+ """
+ The crm company filter to apply.
+ """
crmCompanyFilter: GraphqlCrmCompanyExpr
+ """
+ The foreign entity filter to apply.
+ """
foreignEntityFilter: GraphqlForeignEntityExpr
+ """
+ The properties filter to apply.
+ """
propertiesFilter: GraphqlPropertiesExpr
}
+"""
+Input identifying an entity referenced by a property value.
+"""
input GraphqlEntityReferenceInput {
+ """
+ Type of the referenced entity.
+ """
entityType: GraphqlPropertyEntityType!
+ """
+ Identifier of the referenced entity.
+ """
entityId: String!
+ """
+ Specific message when the reference targets a thread message.
+ """
specificMessageId: ID
}
@@ -271,24 +796,69 @@ type GraphqlEntityReferencePropertyValue {
references: [GraphqlPropertyEntityReference!]!
}
+"""
+The two operands of a recursive `ForeignEntityFilterExpr` binary expression.
+"""
input GraphqlForeignEntityBinaryExpr {
+ """
+ The left-hand expression.
+ """
left: GraphqlForeignEntityExpr!
+ """
+ The right-hand expression.
+ """
right: GraphqlForeignEntityExpr!
}
+"""
+A recursive `ForeignEntityFilterExpr` filter expression.
+"""
input GraphqlForeignEntityExpr @oneOf {
+ """
+ Matches when both expressions match.
+ """
and: GraphqlForeignEntityBinaryExpr
+ """
+ Matches when either expression matches.
+ """
or: GraphqlForeignEntityBinaryExpr
+ """
+ Negates an expression.
+ """
not: GraphqlForeignEntityExpr
+ """
+ Matches a domain-specific literal condition.
+ """
literal: GraphqlForeignEntityLiteral
}
+"""
+GraphQL input representing the foreign entity literal.
+"""
input GraphqlForeignEntityLiteral @oneOf {
+ """
+ The id option.
+ """
id: ID
+ """
+ The foreign entity id option.
+ """
foreignEntityId: String
+ """
+ The foreign entity source option.
+ """
foreignEntitySource: String
+ """
+ The includes me option.
+ """
includesMe: Boolean
+ """
+ The notification done option.
+ """
notificationDone: Boolean
+ """
+ The notification seen option.
+ """
notificationSeen: Boolean
}
@@ -312,38 +882,113 @@ type GraphqlNumberPropertyValue {
value: Float!
}
+"""
+The two operands of a recursive `ProjectFilterExpr` binary expression.
+"""
input GraphqlProjectBinaryExpr {
+ """
+ The left-hand expression.
+ """
left: GraphqlProjectExpr!
+ """
+ The right-hand expression.
+ """
right: GraphqlProjectExpr!
}
+"""
+A recursive `ProjectFilterExpr` filter expression.
+"""
input GraphqlProjectExpr @oneOf {
+ """
+ Matches when both expressions match.
+ """
and: GraphqlProjectBinaryExpr
+ """
+ Matches when either expression matches.
+ """
or: GraphqlProjectBinaryExpr
+ """
+ Negates an expression.
+ """
not: GraphqlProjectExpr
+ """
+ Matches a domain-specific literal condition.
+ """
literal: GraphqlProjectLiteral
}
+"""
+GraphQL input representing the project literal.
+"""
input GraphqlProjectLiteral @oneOf {
+ """
+ The project id option.
+ """
projectId: ID
+ """
+ The project id self option.
+ """
projectIdSelf: ID
+ """
+ The owner option.
+ """
owner: String
+ """
+ The importance option.
+ """
importance: Boolean
+ """
+ The notification done option.
+ """
notificationDone: Boolean
+ """
+ The notification seen option.
+ """
notificationSeen: Boolean
+ """
+ The created at option.
+ """
createdAt: GraphqlDateLiteral
+ """
+ The updated at option.
+ """
updatedAt: GraphqlDateLiteral
}
+"""
+The two operands of a recursive `PropertiesFilterExpr` binary expression.
+"""
input GraphqlPropertiesBinaryExpr {
+ """
+ The left-hand expression.
+ """
left: GraphqlPropertiesExpr!
+ """
+ The right-hand expression.
+ """
right: GraphqlPropertiesExpr!
}
+"""
+A recursive `PropertiesFilterExpr` filter expression.
+"""
input GraphqlPropertiesExpr @oneOf {
+ """
+ Matches when both expressions match.
+ """
and: GraphqlPropertiesBinaryExpr
+ """
+ Matches when either expression matches.
+ """
or: GraphqlPropertiesBinaryExpr
+ """
+ Negates an expression.
+ """
not: GraphqlPropertiesExpr
+ """
+ Matches a domain-specific literal condition.
+ """
literal: GraphqlPropertiesLiteral
}
@@ -365,6 +1010,9 @@ input GraphqlPropertiesLiteral {
value: GraphqlPropertyMatchValue!
}
+"""
+A property assignment and its current value.
+"""
type GraphqlProperty {
"""
The globally unique identifier of this entity-property assignment.
@@ -535,22 +1183,67 @@ type GraphqlSelectOptionPropertyValue {
optionIds: [ID!]!
}
+"""
+A typed value accepted when setting an entity property.
+"""
input GraphqlSetPropertyValue @oneOf {
+ """
+ A Boolean value.
+ """
boolean: Boolean
+ """
+ An RFC 3339 date-time value.
+ """
date: String
+ """
+ A numeric value.
+ """
number: Float
+ """
+ A string value.
+ """
string: String
+ """
+ A single selected option identifier.
+ """
selectOption: ID
+ """
+ Multiple selected option identifiers.
+ """
multiSelectOption: [ID!]
+ """
+ A single entity reference.
+ """
entityReference: GraphqlEntityReferenceInput
+ """
+ Multiple entity references.
+ """
multiEntityReference: [GraphqlEntityReferenceInput!]
+ """
+ A single URL value.
+ """
link: String
+ """
+ Multiple URL values.
+ """
multiLink: [String!]
}
+"""
+GraphQL input representing the shared email filter.
+"""
enum GraphqlSharedEmailFilter {
+ """
+ The exclude option.
+ """
EXCLUDE
+ """
+ The include option.
+ """
INCLUDE
+ """
+ The only option.
+ """
ONLY
}
@@ -576,227 +1269,797 @@ enum GraphqlSimpleSortMethod {
VIEWED_UPDATED
}
+"""
+GraphQL representation of the soup call.
+"""
type GraphqlSoupCall {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The identifier of the channel.
+ """
channelId: ID!
+ """
+ The channel name.
+ """
channelName: String
+ """
+ The user who created the call.
+ """
createdBy: String!
+ """
+ The custom name.
+ """
customName: String
+ """
+ The name.
+ """
name: String
+ """
+ The summary.
+ """
summary: String
+ """
+ The started timestamp in RFC 3339 format.
+ """
startedAt: String!
+ """
+ The ended timestamp in RFC 3339 format.
+ """
endedAt: String
+ """
+ The duration ms.
+ """
durationMs: Int
+ """
+ Whether the call is currently active.
+ """
isActive: Boolean!
+ """
+ The status.
+ """
status: String!
+ """
+ Whether the requesting user attended this call.
+ """
attended: Boolean!
+ """
+ The participant count.
+ """
participantCount: Int!
+ """
+ The identifiers of the participants.
+ """
participantIds: [String!]!
+ """
+ The participants.
+ """
participants: [GraphqlSoupCallParticipant!]!
+ """
+ Properties assigned to this entity that the authenticated user may view.
+ """
properties: [GraphqlProperty!]!
+ """
+ Notifications associated with this entity for the authenticated user.
+ """
notifications: [GraphqlSoupNotification!]!
}
+"""
+GraphQL representation of the soup call participant.
+"""
type GraphqlSoupCallParticipant {
+ """
+ The identifier of the user.
+ """
userId: String!
+ """
+ The joined timestamp in RFC 3339 format.
+ """
joinedAt: String!
+ """
+ The left timestamp in RFC 3339 format.
+ """
leftAt: String
}
+"""
+GraphQL representation of the soup channel.
+"""
type GraphqlSoupChannel {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The name.
+ """
name: String
+ """
+ The channel type.
+ """
channelType: String!
+ """
+ The identifier of the owner.
+ """
ownerId: String!
+ """
+ The identifier of the organization.
+ """
organizationId: ID
+ """
+ The identifier of the team.
+ """
teamId: ID
+ """
+ The created timestamp in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The updated timestamp in RFC 3339 format.
+ """
updatedAt: String!
+ """
+ The viewed timestamp in RFC 3339 format.
+ """
viewedAt: String
+ """
+ The interacted timestamp in RFC 3339 format.
+ """
interactedAt: String
+ """
+ The participant count.
+ """
participantCount: Int!
+ """
+ The identifiers of the participants.
+ """
participantIds: [String!]!
+ """
+ The participants.
+ """
participants: [GraphqlSoupChannelParticipant!]!
+ """
+ The latest message.
+ """
latestMessage: GraphqlSoupChannelMessage
+ """
+ The latest non thread message.
+ """
latestNonThreadMessage: GraphqlSoupChannelMessage
+ """
+ Properties assigned to this entity that the authenticated user may view.
+ """
properties: [GraphqlProperty!]!
+ """
+ Notifications associated with this entity for the authenticated user.
+ """
notifications: [GraphqlSoupNotification!]!
}
+"""
+GraphQL representation of the soup channel message.
+"""
type GraphqlSoupChannelMessage {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The identifier of the thread.
+ """
threadId: ID
+ """
+ The identifier of the sender.
+ """
senderId: String!
+ """
+ The content.
+ """
content: String!
+ """
+ The created timestamp in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The updated timestamp in RFC 3339 format.
+ """
updatedAt: String!
+ """
+ The deleted timestamp in RFC 3339 format.
+ """
deletedAt: String
+ """
+ The mentions.
+ """
mentions: [String!]!
}
+"""
+GraphQL representation of the soup channel participant.
+"""
type GraphqlSoupChannelParticipant {
+ """
+ The identifier of the channel.
+ """
channelId: ID!
+ """
+ The identifier of the user.
+ """
userId: String!
+ """
+ The role.
+ """
role: String!
+ """
+ The joined timestamp in RFC 3339 format.
+ """
joinedAt: String!
+ """
+ The left timestamp in RFC 3339 format.
+ """
leftAt: String
}
+"""
+GraphQL representation of the soup channel thread.
+"""
type GraphqlSoupChannelThread {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The identifier of the channel.
+ """
channelId: ID!
+ """
+ The identifier of the sender.
+ """
senderId: String!
+ """
+ The content.
+ """
content: String!
+ """
+ The created timestamp in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The updated timestamp in RFC 3339 format.
+ """
updatedAt: String!
+ """
+ The effective updated timestamp in RFC 3339 format.
+ """
effectiveUpdatedAt: String!
+ """
+ The reply count.
+ """
replyCount: Int!
+ """
+ Properties assigned to this entity that the authenticated user may view.
+ """
properties: [GraphqlProperty!]!
+ """
+ Notifications associated with this entity for the authenticated user.
+ """
notifications: [GraphqlSoupNotification!]!
}
+"""
+GraphQL representation of the soup chat.
+"""
type GraphqlSoupChat {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The name.
+ """
name: String!
+ """
+ The identifier of the owner.
+ """
ownerId: String!
+ """
+ The identifier of the project.
+ """
projectId: ID
+ """
+ Whether the chat is persistent.
+ """
isPersistent: Boolean!
+ """
+ The created timestamp in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The updated timestamp in RFC 3339 format.
+ """
updatedAt: String!
+ """
+ The viewed timestamp in RFC 3339 format.
+ """
viewedAt: String
+ """
+ The deleted timestamp in RFC 3339 format.
+ """
deletedAt: String
+ """
+ Properties assigned to this entity that the authenticated user may view.
+ """
properties: [GraphqlProperty!]!
+ """
+ Notifications associated with this entity for the authenticated user.
+ """
notifications: [GraphqlSoupNotification!]!
}
+"""
+GraphQL representation of the soup crm company.
+"""
type GraphqlSoupCrmCompany {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The identifier of the team.
+ """
teamId: ID!
+ """
+ The name.
+ """
name: String
+ """
+ The description.
+ """
description: String
+ """
+ Whether email sync is enabled for this company.
+ """
emailSync: Boolean!
+ """
+ Whether the company is hidden from CRM listings.
+ """
hidden: Boolean!
+ """
+ The created timestamp in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The updated timestamp in RFC 3339 format.
+ """
updatedAt: String!
+ """
+ The viewed timestamp in RFC 3339 format.
+ """
viewedAt: String
+ """
+ The domains.
+ """
domains: [String!]!
+ """
+ Properties assigned to this entity that the authenticated user may view.
+ """
properties: [GraphqlProperty!]!
+ """
+ Notifications associated with this entity for the authenticated user.
+ """
notifications: [GraphqlSoupNotification!]!
}
+"""
+GraphQL representation of the soup document.
+"""
type GraphqlSoupDocument {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The name.
+ """
name: String!
+ """
+ The identifier of the owner.
+ """
ownerId: String!
+ """
+ The file type.
+ """
fileType: String
+ """
+ The identifier of the project.
+ """
projectId: ID
+ """
+ The created timestamp in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The updated timestamp in RFC 3339 format.
+ """
updatedAt: String!
+ """
+ The viewed timestamp in RFC 3339 format.
+ """
viewedAt: String
+ """
+ The deleted timestamp in RFC 3339 format.
+ """
deletedAt: String
+ """
+ The sub type.
+ """
subType: GraphqlSoupDocumentSubType
+ """
+ Properties assigned to this entity that the authenticated user may view.
+ """
properties: [GraphqlProperty!]!
+ """
+ Notifications associated with this entity for the authenticated user.
+ """
notifications: [GraphqlSoupNotification!]!
}
+"""
+GraphQL representation of the soup document sub type.
+"""
type GraphqlSoupDocumentSubType {
+ """
+ The kind.
+ """
kind: String!
+ """
+ Whether the task is completed.
+ """
isCompleted: Boolean
}
+"""
+GraphQL representation of the soup email attachment.
+"""
type GraphqlSoupEmailAttachment {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The identifier of the message.
+ """
messageId: ID!
+ """
+ The identifier of the provider attachment.
+ """
providerAttachmentId: String
+ """
+ The filename.
+ """
filename: String
+ """
+ The mime type.
+ """
mimeType: String
+ """
+ The size bytes.
+ """
sizeBytes: Int
+ """
+ The identifier of the content.
+ """
contentId: String
+ """
+ The created timestamp in RFC 3339 format.
+ """
createdAt: String!
}
+"""
+An email sender or recipient embedded in a message.
+"""
type GraphqlSoupEmailContact {
+ """
+ The contact's email address.
+ """
email: String!
+ """
+ The contact's display name.
+ """
name: String
+ """
+ The contact's profile photo URL.
+ """
photoUrl: String
}
+"""
+GraphQL representation of the soup email label.
+"""
type GraphqlSoupEmailLabel {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The identifier of the link.
+ """
linkId: ID!
+ """
+ The identifier of the provider label.
+ """
providerLabelId: String!
+ """
+ The name.
+ """
name: String!
+ """
+ The created timestamp in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The message list visibility.
+ """
messageListVisibility: String!
+ """
+ The label list visibility.
+ """
labelListVisibility: String!
+ """
+ The type.
+ """
type: String!
}
+"""
+A lightweight email content projection for Soup queries.
+"""
type GraphqlSoupEmailMessage {
+ """
+ The unique message identifier.
+ """
id: ID!
+ """
+ The identifier of the containing thread.
+ """
threadId: ID!
+ """
+ The identifier of the linked email account.
+ """
linkId: ID!
+ """
+ The message subject.
+ """
subject: String
+ """
+ A short preview of the message content.
+ """
snippet: String
+ """
+ The provider's internal timestamp in RFC 3339 format.
+ """
internalDateTs: String
+ """
+ The sent timestamp in RFC 3339 format.
+ """
sentAt: String
+ """
+ Whether the message has been read.
+ """
isRead: Boolean!
+ """
+ Whether the message is starred.
+ """
isStarred: Boolean!
+ """
+ Whether the message was sent by the linked account.
+ """
isSent: Boolean!
+ """
+ Whether the message has attachments.
+ """
hasAttachments: Boolean!
+ """
+ The sender of the message.
+ """
from: GraphqlSoupEmailContact
+ """
+ The primary recipients of the message.
+ """
to: [GraphqlSoupEmailContact!]!
+ """
+ The carbon-copy recipients of the message.
+ """
cc: [GraphqlSoupEmailContact!]!
+ """
+ The blind-carbon-copy recipients of the message.
+ """
bcc: [GraphqlSoupEmailContact!]!
+ """
+ Labels assigned to the message.
+ """
labels: [GraphqlSoupEmailMessageLabel!]!
+ """
+ The parsed message body.
+ """
bodyParsed: String
+ """
+ The plain-text message body.
+ """
bodyText: String
+ """
+ The sanitized HTML message body.
+ """
bodyHtmlSanitized: String
+ """
+ The message body in Macro's rich-text format.
+ """
bodyMacro: String
+ """
+ The message body with quoted replies removed.
+ """
bodyReplyless: String
+ """
+ The creation timestamp in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The last-updated timestamp in RFC 3339 format.
+ """
updatedAt: String!
}
+"""
+A lightweight label embedded in an email message.
+"""
type GraphqlSoupEmailMessageLabel {
+ """
+ The label identifier assigned by the email provider.
+ """
providerLabelId: String!
+ """
+ The label name.
+ """
name: String!
}
+"""
+GraphQL representation of the soup email participant.
+"""
type GraphqlSoupEmailParticipant {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The identifier of the link.
+ """
linkId: ID!
+ """
+ The name.
+ """
name: String
+ """
+ The email.
+ """
email: String
+ """
+ The sfs photo url.
+ """
sfsPhotoUrl: String
}
+"""
+GraphQL representation of the soup email thread.
+"""
type GraphqlSoupEmailThread {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The identifier of the provider.
+ """
providerId: String
+ """
+ The identifier of the owner.
+ """
ownerId: String!
+ """
+ Whether the thread should appear in the inbox.
+ """
inboxVisible: Boolean!
+ """
+ The identifier of the link.
+ """
linkId: ID
+ """
+ The name.
+ """
name: String
+ """
+ The snippet.
+ """
snippet: String
+ """
+ The sender email.
+ """
senderEmail: String
+ """
+ The sender name.
+ """
senderName: String
+ """
+ The sender photo url.
+ """
senderPhotoUrl: String
+ """
+ Whether the thread has been read.
+ """
isRead: Boolean!
+ """
+ Whether the thread contains a draft.
+ """
isDraft: Boolean!
+ """
+ Whether the thread is marked important.
+ """
isImportant: Boolean!
+ """
+ The identifier of the project.
+ """
projectId: ID
+ """
+ Timestamp used for email thread sorting, in RFC 3339 format.
+ """
sortTs: String!
+ """
+ The created timestamp in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The updated timestamp in RFC 3339 format.
+ """
updatedAt: String!
+ """
+ The viewed timestamp in RFC 3339 format.
+ """
viewedAt: String
+ """
+ The attachment count.
+ """
attachmentCount: Int!
+ """
+ The participant count.
+ """
participantCount: Int!
+ """
+ The participants.
+ """
participants: [GraphqlSoupEmailParticipant!]!
+ """
+ The attachments.
+ """
attachments: [GraphqlSoupEmailAttachment!]!
+ """
+ The labels.
+ """
labels: [GraphqlSoupEmailLabel!]!
+ """
+ Properties assigned to this entity that the authenticated user may view.
+ """
properties: [GraphqlProperty!]!
+ """
+ Notifications associated with this entity for the authenticated user.
+ """
notifications: [GraphqlSoupNotification!]!
+ """
+ The newest non-draft content message in this thread.
+ """
latestContentMessage: GraphqlSoupEmailMessage
}
@@ -863,51 +2126,171 @@ enum GraphqlSoupEntityType {
CRM_CONTACT
}
+"""
+GraphQL representation of the soup foreign entity.
+"""
type GraphqlSoupForeignEntity {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The identifier of the foreign entity.
+ """
foreignEntityId: String!
+ """
+ The foreign entity source.
+ """
foreignEntitySource: String!
+ """
+ The identifier of the stored for.
+ """
storedForId: String!
+ """
+ The stored for auth entity.
+ """
storedForAuthEntity: String!
+ """
+ The metadata.
+ """
metadata: JSON!
+ """
+ The created timestamp in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The updated timestamp in RFC 3339 format.
+ """
updatedAt: String!
+ """
+ Properties assigned to this entity that the authenticated user may view.
+ """
properties: [GraphqlProperty!]!
+ """
+ Notifications associated with this entity for the authenticated user.
+ """
notifications: [GraphqlSoupNotification!]!
}
+"""
+GraphQL representation of the soup item.
+"""
type GraphqlSoupItem {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The entity type.
+ """
entityType: GraphqlSoupEntityType!
+ """
+ The frecency score.
+ """
frecencyScore: Float!
+ """
+ The expanded Soup entity.
+ """
entity: GraphqlSoupEntity!
}
+"""
+A notification associated with a Soup entity.
+"""
type GraphqlSoupNotification {
+ """
+ The notification identifier.
+ """
id: ID!
+ """
+ The event that produced the notification.
+ """
eventType: String!
+ """
+ The type of the associated entity.
+ """
entityType: GraphqlSoupEntityType!
+ """
+ The identifier of the associated entity.
+ """
entityId: String!
+ """
+ Whether the notification has been sent.
+ """
sent: Boolean!
+ """
+ Whether notification processing is complete.
+ """
done: Boolean!
+ """
+ Whether the recipient has seen the notification.
+ """
seen: Boolean!
+ """
+ The notification creation time in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The time the notification was viewed, in RFC 3339 format.
+ """
viewedAt: String
+ """
+ The notification's last update time in RFC 3339 format.
+ """
updatedAt: String!
+ """
+ The identifier of the user who triggered the notification.
+ """
senderId: String
+ """
+ Event-specific notification metadata.
+ """
metadata: JSON!
}
+"""
+GraphQL representation of the soup project.
+"""
type GraphqlSoupProject {
+ """
+ The unique identifier.
+ """
id: ID!
+ """
+ The name.
+ """
name: String!
+ """
+ The identifier of the owner.
+ """
ownerId: String!
+ """
+ The identifier of the parent.
+ """
parentId: ID
+ """
+ The created timestamp in RFC 3339 format.
+ """
createdAt: String!
+ """
+ The updated timestamp in RFC 3339 format.
+ """
updatedAt: String!
+ """
+ The viewed timestamp in RFC 3339 format.
+ """
viewedAt: String
+ """
+ The deleted timestamp in RFC 3339 format.
+ """
deletedAt: String
+ """
+ Properties assigned to this entity that the authenticated user may view.
+ """
properties: [GraphqlProperty!]!
+ """
+ Notifications associated with this entity for the authenticated user.
+ """
notifications: [GraphqlSoupNotification!]!
}
@@ -921,6 +2304,9 @@ type GraphqlStringPropertyValue {
value: String!
}
+"""
+The authenticated user and their user-scoped data.
+"""
type GraphqlUser {
"""
Stable id of the authenticated user.
@@ -937,6 +2323,9 @@ A scalar that can represent any JSON value.
"""
scalar JSON
+"""
+Mutations for assigning and updating entity properties.
+"""
type PropertiesMutationRoot {
"""
Set or attach one property on an entity.
@@ -944,9 +2333,21 @@ type PropertiesMutationRoot {
setEntityProperty(input: SetEntityPropertyInput!): GraphqlProperty!
}
+"""
+Input for assigning or updating an entity property.
+"""
input SetEntityPropertyInput {
+ """
+ Type of entity receiving the property.
+ """
entityType: GraphqlPropertyEntityType!
+ """
+ Identifier of the entity receiving the property.
+ """
entityId: String!
+ """
+ Identifier of the property definition to assign.
+ """
propertyDefinitionId: ID!
"""
Omit or pass null to attach the property without a value.
@@ -1003,6 +2404,9 @@ type SoupPage {
hasMore: Boolean!
}
+"""
+Root entry point for the complete GraphQL API.
+"""
type SoupQueryRoot {
"""
The authenticated user.