nominal_api/conjure/clients/scout/savedviews/
saved_view_service.rs

1use conjure_http::endpoint;
2/// Saved Views allow users to store and reuse filter and table display configurations across
3/// assets, runs, checklists, and more. They can be favorited, archived, and shared across a workspace.
4#[conjure_http::conjure_client(name = "SavedViewService")]
5pub trait SavedViewService<
6    #[response_body]
7    I: Iterator<
8            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
9        >,
10> {
11    /// Creates a new saved view in the given workspace. If no workspace is specified,
12    /// it is created in the user's default workspace.
13    #[endpoint(
14        method = POST,
15        path = "/scout/saved-views/v1",
16        name = "createSavedView",
17        accept = conjure_http::client::StdResponseDeserializer
18    )]
19    fn create_saved_view(
20        &self,
21        #[auth]
22        auth_: &conjure_object::BearerToken,
23        #[body(serializer = conjure_http::client::StdRequestSerializer)]
24        request: &super::super::super::super::objects::scout::savedviews::api::CreateSavedViewRequest,
25    ) -> Result<
26        super::super::super::super::objects::scout::savedviews::api::CreateSavedViewResponse,
27        conjure_http::private::Error,
28    >;
29    /// Fetches a saved view by RID. Throws NOT_FOUND if it does not exist.
30    #[endpoint(
31        method = GET,
32        path = "/scout/saved-views/v1/{savedViewRid}",
33        name = "getSavedView",
34        accept = conjure_http::client::StdResponseDeserializer
35    )]
36    fn get_saved_view(
37        &self,
38        #[auth]
39        auth_: &conjure_object::BearerToken,
40        #[path(
41            name = "savedViewRid",
42            encoder = conjure_http::client::conjure::PlainEncoder
43        )]
44        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
45    ) -> Result<
46        super::super::super::super::objects::scout::savedviews::api::GetSavedViewResponse,
47        conjure_http::private::Error,
48    >;
49    /// Retrieves multiple saved views. Any invalid or unknown RIDs are omitted from the response.
50    #[endpoint(
51        method = POST,
52        path = "/scout/saved-views/v1/batch-get",
53        name = "batchGetSavedViews",
54        accept = conjure_http::client::StdResponseDeserializer
55    )]
56    fn batch_get_saved_views(
57        &self,
58        #[auth]
59        auth_: &conjure_object::BearerToken,
60        #[body(serializer = conjure_http::client::StdRequestSerializer)]
61        saved_view_rids: &std::collections::BTreeSet<
62            super::super::super::super::objects::scout::rids::api::SavedViewRid,
63        >,
64    ) -> Result<
65        super::super::super::super::objects::scout::savedviews::api::BatchGetSavedViewsResponse,
66        conjure_http::private::Error,
67    >;
68    /// Searches for saved views using a nested query expression. Supports pagination.
69    #[endpoint(
70        method = POST,
71        path = "/scout/saved-views/v1/search",
72        name = "searchSavedViews",
73        accept = conjure_http::client::StdResponseDeserializer
74    )]
75    fn search_saved_views(
76        &self,
77        #[auth]
78        auth_: &conjure_object::BearerToken,
79        #[body(serializer = conjure_http::client::StdRequestSerializer)]
80        request: &super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsRequest,
81    ) -> Result<
82        super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsResponse,
83        conjure_http::private::Error,
84    >;
85    /// Updates metadata, search filters, or display settings for an existing saved view.
86    /// Throws NOT_FOUND if the view doesn't exist and INVALID_ARGUMENT if it is archived.
87    #[endpoint(
88        method = PUT,
89        path = "/scout/saved-views/v1/{savedViewRid}",
90        name = "updateSavedView",
91        accept = conjure_http::client::StdResponseDeserializer
92    )]
93    fn update_saved_view(
94        &self,
95        #[auth]
96        auth_: &conjure_object::BearerToken,
97        #[path(
98            name = "savedViewRid",
99            encoder = conjure_http::client::conjure::PlainEncoder
100        )]
101        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
102        #[body(serializer = conjure_http::client::StdRequestSerializer)]
103        request: &super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewRequest,
104    ) -> Result<
105        super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewResponse,
106        conjure_http::private::Error,
107    >;
108    /// Archives the specified saved view. Archived views are hidden from search.
109    #[endpoint(
110        method = POST,
111        path = "/scout/saved-views/v1/{savedViewRid}/archive",
112        name = "archiveSavedView",
113        accept = conjure_http::client::conjure::EmptyResponseDeserializer
114    )]
115    fn archive_saved_view(
116        &self,
117        #[auth]
118        auth_: &conjure_object::BearerToken,
119        #[path(
120            name = "savedViewRid",
121            encoder = conjure_http::client::conjure::PlainEncoder
122        )]
123        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
124    ) -> Result<(), conjure_http::private::Error>;
125    /// Restores archived saved view, making them discoverable in search again.
126    #[endpoint(
127        method = POST,
128        path = "/scout/saved-views/v1/{savedViewRid}/unarchive",
129        name = "unarchiveSavedView",
130        accept = conjure_http::client::conjure::EmptyResponseDeserializer
131    )]
132    fn unarchive_saved_view(
133        &self,
134        #[auth]
135        auth_: &conjure_object::BearerToken,
136        #[path(
137            name = "savedViewRid",
138            encoder = conjure_http::client::conjure::PlainEncoder
139        )]
140        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
141    ) -> Result<(), conjure_http::private::Error>;
142}
143/// Saved Views allow users to store and reuse filter and table display configurations across
144/// assets, runs, checklists, and more. They can be favorited, archived, and shared across a workspace.
145#[conjure_http::conjure_client(name = "SavedViewService")]
146pub trait AsyncSavedViewService<
147    #[response_body]
148    I: conjure_http::private::Stream<
149            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
150        >,
151> {
152    /// Creates a new saved view in the given workspace. If no workspace is specified,
153    /// it is created in the user's default workspace.
154    #[endpoint(
155        method = POST,
156        path = "/scout/saved-views/v1",
157        name = "createSavedView",
158        accept = conjure_http::client::StdResponseDeserializer
159    )]
160    async fn create_saved_view(
161        &self,
162        #[auth]
163        auth_: &conjure_object::BearerToken,
164        #[body(serializer = conjure_http::client::StdRequestSerializer)]
165        request: &super::super::super::super::objects::scout::savedviews::api::CreateSavedViewRequest,
166    ) -> Result<
167        super::super::super::super::objects::scout::savedviews::api::CreateSavedViewResponse,
168        conjure_http::private::Error,
169    >;
170    /// Fetches a saved view by RID. Throws NOT_FOUND if it does not exist.
171    #[endpoint(
172        method = GET,
173        path = "/scout/saved-views/v1/{savedViewRid}",
174        name = "getSavedView",
175        accept = conjure_http::client::StdResponseDeserializer
176    )]
177    async fn get_saved_view(
178        &self,
179        #[auth]
180        auth_: &conjure_object::BearerToken,
181        #[path(
182            name = "savedViewRid",
183            encoder = conjure_http::client::conjure::PlainEncoder
184        )]
185        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
186    ) -> Result<
187        super::super::super::super::objects::scout::savedviews::api::GetSavedViewResponse,
188        conjure_http::private::Error,
189    >;
190    /// Retrieves multiple saved views. Any invalid or unknown RIDs are omitted from the response.
191    #[endpoint(
192        method = POST,
193        path = "/scout/saved-views/v1/batch-get",
194        name = "batchGetSavedViews",
195        accept = conjure_http::client::StdResponseDeserializer
196    )]
197    async fn batch_get_saved_views(
198        &self,
199        #[auth]
200        auth_: &conjure_object::BearerToken,
201        #[body(serializer = conjure_http::client::StdRequestSerializer)]
202        saved_view_rids: &std::collections::BTreeSet<
203            super::super::super::super::objects::scout::rids::api::SavedViewRid,
204        >,
205    ) -> Result<
206        super::super::super::super::objects::scout::savedviews::api::BatchGetSavedViewsResponse,
207        conjure_http::private::Error,
208    >;
209    /// Searches for saved views using a nested query expression. Supports pagination.
210    #[endpoint(
211        method = POST,
212        path = "/scout/saved-views/v1/search",
213        name = "searchSavedViews",
214        accept = conjure_http::client::StdResponseDeserializer
215    )]
216    async fn search_saved_views(
217        &self,
218        #[auth]
219        auth_: &conjure_object::BearerToken,
220        #[body(serializer = conjure_http::client::StdRequestSerializer)]
221        request: &super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsRequest,
222    ) -> Result<
223        super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsResponse,
224        conjure_http::private::Error,
225    >;
226    /// Updates metadata, search filters, or display settings for an existing saved view.
227    /// Throws NOT_FOUND if the view doesn't exist and INVALID_ARGUMENT if it is archived.
228    #[endpoint(
229        method = PUT,
230        path = "/scout/saved-views/v1/{savedViewRid}",
231        name = "updateSavedView",
232        accept = conjure_http::client::StdResponseDeserializer
233    )]
234    async fn update_saved_view(
235        &self,
236        #[auth]
237        auth_: &conjure_object::BearerToken,
238        #[path(
239            name = "savedViewRid",
240            encoder = conjure_http::client::conjure::PlainEncoder
241        )]
242        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
243        #[body(serializer = conjure_http::client::StdRequestSerializer)]
244        request: &super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewRequest,
245    ) -> Result<
246        super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewResponse,
247        conjure_http::private::Error,
248    >;
249    /// Archives the specified saved view. Archived views are hidden from search.
250    #[endpoint(
251        method = POST,
252        path = "/scout/saved-views/v1/{savedViewRid}/archive",
253        name = "archiveSavedView",
254        accept = conjure_http::client::conjure::EmptyResponseDeserializer
255    )]
256    async fn archive_saved_view(
257        &self,
258        #[auth]
259        auth_: &conjure_object::BearerToken,
260        #[path(
261            name = "savedViewRid",
262            encoder = conjure_http::client::conjure::PlainEncoder
263        )]
264        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
265    ) -> Result<(), conjure_http::private::Error>;
266    /// Restores archived saved view, making them discoverable in search again.
267    #[endpoint(
268        method = POST,
269        path = "/scout/saved-views/v1/{savedViewRid}/unarchive",
270        name = "unarchiveSavedView",
271        accept = conjure_http::client::conjure::EmptyResponseDeserializer
272    )]
273    async fn unarchive_saved_view(
274        &self,
275        #[auth]
276        auth_: &conjure_object::BearerToken,
277        #[path(
278            name = "savedViewRid",
279            encoder = conjure_http::client::conjure::PlainEncoder
280        )]
281        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
282    ) -> Result<(), conjure_http::private::Error>;
283}
284/// Saved Views allow users to store and reuse filter and table display configurations across
285/// assets, runs, checklists, and more. They can be favorited, archived, and shared across a workspace.
286#[conjure_http::conjure_client(name = "SavedViewService", local)]
287pub trait LocalAsyncSavedViewService<
288    #[response_body]
289    I: conjure_http::private::Stream<
290            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
291        >,
292> {
293    /// Creates a new saved view in the given workspace. If no workspace is specified,
294    /// it is created in the user's default workspace.
295    #[endpoint(
296        method = POST,
297        path = "/scout/saved-views/v1",
298        name = "createSavedView",
299        accept = conjure_http::client::StdResponseDeserializer
300    )]
301    async fn create_saved_view(
302        &self,
303        #[auth]
304        auth_: &conjure_object::BearerToken,
305        #[body(serializer = conjure_http::client::StdRequestSerializer)]
306        request: &super::super::super::super::objects::scout::savedviews::api::CreateSavedViewRequest,
307    ) -> Result<
308        super::super::super::super::objects::scout::savedviews::api::CreateSavedViewResponse,
309        conjure_http::private::Error,
310    >;
311    /// Fetches a saved view by RID. Throws NOT_FOUND if it does not exist.
312    #[endpoint(
313        method = GET,
314        path = "/scout/saved-views/v1/{savedViewRid}",
315        name = "getSavedView",
316        accept = conjure_http::client::StdResponseDeserializer
317    )]
318    async fn get_saved_view(
319        &self,
320        #[auth]
321        auth_: &conjure_object::BearerToken,
322        #[path(
323            name = "savedViewRid",
324            encoder = conjure_http::client::conjure::PlainEncoder
325        )]
326        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
327    ) -> Result<
328        super::super::super::super::objects::scout::savedviews::api::GetSavedViewResponse,
329        conjure_http::private::Error,
330    >;
331    /// Retrieves multiple saved views. Any invalid or unknown RIDs are omitted from the response.
332    #[endpoint(
333        method = POST,
334        path = "/scout/saved-views/v1/batch-get",
335        name = "batchGetSavedViews",
336        accept = conjure_http::client::StdResponseDeserializer
337    )]
338    async fn batch_get_saved_views(
339        &self,
340        #[auth]
341        auth_: &conjure_object::BearerToken,
342        #[body(serializer = conjure_http::client::StdRequestSerializer)]
343        saved_view_rids: &std::collections::BTreeSet<
344            super::super::super::super::objects::scout::rids::api::SavedViewRid,
345        >,
346    ) -> Result<
347        super::super::super::super::objects::scout::savedviews::api::BatchGetSavedViewsResponse,
348        conjure_http::private::Error,
349    >;
350    /// Searches for saved views using a nested query expression. Supports pagination.
351    #[endpoint(
352        method = POST,
353        path = "/scout/saved-views/v1/search",
354        name = "searchSavedViews",
355        accept = conjure_http::client::StdResponseDeserializer
356    )]
357    async fn search_saved_views(
358        &self,
359        #[auth]
360        auth_: &conjure_object::BearerToken,
361        #[body(serializer = conjure_http::client::StdRequestSerializer)]
362        request: &super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsRequest,
363    ) -> Result<
364        super::super::super::super::objects::scout::savedviews::api::SearchSavedViewsResponse,
365        conjure_http::private::Error,
366    >;
367    /// Updates metadata, search filters, or display settings for an existing saved view.
368    /// Throws NOT_FOUND if the view doesn't exist and INVALID_ARGUMENT if it is archived.
369    #[endpoint(
370        method = PUT,
371        path = "/scout/saved-views/v1/{savedViewRid}",
372        name = "updateSavedView",
373        accept = conjure_http::client::StdResponseDeserializer
374    )]
375    async fn update_saved_view(
376        &self,
377        #[auth]
378        auth_: &conjure_object::BearerToken,
379        #[path(
380            name = "savedViewRid",
381            encoder = conjure_http::client::conjure::PlainEncoder
382        )]
383        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
384        #[body(serializer = conjure_http::client::StdRequestSerializer)]
385        request: &super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewRequest,
386    ) -> Result<
387        super::super::super::super::objects::scout::savedviews::api::UpdateSavedViewResponse,
388        conjure_http::private::Error,
389    >;
390    /// Archives the specified saved view. Archived views are hidden from search.
391    #[endpoint(
392        method = POST,
393        path = "/scout/saved-views/v1/{savedViewRid}/archive",
394        name = "archiveSavedView",
395        accept = conjure_http::client::conjure::EmptyResponseDeserializer
396    )]
397    async fn archive_saved_view(
398        &self,
399        #[auth]
400        auth_: &conjure_object::BearerToken,
401        #[path(
402            name = "savedViewRid",
403            encoder = conjure_http::client::conjure::PlainEncoder
404        )]
405        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
406    ) -> Result<(), conjure_http::private::Error>;
407    /// Restores archived saved view, making them discoverable in search again.
408    #[endpoint(
409        method = POST,
410        path = "/scout/saved-views/v1/{savedViewRid}/unarchive",
411        name = "unarchiveSavedView",
412        accept = conjure_http::client::conjure::EmptyResponseDeserializer
413    )]
414    async fn unarchive_saved_view(
415        &self,
416        #[auth]
417        auth_: &conjure_object::BearerToken,
418        #[path(
419            name = "savedViewRid",
420            encoder = conjure_http::client::conjure::PlainEncoder
421        )]
422        saved_view_rid: &super::super::super::super::objects::scout::rids::api::SavedViewRid,
423    ) -> Result<(), conjure_http::private::Error>;
424}
nominal_api/conjure/clients/scout/savedviews/saved_view_service.rs

nominal_api/conjure/clients/scout/savedviews/
saved_view_service.rs
