Skip to main content

nominal_api/conjure/clients/scout/spatial/
spatial_service.rs

1use conjure_http::endpoint;
2/// The spatial asset service manages spatial assets (point clouds, etc.) and their metadata.
3/// Spatial asset data is stored in Dagger; Scout tracks metadata and references.
4#[conjure_http::conjure_client(name = "SpatialService")]
5pub trait SpatialService<
6    #[response_body]
7    I: Iterator<
8            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
9        >,
10> {
11    /// Returns spatial asset metadata associated with a spatial asset rid.
12    #[endpoint(
13        method = GET,
14        path = "/spatial/v1/spatials/{spatialRid}",
15        name = "get",
16        accept = conjure_http::client::StdResponseDeserializer
17    )]
18    fn get(
19        &self,
20        #[auth]
21        auth_: &conjure_object::BearerToken,
22        #[path(
23            name = "spatialRid",
24            encoder = conjure_http::client::conjure::PlainEncoder
25        )]
26        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
27    ) -> Result<
28        super::super::super::super::objects::scout::spatial::api::Spatial,
29        conjure_http::private::Error,
30    >;
31    /// Returns spatial asset metadata for each given spatial asset rid.
32    #[endpoint(
33        method = POST,
34        path = "/spatial/v1/spatials/batchGet",
35        name = "batchGet",
36        accept = conjure_http::client::StdResponseDeserializer
37    )]
38    fn batch_get(
39        &self,
40        #[auth]
41        auth_: &conjure_object::BearerToken,
42        #[body(serializer = conjure_http::client::StdRequestSerializer)]
43        request: &super::super::super::super::objects::scout::spatial::api::GetSpatialsRequest,
44    ) -> Result<
45        super::super::super::super::objects::scout::spatial::api::GetSpatialsResponse,
46        conjure_http::private::Error,
47    >;
48    /// Returns metadata about spatial assets that match a given query.
49    #[endpoint(
50        method = POST,
51        path = "/spatial/v1/spatials/search",
52        name = "search",
53        accept = conjure_http::client::StdResponseDeserializer
54    )]
55    fn search(
56        &self,
57        #[auth]
58        auth_: &conjure_object::BearerToken,
59        #[body(serializer = conjure_http::client::StdRequestSerializer)]
60        request: &super::super::super::super::objects::scout::spatial::api::SearchSpatialsRequest,
61    ) -> Result<
62        super::super::super::super::objects::scout::spatial::api::SearchSpatialsResponse,
63        conjure_http::private::Error,
64    >;
65    /// Creates and persists a spatial asset entity with the given metadata.
66    #[endpoint(
67        method = POST,
68        path = "/spatial/v1/spatials",
69        name = "create",
70        accept = conjure_http::client::StdResponseDeserializer
71    )]
72    fn create(
73        &self,
74        #[auth]
75        auth_: &conjure_object::BearerToken,
76        #[body(serializer = conjure_http::client::StdRequestSerializer)]
77        request: &super::super::super::super::objects::scout::spatial::api::CreateSpatialRequest,
78    ) -> Result<
79        super::super::super::super::objects::scout::spatial::api::Spatial,
80        conjure_http::private::Error,
81    >;
82    /// Updates the metadata for a spatial asset associated with the given rid.
83    #[endpoint(
84        method = PUT,
85        path = "/spatial/v1/spatials/{spatialRid}",
86        name = "updateMetadata",
87        accept = conjure_http::client::StdResponseDeserializer
88    )]
89    fn update_metadata(
90        &self,
91        #[auth]
92        auth_: &conjure_object::BearerToken,
93        #[path(
94            name = "spatialRid",
95            encoder = conjure_http::client::conjure::PlainEncoder
96        )]
97        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
98        #[body(serializer = conjure_http::client::StdRequestSerializer)]
99        request: &super::super::super::super::objects::scout::spatial::api::UpdateSpatialMetadataRequest,
100    ) -> Result<
101        super::super::super::super::objects::scout::spatial::api::Spatial,
102        conjure_http::private::Error,
103    >;
104    /// Archives a spatial asset, excluding it from search. Can be unarchived.
105    #[endpoint(
106        method = PUT,
107        path = "/spatial/v1/spatials/{spatialRid}/archive",
108        name = "archive",
109        accept = conjure_http::client::conjure::EmptyResponseDeserializer
110    )]
111    fn archive(
112        &self,
113        #[auth]
114        auth_: &conjure_object::BearerToken,
115        #[path(
116            name = "spatialRid",
117            encoder = conjure_http::client::conjure::PlainEncoder
118        )]
119        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
120    ) -> Result<(), conjure_http::private::Error>;
121    /// Unarchives a previously archived spatial asset.
122    #[endpoint(
123        method = PUT,
124        path = "/spatial/v1/spatials/{spatialRid}/unarchive",
125        name = "unarchive",
126        accept = conjure_http::client::conjure::EmptyResponseDeserializer
127    )]
128    fn unarchive(
129        &self,
130        #[auth]
131        auth_: &conjure_object::BearerToken,
132        #[path(
133            name = "spatialRid",
134            encoder = conjure_http::client::conjure::PlainEncoder
135        )]
136        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
137    ) -> Result<(), conjure_http::private::Error>;
138}
139/// The spatial asset service manages spatial assets (point clouds, etc.) and their metadata.
140/// Spatial asset data is stored in Dagger; Scout tracks metadata and references.
141#[conjure_http::conjure_client(name = "SpatialService")]
142pub trait AsyncSpatialService<
143    #[response_body]
144    I: conjure_http::private::Stream<
145            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
146        >,
147> {
148    /// Returns spatial asset metadata associated with a spatial asset rid.
149    #[endpoint(
150        method = GET,
151        path = "/spatial/v1/spatials/{spatialRid}",
152        name = "get",
153        accept = conjure_http::client::StdResponseDeserializer
154    )]
155    async fn get(
156        &self,
157        #[auth]
158        auth_: &conjure_object::BearerToken,
159        #[path(
160            name = "spatialRid",
161            encoder = conjure_http::client::conjure::PlainEncoder
162        )]
163        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
164    ) -> Result<
165        super::super::super::super::objects::scout::spatial::api::Spatial,
166        conjure_http::private::Error,
167    >;
168    /// Returns spatial asset metadata for each given spatial asset rid.
169    #[endpoint(
170        method = POST,
171        path = "/spatial/v1/spatials/batchGet",
172        name = "batchGet",
173        accept = conjure_http::client::StdResponseDeserializer
174    )]
175    async fn batch_get(
176        &self,
177        #[auth]
178        auth_: &conjure_object::BearerToken,
179        #[body(serializer = conjure_http::client::StdRequestSerializer)]
180        request: &super::super::super::super::objects::scout::spatial::api::GetSpatialsRequest,
181    ) -> Result<
182        super::super::super::super::objects::scout::spatial::api::GetSpatialsResponse,
183        conjure_http::private::Error,
184    >;
185    /// Returns metadata about spatial assets that match a given query.
186    #[endpoint(
187        method = POST,
188        path = "/spatial/v1/spatials/search",
189        name = "search",
190        accept = conjure_http::client::StdResponseDeserializer
191    )]
192    async fn search(
193        &self,
194        #[auth]
195        auth_: &conjure_object::BearerToken,
196        #[body(serializer = conjure_http::client::StdRequestSerializer)]
197        request: &super::super::super::super::objects::scout::spatial::api::SearchSpatialsRequest,
198    ) -> Result<
199        super::super::super::super::objects::scout::spatial::api::SearchSpatialsResponse,
200        conjure_http::private::Error,
201    >;
202    /// Creates and persists a spatial asset entity with the given metadata.
203    #[endpoint(
204        method = POST,
205        path = "/spatial/v1/spatials",
206        name = "create",
207        accept = conjure_http::client::StdResponseDeserializer
208    )]
209    async fn create(
210        &self,
211        #[auth]
212        auth_: &conjure_object::BearerToken,
213        #[body(serializer = conjure_http::client::StdRequestSerializer)]
214        request: &super::super::super::super::objects::scout::spatial::api::CreateSpatialRequest,
215    ) -> Result<
216        super::super::super::super::objects::scout::spatial::api::Spatial,
217        conjure_http::private::Error,
218    >;
219    /// Updates the metadata for a spatial asset associated with the given rid.
220    #[endpoint(
221        method = PUT,
222        path = "/spatial/v1/spatials/{spatialRid}",
223        name = "updateMetadata",
224        accept = conjure_http::client::StdResponseDeserializer
225    )]
226    async fn update_metadata(
227        &self,
228        #[auth]
229        auth_: &conjure_object::BearerToken,
230        #[path(
231            name = "spatialRid",
232            encoder = conjure_http::client::conjure::PlainEncoder
233        )]
234        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
235        #[body(serializer = conjure_http::client::StdRequestSerializer)]
236        request: &super::super::super::super::objects::scout::spatial::api::UpdateSpatialMetadataRequest,
237    ) -> Result<
238        super::super::super::super::objects::scout::spatial::api::Spatial,
239        conjure_http::private::Error,
240    >;
241    /// Archives a spatial asset, excluding it from search. Can be unarchived.
242    #[endpoint(
243        method = PUT,
244        path = "/spatial/v1/spatials/{spatialRid}/archive",
245        name = "archive",
246        accept = conjure_http::client::conjure::EmptyResponseDeserializer
247    )]
248    async fn archive(
249        &self,
250        #[auth]
251        auth_: &conjure_object::BearerToken,
252        #[path(
253            name = "spatialRid",
254            encoder = conjure_http::client::conjure::PlainEncoder
255        )]
256        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
257    ) -> Result<(), conjure_http::private::Error>;
258    /// Unarchives a previously archived spatial asset.
259    #[endpoint(
260        method = PUT,
261        path = "/spatial/v1/spatials/{spatialRid}/unarchive",
262        name = "unarchive",
263        accept = conjure_http::client::conjure::EmptyResponseDeserializer
264    )]
265    async fn unarchive(
266        &self,
267        #[auth]
268        auth_: &conjure_object::BearerToken,
269        #[path(
270            name = "spatialRid",
271            encoder = conjure_http::client::conjure::PlainEncoder
272        )]
273        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
274    ) -> Result<(), conjure_http::private::Error>;
275}
276/// The spatial asset service manages spatial assets (point clouds, etc.) and their metadata.
277/// Spatial asset data is stored in Dagger; Scout tracks metadata and references.
278#[conjure_http::conjure_client(name = "SpatialService", local)]
279pub trait LocalAsyncSpatialService<
280    #[response_body]
281    I: conjure_http::private::Stream<
282            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
283        >,
284> {
285    /// Returns spatial asset metadata associated with a spatial asset rid.
286    #[endpoint(
287        method = GET,
288        path = "/spatial/v1/spatials/{spatialRid}",
289        name = "get",
290        accept = conjure_http::client::StdResponseDeserializer
291    )]
292    async fn get(
293        &self,
294        #[auth]
295        auth_: &conjure_object::BearerToken,
296        #[path(
297            name = "spatialRid",
298            encoder = conjure_http::client::conjure::PlainEncoder
299        )]
300        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
301    ) -> Result<
302        super::super::super::super::objects::scout::spatial::api::Spatial,
303        conjure_http::private::Error,
304    >;
305    /// Returns spatial asset metadata for each given spatial asset rid.
306    #[endpoint(
307        method = POST,
308        path = "/spatial/v1/spatials/batchGet",
309        name = "batchGet",
310        accept = conjure_http::client::StdResponseDeserializer
311    )]
312    async fn batch_get(
313        &self,
314        #[auth]
315        auth_: &conjure_object::BearerToken,
316        #[body(serializer = conjure_http::client::StdRequestSerializer)]
317        request: &super::super::super::super::objects::scout::spatial::api::GetSpatialsRequest,
318    ) -> Result<
319        super::super::super::super::objects::scout::spatial::api::GetSpatialsResponse,
320        conjure_http::private::Error,
321    >;
322    /// Returns metadata about spatial assets that match a given query.
323    #[endpoint(
324        method = POST,
325        path = "/spatial/v1/spatials/search",
326        name = "search",
327        accept = conjure_http::client::StdResponseDeserializer
328    )]
329    async fn search(
330        &self,
331        #[auth]
332        auth_: &conjure_object::BearerToken,
333        #[body(serializer = conjure_http::client::StdRequestSerializer)]
334        request: &super::super::super::super::objects::scout::spatial::api::SearchSpatialsRequest,
335    ) -> Result<
336        super::super::super::super::objects::scout::spatial::api::SearchSpatialsResponse,
337        conjure_http::private::Error,
338    >;
339    /// Creates and persists a spatial asset entity with the given metadata.
340    #[endpoint(
341        method = POST,
342        path = "/spatial/v1/spatials",
343        name = "create",
344        accept = conjure_http::client::StdResponseDeserializer
345    )]
346    async fn create(
347        &self,
348        #[auth]
349        auth_: &conjure_object::BearerToken,
350        #[body(serializer = conjure_http::client::StdRequestSerializer)]
351        request: &super::super::super::super::objects::scout::spatial::api::CreateSpatialRequest,
352    ) -> Result<
353        super::super::super::super::objects::scout::spatial::api::Spatial,
354        conjure_http::private::Error,
355    >;
356    /// Updates the metadata for a spatial asset associated with the given rid.
357    #[endpoint(
358        method = PUT,
359        path = "/spatial/v1/spatials/{spatialRid}",
360        name = "updateMetadata",
361        accept = conjure_http::client::StdResponseDeserializer
362    )]
363    async fn update_metadata(
364        &self,
365        #[auth]
366        auth_: &conjure_object::BearerToken,
367        #[path(
368            name = "spatialRid",
369            encoder = conjure_http::client::conjure::PlainEncoder
370        )]
371        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
372        #[body(serializer = conjure_http::client::StdRequestSerializer)]
373        request: &super::super::super::super::objects::scout::spatial::api::UpdateSpatialMetadataRequest,
374    ) -> Result<
375        super::super::super::super::objects::scout::spatial::api::Spatial,
376        conjure_http::private::Error,
377    >;
378    /// Archives a spatial asset, excluding it from search. Can be unarchived.
379    #[endpoint(
380        method = PUT,
381        path = "/spatial/v1/spatials/{spatialRid}/archive",
382        name = "archive",
383        accept = conjure_http::client::conjure::EmptyResponseDeserializer
384    )]
385    async fn archive(
386        &self,
387        #[auth]
388        auth_: &conjure_object::BearerToken,
389        #[path(
390            name = "spatialRid",
391            encoder = conjure_http::client::conjure::PlainEncoder
392        )]
393        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
394    ) -> Result<(), conjure_http::private::Error>;
395    /// Unarchives a previously archived spatial asset.
396    #[endpoint(
397        method = PUT,
398        path = "/spatial/v1/spatials/{spatialRid}/unarchive",
399        name = "unarchive",
400        accept = conjure_http::client::conjure::EmptyResponseDeserializer
401    )]
402    async fn unarchive(
403        &self,
404        #[auth]
405        auth_: &conjure_object::BearerToken,
406        #[path(
407            name = "spatialRid",
408            encoder = conjure_http::client::conjure::PlainEncoder
409        )]
410        spatial_rid: &super::super::super::super::objects::api::rids::SpatialRid,
411    ) -> Result<(), conjure_http::private::Error>;
412}