nominal-api 0.1240.0

use conjure_http::endpoint;
/// Saved Views allow users to store and reuse filter and table display configurations across
/// assets, runs, checklists, and more. They can be favorited, archived, and shared across a workspace.
#[conjure_http::conjure_client(name = "SavedViewService")]
pub trait SavedViewService<
    #[response_body]
    I: Iterator<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Creates a new saved view in the given workspace. If no workspace is specified,
    /// it is created in the user's default workspace.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1",
        name = "createSavedView",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn create_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::savedviews::api::CreateSavedViewRequest,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::CreateSavedViewResponse,
        conjure_http::private::Error,
    >;
    /// Fetches a saved view by RID. Throws NOT_FOUND if it does not exist.
    #[endpoint(
        method = GET,
        path = "/scout/saved-views/v1/{savedViewRid}",
        name = "getSavedView",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::GetSavedViewResponse,
        conjure_http::private::Error,
    >;
    /// Retrieves multiple saved views. Any invalid or unknown RIDs are omitted from the response.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/batch-get",
        name = "batchGetSavedViews",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn batch_get_saved_views(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        saved_view_rids: &std::collections::BTreeSet<
            super::super::super::super::objects::scout::rids::api::SavedViewRid,
        >,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::BatchGetSavedViewsResponse,
        conjure_http::private::Error,
    >;
    /// Searches for saved views using a nested query expression. Supports pagination.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/search",
        name = "searchSavedViews",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn search_saved_views(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsRequest,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsResponse,
        conjure_http::private::Error,
    >;
    /// Updates metadata, search filters, or display settings for an existing saved view.
    /// Throws NOT_FOUND if the view doesn't exist and INVALID_ARGUMENT if it is archived.
    #[endpoint(
        method = PUT,
        path = "/scout/saved-views/v1/{savedViewRid}",
        name = "updateSavedView",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn update_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewRequest,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewResponse,
        conjure_http::private::Error,
    >;
    /// Archives the specified saved view. Archived views are hidden from search.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/{savedViewRid}/archive",
        name = "archiveSavedView",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn archive_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
    ) -> Result<(), conjure_http::private::Error>;
    /// Restores archived saved view, making them discoverable in search again.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/{savedViewRid}/unarchive",
        name = "unarchiveSavedView",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn unarchive_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
    ) -> Result<(), conjure_http::private::Error>;
}
/// Saved Views allow users to store and reuse filter and table display configurations across
/// assets, runs, checklists, and more. They can be favorited, archived, and shared across a workspace.
#[conjure_http::conjure_client(name = "SavedViewService")]
pub trait AsyncSavedViewService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Creates a new saved view in the given workspace. If no workspace is specified,
    /// it is created in the user's default workspace.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1",
        name = "createSavedView",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::savedviews::api::CreateSavedViewRequest,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::CreateSavedViewResponse,
        conjure_http::private::Error,
    >;
    /// Fetches a saved view by RID. Throws NOT_FOUND if it does not exist.
    #[endpoint(
        method = GET,
        path = "/scout/saved-views/v1/{savedViewRid}",
        name = "getSavedView",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::GetSavedViewResponse,
        conjure_http::private::Error,
    >;
    /// Retrieves multiple saved views. Any invalid or unknown RIDs are omitted from the response.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/batch-get",
        name = "batchGetSavedViews",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_get_saved_views(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        saved_view_rids: &std::collections::BTreeSet<
            super::super::super::super::objects::scout::rids::api::SavedViewRid,
        >,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::BatchGetSavedViewsResponse,
        conjure_http::private::Error,
    >;
    /// Searches for saved views using a nested query expression. Supports pagination.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/search",
        name = "searchSavedViews",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn search_saved_views(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsRequest,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsResponse,
        conjure_http::private::Error,
    >;
    /// Updates metadata, search filters, or display settings for an existing saved view.
    /// Throws NOT_FOUND if the view doesn't exist and INVALID_ARGUMENT if it is archived.
    #[endpoint(
        method = PUT,
        path = "/scout/saved-views/v1/{savedViewRid}",
        name = "updateSavedView",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn update_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewRequest,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewResponse,
        conjure_http::private::Error,
    >;
    /// Archives the specified saved view. Archived views are hidden from search.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/{savedViewRid}/archive",
        name = "archiveSavedView",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn archive_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
    ) -> Result<(), conjure_http::private::Error>;
    /// Restores archived saved view, making them discoverable in search again.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/{savedViewRid}/unarchive",
        name = "unarchiveSavedView",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn unarchive_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
    ) -> Result<(), conjure_http::private::Error>;
}
/// Saved Views allow users to store and reuse filter and table display configurations across
/// assets, runs, checklists, and more. They can be favorited, archived, and shared across a workspace.
#[conjure_http::conjure_client(name = "SavedViewService", local)]
pub trait LocalAsyncSavedViewService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Creates a new saved view in the given workspace. If no workspace is specified,
    /// it is created in the user's default workspace.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1",
        name = "createSavedView",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::savedviews::api::CreateSavedViewRequest,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::CreateSavedViewResponse,
        conjure_http::private::Error,
    >;
    /// Fetches a saved view by RID. Throws NOT_FOUND if it does not exist.
    #[endpoint(
        method = GET,
        path = "/scout/saved-views/v1/{savedViewRid}",
        name = "getSavedView",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::GetSavedViewResponse,
        conjure_http::private::Error,
    >;
    /// Retrieves multiple saved views. Any invalid or unknown RIDs are omitted from the response.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/batch-get",
        name = "batchGetSavedViews",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_get_saved_views(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        saved_view_rids: &std::collections::BTreeSet<
            super::super::super::super::objects::scout::rids::api::SavedViewRid,
        >,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::BatchGetSavedViewsResponse,
        conjure_http::private::Error,
    >;
    /// Searches for saved views using a nested query expression. Supports pagination.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/search",
        name = "searchSavedViews",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn search_saved_views(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsRequest,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsResponse,
        conjure_http::private::Error,
    >;
    /// Updates metadata, search filters, or display settings for an existing saved view.
    /// Throws NOT_FOUND if the view doesn't exist and INVALID_ARGUMENT if it is archived.
    #[endpoint(
        method = PUT,
        path = "/scout/saved-views/v1/{savedViewRid}",
        name = "updateSavedView",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn update_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewRequest,
    ) -> Result<
        super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewResponse,
        conjure_http::private::Error,
    >;
    /// Archives the specified saved view. Archived views are hidden from search.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/{savedViewRid}/archive",
        name = "archiveSavedView",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn archive_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
    ) -> Result<(), conjure_http::private::Error>;
    /// Restores archived saved view, making them discoverable in search again.
    #[endpoint(
        method = POST,
        path = "/scout/saved-views/v1/{savedViewRid}/unarchive",
        name = "unarchiveSavedView",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn unarchive_saved_view(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "savedViewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
    ) -> Result<(), conjure_http::private::Error>;
}