nominal-api 0.1241.0

use conjure_http::endpoint;
/// The Checklist Service is responsible for managing checklists and checks.
/// A checklist is a collection of checks that can be executed against a set of data sources.
#[conjure_http::conjure_client(name = "ChecklistService")]
pub trait ChecklistService<
    #[response_body]
    I: Iterator<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Creates a new checklist with the provided checks.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists",
        name = "create",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::CreateChecklistRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Creates a permanent commit with a commit message.
    /// Throws if the checklist or branch doesn't exist.
    /// Throws if the latest commit doesn't match the provided id.
    /// Throws if you commit to an archived checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/commit",
        name = "commit",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn commit(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::CommitChecklistRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Creates a commit that may be compacted, e.g cleaned up and not exist anymore.
    /// Throws if the checklist or branch doesn't exist.
    /// Throws if the latest commit doesn't match the provided id.
    /// Throws if you save to an archived checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/save-working-state",
        name = "saveWorkingState",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn save_working_state(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::SaveChecklistRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Merges the given branch to the "main" branch.
    /// Throws if the checklist or branch doesn't exist.
    /// Throws if the latest commit doesn't match the provided id.
    /// Throws if you merge with an archived checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/merge-to-main",
        name = "mergeToMain",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn merge_to_main(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::MergeToMainRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Updates the data source ref names for all checks within a checklist.
    /// Throws if the checklist doesn't exist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/update-ref-names",
        name = "updateDataSourceRefNames",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn update_data_source_ref_names(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        ref_name_updates: &std::collections::BTreeMap<
            super::super::super::super::super::objects::scout::api::DataSourceRefName,
            super::super::super::super::super::objects::scout::api::DataSourceRefName,
        >,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Updates the metadata of a checklist.
    #[endpoint(
        method = PUT,
        path = "/scout/v1/checklists/{rid}/update-metadata",
        name = "updateMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn update_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::UpdateChecklistMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::ChecklistMetadata,
        conjure_http::private::Error,
    >;
    /// Specify at most one of (branch, commit).
    /// If neither is specified, branch = "main" is the default.
    #[endpoint(
        method = GET,
        path = "/scout/v1/checklists/{rid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[query(
            name = "commit",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        commit: Option<
            &super::super::super::super::super::objects::scout::versioning::api::CommitId,
        >,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Returns the pinned commit for each provided checklist reference.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/batch-get",
        name = "batchGet",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    fn batch_get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        checklist_refs: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::checks::api::PinnedChecklistRef,
        >,
    ) -> Result<
        std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        >,
        conjure_http::private::Error,
    >;
    /// Returns the metadata for each provided checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/batch-get-metadata",
        name = "batchGetMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn batch_get_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataResponse,
        conjure_http::private::Error,
    >;
    /// Results will be the latest commit on main for each checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/search",
        name = "search",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn search(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::SearchChecklistsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklistPage,
        conjure_http::private::Error,
    >;
    /// Archives the provided checklists.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/archive",
        name = "archive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn archive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::ArchiveChecklistsRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Unarchives the provided checklists.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/unarchive",
        name = "unarchive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    fn unarchive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::UnarchiveChecklistsRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Returns the check with the given rid.
    #[endpoint(
        method = GET,
        path = "/scout/v1/checklists/check/{rid}",
        name = "getCheck",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_check(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::rids::api::CheckRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::Check,
        conjure_http::private::Error,
    >;
    /// Returns the checks with the given rids.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/check/batch-get",
        name = "batchGetChecks",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    fn batch_get_checks(
        &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::CheckRid,
        >,
    ) -> Result<
        std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::checks::api::Check,
        >,
        conjure_http::private::Error,
    >;
    /// Returns all labels and properties.
    #[endpoint(
        method = GET,
        path = "/scout/v1/checklists/get-all-labels-properties",
        name = "getAllLabelsAndProperties",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn get_all_labels_and_properties(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[query(
            name = "workspaces",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        workspaces: &std::collections::BTreeSet<
            super::super::super::super::super::objects::api::rids::WorkspaceRid,
        >,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::GetAllLabelsAndPropertiesResponse,
        conjure_http::private::Error,
    >;
    /// Batch edits metadata across multiple checklists. Supports rename/merge for labels and properties.
    /// If more than 1000 checklists are targeted, this endpoint will throw a 400.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/metadata/batch-edit",
        name = "batchEditChecklistMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    fn batch_edit_checklist_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataResponse,
        conjure_http::private::Error,
    >;
}
/// The Checklist Service is responsible for managing checklists and checks.
/// A checklist is a collection of checks that can be executed against a set of data sources.
#[conjure_http::conjure_client(name = "ChecklistService")]
pub trait AsyncChecklistService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Creates a new checklist with the provided checks.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists",
        name = "create",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::CreateChecklistRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Creates a permanent commit with a commit message.
    /// Throws if the checklist or branch doesn't exist.
    /// Throws if the latest commit doesn't match the provided id.
    /// Throws if you commit to an archived checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/commit",
        name = "commit",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn commit(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::CommitChecklistRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Creates a commit that may be compacted, e.g cleaned up and not exist anymore.
    /// Throws if the checklist or branch doesn't exist.
    /// Throws if the latest commit doesn't match the provided id.
    /// Throws if you save to an archived checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/save-working-state",
        name = "saveWorkingState",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn save_working_state(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::SaveChecklistRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Merges the given branch to the "main" branch.
    /// Throws if the checklist or branch doesn't exist.
    /// Throws if the latest commit doesn't match the provided id.
    /// Throws if you merge with an archived checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/merge-to-main",
        name = "mergeToMain",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn merge_to_main(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::MergeToMainRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Updates the data source ref names for all checks within a checklist.
    /// Throws if the checklist doesn't exist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/update-ref-names",
        name = "updateDataSourceRefNames",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn update_data_source_ref_names(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        ref_name_updates: &std::collections::BTreeMap<
            super::super::super::super::super::objects::scout::api::DataSourceRefName,
            super::super::super::super::super::objects::scout::api::DataSourceRefName,
        >,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Updates the metadata of a checklist.
    #[endpoint(
        method = PUT,
        path = "/scout/v1/checklists/{rid}/update-metadata",
        name = "updateMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn update_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::UpdateChecklistMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::ChecklistMetadata,
        conjure_http::private::Error,
    >;
    /// Specify at most one of (branch, commit).
    /// If neither is specified, branch = "main" is the default.
    #[endpoint(
        method = GET,
        path = "/scout/v1/checklists/{rid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[query(
            name = "commit",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        commit: Option<
            &super::super::super::super::super::objects::scout::versioning::api::CommitId,
        >,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Returns the pinned commit for each provided checklist reference.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/batch-get",
        name = "batchGet",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn batch_get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        checklist_refs: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::checks::api::PinnedChecklistRef,
        >,
    ) -> Result<
        std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        >,
        conjure_http::private::Error,
    >;
    /// Returns the metadata for each provided checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/batch-get-metadata",
        name = "batchGetMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_get_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataResponse,
        conjure_http::private::Error,
    >;
    /// Results will be the latest commit on main for each checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/search",
        name = "search",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn search(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::SearchChecklistsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklistPage,
        conjure_http::private::Error,
    >;
    /// Archives the provided checklists.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/archive",
        name = "archive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn archive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::ArchiveChecklistsRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Unarchives the provided checklists.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/unarchive",
        name = "unarchive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn unarchive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::UnarchiveChecklistsRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Returns the check with the given rid.
    #[endpoint(
        method = GET,
        path = "/scout/v1/checklists/check/{rid}",
        name = "getCheck",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_check(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::rids::api::CheckRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::Check,
        conjure_http::private::Error,
    >;
    /// Returns the checks with the given rids.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/check/batch-get",
        name = "batchGetChecks",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn batch_get_checks(
        &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::CheckRid,
        >,
    ) -> Result<
        std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::checks::api::Check,
        >,
        conjure_http::private::Error,
    >;
    /// Returns all labels and properties.
    #[endpoint(
        method = GET,
        path = "/scout/v1/checklists/get-all-labels-properties",
        name = "getAllLabelsAndProperties",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_all_labels_and_properties(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[query(
            name = "workspaces",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        workspaces: &std::collections::BTreeSet<
            super::super::super::super::super::objects::api::rids::WorkspaceRid,
        >,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::GetAllLabelsAndPropertiesResponse,
        conjure_http::private::Error,
    >;
    /// Batch edits metadata across multiple checklists. Supports rename/merge for labels and properties.
    /// If more than 1000 checklists are targeted, this endpoint will throw a 400.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/metadata/batch-edit",
        name = "batchEditChecklistMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_edit_checklist_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataResponse,
        conjure_http::private::Error,
    >;
}
/// The Checklist Service is responsible for managing checklists and checks.
/// A checklist is a collection of checks that can be executed against a set of data sources.
#[conjure_http::conjure_client(name = "ChecklistService", local)]
pub trait LocalAsyncChecklistService<
    #[response_body]
    I: conjure_http::private::Stream<
            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
        >,
> {
    /// Creates a new checklist with the provided checks.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists",
        name = "create",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn create(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::CreateChecklistRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Creates a permanent commit with a commit message.
    /// Throws if the checklist or branch doesn't exist.
    /// Throws if the latest commit doesn't match the provided id.
    /// Throws if you commit to an archived checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/commit",
        name = "commit",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn commit(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::CommitChecklistRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Creates a commit that may be compacted, e.g cleaned up and not exist anymore.
    /// Throws if the checklist or branch doesn't exist.
    /// Throws if the latest commit doesn't match the provided id.
    /// Throws if you save to an archived checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/save-working-state",
        name = "saveWorkingState",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn save_working_state(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::SaveChecklistRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Merges the given branch to the "main" branch.
    /// Throws if the checklist or branch doesn't exist.
    /// Throws if the latest commit doesn't match the provided id.
    /// Throws if you merge with an archived checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/merge-to-main",
        name = "mergeToMain",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn merge_to_main(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::MergeToMainRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Updates the data source ref names for all checks within a checklist.
    /// Throws if the checklist doesn't exist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/{checklistRid}/update-ref-names",
        name = "updateDataSourceRefNames",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn update_data_source_ref_names(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(
            name = "checklistRid",
            encoder = conjure_http::client::conjure::PlainEncoder
        )]
        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        ref_name_updates: &std::collections::BTreeMap<
            super::super::super::super::super::objects::scout::api::DataSourceRefName,
            super::super::super::super::super::objects::scout::api::DataSourceRefName,
        >,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Updates the metadata of a checklist.
    #[endpoint(
        method = PUT,
        path = "/scout/v1/checklists/{rid}/update-metadata",
        name = "updateMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn update_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::UpdateChecklistMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::ChecklistMetadata,
        conjure_http::private::Error,
    >;
    /// Specify at most one of (branch, commit).
    /// If neither is specified, branch = "main" is the default.
    #[endpoint(
        method = GET,
        path = "/scout/v1/checklists/{rid}",
        name = "get",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
        #[query(
            name = "branch",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        branch: Option<
            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
        >,
        #[query(
            name = "commit",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        commit: Option<
            &super::super::super::super::super::objects::scout::versioning::api::CommitId,
        >,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        conjure_http::private::Error,
    >;
    /// Returns the pinned commit for each provided checklist reference.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/batch-get",
        name = "batchGet",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn batch_get(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        checklist_refs: &std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::checks::api::PinnedChecklistRef,
        >,
    ) -> Result<
        std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
        >,
        conjure_http::private::Error,
    >;
    /// Returns the metadata for each provided checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/batch-get-metadata",
        name = "batchGetMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_get_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataResponse,
        conjure_http::private::Error,
    >;
    /// Results will be the latest commit on main for each checklist.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/search",
        name = "search",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn search(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::SearchChecklistsRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::VersionedChecklistPage,
        conjure_http::private::Error,
    >;
    /// Archives the provided checklists.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/archive",
        name = "archive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn archive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::ArchiveChecklistsRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Unarchives the provided checklists.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/unarchive",
        name = "unarchive",
        accept = conjure_http::client::conjure::EmptyResponseDeserializer
    )]
    async fn unarchive(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::UnarchiveChecklistsRequest,
    ) -> Result<(), conjure_http::private::Error>;
    /// Returns the check with the given rid.
    #[endpoint(
        method = GET,
        path = "/scout/v1/checklists/check/{rid}",
        name = "getCheck",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_check(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
        rid: &super::super::super::super::super::objects::scout::rids::api::CheckRid,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::Check,
        conjure_http::private::Error,
    >;
    /// Returns the checks with the given rids.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/check/batch-get",
        name = "batchGetChecks",
        accept = conjure_http::client::conjure::CollectionResponseDeserializer
    )]
    async fn batch_get_checks(
        &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::CheckRid,
        >,
    ) -> Result<
        std::collections::BTreeSet<
            super::super::super::super::super::objects::scout::checks::api::Check,
        >,
        conjure_http::private::Error,
    >;
    /// Returns all labels and properties.
    #[endpoint(
        method = GET,
        path = "/scout/v1/checklists/get-all-labels-properties",
        name = "getAllLabelsAndProperties",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn get_all_labels_and_properties(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[query(
            name = "workspaces",
            encoder = conjure_http::client::conjure::PlainSeqEncoder
        )]
        workspaces: &std::collections::BTreeSet<
            super::super::super::super::super::objects::api::rids::WorkspaceRid,
        >,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::GetAllLabelsAndPropertiesResponse,
        conjure_http::private::Error,
    >;
    /// Batch edits metadata across multiple checklists. Supports rename/merge for labels and properties.
    /// If more than 1000 checklists are targeted, this endpoint will throw a 400.
    #[endpoint(
        method = POST,
        path = "/scout/v1/checklists/metadata/batch-edit",
        name = "batchEditChecklistMetadata",
        accept = conjure_http::client::StdResponseDeserializer
    )]
    async fn batch_edit_checklist_metadata(
        &self,
        #[auth]
        auth_: &conjure_object::BearerToken,
        #[body(serializer = conjure_http::client::StdRequestSerializer)]
        request: &super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataRequest,
    ) -> Result<
        super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataResponse,
        conjure_http::private::Error,
    >;
}