nominal-api 0.1194.0

// This file is @generated by prost-build.
/// A record of a coachmark dismissal, including when it was dismissed and on which app version.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CoachmarkDismissal {
    #[prost(string, tag = "1")]
    pub user_rid: ::prost::alloc::string::String,
    /// The coachmark identifier (typically the feature flag name)
    #[prost(string, tag = "2")]
    pub coachmark_id: ::prost::alloc::string::String,
    /// The apps-scout version (semver) when the coachmark was dismissed
    #[prost(string, tag = "3")]
    pub app_version: ::prost::alloc::string::String,
    #[prost(message, optional, tag = "4")]
    pub dismissed_at: ::core::option::Option<
        super::super::super::super::google::protobuf::Timestamp,
    >,
    /// The step index when dismissed (for multi-step coachmarks).
    /// If not present, the coachmark was dismissed via the X button.
    #[prost(int32, optional, tag = "5")]
    pub step_index: ::core::option::Option<i32>,
}
/// Request to dismiss a coachmark for the current user.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DismissCoachmarkRequest {
    /// The coachmark identifier (typically the feature flag name)
    #[prost(string, tag = "1")]
    pub coachmark_id: ::prost::alloc::string::String,
    /// The apps-scout version (semver) when the coachmark was dismissed
    #[prost(string, tag = "2")]
    pub app_version: ::prost::alloc::string::String,
    /// The step index when dismissed (for multi-step coachmarks).
    /// If not present, the coachmark was dismissed via the X button.
    #[prost(int32, optional, tag = "3")]
    pub step_index: ::core::option::Option<i32>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DismissCoachmarkResponse {
    #[prost(message, optional, tag = "1")]
    pub dismissal: ::core::option::Option<CoachmarkDismissal>,
}
/// Request to list coachmark dismissals for the current user.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListCoachmarkDismissalsRequest {
    /// Optional list of coachmark IDs to filter by.
    /// If empty, returns all dismissals for the user.
    #[prost(string, repeated, tag = "1")]
    pub coachmark_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Response containing coachmark dismissals.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListCoachmarkDismissalsResponse {
    /// Map of coachmark ID to dismissal record.
    #[prost(map = "string, message", tag = "1")]
    pub dismissals: ::std::collections::HashMap<
        ::prost::alloc::string::String,
        CoachmarkDismissal,
    >,
}
/// Request to get a singular coachmark dismissal for the current user.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetCoachmarkDismissalRequest {
    #[prost(string, tag = "1")]
    pub coachmark_id: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetCoachmarkDismissalResponse {
    /// The dismissal record, if the coachmark has been dismissed. Absent otherwise.
    #[prost(message, optional, tag = "1")]
    pub dismissal: ::core::option::Option<CoachmarkDismissal>,
}
/// Request to delete a coachmark dismissal for the current user.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteCoachmarkDismissalRequest {
    #[prost(string, tag = "1")]
    pub coachmark_id: ::prost::alloc::string::String,
}
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct DeleteCoachmarkDismissalResponse {}
/// Generated client implementations.
pub mod coachmarks_service_client {
    #![allow(
        unused_variables,
        dead_code,
        missing_docs,
        clippy::wildcard_imports,
        clippy::let_unit_value,
    )]
    use tonic::codegen::*;
    use tonic::codegen::http::Uri;
    /// Service for managing coachmark dismissals for the authenticated user.
    #[derive(Debug, Clone)]
    pub struct CoachmarksServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl CoachmarksServiceClient<tonic::transport::Channel> {
        /// Attempt to create a new client by connecting to a given endpoint.
        pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
        where
            D: TryInto<tonic::transport::Endpoint>,
            D::Error: Into<StdError>,
        {
            let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
            Ok(Self::new(conn))
        }
    }
    impl<T> CoachmarksServiceClient<T>
    where
        T: tonic::client::GrpcService<tonic::body::Body>,
        T::Error: Into<StdError>,
        T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
        <T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
    {
        pub fn new(inner: T) -> Self {
            let inner = tonic::client::Grpc::new(inner);
            Self { inner }
        }
        pub fn with_origin(inner: T, origin: Uri) -> Self {
            let inner = tonic::client::Grpc::with_origin(inner, origin);
            Self { inner }
        }
        pub fn with_interceptor<F>(
            inner: T,
            interceptor: F,
        ) -> CoachmarksServiceClient<InterceptedService<T, F>>
        where
            F: tonic::service::Interceptor,
            T::ResponseBody: Default,
            T: tonic::codegen::Service<
                http::Request<tonic::body::Body>,
                Response = http::Response<
                    <T as tonic::client::GrpcService<tonic::body::Body>>::ResponseBody,
                >,
            >,
            <T as tonic::codegen::Service<
                http::Request<tonic::body::Body>,
            >>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
        {
            CoachmarksServiceClient::new(InterceptedService::new(inner, interceptor))
        }
        /// Compress requests with the given encoding.
        ///
        /// This requires the server to support it otherwise it might respond with an
        /// error.
        #[must_use]
        pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.send_compressed(encoding);
            self
        }
        /// Enable decompressing responses.
        #[must_use]
        pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.accept_compressed(encoding);
            self
        }
        /// Limits the maximum size of a decoded message.
        ///
        /// Default: `4MB`
        #[must_use]
        pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_decoding_message_size(limit);
            self
        }
        /// Limits the maximum size of an encoded message.
        ///
        /// Default: `usize::MAX`
        #[must_use]
        pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_encoding_message_size(limit);
            self
        }
        /// Lists coachmark dismissals for the authenticated user.
        /// Optionally filter by specific coachmark IDs.
        pub async fn list_coachmark_dismissals(
            &mut self,
            request: impl tonic::IntoRequest<super::ListCoachmarkDismissalsRequest>,
        ) -> std::result::Result<
            tonic::Response<super::ListCoachmarkDismissalsResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/nominal.settings.coachmarks.v1.CoachmarksService/ListCoachmarkDismissals",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.settings.coachmarks.v1.CoachmarksService",
                        "ListCoachmarkDismissals",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Dismisses a coachmark for the authenticated user.
        /// Records the dismissal timestamp and app version.
        pub async fn dismiss_coachmark(
            &mut self,
            request: impl tonic::IntoRequest<super::DismissCoachmarkRequest>,
        ) -> std::result::Result<
            tonic::Response<super::DismissCoachmarkResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/nominal.settings.coachmarks.v1.CoachmarksService/DismissCoachmark",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.settings.coachmarks.v1.CoachmarksService",
                        "DismissCoachmark",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Gets a specific coachmark dismissal for the authenticated user.
        pub async fn get_coachmark_dismissal(
            &mut self,
            request: impl tonic::IntoRequest<super::GetCoachmarkDismissalRequest>,
        ) -> std::result::Result<
            tonic::Response<super::GetCoachmarkDismissalResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/nominal.settings.coachmarks.v1.CoachmarksService/GetCoachmarkDismissal",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.settings.coachmarks.v1.CoachmarksService",
                        "GetCoachmarkDismissal",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Deletes a coachmark dismissal for the authenticated user.
        /// This allows the coachmark to be shown again. Primarily intended for testing and debugging.
        pub async fn delete_coachmark_dismissal(
            &mut self,
            request: impl tonic::IntoRequest<super::DeleteCoachmarkDismissalRequest>,
        ) -> std::result::Result<
            tonic::Response<super::DeleteCoachmarkDismissalResponse>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::unknown(
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/nominal.settings.coachmarks.v1.CoachmarksService/DeleteCoachmarkDismissal",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "nominal.settings.coachmarks.v1.CoachmarksService",
                        "DeleteCoachmarkDismissal",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
    }
}