nominal-api 0.1240.0

use conjure_http::endpoint;
/// The data review service manages the evaluation, disposition, and historical record of checks alerts.
#[conjure_http::conjure_client(name = "DataReviewService")]
pub trait DataReviewService<
    #[response_body]
    I: Iterator<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// For each request, initiates data review for the requested run and checklist and executes
    /// the automatic checks against the run.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/batch-initiate",
        name = "batchInitiate",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn batch_initiate(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchInitiateDataReviewRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::BatchInitiateDataReviewResponse,
        conjure_http::private::Error,
    >;
    /// Re-executes the most recent failed automatic checks for the data review.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/rerun-failed-automatic-checks",
        name = "rerunFailedAutomaticChecks",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn rerun_failed_automatic_checks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::RerunFailedAutomaticChecksRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Returns the data reviews under the provided search parameters.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/search",
        name = "findDataReviews",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn find_data_reviews(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::FindDataReviewsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::DataReviewPage,
        conjure_http::private::Error,
    >;
    /// Throws if not found.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/{dataReviewRid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::DataReview,
        conjure_http::private::Error,
    >;
    /// Throws if not found.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/check-alerts/{checkAlertRid}",
        name = "getCheckAlert",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_check_alert(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checkAlertRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        check_alert_rid: &super::super::super::super::super::objects::scout::rids::api::CheckAlertRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlert,
        conjure_http::private::Error,
    >;
    /// Gets all check alerts from the provided data review.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/{dataReviewRid}/check-alerts",
        name = "getCheckAlertsForDataReview",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    fn get_check_alerts_for_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<
        std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::datareview::api::CheckAlert,
        >,
        conjure_http::private::Error,
    >;
    /// Returns a histogram of alerts that occur across the provided runs or assets. At least one run or asset must be specified.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/check-alerts/histogram",
        name = "getCheckAlertsHistogram",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_check_alerts_histogram(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::CheckAlertsHistogramRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlertsHistogramResponse,
        conjure_http::private::Error,
    >;
    /// Returns the check alerts under the provided search parameters. At least one run or asset must be specified.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/check-alerts",
        name = "searchCheckAlerts",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn search_check_alerts(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::SearchCheckAlertsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::SearchCheckAlertsResponse,
        conjure_http::private::Error,
    >;
    /// Returns a record of the historical actions taken on the provided check alert.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/check-alerts/{checkAlertRid}/action-log",
        name = "getCheckAlertActionLog",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_check_alert_action_log(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checkAlertRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        check_alert_rid: &super::super::super::super::super::objects::scout::rids::api::CheckAlertRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlertActionLog,
        conjure_http::private::Error,
    >;
    /// Returns the number of alerts attached to each provided notebook.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/get-check-alert-counts-for-notebooks",
        name = "getCheckAlertCountsForNotebooks",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    fn get_check_alert_counts_for_notebooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        rids: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
        >,
    ) -> Result<
        std::collections::BTreeMap<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
            i32,
        >,
        conjure_http::private::Error,
    >;
    /// Returns the check alert status of any linked violations for the provided notebooks. If none exist, an empty
    /// optional is returned.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/get-check-alert-status-for-notebooks",
        name = "getCheckAlertStatusForNotebooks",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    fn get_check_alert_status_for_notebooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        rids: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
        >,
    ) -> Result<
        std::collections::BTreeMap<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
            Option<
                super::super::super::super::super::objects::scout::datareview::api::CheckAlertStatus,
            >,
        >,
        conjure_http::private::Error,
    >;
    /// Applies a check alert action to the specified check alert RID.
    #[endpoint(
        method = PUT,
        path = "/scout/v2/data-review/check-alerts/{checkAlertRid}",
        name = "performCheckAlertAction",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn perform_check_alert_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checkAlertRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        check_alert_rid: &super::super::super::super::super::objects::scout::rids::api::CheckAlertRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::CheckAlertAction,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlert,
        conjure_http::private::Error,
    >;
    /// Applies a check alert action to the specified check alert RIDs. If any of the check actions fail,
    /// then none of the check actions will be applied.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/check-alerts/batch-perform-action",
        name = "batchPerformCheckAlertAction",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn batch_perform_check_alert_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchCheckAlertActionRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::BatchCheckAlertActionResponse,
        conjure_http::private::Error,
    >;
    /// Applies an action to the specified check evaluation RIDs. If any of the check actions fail,
    /// then none of the actions will be applied.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/automatic-check-evaluation/batch-perform-action",
        name = "batchPerformAutomaticCheckEvaluationReviewAction",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn batch_perform_automatic_check_evaluation_review_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchAutomaticCheckEvaluationActionRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::BatchAutomaticCheckEvaluationActionResponse,
        conjure_http::private::Error,
    >;
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/automatic-check-evaluation/{rid}/action-log",
        name = "getAutomaticCheckEvaluationActionLog",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_automatic_check_evaluation_action_log(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::api::rids::AutomaticCheckEvaluationRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::AutomaticCheckEvaluationActionLog,
        conjure_http::private::Error,
    >;
    /// Applies an action to the specified check evaluation RIDs. If any of the check actions fail,
    /// then none of the actions will be applied.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/manual-check-evaluation/batch-perform-action",
        name = "batchPerformManualCheckAlertAction",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn batch_perform_manual_check_alert_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchManualCheckEvaluationActionRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Returns a record of the historical manual actions taken on the provided check evaluation.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/manual-check-evaluation/{rid}/action-log",
        name = "getManualCheckEvaluationActionLog",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_manual_check_evaluation_action_log(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::datareview::api::ManualCheckEvaluationRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::ManualCheckEvaluationActionLog,
        conjure_http::private::Error,
    >;
    /// Archives the data review with the given rid.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/{dataReviewRid}/archive",
        name = "archiveDataReview",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn archive_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<bool, conjure_http::private::Error>;
    /// Batch archives the data reviews with the given rids.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/batch-archive",
        name = "batchArchiveDataReview",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn batch_archive_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        rids: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
        >,
    ) -> Result<(), conjure_http::private::Error>;
    /// Unarchives the data review with the given rid.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/unarchive/{dataReviewRid}",
        name = "unarchiveDataReview",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn unarchive_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<(), conjure_http::private::Error>;
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/data-review-check-metrics",
        name = "getDataReviewCheckMetrics",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_data_review_check_metrics(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::GetDataReviewCheckMetricsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::GetDataReviewCheckMetricsResponse,
        conjure_http::private::Error,
    >;
}
/// The data review service manages the evaluation, disposition, and historical record of checks alerts.
#[conjure_http::conjure_client(name = "DataReviewService")]
pub trait AsyncDataReviewService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// For each request, initiates data review for the requested run and checklist and executes
    /// the automatic checks against the run.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/batch-initiate",
        name = "batchInitiate",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_initiate(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchInitiateDataReviewRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::BatchInitiateDataReviewResponse,
        conjure_http::private::Error,
    >;
    /// Re-executes the most recent failed automatic checks for the data review.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/rerun-failed-automatic-checks",
        name = "rerunFailedAutomaticChecks",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn rerun_failed_automatic_checks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::RerunFailedAutomaticChecksRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Returns the data reviews under the provided search parameters.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/search",
        name = "findDataReviews",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn find_data_reviews(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::FindDataReviewsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::DataReviewPage,
        conjure_http::private::Error,
    >;
    /// Throws if not found.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/{dataReviewRid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::DataReview,
        conjure_http::private::Error,
    >;
    /// Throws if not found.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/check-alerts/{checkAlertRid}",
        name = "getCheckAlert",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_check_alert(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checkAlertRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        check_alert_rid: &super::super::super::super::super::objects::scout::rids::api::CheckAlertRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlert,
        conjure_http::private::Error,
    >;
    /// Gets all check alerts from the provided data review.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/{dataReviewRid}/check-alerts",
        name = "getCheckAlertsForDataReview",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn get_check_alerts_for_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<
        std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::datareview::api::CheckAlert,
        >,
        conjure_http::private::Error,
    >;
    /// Returns a histogram of alerts that occur across the provided runs or assets. At least one run or asset must be specified.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/check-alerts/histogram",
        name = "getCheckAlertsHistogram",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_check_alerts_histogram(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::CheckAlertsHistogramRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlertsHistogramResponse,
        conjure_http::private::Error,
    >;
    /// Returns the check alerts under the provided search parameters. At least one run or asset must be specified.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/check-alerts",
        name = "searchCheckAlerts",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn search_check_alerts(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::SearchCheckAlertsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::SearchCheckAlertsResponse,
        conjure_http::private::Error,
    >;
    /// Returns a record of the historical actions taken on the provided check alert.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/check-alerts/{checkAlertRid}/action-log",
        name = "getCheckAlertActionLog",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_check_alert_action_log(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checkAlertRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        check_alert_rid: &super::super::super::super::super::objects::scout::rids::api::CheckAlertRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlertActionLog,
        conjure_http::private::Error,
    >;
    /// Returns the number of alerts attached to each provided notebook.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/get-check-alert-counts-for-notebooks",
        name = "getCheckAlertCountsForNotebooks",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn get_check_alert_counts_for_notebooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        rids: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
        >,
    ) -> Result<
        std::collections::BTreeMap<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
            i32,
        >,
        conjure_http::private::Error,
    >;
    /// Returns the check alert status of any linked violations for the provided notebooks. If none exist, an empty
    /// optional is returned.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/get-check-alert-status-for-notebooks",
        name = "getCheckAlertStatusForNotebooks",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn get_check_alert_status_for_notebooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        rids: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
        >,
    ) -> Result<
        std::collections::BTreeMap<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
            Option<
                super::super::super::super::super::objects::scout::datareview::api::CheckAlertStatus,
            >,
        >,
        conjure_http::private::Error,
    >;
    /// Applies a check alert action to the specified check alert RID.
    #[endpoint(
        method = PUT,
        path = "/scout/v2/data-review/check-alerts/{checkAlertRid}",
        name = "performCheckAlertAction",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn perform_check_alert_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checkAlertRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        check_alert_rid: &super::super::super::super::super::objects::scout::rids::api::CheckAlertRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::CheckAlertAction,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlert,
        conjure_http::private::Error,
    >;
    /// Applies a check alert action to the specified check alert RIDs. If any of the check actions fail,
    /// then none of the check actions will be applied.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/check-alerts/batch-perform-action",
        name = "batchPerformCheckAlertAction",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_perform_check_alert_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchCheckAlertActionRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::BatchCheckAlertActionResponse,
        conjure_http::private::Error,
    >;
    /// Applies an action to the specified check evaluation RIDs. If any of the check actions fail,
    /// then none of the actions will be applied.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/automatic-check-evaluation/batch-perform-action",
        name = "batchPerformAutomaticCheckEvaluationReviewAction",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_perform_automatic_check_evaluation_review_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchAutomaticCheckEvaluationActionRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::BatchAutomaticCheckEvaluationActionResponse,
        conjure_http::private::Error,
    >;
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/automatic-check-evaluation/{rid}/action-log",
        name = "getAutomaticCheckEvaluationActionLog",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_automatic_check_evaluation_action_log(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::api::rids::AutomaticCheckEvaluationRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::AutomaticCheckEvaluationActionLog,
        conjure_http::private::Error,
    >;
    /// Applies an action to the specified check evaluation RIDs. If any of the check actions fail,
    /// then none of the actions will be applied.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/manual-check-evaluation/batch-perform-action",
        name = "batchPerformManualCheckAlertAction",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn batch_perform_manual_check_alert_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchManualCheckEvaluationActionRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Returns a record of the historical manual actions taken on the provided check evaluation.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/manual-check-evaluation/{rid}/action-log",
        name = "getManualCheckEvaluationActionLog",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_manual_check_evaluation_action_log(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::datareview::api::ManualCheckEvaluationRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::ManualCheckEvaluationActionLog,
        conjure_http::private::Error,
    >;
    /// Archives the data review with the given rid.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/{dataReviewRid}/archive",
        name = "archiveDataReview",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn archive_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<bool, conjure_http::private::Error>;
    /// Batch archives the data reviews with the given rids.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/batch-archive",
        name = "batchArchiveDataReview",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn batch_archive_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        rids: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
        >,
    ) -> Result<(), conjure_http::private::Error>;
    /// Unarchives the data review with the given rid.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/unarchive/{dataReviewRid}",
        name = "unarchiveDataReview",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn unarchive_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<(), conjure_http::private::Error>;
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/data-review-check-metrics",
        name = "getDataReviewCheckMetrics",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_data_review_check_metrics(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::GetDataReviewCheckMetricsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::GetDataReviewCheckMetricsResponse,
        conjure_http::private::Error,
    >;
}
/// The data review service manages the evaluation, disposition, and historical record of checks alerts.
#[conjure_http::conjure_client(name = "DataReviewService", local)]
pub trait LocalAsyncDataReviewService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// For each request, initiates data review for the requested run and checklist and executes
    /// the automatic checks against the run.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/batch-initiate",
        name = "batchInitiate",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_initiate(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchInitiateDataReviewRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::BatchInitiateDataReviewResponse,
        conjure_http::private::Error,
    >;
    /// Re-executes the most recent failed automatic checks for the data review.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/rerun-failed-automatic-checks",
        name = "rerunFailedAutomaticChecks",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn rerun_failed_automatic_checks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::RerunFailedAutomaticChecksRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Returns the data reviews under the provided search parameters.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/search",
        name = "findDataReviews",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn find_data_reviews(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::FindDataReviewsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::DataReviewPage,
        conjure_http::private::Error,
    >;
    /// Throws if not found.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/{dataReviewRid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::DataReview,
        conjure_http::private::Error,
    >;
    /// Throws if not found.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/check-alerts/{checkAlertRid}",
        name = "getCheckAlert",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_check_alert(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checkAlertRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        check_alert_rid: &super::super::super::super::super::objects::scout::rids::api::CheckAlertRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlert,
        conjure_http::private::Error,
    >;
    /// Gets all check alerts from the provided data review.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/{dataReviewRid}/check-alerts",
        name = "getCheckAlertsForDataReview",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn get_check_alerts_for_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<
        std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::datareview::api::CheckAlert,
        >,
        conjure_http::private::Error,
    >;
    /// Returns a histogram of alerts that occur across the provided runs or assets. At least one run or asset must be specified.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/check-alerts/histogram",
        name = "getCheckAlertsHistogram",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_check_alerts_histogram(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::CheckAlertsHistogramRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlertsHistogramResponse,
        conjure_http::private::Error,
    >;
    /// Returns the check alerts under the provided search parameters. At least one run or asset must be specified.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/check-alerts",
        name = "searchCheckAlerts",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn search_check_alerts(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::SearchCheckAlertsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::SearchCheckAlertsResponse,
        conjure_http::private::Error,
    >;
    /// Returns a record of the historical actions taken on the provided check alert.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/check-alerts/{checkAlertRid}/action-log",
        name = "getCheckAlertActionLog",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_check_alert_action_log(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checkAlertRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        check_alert_rid: &super::super::super::super::super::objects::scout::rids::api::CheckAlertRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlertActionLog,
        conjure_http::private::Error,
    >;
    /// Returns the number of alerts attached to each provided notebook.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/get-check-alert-counts-for-notebooks",
        name = "getCheckAlertCountsForNotebooks",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn get_check_alert_counts_for_notebooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        rids: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
        >,
    ) -> Result<
        std::collections::BTreeMap<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
            i32,
        >,
        conjure_http::private::Error,
    >;
    /// Returns the check alert status of any linked violations for the provided notebooks. If none exist, an empty
    /// optional is returned.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/get-check-alert-status-for-notebooks",
        name = "getCheckAlertStatusForNotebooks",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn get_check_alert_status_for_notebooks(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        rids: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
        >,
    ) -> Result<
        std::collections::BTreeMap<
            super::super::super::super::super::objects::scout::rids::api::NotebookRid,
            Option<
                super::super::super::super::super::objects::scout::datareview::api::CheckAlertStatus,
            >,
        >,
        conjure_http::private::Error,
    >;
    /// Applies a check alert action to the specified check alert RID.
    #[endpoint(
        method = PUT,
        path = "/scout/v2/data-review/check-alerts/{checkAlertRid}",
        name = "performCheckAlertAction",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn perform_check_alert_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checkAlertRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        check_alert_rid: &super::super::super::super::super::objects::scout::rids::api::CheckAlertRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::CheckAlertAction,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::CheckAlert,
        conjure_http::private::Error,
    >;
    /// Applies a check alert action to the specified check alert RIDs. If any of the check actions fail,
    /// then none of the check actions will be applied.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/check-alerts/batch-perform-action",
        name = "batchPerformCheckAlertAction",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_perform_check_alert_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchCheckAlertActionRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::BatchCheckAlertActionResponse,
        conjure_http::private::Error,
    >;
    /// Applies an action to the specified check evaluation RIDs. If any of the check actions fail,
    /// then none of the actions will be applied.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/automatic-check-evaluation/batch-perform-action",
        name = "batchPerformAutomaticCheckEvaluationReviewAction",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_perform_automatic_check_evaluation_review_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchAutomaticCheckEvaluationActionRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::BatchAutomaticCheckEvaluationActionResponse,
        conjure_http::private::Error,
    >;
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/automatic-check-evaluation/{rid}/action-log",
        name = "getAutomaticCheckEvaluationActionLog",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_automatic_check_evaluation_action_log(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::api::rids::AutomaticCheckEvaluationRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::AutomaticCheckEvaluationActionLog,
        conjure_http::private::Error,
    >;
    /// Applies an action to the specified check evaluation RIDs. If any of the check actions fail,
    /// then none of the actions will be applied.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/manual-check-evaluation/batch-perform-action",
        name = "batchPerformManualCheckAlertAction",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn batch_perform_manual_check_alert_action(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::BatchManualCheckEvaluationActionRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Returns a record of the historical manual actions taken on the provided check evaluation.
    #[endpoint(
        method = GET,
        path = "/scout/v2/data-review/manual-check-evaluation/{rid}/action-log",
        name = "getManualCheckEvaluationActionLog",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_manual_check_evaluation_action_log(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::datareview::api::ManualCheckEvaluationRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::ManualCheckEvaluationActionLog,
        conjure_http::private::Error,
    >;
    /// Archives the data review with the given rid.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/{dataReviewRid}/archive",
        name = "archiveDataReview",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn archive_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<bool, conjure_http::private::Error>;
    /// Batch archives the data reviews with the given rids.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/batch-archive",
        name = "batchArchiveDataReview",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn batch_archive_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        rids: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
        >,
    ) -> Result<(), conjure_http::private::Error>;
    /// Unarchives the data review with the given rid.
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/unarchive/{dataReviewRid}",
        name = "unarchiveDataReview",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn unarchive_data_review(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "dataReviewRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        data_review_rid: &super::super::super::super::super::objects::scout::rids::api::DataReviewRid,
    ) -> Result<(), conjure_http::private::Error>;
    #[endpoint(
        method = POST,
        path = "/scout/v2/data-review/data-review-check-metrics",
        name = "getDataReviewCheckMetrics",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_data_review_check_metrics(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::datareview::api::GetDataReviewCheckMetricsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::datareview::api::GetDataReviewCheckMetricsResponse,
        conjure_http::private::Error,
    >;
}