nominal-api 0.1239.0

API bindings for the Nominal platform
Documentation
use conjure_http::endpoint;
/// Themes service manages themes for exporting charts.
#[conjure_http::conjure_endpoints(
    name = "ThemesService",
    use_legacy_error_serialization
)]
pub trait ThemesService {
    /// Get all chart themes saved to the requested workspaces.
    #[endpoint(
        method = GET,
        path = "/themes/v1/chart-themes",
        name = "listChartThemes",
        produces = conjure_http::server::conjure::CollectionResponseSerializer
    )]
    fn list_chart_themes(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[query(
            name = "workspaces",
            decoder = conjure_http::server::conjure::FromPlainSeqDecoder<_>,
            safe
        )]
        workspaces: std::collections::BTreeSet<
            super::super::super::super::objects::api::rids::WorkspaceRid,
        >,
    ) -> Result<
        Vec<super::super::super::super::objects::themes::api::ChartTheme>,
        conjure_http::private::Error,
    >;
    /// Get a specific chart theme by RID.
    #[endpoint(
        method = GET,
        path = "/themes/v1/chart-themes/{chartThemeRid}",
        name = "getChartTheme",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn get_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "chartThemeRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "chartThemeRid",
            safe
        )]
        chart_theme_rid: super::super::super::super::objects::themes::api::ChartThemeRid,
    ) -> Result<
        super::super::super::super::objects::themes::api::ChartTheme,
        conjure_http::private::Error,
    >;
    /// Create a new chart theme.
    #[endpoint(
        method = POST,
        path = "/themes/v1/chart-themes",
        name = "createChartTheme",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn create_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::themes::api::CreateChartThemeRequest,
    ) -> Result<
        super::super::super::super::objects::themes::api::ChartTheme,
        conjure_http::private::Error,
    >;
    /// Update an existing chart theme.
    #[endpoint(
        method = PUT,
        path = "/themes/v1/chart-themes/{chartThemeRid}",
        name = "updateChartTheme",
        produces = conjure_http::server::StdResponseSerializer
    )]
    fn update_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "chartThemeRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "chartThemeRid",
            safe
        )]
        chart_theme_rid: super::super::super::super::objects::themes::api::ChartThemeRid,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::themes::api::UpdateChartThemeRequest,
    ) -> Result<
        super::super::super::super::objects::themes::api::ChartTheme,
        conjure_http::private::Error,
    >;
    /// Delete an existing comment.
    #[endpoint(
        method = DELETE,
        path = "/themes/v1/chart-themes/{chartThemeRid}",
        name = "deleteChartTheme"
    )]
    fn delete_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "chartThemeRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "chartThemeRid",
            safe
        )]
        chart_theme_rid: super::super::super::super::objects::themes::api::ChartThemeRid,
    ) -> Result<(), conjure_http::private::Error>;
}
/// Themes service manages themes for exporting charts.
#[conjure_http::conjure_endpoints(
    name = "ThemesService",
    use_legacy_error_serialization
)]
pub trait AsyncThemesService {
    /// Get all chart themes saved to the requested workspaces.
    #[endpoint(
        method = GET,
        path = "/themes/v1/chart-themes",
        name = "listChartThemes",
        produces = conjure_http::server::conjure::CollectionResponseSerializer
    )]
    async fn list_chart_themes(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[query(
            name = "workspaces",
            decoder = conjure_http::server::conjure::FromPlainSeqDecoder<_>,
            safe
        )]
        workspaces: std::collections::BTreeSet<
            super::super::super::super::objects::api::rids::WorkspaceRid,
        >,
    ) -> Result<
        Vec<super::super::super::super::objects::themes::api::ChartTheme>,
        conjure_http::private::Error,
    >;
    /// Get a specific chart theme by RID.
    #[endpoint(
        method = GET,
        path = "/themes/v1/chart-themes/{chartThemeRid}",
        name = "getChartTheme",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "chartThemeRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "chartThemeRid",
            safe
        )]
        chart_theme_rid: super::super::super::super::objects::themes::api::ChartThemeRid,
    ) -> Result<
        super::super::super::super::objects::themes::api::ChartTheme,
        conjure_http::private::Error,
    >;
    /// Create a new chart theme.
    #[endpoint(
        method = POST,
        path = "/themes/v1/chart-themes",
        name = "createChartTheme",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn create_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::themes::api::CreateChartThemeRequest,
    ) -> Result<
        super::super::super::super::objects::themes::api::ChartTheme,
        conjure_http::private::Error,
    >;
    /// Update an existing chart theme.
    #[endpoint(
        method = PUT,
        path = "/themes/v1/chart-themes/{chartThemeRid}",
        name = "updateChartTheme",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn update_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "chartThemeRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "chartThemeRid",
            safe
        )]
        chart_theme_rid: super::super::super::super::objects::themes::api::ChartThemeRid,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::themes::api::UpdateChartThemeRequest,
    ) -> Result<
        super::super::super::super::objects::themes::api::ChartTheme,
        conjure_http::private::Error,
    >;
    /// Delete an existing comment.
    #[endpoint(
        method = DELETE,
        path = "/themes/v1/chart-themes/{chartThemeRid}",
        name = "deleteChartTheme"
    )]
    async fn delete_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "chartThemeRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "chartThemeRid",
            safe
        )]
        chart_theme_rid: super::super::super::super::objects::themes::api::ChartThemeRid,
    ) -> Result<(), conjure_http::private::Error>;
}
/// Themes service manages themes for exporting charts.
#[conjure_http::conjure_endpoints(
    name = "ThemesService",
    use_legacy_error_serialization,
    local
)]
pub trait LocalAsyncThemesService {
    /// Get all chart themes saved to the requested workspaces.
    #[endpoint(
        method = GET,
        path = "/themes/v1/chart-themes",
        name = "listChartThemes",
        produces = conjure_http::server::conjure::CollectionResponseSerializer
    )]
    async fn list_chart_themes(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[query(
            name = "workspaces",
            decoder = conjure_http::server::conjure::FromPlainSeqDecoder<_>,
            safe
        )]
        workspaces: std::collections::BTreeSet<
            super::super::super::super::objects::api::rids::WorkspaceRid,
        >,
    ) -> Result<
        Vec<super::super::super::super::objects::themes::api::ChartTheme>,
        conjure_http::private::Error,
    >;
    /// Get a specific chart theme by RID.
    #[endpoint(
        method = GET,
        path = "/themes/v1/chart-themes/{chartThemeRid}",
        name = "getChartTheme",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn get_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "chartThemeRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "chartThemeRid",
            safe
        )]
        chart_theme_rid: super::super::super::super::objects::themes::api::ChartThemeRid,
    ) -> Result<
        super::super::super::super::objects::themes::api::ChartTheme,
        conjure_http::private::Error,
    >;
    /// Create a new chart theme.
    #[endpoint(
        method = POST,
        path = "/themes/v1/chart-themes",
        name = "createChartTheme",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn create_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::themes::api::CreateChartThemeRequest,
    ) -> Result<
        super::super::super::super::objects::themes::api::ChartTheme,
        conjure_http::private::Error,
    >;
    /// Update an existing chart theme.
    #[endpoint(
        method = PUT,
        path = "/themes/v1/chart-themes/{chartThemeRid}",
        name = "updateChartTheme",
        produces = conjure_http::server::StdResponseSerializer
    )]
    async fn update_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "chartThemeRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "chartThemeRid",
            safe
        )]
        chart_theme_rid: super::super::super::super::objects::themes::api::ChartThemeRid,
        #[body(deserializer = conjure_http::server::StdRequestDeserializer)]
        request: super::super::super::super::objects::themes::api::UpdateChartThemeRequest,
    ) -> Result<
        super::super::super::super::objects::themes::api::ChartTheme,
        conjure_http::private::Error,
    >;
    /// Delete an existing comment.
    #[endpoint(
        method = DELETE,
        path = "/themes/v1/chart-themes/{chartThemeRid}",
        name = "deleteChartTheme"
    )]
    async fn delete_chart_theme(
        &self,
        #[auth]
        auth_: conjure_object::BearerToken,
        #[path(
            name = "chartThemeRid",
            decoder = conjure_http::server::conjure::FromPlainDecoder,
            log_as = "chartThemeRid",
            safe
        )]
        chart_theme_rid: super::super::super::super::objects::themes::api::ChartThemeRid,
    ) -> Result<(), conjure_http::private::Error>;
}