nominal_api/conjure/clients/scout/checks/api/
checklist_service.rs

1use conjure_http::endpoint;
2/// The Checklist Service is responsible for managing checklists and checks.
3/// A checklist is a collection of checks that can be executed against a set of data sources.
4#[conjure_http::conjure_client(name = "ChecklistService")]
5pub trait ChecklistService<
6    #[response_body]
7    I: Iterator<
8            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
9        >,
10> {
11    /// Creates a new checklist with the provided checks.
12    #[endpoint(
13        method = POST,
14        path = "/scout/v1/checklists",
15        name = "create",
16        accept = conjure_http::client::StdResponseDeserializer
17    )]
18    fn create(
19        &self,
20        #[auth]
21        auth_: &conjure_object::BearerToken,
22        #[body(serializer = conjure_http::client::StdRequestSerializer)]
23        request: &super::super::super::super::super::objects::scout::checks::api::CreateChecklistRequest,
24    ) -> Result<
25        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
26        conjure_http::private::Error,
27    >;
28    /// Creates a permanent commit with a commit message.
29    /// Throws if the checklist or branch doesn't exist.
30    /// Throws if the latest commit doesn't match the provided id.
31    /// Throws if you commit to an archived checklist.
32    #[endpoint(
33        method = POST,
34        path = "/scout/v1/checklists/{checklistRid}/commit",
35        name = "commit",
36        accept = conjure_http::client::StdResponseDeserializer
37    )]
38    fn commit(
39        &self,
40        #[auth]
41        auth_: &conjure_object::BearerToken,
42        #[path(
43            name = "checklistRid",
44            encoder = conjure_http::client::conjure::PlainEncoder
45        )]
46        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
47        #[query(
48            name = "branch",
49            encoder = conjure_http::client::conjure::PlainSeqEncoder
50        )]
51        branch: Option<
52            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
53        >,
54        #[body(serializer = conjure_http::client::StdRequestSerializer)]
55        request: &super::super::super::super::super::objects::scout::checks::api::CommitChecklistRequest,
56    ) -> Result<
57        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
58        conjure_http::private::Error,
59    >;
60    /// Creates a commit that may be compacted, e.g cleaned up and not exist anymore.
61    /// Throws if the checklist or branch doesn't exist.
62    /// Throws if the latest commit doesn't match the provided id.
63    /// Throws if you save to an archived checklist.
64    #[endpoint(
65        method = POST,
66        path = "/scout/v1/checklists/{checklistRid}/save-working-state",
67        name = "saveWorkingState",
68        accept = conjure_http::client::StdResponseDeserializer
69    )]
70    fn save_working_state(
71        &self,
72        #[auth]
73        auth_: &conjure_object::BearerToken,
74        #[path(
75            name = "checklistRid",
76            encoder = conjure_http::client::conjure::PlainEncoder
77        )]
78        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
79        #[query(
80            name = "branch",
81            encoder = conjure_http::client::conjure::PlainSeqEncoder
82        )]
83        branch: Option<
84            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
85        >,
86        #[body(serializer = conjure_http::client::StdRequestSerializer)]
87        request: &super::super::super::super::super::objects::scout::checks::api::SaveChecklistRequest,
88    ) -> Result<
89        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
90        conjure_http::private::Error,
91    >;
92    /// Merges the given branch to the "main" branch.
93    /// Throws if the checklist or branch doesn't exist.
94    /// Throws if the latest commit doesn't match the provided id.
95    /// Throws if you merge with an archived checklist.
96    #[endpoint(
97        method = POST,
98        path = "/scout/v1/checklists/{checklistRid}/merge-to-main",
99        name = "mergeToMain",
100        accept = conjure_http::client::StdResponseDeserializer
101    )]
102    fn merge_to_main(
103        &self,
104        #[auth]
105        auth_: &conjure_object::BearerToken,
106        #[path(
107            name = "checklistRid",
108            encoder = conjure_http::client::conjure::PlainEncoder
109        )]
110        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
111        #[body(serializer = conjure_http::client::StdRequestSerializer)]
112        request: &super::super::super::super::super::objects::scout::checks::api::MergeToMainRequest,
113    ) -> Result<
114        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
115        conjure_http::private::Error,
116    >;
117    /// Updates the data source ref names for all checks within a checklist.
118    /// Throws if the checklist doesn't exist.
119    #[endpoint(
120        method = POST,
121        path = "/scout/v1/checklists/{checklistRid}/update-ref-names",
122        name = "updateDataSourceRefNames",
123        accept = conjure_http::client::StdResponseDeserializer
124    )]
125    fn update_data_source_ref_names(
126        &self,
127        #[auth]
128        auth_: &conjure_object::BearerToken,
129        #[path(
130            name = "checklistRid",
131            encoder = conjure_http::client::conjure::PlainEncoder
132        )]
133        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
134        #[query(
135            name = "branch",
136            encoder = conjure_http::client::conjure::PlainSeqEncoder
137        )]
138        branch: Option<
139            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
140        >,
141        #[body(serializer = conjure_http::client::StdRequestSerializer)]
142        ref_name_updates: &std::collections::BTreeMap<
143            super::super::super::super::super::objects::scout::api::DataSourceRefName,
144            super::super::super::super::super::objects::scout::api::DataSourceRefName,
145        >,
146    ) -> Result<
147        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
148        conjure_http::private::Error,
149    >;
150    /// Updates the metadata of a checklist.
151    #[endpoint(
152        method = PUT,
153        path = "/scout/v1/checklists/{rid}/update-metadata",
154        name = "updateMetadata",
155        accept = conjure_http::client::StdResponseDeserializer
156    )]
157    fn update_metadata(
158        &self,
159        #[auth]
160        auth_: &conjure_object::BearerToken,
161        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
162        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
163        #[body(serializer = conjure_http::client::StdRequestSerializer)]
164        request: &super::super::super::super::super::objects::scout::checks::api::UpdateChecklistMetadataRequest,
165    ) -> Result<
166        super::super::super::super::super::objects::scout::checks::api::ChecklistMetadata,
167        conjure_http::private::Error,
168    >;
169    /// Specify at most one of (branch, commit).
170    /// If neither is specified, branch = "main" is the default.
171    #[endpoint(
172        method = GET,
173        path = "/scout/v1/checklists/{rid}",
174        name = "get",
175        accept = conjure_http::client::StdResponseDeserializer
176    )]
177    fn get(
178        &self,
179        #[auth]
180        auth_: &conjure_object::BearerToken,
181        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
182        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
183        #[query(
184            name = "branch",
185            encoder = conjure_http::client::conjure::PlainSeqEncoder
186        )]
187        branch: Option<
188            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
189        >,
190        #[query(
191            name = "commit",
192            encoder = conjure_http::client::conjure::PlainSeqEncoder
193        )]
194        commit: Option<
195            &super::super::super::super::super::objects::scout::versioning::api::CommitId,
196        >,
197    ) -> Result<
198        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
199        conjure_http::private::Error,
200    >;
201    /// Returns the pinned commit for each provided checklist reference.
202    #[endpoint(
203        method = POST,
204        path = "/scout/v1/checklists/batch-get",
205        name = "batchGet",
206        accept = conjure_http::client::conjure::CollectionResponseDeserializer
207    )]
208    fn batch_get(
209        &self,
210        #[auth]
211        auth_: &conjure_object::BearerToken,
212        #[body(serializer = conjure_http::client::StdRequestSerializer)]
213        checklist_refs: &std::collections::BTreeSet<
214            super::super::super::super::super::objects::scout::checks::api::PinnedChecklistRef,
215        >,
216    ) -> Result<
217        std::collections::BTreeSet<
218            super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
219        >,
220        conjure_http::private::Error,
221    >;
222    /// Returns the metadata for each provided checklist.
223    #[endpoint(
224        method = POST,
225        path = "/scout/v1/checklists/batch-get-metadata",
226        name = "batchGetMetadata",
227        accept = conjure_http::client::StdResponseDeserializer
228    )]
229    fn batch_get_metadata(
230        &self,
231        #[auth]
232        auth_: &conjure_object::BearerToken,
233        #[body(serializer = conjure_http::client::StdRequestSerializer)]
234        request: &super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataRequest,
235    ) -> Result<
236        super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataResponse,
237        conjure_http::private::Error,
238    >;
239    /// Results will be the latest commit on main for each checklist.
240    #[endpoint(
241        method = POST,
242        path = "/scout/v1/checklists/search",
243        name = "search",
244        accept = conjure_http::client::StdResponseDeserializer
245    )]
246    fn search(
247        &self,
248        #[auth]
249        auth_: &conjure_object::BearerToken,
250        #[body(serializer = conjure_http::client::StdRequestSerializer)]
251        request: &super::super::super::super::super::objects::scout::checks::api::SearchChecklistsRequest,
252    ) -> Result<
253        super::super::super::super::super::objects::scout::checks::api::VersionedChecklistPage,
254        conjure_http::private::Error,
255    >;
256    /// Archives the provided checklists.
257    #[endpoint(
258        method = POST,
259        path = "/scout/v1/checklists/archive",
260        name = "archive",
261        accept = conjure_http::client::conjure::EmptyResponseDeserializer
262    )]
263    fn archive(
264        &self,
265        #[auth]
266        auth_: &conjure_object::BearerToken,
267        #[body(serializer = conjure_http::client::StdRequestSerializer)]
268        request: &super::super::super::super::super::objects::scout::checks::api::ArchiveChecklistsRequest,
269    ) -> Result<(), conjure_http::private::Error>;
270    /// Unarchives the provided checklists.
271    #[endpoint(
272        method = POST,
273        path = "/scout/v1/checklists/unarchive",
274        name = "unarchive",
275        accept = conjure_http::client::conjure::EmptyResponseDeserializer
276    )]
277    fn unarchive(
278        &self,
279        #[auth]
280        auth_: &conjure_object::BearerToken,
281        #[body(serializer = conjure_http::client::StdRequestSerializer)]
282        request: &super::super::super::super::super::objects::scout::checks::api::UnarchiveChecklistsRequest,
283    ) -> Result<(), conjure_http::private::Error>;
284    /// Returns the check with the given rid.
285    #[endpoint(
286        method = GET,
287        path = "/scout/v1/checklists/check/{rid}",
288        name = "getCheck",
289        accept = conjure_http::client::StdResponseDeserializer
290    )]
291    fn get_check(
292        &self,
293        #[auth]
294        auth_: &conjure_object::BearerToken,
295        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
296        rid: &super::super::super::super::super::objects::scout::rids::api::CheckRid,
297    ) -> Result<
298        super::super::super::super::super::objects::scout::checks::api::Check,
299        conjure_http::private::Error,
300    >;
301    /// Returns the checks with the given rids.
302    #[endpoint(
303        method = POST,
304        path = "/scout/v1/checklists/check/batch-get",
305        name = "batchGetChecks",
306        accept = conjure_http::client::conjure::CollectionResponseDeserializer
307    )]
308    fn batch_get_checks(
309        &self,
310        #[auth]
311        auth_: &conjure_object::BearerToken,
312        #[body(serializer = conjure_http::client::StdRequestSerializer)]
313        rids: &std::collections::BTreeSet<
314            super::super::super::super::super::objects::scout::rids::api::CheckRid,
315        >,
316    ) -> Result<
317        std::collections::BTreeSet<
318            super::super::super::super::super::objects::scout::checks::api::Check,
319        >,
320        conjure_http::private::Error,
321    >;
322    /// Returns all labels and properties.
323    #[endpoint(
324        method = GET,
325        path = "/scout/v1/checklists/get-all-labels-properties",
326        name = "getAllLabelsAndProperties",
327        accept = conjure_http::client::StdResponseDeserializer
328    )]
329    fn get_all_labels_and_properties(
330        &self,
331        #[auth]
332        auth_: &conjure_object::BearerToken,
333        #[query(
334            name = "workspaces",
335            encoder = conjure_http::client::conjure::PlainSeqEncoder
336        )]
337        workspaces: &std::collections::BTreeSet<
338            super::super::super::super::super::objects::api::rids::WorkspaceRid,
339        >,
340    ) -> Result<
341        super::super::super::super::super::objects::scout::checks::api::GetAllLabelsAndPropertiesResponse,
342        conjure_http::private::Error,
343    >;
344    /// Batch edits metadata across multiple checklists. Supports rename/merge for labels and properties.
345    /// If more than 1000 checklists are targeted, this endpoint will throw a 400.
346    #[endpoint(
347        method = POST,
348        path = "/scout/v1/checklists/metadata/batch-edit",
349        name = "batchEditChecklistMetadata",
350        accept = conjure_http::client::StdResponseDeserializer
351    )]
352    fn batch_edit_checklist_metadata(
353        &self,
354        #[auth]
355        auth_: &conjure_object::BearerToken,
356        #[body(serializer = conjure_http::client::StdRequestSerializer)]
357        request: &super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataRequest,
358    ) -> Result<
359        super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataResponse,
360        conjure_http::private::Error,
361    >;
362}
363/// The Checklist Service is responsible for managing checklists and checks.
364/// A checklist is a collection of checks that can be executed against a set of data sources.
365#[conjure_http::conjure_client(name = "ChecklistService")]
366pub trait AsyncChecklistService<
367    #[response_body]
368    I: conjure_http::private::Stream<
369            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
370        >,
371> {
372    /// Creates a new checklist with the provided checks.
373    #[endpoint(
374        method = POST,
375        path = "/scout/v1/checklists",
376        name = "create",
377        accept = conjure_http::client::StdResponseDeserializer
378    )]
379    async fn create(
380        &self,
381        #[auth]
382        auth_: &conjure_object::BearerToken,
383        #[body(serializer = conjure_http::client::StdRequestSerializer)]
384        request: &super::super::super::super::super::objects::scout::checks::api::CreateChecklistRequest,
385    ) -> Result<
386        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
387        conjure_http::private::Error,
388    >;
389    /// Creates a permanent commit with a commit message.
390    /// Throws if the checklist or branch doesn't exist.
391    /// Throws if the latest commit doesn't match the provided id.
392    /// Throws if you commit to an archived checklist.
393    #[endpoint(
394        method = POST,
395        path = "/scout/v1/checklists/{checklistRid}/commit",
396        name = "commit",
397        accept = conjure_http::client::StdResponseDeserializer
398    )]
399    async fn commit(
400        &self,
401        #[auth]
402        auth_: &conjure_object::BearerToken,
403        #[path(
404            name = "checklistRid",
405            encoder = conjure_http::client::conjure::PlainEncoder
406        )]
407        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
408        #[query(
409            name = "branch",
410            encoder = conjure_http::client::conjure::PlainSeqEncoder
411        )]
412        branch: Option<
413            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
414        >,
415        #[body(serializer = conjure_http::client::StdRequestSerializer)]
416        request: &super::super::super::super::super::objects::scout::checks::api::CommitChecklistRequest,
417    ) -> Result<
418        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
419        conjure_http::private::Error,
420    >;
421    /// Creates a commit that may be compacted, e.g cleaned up and not exist anymore.
422    /// Throws if the checklist or branch doesn't exist.
423    /// Throws if the latest commit doesn't match the provided id.
424    /// Throws if you save to an archived checklist.
425    #[endpoint(
426        method = POST,
427        path = "/scout/v1/checklists/{checklistRid}/save-working-state",
428        name = "saveWorkingState",
429        accept = conjure_http::client::StdResponseDeserializer
430    )]
431    async fn save_working_state(
432        &self,
433        #[auth]
434        auth_: &conjure_object::BearerToken,
435        #[path(
436            name = "checklistRid",
437            encoder = conjure_http::client::conjure::PlainEncoder
438        )]
439        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
440        #[query(
441            name = "branch",
442            encoder = conjure_http::client::conjure::PlainSeqEncoder
443        )]
444        branch: Option<
445            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
446        >,
447        #[body(serializer = conjure_http::client::StdRequestSerializer)]
448        request: &super::super::super::super::super::objects::scout::checks::api::SaveChecklistRequest,
449    ) -> Result<
450        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
451        conjure_http::private::Error,
452    >;
453    /// Merges the given branch to the "main" branch.
454    /// Throws if the checklist or branch doesn't exist.
455    /// Throws if the latest commit doesn't match the provided id.
456    /// Throws if you merge with an archived checklist.
457    #[endpoint(
458        method = POST,
459        path = "/scout/v1/checklists/{checklistRid}/merge-to-main",
460        name = "mergeToMain",
461        accept = conjure_http::client::StdResponseDeserializer
462    )]
463    async fn merge_to_main(
464        &self,
465        #[auth]
466        auth_: &conjure_object::BearerToken,
467        #[path(
468            name = "checklistRid",
469            encoder = conjure_http::client::conjure::PlainEncoder
470        )]
471        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
472        #[body(serializer = conjure_http::client::StdRequestSerializer)]
473        request: &super::super::super::super::super::objects::scout::checks::api::MergeToMainRequest,
474    ) -> Result<
475        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
476        conjure_http::private::Error,
477    >;
478    /// Updates the data source ref names for all checks within a checklist.
479    /// Throws if the checklist doesn't exist.
480    #[endpoint(
481        method = POST,
482        path = "/scout/v1/checklists/{checklistRid}/update-ref-names",
483        name = "updateDataSourceRefNames",
484        accept = conjure_http::client::StdResponseDeserializer
485    )]
486    async fn update_data_source_ref_names(
487        &self,
488        #[auth]
489        auth_: &conjure_object::BearerToken,
490        #[path(
491            name = "checklistRid",
492            encoder = conjure_http::client::conjure::PlainEncoder
493        )]
494        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
495        #[query(
496            name = "branch",
497            encoder = conjure_http::client::conjure::PlainSeqEncoder
498        )]
499        branch: Option<
500            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
501        >,
502        #[body(serializer = conjure_http::client::StdRequestSerializer)]
503        ref_name_updates: &std::collections::BTreeMap<
504            super::super::super::super::super::objects::scout::api::DataSourceRefName,
505            super::super::super::super::super::objects::scout::api::DataSourceRefName,
506        >,
507    ) -> Result<
508        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
509        conjure_http::private::Error,
510    >;
511    /// Updates the metadata of a checklist.
512    #[endpoint(
513        method = PUT,
514        path = "/scout/v1/checklists/{rid}/update-metadata",
515        name = "updateMetadata",
516        accept = conjure_http::client::StdResponseDeserializer
517    )]
518    async fn update_metadata(
519        &self,
520        #[auth]
521        auth_: &conjure_object::BearerToken,
522        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
523        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
524        #[body(serializer = conjure_http::client::StdRequestSerializer)]
525        request: &super::super::super::super::super::objects::scout::checks::api::UpdateChecklistMetadataRequest,
526    ) -> Result<
527        super::super::super::super::super::objects::scout::checks::api::ChecklistMetadata,
528        conjure_http::private::Error,
529    >;
530    /// Specify at most one of (branch, commit).
531    /// If neither is specified, branch = "main" is the default.
532    #[endpoint(
533        method = GET,
534        path = "/scout/v1/checklists/{rid}",
535        name = "get",
536        accept = conjure_http::client::StdResponseDeserializer
537    )]
538    async fn get(
539        &self,
540        #[auth]
541        auth_: &conjure_object::BearerToken,
542        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
543        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
544        #[query(
545            name = "branch",
546            encoder = conjure_http::client::conjure::PlainSeqEncoder
547        )]
548        branch: Option<
549            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
550        >,
551        #[query(
552            name = "commit",
553            encoder = conjure_http::client::conjure::PlainSeqEncoder
554        )]
555        commit: Option<
556            &super::super::super::super::super::objects::scout::versioning::api::CommitId,
557        >,
558    ) -> Result<
559        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
560        conjure_http::private::Error,
561    >;
562    /// Returns the pinned commit for each provided checklist reference.
563    #[endpoint(
564        method = POST,
565        path = "/scout/v1/checklists/batch-get",
566        name = "batchGet",
567        accept = conjure_http::client::conjure::CollectionResponseDeserializer
568    )]
569    async fn batch_get(
570        &self,
571        #[auth]
572        auth_: &conjure_object::BearerToken,
573        #[body(serializer = conjure_http::client::StdRequestSerializer)]
574        checklist_refs: &std::collections::BTreeSet<
575            super::super::super::super::super::objects::scout::checks::api::PinnedChecklistRef,
576        >,
577    ) -> Result<
578        std::collections::BTreeSet<
579            super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
580        >,
581        conjure_http::private::Error,
582    >;
583    /// Returns the metadata for each provided checklist.
584    #[endpoint(
585        method = POST,
586        path = "/scout/v1/checklists/batch-get-metadata",
587        name = "batchGetMetadata",
588        accept = conjure_http::client::StdResponseDeserializer
589    )]
590    async fn batch_get_metadata(
591        &self,
592        #[auth]
593        auth_: &conjure_object::BearerToken,
594        #[body(serializer = conjure_http::client::StdRequestSerializer)]
595        request: &super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataRequest,
596    ) -> Result<
597        super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataResponse,
598        conjure_http::private::Error,
599    >;
600    /// Results will be the latest commit on main for each checklist.
601    #[endpoint(
602        method = POST,
603        path = "/scout/v1/checklists/search",
604        name = "search",
605        accept = conjure_http::client::StdResponseDeserializer
606    )]
607    async fn search(
608        &self,
609        #[auth]
610        auth_: &conjure_object::BearerToken,
611        #[body(serializer = conjure_http::client::StdRequestSerializer)]
612        request: &super::super::super::super::super::objects::scout::checks::api::SearchChecklistsRequest,
613    ) -> Result<
614        super::super::super::super::super::objects::scout::checks::api::VersionedChecklistPage,
615        conjure_http::private::Error,
616    >;
617    /// Archives the provided checklists.
618    #[endpoint(
619        method = POST,
620        path = "/scout/v1/checklists/archive",
621        name = "archive",
622        accept = conjure_http::client::conjure::EmptyResponseDeserializer
623    )]
624    async fn archive(
625        &self,
626        #[auth]
627        auth_: &conjure_object::BearerToken,
628        #[body(serializer = conjure_http::client::StdRequestSerializer)]
629        request: &super::super::super::super::super::objects::scout::checks::api::ArchiveChecklistsRequest,
630    ) -> Result<(), conjure_http::private::Error>;
631    /// Unarchives the provided checklists.
632    #[endpoint(
633        method = POST,
634        path = "/scout/v1/checklists/unarchive",
635        name = "unarchive",
636        accept = conjure_http::client::conjure::EmptyResponseDeserializer
637    )]
638    async fn unarchive(
639        &self,
640        #[auth]
641        auth_: &conjure_object::BearerToken,
642        #[body(serializer = conjure_http::client::StdRequestSerializer)]
643        request: &super::super::super::super::super::objects::scout::checks::api::UnarchiveChecklistsRequest,
644    ) -> Result<(), conjure_http::private::Error>;
645    /// Returns the check with the given rid.
646    #[endpoint(
647        method = GET,
648        path = "/scout/v1/checklists/check/{rid}",
649        name = "getCheck",
650        accept = conjure_http::client::StdResponseDeserializer
651    )]
652    async fn get_check(
653        &self,
654        #[auth]
655        auth_: &conjure_object::BearerToken,
656        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
657        rid: &super::super::super::super::super::objects::scout::rids::api::CheckRid,
658    ) -> Result<
659        super::super::super::super::super::objects::scout::checks::api::Check,
660        conjure_http::private::Error,
661    >;
662    /// Returns the checks with the given rids.
663    #[endpoint(
664        method = POST,
665        path = "/scout/v1/checklists/check/batch-get",
666        name = "batchGetChecks",
667        accept = conjure_http::client::conjure::CollectionResponseDeserializer
668    )]
669    async fn batch_get_checks(
670        &self,
671        #[auth]
672        auth_: &conjure_object::BearerToken,
673        #[body(serializer = conjure_http::client::StdRequestSerializer)]
674        rids: &std::collections::BTreeSet<
675            super::super::super::super::super::objects::scout::rids::api::CheckRid,
676        >,
677    ) -> Result<
678        std::collections::BTreeSet<
679            super::super::super::super::super::objects::scout::checks::api::Check,
680        >,
681        conjure_http::private::Error,
682    >;
683    /// Returns all labels and properties.
684    #[endpoint(
685        method = GET,
686        path = "/scout/v1/checklists/get-all-labels-properties",
687        name = "getAllLabelsAndProperties",
688        accept = conjure_http::client::StdResponseDeserializer
689    )]
690    async fn get_all_labels_and_properties(
691        &self,
692        #[auth]
693        auth_: &conjure_object::BearerToken,
694        #[query(
695            name = "workspaces",
696            encoder = conjure_http::client::conjure::PlainSeqEncoder
697        )]
698        workspaces: &std::collections::BTreeSet<
699            super::super::super::super::super::objects::api::rids::WorkspaceRid,
700        >,
701    ) -> Result<
702        super::super::super::super::super::objects::scout::checks::api::GetAllLabelsAndPropertiesResponse,
703        conjure_http::private::Error,
704    >;
705    /// Batch edits metadata across multiple checklists. Supports rename/merge for labels and properties.
706    /// If more than 1000 checklists are targeted, this endpoint will throw a 400.
707    #[endpoint(
708        method = POST,
709        path = "/scout/v1/checklists/metadata/batch-edit",
710        name = "batchEditChecklistMetadata",
711        accept = conjure_http::client::StdResponseDeserializer
712    )]
713    async fn batch_edit_checklist_metadata(
714        &self,
715        #[auth]
716        auth_: &conjure_object::BearerToken,
717        #[body(serializer = conjure_http::client::StdRequestSerializer)]
718        request: &super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataRequest,
719    ) -> Result<
720        super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataResponse,
721        conjure_http::private::Error,
722    >;
723}
724/// The Checklist Service is responsible for managing checklists and checks.
725/// A checklist is a collection of checks that can be executed against a set of data sources.
726#[conjure_http::conjure_client(name = "ChecklistService", local)]
727pub trait LocalAsyncChecklistService<
728    #[response_body]
729    I: conjure_http::private::Stream<
730            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
731        >,
732> {
733    /// Creates a new checklist with the provided checks.
734    #[endpoint(
735        method = POST,
736        path = "/scout/v1/checklists",
737        name = "create",
738        accept = conjure_http::client::StdResponseDeserializer
739    )]
740    async fn create(
741        &self,
742        #[auth]
743        auth_: &conjure_object::BearerToken,
744        #[body(serializer = conjure_http::client::StdRequestSerializer)]
745        request: &super::super::super::super::super::objects::scout::checks::api::CreateChecklistRequest,
746    ) -> Result<
747        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
748        conjure_http::private::Error,
749    >;
750    /// Creates a permanent commit with a commit message.
751    /// Throws if the checklist or branch doesn't exist.
752    /// Throws if the latest commit doesn't match the provided id.
753    /// Throws if you commit to an archived checklist.
754    #[endpoint(
755        method = POST,
756        path = "/scout/v1/checklists/{checklistRid}/commit",
757        name = "commit",
758        accept = conjure_http::client::StdResponseDeserializer
759    )]
760    async fn commit(
761        &self,
762        #[auth]
763        auth_: &conjure_object::BearerToken,
764        #[path(
765            name = "checklistRid",
766            encoder = conjure_http::client::conjure::PlainEncoder
767        )]
768        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
769        #[query(
770            name = "branch",
771            encoder = conjure_http::client::conjure::PlainSeqEncoder
772        )]
773        branch: Option<
774            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
775        >,
776        #[body(serializer = conjure_http::client::StdRequestSerializer)]
777        request: &super::super::super::super::super::objects::scout::checks::api::CommitChecklistRequest,
778    ) -> Result<
779        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
780        conjure_http::private::Error,
781    >;
782    /// Creates a commit that may be compacted, e.g cleaned up and not exist anymore.
783    /// Throws if the checklist or branch doesn't exist.
784    /// Throws if the latest commit doesn't match the provided id.
785    /// Throws if you save to an archived checklist.
786    #[endpoint(
787        method = POST,
788        path = "/scout/v1/checklists/{checklistRid}/save-working-state",
789        name = "saveWorkingState",
790        accept = conjure_http::client::StdResponseDeserializer
791    )]
792    async fn save_working_state(
793        &self,
794        #[auth]
795        auth_: &conjure_object::BearerToken,
796        #[path(
797            name = "checklistRid",
798            encoder = conjure_http::client::conjure::PlainEncoder
799        )]
800        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
801        #[query(
802            name = "branch",
803            encoder = conjure_http::client::conjure::PlainSeqEncoder
804        )]
805        branch: Option<
806            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
807        >,
808        #[body(serializer = conjure_http::client::StdRequestSerializer)]
809        request: &super::super::super::super::super::objects::scout::checks::api::SaveChecklistRequest,
810    ) -> Result<
811        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
812        conjure_http::private::Error,
813    >;
814    /// Merges the given branch to the "main" branch.
815    /// Throws if the checklist or branch doesn't exist.
816    /// Throws if the latest commit doesn't match the provided id.
817    /// Throws if you merge with an archived checklist.
818    #[endpoint(
819        method = POST,
820        path = "/scout/v1/checklists/{checklistRid}/merge-to-main",
821        name = "mergeToMain",
822        accept = conjure_http::client::StdResponseDeserializer
823    )]
824    async fn merge_to_main(
825        &self,
826        #[auth]
827        auth_: &conjure_object::BearerToken,
828        #[path(
829            name = "checklistRid",
830            encoder = conjure_http::client::conjure::PlainEncoder
831        )]
832        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
833        #[body(serializer = conjure_http::client::StdRequestSerializer)]
834        request: &super::super::super::super::super::objects::scout::checks::api::MergeToMainRequest,
835    ) -> Result<
836        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
837        conjure_http::private::Error,
838    >;
839    /// Updates the data source ref names for all checks within a checklist.
840    /// Throws if the checklist doesn't exist.
841    #[endpoint(
842        method = POST,
843        path = "/scout/v1/checklists/{checklistRid}/update-ref-names",
844        name = "updateDataSourceRefNames",
845        accept = conjure_http::client::StdResponseDeserializer
846    )]
847    async fn update_data_source_ref_names(
848        &self,
849        #[auth]
850        auth_: &conjure_object::BearerToken,
851        #[path(
852            name = "checklistRid",
853            encoder = conjure_http::client::conjure::PlainEncoder
854        )]
855        checklist_rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
856        #[query(
857            name = "branch",
858            encoder = conjure_http::client::conjure::PlainSeqEncoder
859        )]
860        branch: Option<
861            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
862        >,
863        #[body(serializer = conjure_http::client::StdRequestSerializer)]
864        ref_name_updates: &std::collections::BTreeMap<
865            super::super::super::super::super::objects::scout::api::DataSourceRefName,
866            super::super::super::super::super::objects::scout::api::DataSourceRefName,
867        >,
868    ) -> Result<
869        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
870        conjure_http::private::Error,
871    >;
872    /// Updates the metadata of a checklist.
873    #[endpoint(
874        method = PUT,
875        path = "/scout/v1/checklists/{rid}/update-metadata",
876        name = "updateMetadata",
877        accept = conjure_http::client::StdResponseDeserializer
878    )]
879    async fn update_metadata(
880        &self,
881        #[auth]
882        auth_: &conjure_object::BearerToken,
883        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
884        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
885        #[body(serializer = conjure_http::client::StdRequestSerializer)]
886        request: &super::super::super::super::super::objects::scout::checks::api::UpdateChecklistMetadataRequest,
887    ) -> Result<
888        super::super::super::super::super::objects::scout::checks::api::ChecklistMetadata,
889        conjure_http::private::Error,
890    >;
891    /// Specify at most one of (branch, commit).
892    /// If neither is specified, branch = "main" is the default.
893    #[endpoint(
894        method = GET,
895        path = "/scout/v1/checklists/{rid}",
896        name = "get",
897        accept = conjure_http::client::StdResponseDeserializer
898    )]
899    async fn get(
900        &self,
901        #[auth]
902        auth_: &conjure_object::BearerToken,
903        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
904        rid: &super::super::super::super::super::objects::scout::rids::api::ChecklistRid,
905        #[query(
906            name = "branch",
907            encoder = conjure_http::client::conjure::PlainSeqEncoder
908        )]
909        branch: Option<
910            &super::super::super::super::super::objects::scout::versioning::api::BranchName,
911        >,
912        #[query(
913            name = "commit",
914            encoder = conjure_http::client::conjure::PlainSeqEncoder
915        )]
916        commit: Option<
917            &super::super::super::super::super::objects::scout::versioning::api::CommitId,
918        >,
919    ) -> Result<
920        super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
921        conjure_http::private::Error,
922    >;
923    /// Returns the pinned commit for each provided checklist reference.
924    #[endpoint(
925        method = POST,
926        path = "/scout/v1/checklists/batch-get",
927        name = "batchGet",
928        accept = conjure_http::client::conjure::CollectionResponseDeserializer
929    )]
930    async fn batch_get(
931        &self,
932        #[auth]
933        auth_: &conjure_object::BearerToken,
934        #[body(serializer = conjure_http::client::StdRequestSerializer)]
935        checklist_refs: &std::collections::BTreeSet<
936            super::super::super::super::super::objects::scout::checks::api::PinnedChecklistRef,
937        >,
938    ) -> Result<
939        std::collections::BTreeSet<
940            super::super::super::super::super::objects::scout::checks::api::VersionedChecklist,
941        >,
942        conjure_http::private::Error,
943    >;
944    /// Returns the metadata for each provided checklist.
945    #[endpoint(
946        method = POST,
947        path = "/scout/v1/checklists/batch-get-metadata",
948        name = "batchGetMetadata",
949        accept = conjure_http::client::StdResponseDeserializer
950    )]
951    async fn batch_get_metadata(
952        &self,
953        #[auth]
954        auth_: &conjure_object::BearerToken,
955        #[body(serializer = conjure_http::client::StdRequestSerializer)]
956        request: &super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataRequest,
957    ) -> Result<
958        super::super::super::super::super::objects::scout::checks::api::BatchGetChecklistMetadataResponse,
959        conjure_http::private::Error,
960    >;
961    /// Results will be the latest commit on main for each checklist.
962    #[endpoint(
963        method = POST,
964        path = "/scout/v1/checklists/search",
965        name = "search",
966        accept = conjure_http::client::StdResponseDeserializer
967    )]
968    async fn search(
969        &self,
970        #[auth]
971        auth_: &conjure_object::BearerToken,
972        #[body(serializer = conjure_http::client::StdRequestSerializer)]
973        request: &super::super::super::super::super::objects::scout::checks::api::SearchChecklistsRequest,
974    ) -> Result<
975        super::super::super::super::super::objects::scout::checks::api::VersionedChecklistPage,
976        conjure_http::private::Error,
977    >;
978    /// Archives the provided checklists.
979    #[endpoint(
980        method = POST,
981        path = "/scout/v1/checklists/archive",
982        name = "archive",
983        accept = conjure_http::client::conjure::EmptyResponseDeserializer
984    )]
985    async fn archive(
986        &self,
987        #[auth]
988        auth_: &conjure_object::BearerToken,
989        #[body(serializer = conjure_http::client::StdRequestSerializer)]
990        request: &super::super::super::super::super::objects::scout::checks::api::ArchiveChecklistsRequest,
991    ) -> Result<(), conjure_http::private::Error>;
992    /// Unarchives the provided checklists.
993    #[endpoint(
994        method = POST,
995        path = "/scout/v1/checklists/unarchive",
996        name = "unarchive",
997        accept = conjure_http::client::conjure::EmptyResponseDeserializer
998    )]
999    async fn unarchive(
1000        &self,
1001        #[auth]
1002        auth_: &conjure_object::BearerToken,
1003        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1004        request: &super::super::super::super::super::objects::scout::checks::api::UnarchiveChecklistsRequest,
1005    ) -> Result<(), conjure_http::private::Error>;
1006    /// Returns the check with the given rid.
1007    #[endpoint(
1008        method = GET,
1009        path = "/scout/v1/checklists/check/{rid}",
1010        name = "getCheck",
1011        accept = conjure_http::client::StdResponseDeserializer
1012    )]
1013    async fn get_check(
1014        &self,
1015        #[auth]
1016        auth_: &conjure_object::BearerToken,
1017        #[path(name = "rid", encoder = conjure_http::client::conjure::PlainEncoder)]
1018        rid: &super::super::super::super::super::objects::scout::rids::api::CheckRid,
1019    ) -> Result<
1020        super::super::super::super::super::objects::scout::checks::api::Check,
1021        conjure_http::private::Error,
1022    >;
1023    /// Returns the checks with the given rids.
1024    #[endpoint(
1025        method = POST,
1026        path = "/scout/v1/checklists/check/batch-get",
1027        name = "batchGetChecks",
1028        accept = conjure_http::client::conjure::CollectionResponseDeserializer
1029    )]
1030    async fn batch_get_checks(
1031        &self,
1032        #[auth]
1033        auth_: &conjure_object::BearerToken,
1034        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1035        rids: &std::collections::BTreeSet<
1036            super::super::super::super::super::objects::scout::rids::api::CheckRid,
1037        >,
1038    ) -> Result<
1039        std::collections::BTreeSet<
1040            super::super::super::super::super::objects::scout::checks::api::Check,
1041        >,
1042        conjure_http::private::Error,
1043    >;
1044    /// Returns all labels and properties.
1045    #[endpoint(
1046        method = GET,
1047        path = "/scout/v1/checklists/get-all-labels-properties",
1048        name = "getAllLabelsAndProperties",
1049        accept = conjure_http::client::StdResponseDeserializer
1050    )]
1051    async fn get_all_labels_and_properties(
1052        &self,
1053        #[auth]
1054        auth_: &conjure_object::BearerToken,
1055        #[query(
1056            name = "workspaces",
1057            encoder = conjure_http::client::conjure::PlainSeqEncoder
1058        )]
1059        workspaces: &std::collections::BTreeSet<
1060            super::super::super::super::super::objects::api::rids::WorkspaceRid,
1061        >,
1062    ) -> Result<
1063        super::super::super::super::super::objects::scout::checks::api::GetAllLabelsAndPropertiesResponse,
1064        conjure_http::private::Error,
1065    >;
1066    /// Batch edits metadata across multiple checklists. Supports rename/merge for labels and properties.
1067    /// If more than 1000 checklists are targeted, this endpoint will throw a 400.
1068    #[endpoint(
1069        method = POST,
1070        path = "/scout/v1/checklists/metadata/batch-edit",
1071        name = "batchEditChecklistMetadata",
1072        accept = conjure_http::client::StdResponseDeserializer
1073    )]
1074    async fn batch_edit_checklist_metadata(
1075        &self,
1076        #[auth]
1077        auth_: &conjure_object::BearerToken,
1078        #[body(serializer = conjure_http::client::StdRequestSerializer)]
1079        request: &super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataRequest,
1080    ) -> Result<
1081        super::super::super::super::super::objects::scout::checks::api::BatchEditChecklistMetadataResponse,
1082        conjure_http::private::Error,
1083    >;
1084}
nominal_api/conjure/clients/scout/checks/api/checklist_service.rs

nominal_api/conjure/clients/scout/checks/api/
checklist_service.rs
