nominal_api/conjure/clients/module/
module_service.rs

1use conjure_http::endpoint;
2/// Modules define collections of compute logic that can be shared and used across different contexts.
3/// The Modules Service provides the API for managing these collections of functions.
4#[conjure_http::conjure_client(name = "ModuleService")]
5pub trait ModuleService<
6    #[response_body]
7    I: Iterator<
8            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
9        >,
10> {
11    /// Create a new module.
12    #[endpoint(
13        method = POST,
14        path = "/scout/v2/module",
15        name = "createModule",
16        accept = conjure_http::client::StdResponseDeserializer
17    )]
18    fn create_module(
19        &self,
20        #[auth]
21        auth_: &conjure_object::BearerToken,
22        #[body(serializer = conjure_http::client::StdRequestSerializer)]
23        request: &super::super::super::objects::module::CreateModuleRequest,
24    ) -> Result<
25        super::super::super::objects::module::Module,
26        conjure_http::private::Error,
27    >;
28    /// Update an existing module.
29    #[endpoint(
30        method = PUT,
31        path = "/scout/v2/module/{moduleRid}",
32        name = "updateModule",
33        accept = conjure_http::client::StdResponseDeserializer
34    )]
35    fn update_module(
36        &self,
37        #[auth]
38        auth_: &conjure_object::BearerToken,
39        #[path(
40            name = "moduleRid",
41            encoder = conjure_http::client::conjure::PlainEncoder
42        )]
43        module_rid: &super::super::super::objects::modules::api::ModuleRid,
44        #[body(serializer = conjure_http::client::StdRequestSerializer)]
45        request: &super::super::super::objects::module::UpdateModuleRequest,
46    ) -> Result<
47        super::super::super::objects::module::Module,
48        conjure_http::private::Error,
49    >;
50    /// Get a list of modules by their RIDs and version specifiers if provided.
51    #[endpoint(
52        method = POST,
53        path = "/scout/v2/module/batch-get",
54        name = "batchGetModules",
55        accept = conjure_http::client::conjure::CollectionResponseDeserializer
56    )]
57    fn batch_get_modules(
58        &self,
59        #[auth]
60        auth_: &conjure_object::BearerToken,
61        #[body(serializer = conjure_http::client::StdRequestSerializer)]
62        request: &super::super::super::objects::module::BatchGetModulesRequest,
63    ) -> Result<
64        Vec<super::super::super::objects::module::Module>,
65        conjure_http::private::Error,
66    >;
67    /// Search for modules.
68    #[endpoint(
69        method = POST,
70        path = "/scout/v2/module/search",
71        name = "searchModules",
72        accept = conjure_http::client::StdResponseDeserializer
73    )]
74    fn search_modules(
75        &self,
76        #[auth]
77        auth_: &conjure_object::BearerToken,
78        #[body(serializer = conjure_http::client::StdRequestSerializer)]
79        request: &super::super::super::objects::module::SearchModulesRequest,
80    ) -> Result<
81        super::super::super::objects::module::SearchModulesResponse,
82        conjure_http::private::Error,
83    >;
84    /// Archive a set of modules.
85    #[endpoint(
86        method = POST,
87        path = "/scout/v2/module/archive",
88        name = "batchArchiveModules",
89        accept = conjure_http::client::StdResponseDeserializer
90    )]
91    fn batch_archive_modules(
92        &self,
93        #[auth]
94        auth_: &conjure_object::BearerToken,
95        #[body(serializer = conjure_http::client::StdRequestSerializer)]
96        request: &super::super::super::objects::module::BatchArchiveModulesRequest,
97    ) -> Result<
98        super::super::super::objects::module::BatchArchiveModulesResponse,
99        conjure_http::private::Error,
100    >;
101    /// Unarchive a set of modules.
102    #[endpoint(
103        method = POST,
104        path = "/scout/v2/module/unarchive",
105        name = "batchUnarchiveModules",
106        accept = conjure_http::client::StdResponseDeserializer
107    )]
108    fn batch_unarchive_modules(
109        &self,
110        #[auth]
111        auth_: &conjure_object::BearerToken,
112        #[body(serializer = conjure_http::client::StdRequestSerializer)]
113        request: &super::super::super::objects::module::BatchUnarchiveModulesRequest,
114    ) -> Result<
115        super::super::super::objects::module::BatchUnarchiveModulesResponse,
116        conjure_http::private::Error,
117    >;
118}
119/// Modules define collections of compute logic that can be shared and used across different contexts.
120/// The Modules Service provides the API for managing these collections of functions.
121#[conjure_http::conjure_client(name = "ModuleService")]
122pub trait AsyncModuleService<
123    #[response_body]
124    I: conjure_http::private::Stream<
125            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
126        >,
127> {
128    /// Create a new module.
129    #[endpoint(
130        method = POST,
131        path = "/scout/v2/module",
132        name = "createModule",
133        accept = conjure_http::client::StdResponseDeserializer
134    )]
135    async fn create_module(
136        &self,
137        #[auth]
138        auth_: &conjure_object::BearerToken,
139        #[body(serializer = conjure_http::client::StdRequestSerializer)]
140        request: &super::super::super::objects::module::CreateModuleRequest,
141    ) -> Result<
142        super::super::super::objects::module::Module,
143        conjure_http::private::Error,
144    >;
145    /// Update an existing module.
146    #[endpoint(
147        method = PUT,
148        path = "/scout/v2/module/{moduleRid}",
149        name = "updateModule",
150        accept = conjure_http::client::StdResponseDeserializer
151    )]
152    async fn update_module(
153        &self,
154        #[auth]
155        auth_: &conjure_object::BearerToken,
156        #[path(
157            name = "moduleRid",
158            encoder = conjure_http::client::conjure::PlainEncoder
159        )]
160        module_rid: &super::super::super::objects::modules::api::ModuleRid,
161        #[body(serializer = conjure_http::client::StdRequestSerializer)]
162        request: &super::super::super::objects::module::UpdateModuleRequest,
163    ) -> Result<
164        super::super::super::objects::module::Module,
165        conjure_http::private::Error,
166    >;
167    /// Get a list of modules by their RIDs and version specifiers if provided.
168    #[endpoint(
169        method = POST,
170        path = "/scout/v2/module/batch-get",
171        name = "batchGetModules",
172        accept = conjure_http::client::conjure::CollectionResponseDeserializer
173    )]
174    async fn batch_get_modules(
175        &self,
176        #[auth]
177        auth_: &conjure_object::BearerToken,
178        #[body(serializer = conjure_http::client::StdRequestSerializer)]
179        request: &super::super::super::objects::module::BatchGetModulesRequest,
180    ) -> Result<
181        Vec<super::super::super::objects::module::Module>,
182        conjure_http::private::Error,
183    >;
184    /// Search for modules.
185    #[endpoint(
186        method = POST,
187        path = "/scout/v2/module/search",
188        name = "searchModules",
189        accept = conjure_http::client::StdResponseDeserializer
190    )]
191    async fn search_modules(
192        &self,
193        #[auth]
194        auth_: &conjure_object::BearerToken,
195        #[body(serializer = conjure_http::client::StdRequestSerializer)]
196        request: &super::super::super::objects::module::SearchModulesRequest,
197    ) -> Result<
198        super::super::super::objects::module::SearchModulesResponse,
199        conjure_http::private::Error,
200    >;
201    /// Archive a set of modules.
202    #[endpoint(
203        method = POST,
204        path = "/scout/v2/module/archive",
205        name = "batchArchiveModules",
206        accept = conjure_http::client::StdResponseDeserializer
207    )]
208    async fn batch_archive_modules(
209        &self,
210        #[auth]
211        auth_: &conjure_object::BearerToken,
212        #[body(serializer = conjure_http::client::StdRequestSerializer)]
213        request: &super::super::super::objects::module::BatchArchiveModulesRequest,
214    ) -> Result<
215        super::super::super::objects::module::BatchArchiveModulesResponse,
216        conjure_http::private::Error,
217    >;
218    /// Unarchive a set of modules.
219    #[endpoint(
220        method = POST,
221        path = "/scout/v2/module/unarchive",
222        name = "batchUnarchiveModules",
223        accept = conjure_http::client::StdResponseDeserializer
224    )]
225    async fn batch_unarchive_modules(
226        &self,
227        #[auth]
228        auth_: &conjure_object::BearerToken,
229        #[body(serializer = conjure_http::client::StdRequestSerializer)]
230        request: &super::super::super::objects::module::BatchUnarchiveModulesRequest,
231    ) -> Result<
232        super::super::super::objects::module::BatchUnarchiveModulesResponse,
233        conjure_http::private::Error,
234    >;
235}
236/// Modules define collections of compute logic that can be shared and used across different contexts.
237/// The Modules Service provides the API for managing these collections of functions.
238#[conjure_http::conjure_client(name = "ModuleService", local)]
239pub trait LocalAsyncModuleService<
240    #[response_body]
241    I: conjure_http::private::Stream<
242            Item = Result<conjure_http::private::Bytes, conjure_http::private::Error>,
243        >,
244> {
245    /// Create a new module.
246    #[endpoint(
247        method = POST,
248        path = "/scout/v2/module",
249        name = "createModule",
250        accept = conjure_http::client::StdResponseDeserializer
251    )]
252    async fn create_module(
253        &self,
254        #[auth]
255        auth_: &conjure_object::BearerToken,
256        #[body(serializer = conjure_http::client::StdRequestSerializer)]
257        request: &super::super::super::objects::module::CreateModuleRequest,
258    ) -> Result<
259        super::super::super::objects::module::Module,
260        conjure_http::private::Error,
261    >;
262    /// Update an existing module.
263    #[endpoint(
264        method = PUT,
265        path = "/scout/v2/module/{moduleRid}",
266        name = "updateModule",
267        accept = conjure_http::client::StdResponseDeserializer
268    )]
269    async fn update_module(
270        &self,
271        #[auth]
272        auth_: &conjure_object::BearerToken,
273        #[path(
274            name = "moduleRid",
275            encoder = conjure_http::client::conjure::PlainEncoder
276        )]
277        module_rid: &super::super::super::objects::modules::api::ModuleRid,
278        #[body(serializer = conjure_http::client::StdRequestSerializer)]
279        request: &super::super::super::objects::module::UpdateModuleRequest,
280    ) -> Result<
281        super::super::super::objects::module::Module,
282        conjure_http::private::Error,
283    >;
284    /// Get a list of modules by their RIDs and version specifiers if provided.
285    #[endpoint(
286        method = POST,
287        path = "/scout/v2/module/batch-get",
288        name = "batchGetModules",
289        accept = conjure_http::client::conjure::CollectionResponseDeserializer
290    )]
291    async fn batch_get_modules(
292        &self,
293        #[auth]
294        auth_: &conjure_object::BearerToken,
295        #[body(serializer = conjure_http::client::StdRequestSerializer)]
296        request: &super::super::super::objects::module::BatchGetModulesRequest,
297    ) -> Result<
298        Vec<super::super::super::objects::module::Module>,
299        conjure_http::private::Error,
300    >;
301    /// Search for modules.
302    #[endpoint(
303        method = POST,
304        path = "/scout/v2/module/search",
305        name = "searchModules",
306        accept = conjure_http::client::StdResponseDeserializer
307    )]
308    async fn search_modules(
309        &self,
310        #[auth]
311        auth_: &conjure_object::BearerToken,
312        #[body(serializer = conjure_http::client::StdRequestSerializer)]
313        request: &super::super::super::objects::module::SearchModulesRequest,
314    ) -> Result<
315        super::super::super::objects::module::SearchModulesResponse,
316        conjure_http::private::Error,
317    >;
318    /// Archive a set of modules.
319    #[endpoint(
320        method = POST,
321        path = "/scout/v2/module/archive",
322        name = "batchArchiveModules",
323        accept = conjure_http::client::StdResponseDeserializer
324    )]
325    async fn batch_archive_modules(
326        &self,
327        #[auth]
328        auth_: &conjure_object::BearerToken,
329        #[body(serializer = conjure_http::client::StdRequestSerializer)]
330        request: &super::super::super::objects::module::BatchArchiveModulesRequest,
331    ) -> Result<
332        super::super::super::objects::module::BatchArchiveModulesResponse,
333        conjure_http::private::Error,
334    >;
335    /// Unarchive a set of modules.
336    #[endpoint(
337        method = POST,
338        path = "/scout/v2/module/unarchive",
339        name = "batchUnarchiveModules",
340        accept = conjure_http::client::StdResponseDeserializer
341    )]
342    async fn batch_unarchive_modules(
343        &self,
344        #[auth]
345        auth_: &conjure_object::BearerToken,
346        #[body(serializer = conjure_http::client::StdRequestSerializer)]
347        request: &super::super::super::objects::module::BatchUnarchiveModulesRequest,
348    ) -> Result<
349        super::super::super::objects::module::BatchUnarchiveModulesResponse,
350        conjure_http::private::Error,
351    >;
352}
nominal_api/conjure/clients/module/module_service.rs

nominal_api/conjure/clients/module/
module_service.rs
