aind-metadata-service-async-client 2.1.1__py3-none-any.whl → 2.3.5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of aind-metadata-service-async-client might be problematic. Click here for more details.

@@ -5,7 +5,7 @@
5
5
 
6
6
  ## aind-metadata-service Service to pull data from example backend.
7
7
 
8
- The version of the OpenAPI document: 2.1.1
8
+ The version of the OpenAPI document: 2.3.5
9
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
10
10
 
11
11
  Do not edit the class manually.
@@ -19,7 +19,7 @@ from typing_extensions import Annotated
19
19
  from pydantic import Field, StrictBool, StrictStr
20
20
  from typing import Any, Dict, Optional
21
21
  from typing_extensions import Annotated
22
- from aind_metadata_service_async_client.models.slims_workflow import SlimsWorkflow
22
+ from aind_metadata_service_async_client.models.aind_metadata_service_server_routes_slims_slims_workflow import AindMetadataServiceServerRoutesSlimsSlimsWorkflow
23
23
 
24
24
  from aind_metadata_service_async_client.api_client import ApiClient, RequestSerialized
25
25
  from aind_metadata_service_async_client.api_response import ApiResponse
@@ -39,10 +39,2660 @@ class DefaultApi:
39
39
  self.api_client = api_client
40
40
 
41
41
 
42
+ @validate_call
43
+ async def get_funding(
44
+ self,
45
+ project_name: StrictStr,
46
+ _request_timeout: Union[
47
+ None,
48
+ Annotated[StrictFloat, Field(gt=0)],
49
+ Tuple[
50
+ Annotated[StrictFloat, Field(gt=0)],
51
+ Annotated[StrictFloat, Field(gt=0)]
52
+ ]
53
+ ] = None,
54
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
55
+ _content_type: Optional[StrictStr] = None,
56
+ _headers: Optional[Dict[StrictStr, Any]] = None,
57
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
58
+ ) -> object:
59
+ """Get Funding
60
+
61
+ ## Funding Return Funding metadata.
62
+
63
+ :param project_name: (required)
64
+ :type project_name: str
65
+ :param _request_timeout: timeout setting for this request. If one
66
+ number provided, it will be total request
67
+ timeout. It can also be a pair (tuple) of
68
+ (connection, read) timeouts.
69
+ :type _request_timeout: int, tuple(int, int), optional
70
+ :param _request_auth: set to override the auth_settings for an a single
71
+ request; this effectively ignores the
72
+ authentication in the spec for a single request.
73
+ :type _request_auth: dict, optional
74
+ :param _content_type: force content-type for the request.
75
+ :type _content_type: str, Optional
76
+ :param _headers: set to override the headers for a single
77
+ request; this effectively ignores the headers
78
+ in the spec for a single request.
79
+ :type _headers: dict, optional
80
+ :param _host_index: set to override the host_index for a single
81
+ request; this effectively ignores the host_index
82
+ in the spec for a single request.
83
+ :type _host_index: int, optional
84
+ :return: Returns the result object.
85
+ """ # noqa: E501
86
+
87
+ _param = self._get_funding_serialize(
88
+ project_name=project_name,
89
+ _request_auth=_request_auth,
90
+ _content_type=_content_type,
91
+ _headers=_headers,
92
+ _host_index=_host_index
93
+ )
94
+
95
+ _response_types_map: Dict[str, Optional[str]] = {
96
+ '200': "object",
97
+ '422': "HTTPValidationError",
98
+ }
99
+ response_data = await self.api_client.call_api(
100
+ *_param,
101
+ _request_timeout=_request_timeout
102
+ )
103
+ await response_data.read()
104
+ return self.api_client.response_deserialize(
105
+ response_data=response_data,
106
+ response_types_map=_response_types_map,
107
+ ).data
108
+
109
+
110
+ @validate_call
111
+ async def get_funding_with_http_info(
112
+ self,
113
+ project_name: StrictStr,
114
+ _request_timeout: Union[
115
+ None,
116
+ Annotated[StrictFloat, Field(gt=0)],
117
+ Tuple[
118
+ Annotated[StrictFloat, Field(gt=0)],
119
+ Annotated[StrictFloat, Field(gt=0)]
120
+ ]
121
+ ] = None,
122
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
123
+ _content_type: Optional[StrictStr] = None,
124
+ _headers: Optional[Dict[StrictStr, Any]] = None,
125
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
126
+ ) -> ApiResponse[object]:
127
+ """Get Funding
128
+
129
+ ## Funding Return Funding metadata.
130
+
131
+ :param project_name: (required)
132
+ :type project_name: str
133
+ :param _request_timeout: timeout setting for this request. If one
134
+ number provided, it will be total request
135
+ timeout. It can also be a pair (tuple) of
136
+ (connection, read) timeouts.
137
+ :type _request_timeout: int, tuple(int, int), optional
138
+ :param _request_auth: set to override the auth_settings for an a single
139
+ request; this effectively ignores the
140
+ authentication in the spec for a single request.
141
+ :type _request_auth: dict, optional
142
+ :param _content_type: force content-type for the request.
143
+ :type _content_type: str, Optional
144
+ :param _headers: set to override the headers for a single
145
+ request; this effectively ignores the headers
146
+ in the spec for a single request.
147
+ :type _headers: dict, optional
148
+ :param _host_index: set to override the host_index for a single
149
+ request; this effectively ignores the host_index
150
+ in the spec for a single request.
151
+ :type _host_index: int, optional
152
+ :return: Returns the result object.
153
+ """ # noqa: E501
154
+
155
+ _param = self._get_funding_serialize(
156
+ project_name=project_name,
157
+ _request_auth=_request_auth,
158
+ _content_type=_content_type,
159
+ _headers=_headers,
160
+ _host_index=_host_index
161
+ )
162
+
163
+ _response_types_map: Dict[str, Optional[str]] = {
164
+ '200': "object",
165
+ '422': "HTTPValidationError",
166
+ }
167
+ response_data = await self.api_client.call_api(
168
+ *_param,
169
+ _request_timeout=_request_timeout
170
+ )
171
+ await response_data.read()
172
+ return self.api_client.response_deserialize(
173
+ response_data=response_data,
174
+ response_types_map=_response_types_map,
175
+ )
176
+
177
+
178
+ @validate_call
179
+ async def get_funding_without_preload_content(
180
+ self,
181
+ project_name: StrictStr,
182
+ _request_timeout: Union[
183
+ None,
184
+ Annotated[StrictFloat, Field(gt=0)],
185
+ Tuple[
186
+ Annotated[StrictFloat, Field(gt=0)],
187
+ Annotated[StrictFloat, Field(gt=0)]
188
+ ]
189
+ ] = None,
190
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
191
+ _content_type: Optional[StrictStr] = None,
192
+ _headers: Optional[Dict[StrictStr, Any]] = None,
193
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
194
+ ) -> RESTResponseType:
195
+ """Get Funding
196
+
197
+ ## Funding Return Funding metadata.
198
+
199
+ :param project_name: (required)
200
+ :type project_name: str
201
+ :param _request_timeout: timeout setting for this request. If one
202
+ number provided, it will be total request
203
+ timeout. It can also be a pair (tuple) of
204
+ (connection, read) timeouts.
205
+ :type _request_timeout: int, tuple(int, int), optional
206
+ :param _request_auth: set to override the auth_settings for an a single
207
+ request; this effectively ignores the
208
+ authentication in the spec for a single request.
209
+ :type _request_auth: dict, optional
210
+ :param _content_type: force content-type for the request.
211
+ :type _content_type: str, Optional
212
+ :param _headers: set to override the headers for a single
213
+ request; this effectively ignores the headers
214
+ in the spec for a single request.
215
+ :type _headers: dict, optional
216
+ :param _host_index: set to override the host_index for a single
217
+ request; this effectively ignores the host_index
218
+ in the spec for a single request.
219
+ :type _host_index: int, optional
220
+ :return: Returns the result object.
221
+ """ # noqa: E501
222
+
223
+ _param = self._get_funding_serialize(
224
+ project_name=project_name,
225
+ _request_auth=_request_auth,
226
+ _content_type=_content_type,
227
+ _headers=_headers,
228
+ _host_index=_host_index
229
+ )
230
+
231
+ _response_types_map: Dict[str, Optional[str]] = {
232
+ '200': "object",
233
+ '422': "HTTPValidationError",
234
+ }
235
+ response_data = await self.api_client.call_api(
236
+ *_param,
237
+ _request_timeout=_request_timeout
238
+ )
239
+ return response_data.response
240
+
241
+
242
+ def _get_funding_serialize(
243
+ self,
244
+ project_name,
245
+ _request_auth,
246
+ _content_type,
247
+ _headers,
248
+ _host_index,
249
+ ) -> RequestSerialized:
250
+
251
+ _host = None
252
+
253
+ _collection_formats: Dict[str, str] = {
254
+ }
255
+
256
+ _path_params: Dict[str, str] = {}
257
+ _query_params: List[Tuple[str, str]] = []
258
+ _header_params: Dict[str, Optional[str]] = _headers or {}
259
+ _form_params: List[Tuple[str, str]] = []
260
+ _files: Dict[
261
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
262
+ ] = {}
263
+ _body_params: Optional[bytes] = None
264
+
265
+ # process the path parameters
266
+ if project_name is not None:
267
+ _path_params['project_name'] = project_name
268
+ # process the query parameters
269
+ # process the header parameters
270
+ # process the form parameters
271
+ # process the body parameter
272
+
273
+
274
+ # set the HTTP header `Accept`
275
+ if 'Accept' not in _header_params:
276
+ _header_params['Accept'] = self.api_client.select_header_accept(
277
+ [
278
+ 'application/json'
279
+ ]
280
+ )
281
+
282
+
283
+ # authentication setting
284
+ _auth_settings: List[str] = [
285
+ ]
286
+
287
+ return self.api_client.param_serialize(
288
+ method='GET',
289
+ resource_path='/api/v2/funding/{project_name}',
290
+ path_params=_path_params,
291
+ query_params=_query_params,
292
+ header_params=_header_params,
293
+ body=_body_params,
294
+ post_params=_form_params,
295
+ files=_files,
296
+ auth_settings=_auth_settings,
297
+ collection_formats=_collection_formats,
298
+ _host=_host,
299
+ _request_auth=_request_auth
300
+ )
301
+
302
+
303
+
304
+
305
+ @validate_call
306
+ async def get_injection_materials(
307
+ self,
308
+ prep_lot_number: StrictStr,
309
+ _request_timeout: Union[
310
+ None,
311
+ Annotated[StrictFloat, Field(gt=0)],
312
+ Tuple[
313
+ Annotated[StrictFloat, Field(gt=0)],
314
+ Annotated[StrictFloat, Field(gt=0)]
315
+ ]
316
+ ] = None,
317
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
318
+ _content_type: Optional[StrictStr] = None,
319
+ _headers: Optional[Dict[StrictStr, Any]] = None,
320
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
321
+ ) -> object:
322
+ """Get Injection Materials
323
+
324
+ ## Injection Materials Return Injection Materials metadata.
325
+
326
+ :param prep_lot_number: (required)
327
+ :type prep_lot_number: str
328
+ :param _request_timeout: timeout setting for this request. If one
329
+ number provided, it will be total request
330
+ timeout. It can also be a pair (tuple) of
331
+ (connection, read) timeouts.
332
+ :type _request_timeout: int, tuple(int, int), optional
333
+ :param _request_auth: set to override the auth_settings for an a single
334
+ request; this effectively ignores the
335
+ authentication in the spec for a single request.
336
+ :type _request_auth: dict, optional
337
+ :param _content_type: force content-type for the request.
338
+ :type _content_type: str, Optional
339
+ :param _headers: set to override the headers for a single
340
+ request; this effectively ignores the headers
341
+ in the spec for a single request.
342
+ :type _headers: dict, optional
343
+ :param _host_index: set to override the host_index for a single
344
+ request; this effectively ignores the host_index
345
+ in the spec for a single request.
346
+ :type _host_index: int, optional
347
+ :return: Returns the result object.
348
+ """ # noqa: E501
349
+
350
+ _param = self._get_injection_materials_serialize(
351
+ prep_lot_number=prep_lot_number,
352
+ _request_auth=_request_auth,
353
+ _content_type=_content_type,
354
+ _headers=_headers,
355
+ _host_index=_host_index
356
+ )
357
+
358
+ _response_types_map: Dict[str, Optional[str]] = {
359
+ '200': "object",
360
+ '422': "HTTPValidationError",
361
+ }
362
+ response_data = await self.api_client.call_api(
363
+ *_param,
364
+ _request_timeout=_request_timeout
365
+ )
366
+ await response_data.read()
367
+ return self.api_client.response_deserialize(
368
+ response_data=response_data,
369
+ response_types_map=_response_types_map,
370
+ ).data
371
+
372
+
373
+ @validate_call
374
+ async def get_injection_materials_with_http_info(
375
+ self,
376
+ prep_lot_number: StrictStr,
377
+ _request_timeout: Union[
378
+ None,
379
+ Annotated[StrictFloat, Field(gt=0)],
380
+ Tuple[
381
+ Annotated[StrictFloat, Field(gt=0)],
382
+ Annotated[StrictFloat, Field(gt=0)]
383
+ ]
384
+ ] = None,
385
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
386
+ _content_type: Optional[StrictStr] = None,
387
+ _headers: Optional[Dict[StrictStr, Any]] = None,
388
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
389
+ ) -> ApiResponse[object]:
390
+ """Get Injection Materials
391
+
392
+ ## Injection Materials Return Injection Materials metadata.
393
+
394
+ :param prep_lot_number: (required)
395
+ :type prep_lot_number: str
396
+ :param _request_timeout: timeout setting for this request. If one
397
+ number provided, it will be total request
398
+ timeout. It can also be a pair (tuple) of
399
+ (connection, read) timeouts.
400
+ :type _request_timeout: int, tuple(int, int), optional
401
+ :param _request_auth: set to override the auth_settings for an a single
402
+ request; this effectively ignores the
403
+ authentication in the spec for a single request.
404
+ :type _request_auth: dict, optional
405
+ :param _content_type: force content-type for the request.
406
+ :type _content_type: str, Optional
407
+ :param _headers: set to override the headers for a single
408
+ request; this effectively ignores the headers
409
+ in the spec for a single request.
410
+ :type _headers: dict, optional
411
+ :param _host_index: set to override the host_index for a single
412
+ request; this effectively ignores the host_index
413
+ in the spec for a single request.
414
+ :type _host_index: int, optional
415
+ :return: Returns the result object.
416
+ """ # noqa: E501
417
+
418
+ _param = self._get_injection_materials_serialize(
419
+ prep_lot_number=prep_lot_number,
420
+ _request_auth=_request_auth,
421
+ _content_type=_content_type,
422
+ _headers=_headers,
423
+ _host_index=_host_index
424
+ )
425
+
426
+ _response_types_map: Dict[str, Optional[str]] = {
427
+ '200': "object",
428
+ '422': "HTTPValidationError",
429
+ }
430
+ response_data = await self.api_client.call_api(
431
+ *_param,
432
+ _request_timeout=_request_timeout
433
+ )
434
+ await response_data.read()
435
+ return self.api_client.response_deserialize(
436
+ response_data=response_data,
437
+ response_types_map=_response_types_map,
438
+ )
439
+
440
+
441
+ @validate_call
442
+ async def get_injection_materials_without_preload_content(
443
+ self,
444
+ prep_lot_number: StrictStr,
445
+ _request_timeout: Union[
446
+ None,
447
+ Annotated[StrictFloat, Field(gt=0)],
448
+ Tuple[
449
+ Annotated[StrictFloat, Field(gt=0)],
450
+ Annotated[StrictFloat, Field(gt=0)]
451
+ ]
452
+ ] = None,
453
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
454
+ _content_type: Optional[StrictStr] = None,
455
+ _headers: Optional[Dict[StrictStr, Any]] = None,
456
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
457
+ ) -> RESTResponseType:
458
+ """Get Injection Materials
459
+
460
+ ## Injection Materials Return Injection Materials metadata.
461
+
462
+ :param prep_lot_number: (required)
463
+ :type prep_lot_number: str
464
+ :param _request_timeout: timeout setting for this request. If one
465
+ number provided, it will be total request
466
+ timeout. It can also be a pair (tuple) of
467
+ (connection, read) timeouts.
468
+ :type _request_timeout: int, tuple(int, int), optional
469
+ :param _request_auth: set to override the auth_settings for an a single
470
+ request; this effectively ignores the
471
+ authentication in the spec for a single request.
472
+ :type _request_auth: dict, optional
473
+ :param _content_type: force content-type for the request.
474
+ :type _content_type: str, Optional
475
+ :param _headers: set to override the headers for a single
476
+ request; this effectively ignores the headers
477
+ in the spec for a single request.
478
+ :type _headers: dict, optional
479
+ :param _host_index: set to override the host_index for a single
480
+ request; this effectively ignores the host_index
481
+ in the spec for a single request.
482
+ :type _host_index: int, optional
483
+ :return: Returns the result object.
484
+ """ # noqa: E501
485
+
486
+ _param = self._get_injection_materials_serialize(
487
+ prep_lot_number=prep_lot_number,
488
+ _request_auth=_request_auth,
489
+ _content_type=_content_type,
490
+ _headers=_headers,
491
+ _host_index=_host_index
492
+ )
493
+
494
+ _response_types_map: Dict[str, Optional[str]] = {
495
+ '200': "object",
496
+ '422': "HTTPValidationError",
497
+ }
498
+ response_data = await self.api_client.call_api(
499
+ *_param,
500
+ _request_timeout=_request_timeout
501
+ )
502
+ return response_data.response
503
+
504
+
505
+ def _get_injection_materials_serialize(
506
+ self,
507
+ prep_lot_number,
508
+ _request_auth,
509
+ _content_type,
510
+ _headers,
511
+ _host_index,
512
+ ) -> RequestSerialized:
513
+
514
+ _host = None
515
+
516
+ _collection_formats: Dict[str, str] = {
517
+ }
518
+
519
+ _path_params: Dict[str, str] = {}
520
+ _query_params: List[Tuple[str, str]] = []
521
+ _header_params: Dict[str, Optional[str]] = _headers or {}
522
+ _form_params: List[Tuple[str, str]] = []
523
+ _files: Dict[
524
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
525
+ ] = {}
526
+ _body_params: Optional[bytes] = None
527
+
528
+ # process the path parameters
529
+ if prep_lot_number is not None:
530
+ _path_params['prep_lot_number'] = prep_lot_number
531
+ # process the query parameters
532
+ # process the header parameters
533
+ # process the form parameters
534
+ # process the body parameter
535
+
536
+
537
+ # set the HTTP header `Accept`
538
+ if 'Accept' not in _header_params:
539
+ _header_params['Accept'] = self.api_client.select_header_accept(
540
+ [
541
+ 'application/json'
542
+ ]
543
+ )
544
+
545
+
546
+ # authentication setting
547
+ _auth_settings: List[str] = [
548
+ ]
549
+
550
+ return self.api_client.param_serialize(
551
+ method='GET',
552
+ resource_path='/api/v2/tars_injection_materials/{prep_lot_number}',
553
+ path_params=_path_params,
554
+ query_params=_query_params,
555
+ header_params=_header_params,
556
+ body=_body_params,
557
+ post_params=_form_params,
558
+ files=_files,
559
+ auth_settings=_auth_settings,
560
+ collection_formats=_collection_formats,
561
+ _host=_host,
562
+ _request_auth=_request_auth
563
+ )
564
+
565
+
566
+
567
+
568
+ @validate_call
569
+ async def get_instrument(
570
+ self,
571
+ instrument_id: StrictStr,
572
+ partial_match: Optional[StrictBool] = None,
573
+ _request_timeout: Union[
574
+ None,
575
+ Annotated[StrictFloat, Field(gt=0)],
576
+ Tuple[
577
+ Annotated[StrictFloat, Field(gt=0)],
578
+ Annotated[StrictFloat, Field(gt=0)]
579
+ ]
580
+ ] = None,
581
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
582
+ _content_type: Optional[StrictStr] = None,
583
+ _headers: Optional[Dict[StrictStr, Any]] = None,
584
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
585
+ ) -> object:
586
+ """Get Instrument
587
+
588
+ ## Instrument Return an Instrument.
589
+
590
+ :param instrument_id: (required)
591
+ :type instrument_id: str
592
+ :param partial_match:
593
+ :type partial_match: bool
594
+ :param _request_timeout: timeout setting for this request. If one
595
+ number provided, it will be total request
596
+ timeout. It can also be a pair (tuple) of
597
+ (connection, read) timeouts.
598
+ :type _request_timeout: int, tuple(int, int), optional
599
+ :param _request_auth: set to override the auth_settings for an a single
600
+ request; this effectively ignores the
601
+ authentication in the spec for a single request.
602
+ :type _request_auth: dict, optional
603
+ :param _content_type: force content-type for the request.
604
+ :type _content_type: str, Optional
605
+ :param _headers: set to override the headers for a single
606
+ request; this effectively ignores the headers
607
+ in the spec for a single request.
608
+ :type _headers: dict, optional
609
+ :param _host_index: set to override the host_index for a single
610
+ request; this effectively ignores the host_index
611
+ in the spec for a single request.
612
+ :type _host_index: int, optional
613
+ :return: Returns the result object.
614
+ """ # noqa: E501
615
+
616
+ _param = self._get_instrument_serialize(
617
+ instrument_id=instrument_id,
618
+ partial_match=partial_match,
619
+ _request_auth=_request_auth,
620
+ _content_type=_content_type,
621
+ _headers=_headers,
622
+ _host_index=_host_index
623
+ )
624
+
625
+ _response_types_map: Dict[str, Optional[str]] = {
626
+ '200': "object",
627
+ '422': "HTTPValidationError",
628
+ }
629
+ response_data = await self.api_client.call_api(
630
+ *_param,
631
+ _request_timeout=_request_timeout
632
+ )
633
+ await response_data.read()
634
+ return self.api_client.response_deserialize(
635
+ response_data=response_data,
636
+ response_types_map=_response_types_map,
637
+ ).data
638
+
639
+
640
+ @validate_call
641
+ async def get_instrument_with_http_info(
642
+ self,
643
+ instrument_id: StrictStr,
644
+ partial_match: Optional[StrictBool] = None,
645
+ _request_timeout: Union[
646
+ None,
647
+ Annotated[StrictFloat, Field(gt=0)],
648
+ Tuple[
649
+ Annotated[StrictFloat, Field(gt=0)],
650
+ Annotated[StrictFloat, Field(gt=0)]
651
+ ]
652
+ ] = None,
653
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
654
+ _content_type: Optional[StrictStr] = None,
655
+ _headers: Optional[Dict[StrictStr, Any]] = None,
656
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
657
+ ) -> ApiResponse[object]:
658
+ """Get Instrument
659
+
660
+ ## Instrument Return an Instrument.
661
+
662
+ :param instrument_id: (required)
663
+ :type instrument_id: str
664
+ :param partial_match:
665
+ :type partial_match: bool
666
+ :param _request_timeout: timeout setting for this request. If one
667
+ number provided, it will be total request
668
+ timeout. It can also be a pair (tuple) of
669
+ (connection, read) timeouts.
670
+ :type _request_timeout: int, tuple(int, int), optional
671
+ :param _request_auth: set to override the auth_settings for an a single
672
+ request; this effectively ignores the
673
+ authentication in the spec for a single request.
674
+ :type _request_auth: dict, optional
675
+ :param _content_type: force content-type for the request.
676
+ :type _content_type: str, Optional
677
+ :param _headers: set to override the headers for a single
678
+ request; this effectively ignores the headers
679
+ in the spec for a single request.
680
+ :type _headers: dict, optional
681
+ :param _host_index: set to override the host_index for a single
682
+ request; this effectively ignores the host_index
683
+ in the spec for a single request.
684
+ :type _host_index: int, optional
685
+ :return: Returns the result object.
686
+ """ # noqa: E501
687
+
688
+ _param = self._get_instrument_serialize(
689
+ instrument_id=instrument_id,
690
+ partial_match=partial_match,
691
+ _request_auth=_request_auth,
692
+ _content_type=_content_type,
693
+ _headers=_headers,
694
+ _host_index=_host_index
695
+ )
696
+
697
+ _response_types_map: Dict[str, Optional[str]] = {
698
+ '200': "object",
699
+ '422': "HTTPValidationError",
700
+ }
701
+ response_data = await self.api_client.call_api(
702
+ *_param,
703
+ _request_timeout=_request_timeout
704
+ )
705
+ await response_data.read()
706
+ return self.api_client.response_deserialize(
707
+ response_data=response_data,
708
+ response_types_map=_response_types_map,
709
+ )
710
+
711
+
712
+ @validate_call
713
+ async def get_instrument_without_preload_content(
714
+ self,
715
+ instrument_id: StrictStr,
716
+ partial_match: Optional[StrictBool] = None,
717
+ _request_timeout: Union[
718
+ None,
719
+ Annotated[StrictFloat, Field(gt=0)],
720
+ Tuple[
721
+ Annotated[StrictFloat, Field(gt=0)],
722
+ Annotated[StrictFloat, Field(gt=0)]
723
+ ]
724
+ ] = None,
725
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
726
+ _content_type: Optional[StrictStr] = None,
727
+ _headers: Optional[Dict[StrictStr, Any]] = None,
728
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
729
+ ) -> RESTResponseType:
730
+ """Get Instrument
731
+
732
+ ## Instrument Return an Instrument.
733
+
734
+ :param instrument_id: (required)
735
+ :type instrument_id: str
736
+ :param partial_match:
737
+ :type partial_match: bool
738
+ :param _request_timeout: timeout setting for this request. If one
739
+ number provided, it will be total request
740
+ timeout. It can also be a pair (tuple) of
741
+ (connection, read) timeouts.
742
+ :type _request_timeout: int, tuple(int, int), optional
743
+ :param _request_auth: set to override the auth_settings for an a single
744
+ request; this effectively ignores the
745
+ authentication in the spec for a single request.
746
+ :type _request_auth: dict, optional
747
+ :param _content_type: force content-type for the request.
748
+ :type _content_type: str, Optional
749
+ :param _headers: set to override the headers for a single
750
+ request; this effectively ignores the headers
751
+ in the spec for a single request.
752
+ :type _headers: dict, optional
753
+ :param _host_index: set to override the host_index for a single
754
+ request; this effectively ignores the host_index
755
+ in the spec for a single request.
756
+ :type _host_index: int, optional
757
+ :return: Returns the result object.
758
+ """ # noqa: E501
759
+
760
+ _param = self._get_instrument_serialize(
761
+ instrument_id=instrument_id,
762
+ partial_match=partial_match,
763
+ _request_auth=_request_auth,
764
+ _content_type=_content_type,
765
+ _headers=_headers,
766
+ _host_index=_host_index
767
+ )
768
+
769
+ _response_types_map: Dict[str, Optional[str]] = {
770
+ '200': "object",
771
+ '422': "HTTPValidationError",
772
+ }
773
+ response_data = await self.api_client.call_api(
774
+ *_param,
775
+ _request_timeout=_request_timeout
776
+ )
777
+ return response_data.response
778
+
779
+
780
+ def _get_instrument_serialize(
781
+ self,
782
+ instrument_id,
783
+ partial_match,
784
+ _request_auth,
785
+ _content_type,
786
+ _headers,
787
+ _host_index,
788
+ ) -> RequestSerialized:
789
+
790
+ _host = None
791
+
792
+ _collection_formats: Dict[str, str] = {
793
+ }
794
+
795
+ _path_params: Dict[str, str] = {}
796
+ _query_params: List[Tuple[str, str]] = []
797
+ _header_params: Dict[str, Optional[str]] = _headers or {}
798
+ _form_params: List[Tuple[str, str]] = []
799
+ _files: Dict[
800
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
801
+ ] = {}
802
+ _body_params: Optional[bytes] = None
803
+
804
+ # process the path parameters
805
+ if instrument_id is not None:
806
+ _path_params['instrument_id'] = instrument_id
807
+ # process the query parameters
808
+ if partial_match is not None:
809
+
810
+ _query_params.append(('partial_match', partial_match))
811
+
812
+ # process the header parameters
813
+ # process the form parameters
814
+ # process the body parameter
815
+
816
+
817
+ # set the HTTP header `Accept`
818
+ if 'Accept' not in _header_params:
819
+ _header_params['Accept'] = self.api_client.select_header_accept(
820
+ [
821
+ 'application/json'
822
+ ]
823
+ )
824
+
825
+
826
+ # authentication setting
827
+ _auth_settings: List[str] = [
828
+ ]
829
+
830
+ return self.api_client.param_serialize(
831
+ method='GET',
832
+ resource_path='/api/v2/instrument/{instrument_id}',
833
+ path_params=_path_params,
834
+ query_params=_query_params,
835
+ header_params=_header_params,
836
+ body=_body_params,
837
+ post_params=_form_params,
838
+ files=_files,
839
+ auth_settings=_auth_settings,
840
+ collection_formats=_collection_formats,
841
+ _host=_host,
842
+ _request_auth=_request_auth
843
+ )
844
+
845
+
846
+
847
+
848
+ @validate_call
849
+ async def get_intended_measurements(
850
+ self,
851
+ subject_id: StrictStr,
852
+ _request_timeout: Union[
853
+ None,
854
+ Annotated[StrictFloat, Field(gt=0)],
855
+ Tuple[
856
+ Annotated[StrictFloat, Field(gt=0)],
857
+ Annotated[StrictFloat, Field(gt=0)]
858
+ ]
859
+ ] = None,
860
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
861
+ _content_type: Optional[StrictStr] = None,
862
+ _headers: Optional[Dict[StrictStr, Any]] = None,
863
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
864
+ ) -> object:
865
+ """Get Intended Measurements
866
+
867
+ ## Intended Measurements Return Intended Measurements metadata.
868
+
869
+ :param subject_id: (required)
870
+ :type subject_id: str
871
+ :param _request_timeout: timeout setting for this request. If one
872
+ number provided, it will be total request
873
+ timeout. It can also be a pair (tuple) of
874
+ (connection, read) timeouts.
875
+ :type _request_timeout: int, tuple(int, int), optional
876
+ :param _request_auth: set to override the auth_settings for an a single
877
+ request; this effectively ignores the
878
+ authentication in the spec for a single request.
879
+ :type _request_auth: dict, optional
880
+ :param _content_type: force content-type for the request.
881
+ :type _content_type: str, Optional
882
+ :param _headers: set to override the headers for a single
883
+ request; this effectively ignores the headers
884
+ in the spec for a single request.
885
+ :type _headers: dict, optional
886
+ :param _host_index: set to override the host_index for a single
887
+ request; this effectively ignores the host_index
888
+ in the spec for a single request.
889
+ :type _host_index: int, optional
890
+ :return: Returns the result object.
891
+ """ # noqa: E501
892
+
893
+ _param = self._get_intended_measurements_serialize(
894
+ subject_id=subject_id,
895
+ _request_auth=_request_auth,
896
+ _content_type=_content_type,
897
+ _headers=_headers,
898
+ _host_index=_host_index
899
+ )
900
+
901
+ _response_types_map: Dict[str, Optional[str]] = {
902
+ '200': "object",
903
+ '422': "HTTPValidationError",
904
+ }
905
+ response_data = await self.api_client.call_api(
906
+ *_param,
907
+ _request_timeout=_request_timeout
908
+ )
909
+ await response_data.read()
910
+ return self.api_client.response_deserialize(
911
+ response_data=response_data,
912
+ response_types_map=_response_types_map,
913
+ ).data
914
+
915
+
916
+ @validate_call
917
+ async def get_intended_measurements_with_http_info(
918
+ self,
919
+ subject_id: StrictStr,
920
+ _request_timeout: Union[
921
+ None,
922
+ Annotated[StrictFloat, Field(gt=0)],
923
+ Tuple[
924
+ Annotated[StrictFloat, Field(gt=0)],
925
+ Annotated[StrictFloat, Field(gt=0)]
926
+ ]
927
+ ] = None,
928
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
929
+ _content_type: Optional[StrictStr] = None,
930
+ _headers: Optional[Dict[StrictStr, Any]] = None,
931
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
932
+ ) -> ApiResponse[object]:
933
+ """Get Intended Measurements
934
+
935
+ ## Intended Measurements Return Intended Measurements metadata.
936
+
937
+ :param subject_id: (required)
938
+ :type subject_id: str
939
+ :param _request_timeout: timeout setting for this request. If one
940
+ number provided, it will be total request
941
+ timeout. It can also be a pair (tuple) of
942
+ (connection, read) timeouts.
943
+ :type _request_timeout: int, tuple(int, int), optional
944
+ :param _request_auth: set to override the auth_settings for an a single
945
+ request; this effectively ignores the
946
+ authentication in the spec for a single request.
947
+ :type _request_auth: dict, optional
948
+ :param _content_type: force content-type for the request.
949
+ :type _content_type: str, Optional
950
+ :param _headers: set to override the headers for a single
951
+ request; this effectively ignores the headers
952
+ in the spec for a single request.
953
+ :type _headers: dict, optional
954
+ :param _host_index: set to override the host_index for a single
955
+ request; this effectively ignores the host_index
956
+ in the spec for a single request.
957
+ :type _host_index: int, optional
958
+ :return: Returns the result object.
959
+ """ # noqa: E501
960
+
961
+ _param = self._get_intended_measurements_serialize(
962
+ subject_id=subject_id,
963
+ _request_auth=_request_auth,
964
+ _content_type=_content_type,
965
+ _headers=_headers,
966
+ _host_index=_host_index
967
+ )
968
+
969
+ _response_types_map: Dict[str, Optional[str]] = {
970
+ '200': "object",
971
+ '422': "HTTPValidationError",
972
+ }
973
+ response_data = await self.api_client.call_api(
974
+ *_param,
975
+ _request_timeout=_request_timeout
976
+ )
977
+ await response_data.read()
978
+ return self.api_client.response_deserialize(
979
+ response_data=response_data,
980
+ response_types_map=_response_types_map,
981
+ )
982
+
983
+
984
+ @validate_call
985
+ async def get_intended_measurements_without_preload_content(
986
+ self,
987
+ subject_id: StrictStr,
988
+ _request_timeout: Union[
989
+ None,
990
+ Annotated[StrictFloat, Field(gt=0)],
991
+ Tuple[
992
+ Annotated[StrictFloat, Field(gt=0)],
993
+ Annotated[StrictFloat, Field(gt=0)]
994
+ ]
995
+ ] = None,
996
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
997
+ _content_type: Optional[StrictStr] = None,
998
+ _headers: Optional[Dict[StrictStr, Any]] = None,
999
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1000
+ ) -> RESTResponseType:
1001
+ """Get Intended Measurements
1002
+
1003
+ ## Intended Measurements Return Intended Measurements metadata.
1004
+
1005
+ :param subject_id: (required)
1006
+ :type subject_id: str
1007
+ :param _request_timeout: timeout setting for this request. If one
1008
+ number provided, it will be total request
1009
+ timeout. It can also be a pair (tuple) of
1010
+ (connection, read) timeouts.
1011
+ :type _request_timeout: int, tuple(int, int), optional
1012
+ :param _request_auth: set to override the auth_settings for an a single
1013
+ request; this effectively ignores the
1014
+ authentication in the spec for a single request.
1015
+ :type _request_auth: dict, optional
1016
+ :param _content_type: force content-type for the request.
1017
+ :type _content_type: str, Optional
1018
+ :param _headers: set to override the headers for a single
1019
+ request; this effectively ignores the headers
1020
+ in the spec for a single request.
1021
+ :type _headers: dict, optional
1022
+ :param _host_index: set to override the host_index for a single
1023
+ request; this effectively ignores the host_index
1024
+ in the spec for a single request.
1025
+ :type _host_index: int, optional
1026
+ :return: Returns the result object.
1027
+ """ # noqa: E501
1028
+
1029
+ _param = self._get_intended_measurements_serialize(
1030
+ subject_id=subject_id,
1031
+ _request_auth=_request_auth,
1032
+ _content_type=_content_type,
1033
+ _headers=_headers,
1034
+ _host_index=_host_index
1035
+ )
1036
+
1037
+ _response_types_map: Dict[str, Optional[str]] = {
1038
+ '200': "object",
1039
+ '422': "HTTPValidationError",
1040
+ }
1041
+ response_data = await self.api_client.call_api(
1042
+ *_param,
1043
+ _request_timeout=_request_timeout
1044
+ )
1045
+ return response_data.response
1046
+
1047
+
1048
+ def _get_intended_measurements_serialize(
1049
+ self,
1050
+ subject_id,
1051
+ _request_auth,
1052
+ _content_type,
1053
+ _headers,
1054
+ _host_index,
1055
+ ) -> RequestSerialized:
1056
+
1057
+ _host = None
1058
+
1059
+ _collection_formats: Dict[str, str] = {
1060
+ }
1061
+
1062
+ _path_params: Dict[str, str] = {}
1063
+ _query_params: List[Tuple[str, str]] = []
1064
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1065
+ _form_params: List[Tuple[str, str]] = []
1066
+ _files: Dict[
1067
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1068
+ ] = {}
1069
+ _body_params: Optional[bytes] = None
1070
+
1071
+ # process the path parameters
1072
+ if subject_id is not None:
1073
+ _path_params['subject_id'] = subject_id
1074
+ # process the query parameters
1075
+ # process the header parameters
1076
+ # process the form parameters
1077
+ # process the body parameter
1078
+
1079
+
1080
+ # set the HTTP header `Accept`
1081
+ if 'Accept' not in _header_params:
1082
+ _header_params['Accept'] = self.api_client.select_header_accept(
1083
+ [
1084
+ 'application/json'
1085
+ ]
1086
+ )
1087
+
1088
+
1089
+ # authentication setting
1090
+ _auth_settings: List[str] = [
1091
+ ]
1092
+
1093
+ return self.api_client.param_serialize(
1094
+ method='GET',
1095
+ resource_path='/api/v2/intended_measurements/{subject_id}',
1096
+ path_params=_path_params,
1097
+ query_params=_query_params,
1098
+ header_params=_header_params,
1099
+ body=_body_params,
1100
+ post_params=_form_params,
1101
+ files=_files,
1102
+ auth_settings=_auth_settings,
1103
+ collection_formats=_collection_formats,
1104
+ _host=_host,
1105
+ _request_auth=_request_auth
1106
+ )
1107
+
1108
+
1109
+
1110
+
1111
+ @validate_call
1112
+ async def get_mgi_allele(
1113
+ self,
1114
+ allele_name: StrictStr,
1115
+ _request_timeout: Union[
1116
+ None,
1117
+ Annotated[StrictFloat, Field(gt=0)],
1118
+ Tuple[
1119
+ Annotated[StrictFloat, Field(gt=0)],
1120
+ Annotated[StrictFloat, Field(gt=0)]
1121
+ ]
1122
+ ] = None,
1123
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1124
+ _content_type: Optional[StrictStr] = None,
1125
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1126
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1127
+ ) -> object:
1128
+ """Get Mgi Allele
1129
+
1130
+ ## MGI Allele Return MGI Allele metadata.
1131
+
1132
+ :param allele_name: (required)
1133
+ :type allele_name: str
1134
+ :param _request_timeout: timeout setting for this request. If one
1135
+ number provided, it will be total request
1136
+ timeout. It can also be a pair (tuple) of
1137
+ (connection, read) timeouts.
1138
+ :type _request_timeout: int, tuple(int, int), optional
1139
+ :param _request_auth: set to override the auth_settings for an a single
1140
+ request; this effectively ignores the
1141
+ authentication in the spec for a single request.
1142
+ :type _request_auth: dict, optional
1143
+ :param _content_type: force content-type for the request.
1144
+ :type _content_type: str, Optional
1145
+ :param _headers: set to override the headers for a single
1146
+ request; this effectively ignores the headers
1147
+ in the spec for a single request.
1148
+ :type _headers: dict, optional
1149
+ :param _host_index: set to override the host_index for a single
1150
+ request; this effectively ignores the host_index
1151
+ in the spec for a single request.
1152
+ :type _host_index: int, optional
1153
+ :return: Returns the result object.
1154
+ """ # noqa: E501
1155
+
1156
+ _param = self._get_mgi_allele_serialize(
1157
+ allele_name=allele_name,
1158
+ _request_auth=_request_auth,
1159
+ _content_type=_content_type,
1160
+ _headers=_headers,
1161
+ _host_index=_host_index
1162
+ )
1163
+
1164
+ _response_types_map: Dict[str, Optional[str]] = {
1165
+ '200': "object",
1166
+ '422': "HTTPValidationError",
1167
+ }
1168
+ response_data = await self.api_client.call_api(
1169
+ *_param,
1170
+ _request_timeout=_request_timeout
1171
+ )
1172
+ await response_data.read()
1173
+ return self.api_client.response_deserialize(
1174
+ response_data=response_data,
1175
+ response_types_map=_response_types_map,
1176
+ ).data
1177
+
1178
+
1179
+ @validate_call
1180
+ async def get_mgi_allele_with_http_info(
1181
+ self,
1182
+ allele_name: StrictStr,
1183
+ _request_timeout: Union[
1184
+ None,
1185
+ Annotated[StrictFloat, Field(gt=0)],
1186
+ Tuple[
1187
+ Annotated[StrictFloat, Field(gt=0)],
1188
+ Annotated[StrictFloat, Field(gt=0)]
1189
+ ]
1190
+ ] = None,
1191
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1192
+ _content_type: Optional[StrictStr] = None,
1193
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1194
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1195
+ ) -> ApiResponse[object]:
1196
+ """Get Mgi Allele
1197
+
1198
+ ## MGI Allele Return MGI Allele metadata.
1199
+
1200
+ :param allele_name: (required)
1201
+ :type allele_name: str
1202
+ :param _request_timeout: timeout setting for this request. If one
1203
+ number provided, it will be total request
1204
+ timeout. It can also be a pair (tuple) of
1205
+ (connection, read) timeouts.
1206
+ :type _request_timeout: int, tuple(int, int), optional
1207
+ :param _request_auth: set to override the auth_settings for an a single
1208
+ request; this effectively ignores the
1209
+ authentication in the spec for a single request.
1210
+ :type _request_auth: dict, optional
1211
+ :param _content_type: force content-type for the request.
1212
+ :type _content_type: str, Optional
1213
+ :param _headers: set to override the headers for a single
1214
+ request; this effectively ignores the headers
1215
+ in the spec for a single request.
1216
+ :type _headers: dict, optional
1217
+ :param _host_index: set to override the host_index for a single
1218
+ request; this effectively ignores the host_index
1219
+ in the spec for a single request.
1220
+ :type _host_index: int, optional
1221
+ :return: Returns the result object.
1222
+ """ # noqa: E501
1223
+
1224
+ _param = self._get_mgi_allele_serialize(
1225
+ allele_name=allele_name,
1226
+ _request_auth=_request_auth,
1227
+ _content_type=_content_type,
1228
+ _headers=_headers,
1229
+ _host_index=_host_index
1230
+ )
1231
+
1232
+ _response_types_map: Dict[str, Optional[str]] = {
1233
+ '200': "object",
1234
+ '422': "HTTPValidationError",
1235
+ }
1236
+ response_data = await self.api_client.call_api(
1237
+ *_param,
1238
+ _request_timeout=_request_timeout
1239
+ )
1240
+ await response_data.read()
1241
+ return self.api_client.response_deserialize(
1242
+ response_data=response_data,
1243
+ response_types_map=_response_types_map,
1244
+ )
1245
+
1246
+
1247
+ @validate_call
1248
+ async def get_mgi_allele_without_preload_content(
1249
+ self,
1250
+ allele_name: StrictStr,
1251
+ _request_timeout: Union[
1252
+ None,
1253
+ Annotated[StrictFloat, Field(gt=0)],
1254
+ Tuple[
1255
+ Annotated[StrictFloat, Field(gt=0)],
1256
+ Annotated[StrictFloat, Field(gt=0)]
1257
+ ]
1258
+ ] = None,
1259
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1260
+ _content_type: Optional[StrictStr] = None,
1261
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1262
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1263
+ ) -> RESTResponseType:
1264
+ """Get Mgi Allele
1265
+
1266
+ ## MGI Allele Return MGI Allele metadata.
1267
+
1268
+ :param allele_name: (required)
1269
+ :type allele_name: str
1270
+ :param _request_timeout: timeout setting for this request. If one
1271
+ number provided, it will be total request
1272
+ timeout. It can also be a pair (tuple) of
1273
+ (connection, read) timeouts.
1274
+ :type _request_timeout: int, tuple(int, int), optional
1275
+ :param _request_auth: set to override the auth_settings for an a single
1276
+ request; this effectively ignores the
1277
+ authentication in the spec for a single request.
1278
+ :type _request_auth: dict, optional
1279
+ :param _content_type: force content-type for the request.
1280
+ :type _content_type: str, Optional
1281
+ :param _headers: set to override the headers for a single
1282
+ request; this effectively ignores the headers
1283
+ in the spec for a single request.
1284
+ :type _headers: dict, optional
1285
+ :param _host_index: set to override the host_index for a single
1286
+ request; this effectively ignores the host_index
1287
+ in the spec for a single request.
1288
+ :type _host_index: int, optional
1289
+ :return: Returns the result object.
1290
+ """ # noqa: E501
1291
+
1292
+ _param = self._get_mgi_allele_serialize(
1293
+ allele_name=allele_name,
1294
+ _request_auth=_request_auth,
1295
+ _content_type=_content_type,
1296
+ _headers=_headers,
1297
+ _host_index=_host_index
1298
+ )
1299
+
1300
+ _response_types_map: Dict[str, Optional[str]] = {
1301
+ '200': "object",
1302
+ '422': "HTTPValidationError",
1303
+ }
1304
+ response_data = await self.api_client.call_api(
1305
+ *_param,
1306
+ _request_timeout=_request_timeout
1307
+ )
1308
+ return response_data.response
1309
+
1310
+
1311
+ def _get_mgi_allele_serialize(
1312
+ self,
1313
+ allele_name,
1314
+ _request_auth,
1315
+ _content_type,
1316
+ _headers,
1317
+ _host_index,
1318
+ ) -> RequestSerialized:
1319
+
1320
+ _host = None
1321
+
1322
+ _collection_formats: Dict[str, str] = {
1323
+ }
1324
+
1325
+ _path_params: Dict[str, str] = {}
1326
+ _query_params: List[Tuple[str, str]] = []
1327
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1328
+ _form_params: List[Tuple[str, str]] = []
1329
+ _files: Dict[
1330
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1331
+ ] = {}
1332
+ _body_params: Optional[bytes] = None
1333
+
1334
+ # process the path parameters
1335
+ if allele_name is not None:
1336
+ _path_params['allele_name'] = allele_name
1337
+ # process the query parameters
1338
+ # process the header parameters
1339
+ # process the form parameters
1340
+ # process the body parameter
1341
+
1342
+
1343
+ # set the HTTP header `Accept`
1344
+ if 'Accept' not in _header_params:
1345
+ _header_params['Accept'] = self.api_client.select_header_accept(
1346
+ [
1347
+ 'application/json'
1348
+ ]
1349
+ )
1350
+
1351
+
1352
+ # authentication setting
1353
+ _auth_settings: List[str] = [
1354
+ ]
1355
+
1356
+ return self.api_client.param_serialize(
1357
+ method='GET',
1358
+ resource_path='/api/v2/mgi_allele/{allele_name}',
1359
+ path_params=_path_params,
1360
+ query_params=_query_params,
1361
+ header_params=_header_params,
1362
+ body=_body_params,
1363
+ post_params=_form_params,
1364
+ files=_files,
1365
+ auth_settings=_auth_settings,
1366
+ collection_formats=_collection_formats,
1367
+ _host=_host,
1368
+ _request_auth=_request_auth
1369
+ )
1370
+
1371
+
1372
+
1373
+
1374
+ @validate_call
1375
+ async def get_perfusions(
1376
+ self,
1377
+ subject_id: StrictStr,
1378
+ _request_timeout: Union[
1379
+ None,
1380
+ Annotated[StrictFloat, Field(gt=0)],
1381
+ Tuple[
1382
+ Annotated[StrictFloat, Field(gt=0)],
1383
+ Annotated[StrictFloat, Field(gt=0)]
1384
+ ]
1385
+ ] = None,
1386
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1387
+ _content_type: Optional[StrictStr] = None,
1388
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1389
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1390
+ ) -> object:
1391
+ """Get Perfusions
1392
+
1393
+ ## Perfusions Return Perfusions metadata.
1394
+
1395
+ :param subject_id: (required)
1396
+ :type subject_id: str
1397
+ :param _request_timeout: timeout setting for this request. If one
1398
+ number provided, it will be total request
1399
+ timeout. It can also be a pair (tuple) of
1400
+ (connection, read) timeouts.
1401
+ :type _request_timeout: int, tuple(int, int), optional
1402
+ :param _request_auth: set to override the auth_settings for an a single
1403
+ request; this effectively ignores the
1404
+ authentication in the spec for a single request.
1405
+ :type _request_auth: dict, optional
1406
+ :param _content_type: force content-type for the request.
1407
+ :type _content_type: str, Optional
1408
+ :param _headers: set to override the headers for a single
1409
+ request; this effectively ignores the headers
1410
+ in the spec for a single request.
1411
+ :type _headers: dict, optional
1412
+ :param _host_index: set to override the host_index for a single
1413
+ request; this effectively ignores the host_index
1414
+ in the spec for a single request.
1415
+ :type _host_index: int, optional
1416
+ :return: Returns the result object.
1417
+ """ # noqa: E501
1418
+
1419
+ _param = self._get_perfusions_serialize(
1420
+ subject_id=subject_id,
1421
+ _request_auth=_request_auth,
1422
+ _content_type=_content_type,
1423
+ _headers=_headers,
1424
+ _host_index=_host_index
1425
+ )
1426
+
1427
+ _response_types_map: Dict[str, Optional[str]] = {
1428
+ '200': "object",
1429
+ '422': "HTTPValidationError",
1430
+ }
1431
+ response_data = await self.api_client.call_api(
1432
+ *_param,
1433
+ _request_timeout=_request_timeout
1434
+ )
1435
+ await response_data.read()
1436
+ return self.api_client.response_deserialize(
1437
+ response_data=response_data,
1438
+ response_types_map=_response_types_map,
1439
+ ).data
1440
+
1441
+
1442
+ @validate_call
1443
+ async def get_perfusions_with_http_info(
1444
+ self,
1445
+ subject_id: StrictStr,
1446
+ _request_timeout: Union[
1447
+ None,
1448
+ Annotated[StrictFloat, Field(gt=0)],
1449
+ Tuple[
1450
+ Annotated[StrictFloat, Field(gt=0)],
1451
+ Annotated[StrictFloat, Field(gt=0)]
1452
+ ]
1453
+ ] = None,
1454
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1455
+ _content_type: Optional[StrictStr] = None,
1456
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1457
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1458
+ ) -> ApiResponse[object]:
1459
+ """Get Perfusions
1460
+
1461
+ ## Perfusions Return Perfusions metadata.
1462
+
1463
+ :param subject_id: (required)
1464
+ :type subject_id: str
1465
+ :param _request_timeout: timeout setting for this request. If one
1466
+ number provided, it will be total request
1467
+ timeout. It can also be a pair (tuple) of
1468
+ (connection, read) timeouts.
1469
+ :type _request_timeout: int, tuple(int, int), optional
1470
+ :param _request_auth: set to override the auth_settings for an a single
1471
+ request; this effectively ignores the
1472
+ authentication in the spec for a single request.
1473
+ :type _request_auth: dict, optional
1474
+ :param _content_type: force content-type for the request.
1475
+ :type _content_type: str, Optional
1476
+ :param _headers: set to override the headers for a single
1477
+ request; this effectively ignores the headers
1478
+ in the spec for a single request.
1479
+ :type _headers: dict, optional
1480
+ :param _host_index: set to override the host_index for a single
1481
+ request; this effectively ignores the host_index
1482
+ in the spec for a single request.
1483
+ :type _host_index: int, optional
1484
+ :return: Returns the result object.
1485
+ """ # noqa: E501
1486
+
1487
+ _param = self._get_perfusions_serialize(
1488
+ subject_id=subject_id,
1489
+ _request_auth=_request_auth,
1490
+ _content_type=_content_type,
1491
+ _headers=_headers,
1492
+ _host_index=_host_index
1493
+ )
1494
+
1495
+ _response_types_map: Dict[str, Optional[str]] = {
1496
+ '200': "object",
1497
+ '422': "HTTPValidationError",
1498
+ }
1499
+ response_data = await self.api_client.call_api(
1500
+ *_param,
1501
+ _request_timeout=_request_timeout
1502
+ )
1503
+ await response_data.read()
1504
+ return self.api_client.response_deserialize(
1505
+ response_data=response_data,
1506
+ response_types_map=_response_types_map,
1507
+ )
1508
+
1509
+
1510
+ @validate_call
1511
+ async def get_perfusions_without_preload_content(
1512
+ self,
1513
+ subject_id: StrictStr,
1514
+ _request_timeout: Union[
1515
+ None,
1516
+ Annotated[StrictFloat, Field(gt=0)],
1517
+ Tuple[
1518
+ Annotated[StrictFloat, Field(gt=0)],
1519
+ Annotated[StrictFloat, Field(gt=0)]
1520
+ ]
1521
+ ] = None,
1522
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1523
+ _content_type: Optional[StrictStr] = None,
1524
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1525
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1526
+ ) -> RESTResponseType:
1527
+ """Get Perfusions
1528
+
1529
+ ## Perfusions Return Perfusions metadata.
1530
+
1531
+ :param subject_id: (required)
1532
+ :type subject_id: str
1533
+ :param _request_timeout: timeout setting for this request. If one
1534
+ number provided, it will be total request
1535
+ timeout. It can also be a pair (tuple) of
1536
+ (connection, read) timeouts.
1537
+ :type _request_timeout: int, tuple(int, int), optional
1538
+ :param _request_auth: set to override the auth_settings for an a single
1539
+ request; this effectively ignores the
1540
+ authentication in the spec for a single request.
1541
+ :type _request_auth: dict, optional
1542
+ :param _content_type: force content-type for the request.
1543
+ :type _content_type: str, Optional
1544
+ :param _headers: set to override the headers for a single
1545
+ request; this effectively ignores the headers
1546
+ in the spec for a single request.
1547
+ :type _headers: dict, optional
1548
+ :param _host_index: set to override the host_index for a single
1549
+ request; this effectively ignores the host_index
1550
+ in the spec for a single request.
1551
+ :type _host_index: int, optional
1552
+ :return: Returns the result object.
1553
+ """ # noqa: E501
1554
+
1555
+ _param = self._get_perfusions_serialize(
1556
+ subject_id=subject_id,
1557
+ _request_auth=_request_auth,
1558
+ _content_type=_content_type,
1559
+ _headers=_headers,
1560
+ _host_index=_host_index
1561
+ )
1562
+
1563
+ _response_types_map: Dict[str, Optional[str]] = {
1564
+ '200': "object",
1565
+ '422': "HTTPValidationError",
1566
+ }
1567
+ response_data = await self.api_client.call_api(
1568
+ *_param,
1569
+ _request_timeout=_request_timeout
1570
+ )
1571
+ return response_data.response
1572
+
1573
+
1574
+ def _get_perfusions_serialize(
1575
+ self,
1576
+ subject_id,
1577
+ _request_auth,
1578
+ _content_type,
1579
+ _headers,
1580
+ _host_index,
1581
+ ) -> RequestSerialized:
1582
+
1583
+ _host = None
1584
+
1585
+ _collection_formats: Dict[str, str] = {
1586
+ }
1587
+
1588
+ _path_params: Dict[str, str] = {}
1589
+ _query_params: List[Tuple[str, str]] = []
1590
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1591
+ _form_params: List[Tuple[str, str]] = []
1592
+ _files: Dict[
1593
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1594
+ ] = {}
1595
+ _body_params: Optional[bytes] = None
1596
+
1597
+ # process the path parameters
1598
+ if subject_id is not None:
1599
+ _path_params['subject_id'] = subject_id
1600
+ # process the query parameters
1601
+ # process the header parameters
1602
+ # process the form parameters
1603
+ # process the body parameter
1604
+
1605
+
1606
+ # set the HTTP header `Accept`
1607
+ if 'Accept' not in _header_params:
1608
+ _header_params['Accept'] = self.api_client.select_header_accept(
1609
+ [
1610
+ 'application/json'
1611
+ ]
1612
+ )
1613
+
1614
+
1615
+ # authentication setting
1616
+ _auth_settings: List[str] = [
1617
+ ]
1618
+
1619
+ return self.api_client.param_serialize(
1620
+ method='GET',
1621
+ resource_path='/api/v2/perfusions/{subject_id}',
1622
+ path_params=_path_params,
1623
+ query_params=_query_params,
1624
+ header_params=_header_params,
1625
+ body=_body_params,
1626
+ post_params=_form_params,
1627
+ files=_files,
1628
+ auth_settings=_auth_settings,
1629
+ collection_formats=_collection_formats,
1630
+ _host=_host,
1631
+ _request_auth=_request_auth
1632
+ )
1633
+
1634
+
1635
+
1636
+
42
1637
  @validate_call
43
1638
  async def get_procedures(
44
1639
  self,
45
- subject_id: StrictStr,
1640
+ subject_id: StrictStr,
1641
+ _request_timeout: Union[
1642
+ None,
1643
+ Annotated[StrictFloat, Field(gt=0)],
1644
+ Tuple[
1645
+ Annotated[StrictFloat, Field(gt=0)],
1646
+ Annotated[StrictFloat, Field(gt=0)]
1647
+ ]
1648
+ ] = None,
1649
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1650
+ _content_type: Optional[StrictStr] = None,
1651
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1652
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1653
+ ) -> object:
1654
+ """Get Procedures
1655
+
1656
+ ## Procedures Return Procedure metadata.
1657
+
1658
+ :param subject_id: (required)
1659
+ :type subject_id: str
1660
+ :param _request_timeout: timeout setting for this request. If one
1661
+ number provided, it will be total request
1662
+ timeout. It can also be a pair (tuple) of
1663
+ (connection, read) timeouts.
1664
+ :type _request_timeout: int, tuple(int, int), optional
1665
+ :param _request_auth: set to override the auth_settings for an a single
1666
+ request; this effectively ignores the
1667
+ authentication in the spec for a single request.
1668
+ :type _request_auth: dict, optional
1669
+ :param _content_type: force content-type for the request.
1670
+ :type _content_type: str, Optional
1671
+ :param _headers: set to override the headers for a single
1672
+ request; this effectively ignores the headers
1673
+ in the spec for a single request.
1674
+ :type _headers: dict, optional
1675
+ :param _host_index: set to override the host_index for a single
1676
+ request; this effectively ignores the host_index
1677
+ in the spec for a single request.
1678
+ :type _host_index: int, optional
1679
+ :return: Returns the result object.
1680
+ """ # noqa: E501
1681
+
1682
+ _param = self._get_procedures_serialize(
1683
+ subject_id=subject_id,
1684
+ _request_auth=_request_auth,
1685
+ _content_type=_content_type,
1686
+ _headers=_headers,
1687
+ _host_index=_host_index
1688
+ )
1689
+
1690
+ _response_types_map: Dict[str, Optional[str]] = {
1691
+ '200': "object",
1692
+ '422': "HTTPValidationError",
1693
+ }
1694
+ response_data = await self.api_client.call_api(
1695
+ *_param,
1696
+ _request_timeout=_request_timeout
1697
+ )
1698
+ await response_data.read()
1699
+ return self.api_client.response_deserialize(
1700
+ response_data=response_data,
1701
+ response_types_map=_response_types_map,
1702
+ ).data
1703
+
1704
+
1705
+ @validate_call
1706
+ async def get_procedures_with_http_info(
1707
+ self,
1708
+ subject_id: StrictStr,
1709
+ _request_timeout: Union[
1710
+ None,
1711
+ Annotated[StrictFloat, Field(gt=0)],
1712
+ Tuple[
1713
+ Annotated[StrictFloat, Field(gt=0)],
1714
+ Annotated[StrictFloat, Field(gt=0)]
1715
+ ]
1716
+ ] = None,
1717
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1718
+ _content_type: Optional[StrictStr] = None,
1719
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1720
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1721
+ ) -> ApiResponse[object]:
1722
+ """Get Procedures
1723
+
1724
+ ## Procedures Return Procedure metadata.
1725
+
1726
+ :param subject_id: (required)
1727
+ :type subject_id: str
1728
+ :param _request_timeout: timeout setting for this request. If one
1729
+ number provided, it will be total request
1730
+ timeout. It can also be a pair (tuple) of
1731
+ (connection, read) timeouts.
1732
+ :type _request_timeout: int, tuple(int, int), optional
1733
+ :param _request_auth: set to override the auth_settings for an a single
1734
+ request; this effectively ignores the
1735
+ authentication in the spec for a single request.
1736
+ :type _request_auth: dict, optional
1737
+ :param _content_type: force content-type for the request.
1738
+ :type _content_type: str, Optional
1739
+ :param _headers: set to override the headers for a single
1740
+ request; this effectively ignores the headers
1741
+ in the spec for a single request.
1742
+ :type _headers: dict, optional
1743
+ :param _host_index: set to override the host_index for a single
1744
+ request; this effectively ignores the host_index
1745
+ in the spec for a single request.
1746
+ :type _host_index: int, optional
1747
+ :return: Returns the result object.
1748
+ """ # noqa: E501
1749
+
1750
+ _param = self._get_procedures_serialize(
1751
+ subject_id=subject_id,
1752
+ _request_auth=_request_auth,
1753
+ _content_type=_content_type,
1754
+ _headers=_headers,
1755
+ _host_index=_host_index
1756
+ )
1757
+
1758
+ _response_types_map: Dict[str, Optional[str]] = {
1759
+ '200': "object",
1760
+ '422': "HTTPValidationError",
1761
+ }
1762
+ response_data = await self.api_client.call_api(
1763
+ *_param,
1764
+ _request_timeout=_request_timeout
1765
+ )
1766
+ await response_data.read()
1767
+ return self.api_client.response_deserialize(
1768
+ response_data=response_data,
1769
+ response_types_map=_response_types_map,
1770
+ )
1771
+
1772
+
1773
+ @validate_call
1774
+ async def get_procedures_without_preload_content(
1775
+ self,
1776
+ subject_id: StrictStr,
1777
+ _request_timeout: Union[
1778
+ None,
1779
+ Annotated[StrictFloat, Field(gt=0)],
1780
+ Tuple[
1781
+ Annotated[StrictFloat, Field(gt=0)],
1782
+ Annotated[StrictFloat, Field(gt=0)]
1783
+ ]
1784
+ ] = None,
1785
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1786
+ _content_type: Optional[StrictStr] = None,
1787
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1788
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1789
+ ) -> RESTResponseType:
1790
+ """Get Procedures
1791
+
1792
+ ## Procedures Return Procedure metadata.
1793
+
1794
+ :param subject_id: (required)
1795
+ :type subject_id: str
1796
+ :param _request_timeout: timeout setting for this request. If one
1797
+ number provided, it will be total request
1798
+ timeout. It can also be a pair (tuple) of
1799
+ (connection, read) timeouts.
1800
+ :type _request_timeout: int, tuple(int, int), optional
1801
+ :param _request_auth: set to override the auth_settings for an a single
1802
+ request; this effectively ignores the
1803
+ authentication in the spec for a single request.
1804
+ :type _request_auth: dict, optional
1805
+ :param _content_type: force content-type for the request.
1806
+ :type _content_type: str, Optional
1807
+ :param _headers: set to override the headers for a single
1808
+ request; this effectively ignores the headers
1809
+ in the spec for a single request.
1810
+ :type _headers: dict, optional
1811
+ :param _host_index: set to override the host_index for a single
1812
+ request; this effectively ignores the host_index
1813
+ in the spec for a single request.
1814
+ :type _host_index: int, optional
1815
+ :return: Returns the result object.
1816
+ """ # noqa: E501
1817
+
1818
+ _param = self._get_procedures_serialize(
1819
+ subject_id=subject_id,
1820
+ _request_auth=_request_auth,
1821
+ _content_type=_content_type,
1822
+ _headers=_headers,
1823
+ _host_index=_host_index
1824
+ )
1825
+
1826
+ _response_types_map: Dict[str, Optional[str]] = {
1827
+ '200': "object",
1828
+ '422': "HTTPValidationError",
1829
+ }
1830
+ response_data = await self.api_client.call_api(
1831
+ *_param,
1832
+ _request_timeout=_request_timeout
1833
+ )
1834
+ return response_data.response
1835
+
1836
+
1837
+ def _get_procedures_serialize(
1838
+ self,
1839
+ subject_id,
1840
+ _request_auth,
1841
+ _content_type,
1842
+ _headers,
1843
+ _host_index,
1844
+ ) -> RequestSerialized:
1845
+
1846
+ _host = None
1847
+
1848
+ _collection_formats: Dict[str, str] = {
1849
+ }
1850
+
1851
+ _path_params: Dict[str, str] = {}
1852
+ _query_params: List[Tuple[str, str]] = []
1853
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1854
+ _form_params: List[Tuple[str, str]] = []
1855
+ _files: Dict[
1856
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1857
+ ] = {}
1858
+ _body_params: Optional[bytes] = None
1859
+
1860
+ # process the path parameters
1861
+ if subject_id is not None:
1862
+ _path_params['subject_id'] = subject_id
1863
+ # process the query parameters
1864
+ # process the header parameters
1865
+ # process the form parameters
1866
+ # process the body parameter
1867
+
1868
+
1869
+ # set the HTTP header `Accept`
1870
+ if 'Accept' not in _header_params:
1871
+ _header_params['Accept'] = self.api_client.select_header_accept(
1872
+ [
1873
+ 'application/json'
1874
+ ]
1875
+ )
1876
+
1877
+
1878
+ # authentication setting
1879
+ _auth_settings: List[str] = [
1880
+ ]
1881
+
1882
+ return self.api_client.param_serialize(
1883
+ method='GET',
1884
+ resource_path='/api/v2/procedures/{subject_id}',
1885
+ path_params=_path_params,
1886
+ query_params=_query_params,
1887
+ header_params=_header_params,
1888
+ body=_body_params,
1889
+ post_params=_form_params,
1890
+ files=_files,
1891
+ auth_settings=_auth_settings,
1892
+ collection_formats=_collection_formats,
1893
+ _host=_host,
1894
+ _request_auth=_request_auth
1895
+ )
1896
+
1897
+
1898
+
1899
+
1900
+ @validate_call
1901
+ async def get_project_names(
1902
+ self,
1903
+ _request_timeout: Union[
1904
+ None,
1905
+ Annotated[StrictFloat, Field(gt=0)],
1906
+ Tuple[
1907
+ Annotated[StrictFloat, Field(gt=0)],
1908
+ Annotated[StrictFloat, Field(gt=0)]
1909
+ ]
1910
+ ] = None,
1911
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1912
+ _content_type: Optional[StrictStr] = None,
1913
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1914
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1915
+ ) -> object:
1916
+ """Get Project Names
1917
+
1918
+ Get a list of project names from the Smartsheet API.
1919
+
1920
+ :param _request_timeout: timeout setting for this request. If one
1921
+ number provided, it will be total request
1922
+ timeout. It can also be a pair (tuple) of
1923
+ (connection, read) timeouts.
1924
+ :type _request_timeout: int, tuple(int, int), optional
1925
+ :param _request_auth: set to override the auth_settings for an a single
1926
+ request; this effectively ignores the
1927
+ authentication in the spec for a single request.
1928
+ :type _request_auth: dict, optional
1929
+ :param _content_type: force content-type for the request.
1930
+ :type _content_type: str, Optional
1931
+ :param _headers: set to override the headers for a single
1932
+ request; this effectively ignores the headers
1933
+ in the spec for a single request.
1934
+ :type _headers: dict, optional
1935
+ :param _host_index: set to override the host_index for a single
1936
+ request; this effectively ignores the host_index
1937
+ in the spec for a single request.
1938
+ :type _host_index: int, optional
1939
+ :return: Returns the result object.
1940
+ """ # noqa: E501
1941
+
1942
+ _param = self._get_project_names_serialize(
1943
+ _request_auth=_request_auth,
1944
+ _content_type=_content_type,
1945
+ _headers=_headers,
1946
+ _host_index=_host_index
1947
+ )
1948
+
1949
+ _response_types_map: Dict[str, Optional[str]] = {
1950
+ '200': "object",
1951
+ }
1952
+ response_data = await self.api_client.call_api(
1953
+ *_param,
1954
+ _request_timeout=_request_timeout
1955
+ )
1956
+ await response_data.read()
1957
+ return self.api_client.response_deserialize(
1958
+ response_data=response_data,
1959
+ response_types_map=_response_types_map,
1960
+ ).data
1961
+
1962
+
1963
+ @validate_call
1964
+ async def get_project_names_with_http_info(
1965
+ self,
1966
+ _request_timeout: Union[
1967
+ None,
1968
+ Annotated[StrictFloat, Field(gt=0)],
1969
+ Tuple[
1970
+ Annotated[StrictFloat, Field(gt=0)],
1971
+ Annotated[StrictFloat, Field(gt=0)]
1972
+ ]
1973
+ ] = None,
1974
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1975
+ _content_type: Optional[StrictStr] = None,
1976
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1977
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1978
+ ) -> ApiResponse[object]:
1979
+ """Get Project Names
1980
+
1981
+ Get a list of project names from the Smartsheet API.
1982
+
1983
+ :param _request_timeout: timeout setting for this request. If one
1984
+ number provided, it will be total request
1985
+ timeout. It can also be a pair (tuple) of
1986
+ (connection, read) timeouts.
1987
+ :type _request_timeout: int, tuple(int, int), optional
1988
+ :param _request_auth: set to override the auth_settings for an a single
1989
+ request; this effectively ignores the
1990
+ authentication in the spec for a single request.
1991
+ :type _request_auth: dict, optional
1992
+ :param _content_type: force content-type for the request.
1993
+ :type _content_type: str, Optional
1994
+ :param _headers: set to override the headers for a single
1995
+ request; this effectively ignores the headers
1996
+ in the spec for a single request.
1997
+ :type _headers: dict, optional
1998
+ :param _host_index: set to override the host_index for a single
1999
+ request; this effectively ignores the host_index
2000
+ in the spec for a single request.
2001
+ :type _host_index: int, optional
2002
+ :return: Returns the result object.
2003
+ """ # noqa: E501
2004
+
2005
+ _param = self._get_project_names_serialize(
2006
+ _request_auth=_request_auth,
2007
+ _content_type=_content_type,
2008
+ _headers=_headers,
2009
+ _host_index=_host_index
2010
+ )
2011
+
2012
+ _response_types_map: Dict[str, Optional[str]] = {
2013
+ '200': "object",
2014
+ }
2015
+ response_data = await self.api_client.call_api(
2016
+ *_param,
2017
+ _request_timeout=_request_timeout
2018
+ )
2019
+ await response_data.read()
2020
+ return self.api_client.response_deserialize(
2021
+ response_data=response_data,
2022
+ response_types_map=_response_types_map,
2023
+ )
2024
+
2025
+
2026
+ @validate_call
2027
+ async def get_project_names_without_preload_content(
2028
+ self,
2029
+ _request_timeout: Union[
2030
+ None,
2031
+ Annotated[StrictFloat, Field(gt=0)],
2032
+ Tuple[
2033
+ Annotated[StrictFloat, Field(gt=0)],
2034
+ Annotated[StrictFloat, Field(gt=0)]
2035
+ ]
2036
+ ] = None,
2037
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2038
+ _content_type: Optional[StrictStr] = None,
2039
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2040
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2041
+ ) -> RESTResponseType:
2042
+ """Get Project Names
2043
+
2044
+ Get a list of project names from the Smartsheet API.
2045
+
2046
+ :param _request_timeout: timeout setting for this request. If one
2047
+ number provided, it will be total request
2048
+ timeout. It can also be a pair (tuple) of
2049
+ (connection, read) timeouts.
2050
+ :type _request_timeout: int, tuple(int, int), optional
2051
+ :param _request_auth: set to override the auth_settings for an a single
2052
+ request; this effectively ignores the
2053
+ authentication in the spec for a single request.
2054
+ :type _request_auth: dict, optional
2055
+ :param _content_type: force content-type for the request.
2056
+ :type _content_type: str, Optional
2057
+ :param _headers: set to override the headers for a single
2058
+ request; this effectively ignores the headers
2059
+ in the spec for a single request.
2060
+ :type _headers: dict, optional
2061
+ :param _host_index: set to override the host_index for a single
2062
+ request; this effectively ignores the host_index
2063
+ in the spec for a single request.
2064
+ :type _host_index: int, optional
2065
+ :return: Returns the result object.
2066
+ """ # noqa: E501
2067
+
2068
+ _param = self._get_project_names_serialize(
2069
+ _request_auth=_request_auth,
2070
+ _content_type=_content_type,
2071
+ _headers=_headers,
2072
+ _host_index=_host_index
2073
+ )
2074
+
2075
+ _response_types_map: Dict[str, Optional[str]] = {
2076
+ '200': "object",
2077
+ }
2078
+ response_data = await self.api_client.call_api(
2079
+ *_param,
2080
+ _request_timeout=_request_timeout
2081
+ )
2082
+ return response_data.response
2083
+
2084
+
2085
+ def _get_project_names_serialize(
2086
+ self,
2087
+ _request_auth,
2088
+ _content_type,
2089
+ _headers,
2090
+ _host_index,
2091
+ ) -> RequestSerialized:
2092
+
2093
+ _host = None
2094
+
2095
+ _collection_formats: Dict[str, str] = {
2096
+ }
2097
+
2098
+ _path_params: Dict[str, str] = {}
2099
+ _query_params: List[Tuple[str, str]] = []
2100
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2101
+ _form_params: List[Tuple[str, str]] = []
2102
+ _files: Dict[
2103
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2104
+ ] = {}
2105
+ _body_params: Optional[bytes] = None
2106
+
2107
+ # process the path parameters
2108
+ # process the query parameters
2109
+ # process the header parameters
2110
+ # process the form parameters
2111
+ # process the body parameter
2112
+
2113
+
2114
+ # set the HTTP header `Accept`
2115
+ if 'Accept' not in _header_params:
2116
+ _header_params['Accept'] = self.api_client.select_header_accept(
2117
+ [
2118
+ 'application/json'
2119
+ ]
2120
+ )
2121
+
2122
+
2123
+ # authentication setting
2124
+ _auth_settings: List[str] = [
2125
+ ]
2126
+
2127
+ return self.api_client.param_serialize(
2128
+ method='GET',
2129
+ resource_path='/api/v2/project_names',
2130
+ path_params=_path_params,
2131
+ query_params=_query_params,
2132
+ header_params=_header_params,
2133
+ body=_body_params,
2134
+ post_params=_form_params,
2135
+ files=_files,
2136
+ auth_settings=_auth_settings,
2137
+ collection_formats=_collection_formats,
2138
+ _host=_host,
2139
+ _request_auth=_request_auth
2140
+ )
2141
+
2142
+
2143
+
2144
+
2145
+ @validate_call
2146
+ async def get_protocols(
2147
+ self,
2148
+ protocol_name: StrictStr,
2149
+ _request_timeout: Union[
2150
+ None,
2151
+ Annotated[StrictFloat, Field(gt=0)],
2152
+ Tuple[
2153
+ Annotated[StrictFloat, Field(gt=0)],
2154
+ Annotated[StrictFloat, Field(gt=0)]
2155
+ ]
2156
+ ] = None,
2157
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2158
+ _content_type: Optional[StrictStr] = None,
2159
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2160
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2161
+ ) -> object:
2162
+ """Get Protocols
2163
+
2164
+ ## Protocols Return Protocols metadata.
2165
+
2166
+ :param protocol_name: (required)
2167
+ :type protocol_name: str
2168
+ :param _request_timeout: timeout setting for this request. If one
2169
+ number provided, it will be total request
2170
+ timeout. It can also be a pair (tuple) of
2171
+ (connection, read) timeouts.
2172
+ :type _request_timeout: int, tuple(int, int), optional
2173
+ :param _request_auth: set to override the auth_settings for an a single
2174
+ request; this effectively ignores the
2175
+ authentication in the spec for a single request.
2176
+ :type _request_auth: dict, optional
2177
+ :param _content_type: force content-type for the request.
2178
+ :type _content_type: str, Optional
2179
+ :param _headers: set to override the headers for a single
2180
+ request; this effectively ignores the headers
2181
+ in the spec for a single request.
2182
+ :type _headers: dict, optional
2183
+ :param _host_index: set to override the host_index for a single
2184
+ request; this effectively ignores the host_index
2185
+ in the spec for a single request.
2186
+ :type _host_index: int, optional
2187
+ :return: Returns the result object.
2188
+ """ # noqa: E501
2189
+
2190
+ _param = self._get_protocols_serialize(
2191
+ protocol_name=protocol_name,
2192
+ _request_auth=_request_auth,
2193
+ _content_type=_content_type,
2194
+ _headers=_headers,
2195
+ _host_index=_host_index
2196
+ )
2197
+
2198
+ _response_types_map: Dict[str, Optional[str]] = {
2199
+ '200': "object",
2200
+ '422': "HTTPValidationError",
2201
+ }
2202
+ response_data = await self.api_client.call_api(
2203
+ *_param,
2204
+ _request_timeout=_request_timeout
2205
+ )
2206
+ await response_data.read()
2207
+ return self.api_client.response_deserialize(
2208
+ response_data=response_data,
2209
+ response_types_map=_response_types_map,
2210
+ ).data
2211
+
2212
+
2213
+ @validate_call
2214
+ async def get_protocols_with_http_info(
2215
+ self,
2216
+ protocol_name: StrictStr,
2217
+ _request_timeout: Union[
2218
+ None,
2219
+ Annotated[StrictFloat, Field(gt=0)],
2220
+ Tuple[
2221
+ Annotated[StrictFloat, Field(gt=0)],
2222
+ Annotated[StrictFloat, Field(gt=0)]
2223
+ ]
2224
+ ] = None,
2225
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2226
+ _content_type: Optional[StrictStr] = None,
2227
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2228
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2229
+ ) -> ApiResponse[object]:
2230
+ """Get Protocols
2231
+
2232
+ ## Protocols Return Protocols metadata.
2233
+
2234
+ :param protocol_name: (required)
2235
+ :type protocol_name: str
2236
+ :param _request_timeout: timeout setting for this request. If one
2237
+ number provided, it will be total request
2238
+ timeout. It can also be a pair (tuple) of
2239
+ (connection, read) timeouts.
2240
+ :type _request_timeout: int, tuple(int, int), optional
2241
+ :param _request_auth: set to override the auth_settings for an a single
2242
+ request; this effectively ignores the
2243
+ authentication in the spec for a single request.
2244
+ :type _request_auth: dict, optional
2245
+ :param _content_type: force content-type for the request.
2246
+ :type _content_type: str, Optional
2247
+ :param _headers: set to override the headers for a single
2248
+ request; this effectively ignores the headers
2249
+ in the spec for a single request.
2250
+ :type _headers: dict, optional
2251
+ :param _host_index: set to override the host_index for a single
2252
+ request; this effectively ignores the host_index
2253
+ in the spec for a single request.
2254
+ :type _host_index: int, optional
2255
+ :return: Returns the result object.
2256
+ """ # noqa: E501
2257
+
2258
+ _param = self._get_protocols_serialize(
2259
+ protocol_name=protocol_name,
2260
+ _request_auth=_request_auth,
2261
+ _content_type=_content_type,
2262
+ _headers=_headers,
2263
+ _host_index=_host_index
2264
+ )
2265
+
2266
+ _response_types_map: Dict[str, Optional[str]] = {
2267
+ '200': "object",
2268
+ '422': "HTTPValidationError",
2269
+ }
2270
+ response_data = await self.api_client.call_api(
2271
+ *_param,
2272
+ _request_timeout=_request_timeout
2273
+ )
2274
+ await response_data.read()
2275
+ return self.api_client.response_deserialize(
2276
+ response_data=response_data,
2277
+ response_types_map=_response_types_map,
2278
+ )
2279
+
2280
+
2281
+ @validate_call
2282
+ async def get_protocols_without_preload_content(
2283
+ self,
2284
+ protocol_name: StrictStr,
2285
+ _request_timeout: Union[
2286
+ None,
2287
+ Annotated[StrictFloat, Field(gt=0)],
2288
+ Tuple[
2289
+ Annotated[StrictFloat, Field(gt=0)],
2290
+ Annotated[StrictFloat, Field(gt=0)]
2291
+ ]
2292
+ ] = None,
2293
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2294
+ _content_type: Optional[StrictStr] = None,
2295
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2296
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2297
+ ) -> RESTResponseType:
2298
+ """Get Protocols
2299
+
2300
+ ## Protocols Return Protocols metadata.
2301
+
2302
+ :param protocol_name: (required)
2303
+ :type protocol_name: str
2304
+ :param _request_timeout: timeout setting for this request. If one
2305
+ number provided, it will be total request
2306
+ timeout. It can also be a pair (tuple) of
2307
+ (connection, read) timeouts.
2308
+ :type _request_timeout: int, tuple(int, int), optional
2309
+ :param _request_auth: set to override the auth_settings for an a single
2310
+ request; this effectively ignores the
2311
+ authentication in the spec for a single request.
2312
+ :type _request_auth: dict, optional
2313
+ :param _content_type: force content-type for the request.
2314
+ :type _content_type: str, Optional
2315
+ :param _headers: set to override the headers for a single
2316
+ request; this effectively ignores the headers
2317
+ in the spec for a single request.
2318
+ :type _headers: dict, optional
2319
+ :param _host_index: set to override the host_index for a single
2320
+ request; this effectively ignores the host_index
2321
+ in the spec for a single request.
2322
+ :type _host_index: int, optional
2323
+ :return: Returns the result object.
2324
+ """ # noqa: E501
2325
+
2326
+ _param = self._get_protocols_serialize(
2327
+ protocol_name=protocol_name,
2328
+ _request_auth=_request_auth,
2329
+ _content_type=_content_type,
2330
+ _headers=_headers,
2331
+ _host_index=_host_index
2332
+ )
2333
+
2334
+ _response_types_map: Dict[str, Optional[str]] = {
2335
+ '200': "object",
2336
+ '422': "HTTPValidationError",
2337
+ }
2338
+ response_data = await self.api_client.call_api(
2339
+ *_param,
2340
+ _request_timeout=_request_timeout
2341
+ )
2342
+ return response_data.response
2343
+
2344
+
2345
+ def _get_protocols_serialize(
2346
+ self,
2347
+ protocol_name,
2348
+ _request_auth,
2349
+ _content_type,
2350
+ _headers,
2351
+ _host_index,
2352
+ ) -> RequestSerialized:
2353
+
2354
+ _host = None
2355
+
2356
+ _collection_formats: Dict[str, str] = {
2357
+ }
2358
+
2359
+ _path_params: Dict[str, str] = {}
2360
+ _query_params: List[Tuple[str, str]] = []
2361
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2362
+ _form_params: List[Tuple[str, str]] = []
2363
+ _files: Dict[
2364
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2365
+ ] = {}
2366
+ _body_params: Optional[bytes] = None
2367
+
2368
+ # process the path parameters
2369
+ if protocol_name is not None:
2370
+ _path_params['protocol_name'] = protocol_name
2371
+ # process the query parameters
2372
+ # process the header parameters
2373
+ # process the form parameters
2374
+ # process the body parameter
2375
+
2376
+
2377
+ # set the HTTP header `Accept`
2378
+ if 'Accept' not in _header_params:
2379
+ _header_params['Accept'] = self.api_client.select_header_accept(
2380
+ [
2381
+ 'application/json'
2382
+ ]
2383
+ )
2384
+
2385
+
2386
+ # authentication setting
2387
+ _auth_settings: List[str] = [
2388
+ ]
2389
+
2390
+ return self.api_client.param_serialize(
2391
+ method='GET',
2392
+ resource_path='/api/v2/protocols/{protocol_name}',
2393
+ path_params=_path_params,
2394
+ query_params=_query_params,
2395
+ header_params=_header_params,
2396
+ body=_body_params,
2397
+ post_params=_form_params,
2398
+ files=_files,
2399
+ auth_settings=_auth_settings,
2400
+ collection_formats=_collection_formats,
2401
+ _host=_host,
2402
+ _request_auth=_request_auth
2403
+ )
2404
+
2405
+
2406
+
2407
+
2408
+ @validate_call
2409
+ async def get_rig(
2410
+ self,
2411
+ rig_id: StrictStr,
2412
+ partial_match: Optional[StrictBool] = None,
2413
+ _request_timeout: Union[
2414
+ None,
2415
+ Annotated[StrictFloat, Field(gt=0)],
2416
+ Tuple[
2417
+ Annotated[StrictFloat, Field(gt=0)],
2418
+ Annotated[StrictFloat, Field(gt=0)]
2419
+ ]
2420
+ ] = None,
2421
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2422
+ _content_type: Optional[StrictStr] = None,
2423
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2424
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2425
+ ) -> object:
2426
+ """Get Rig
2427
+
2428
+ ## Rig Return a Rig.
2429
+
2430
+ :param rig_id: (required)
2431
+ :type rig_id: str
2432
+ :param partial_match:
2433
+ :type partial_match: bool
2434
+ :param _request_timeout: timeout setting for this request. If one
2435
+ number provided, it will be total request
2436
+ timeout. It can also be a pair (tuple) of
2437
+ (connection, read) timeouts.
2438
+ :type _request_timeout: int, tuple(int, int), optional
2439
+ :param _request_auth: set to override the auth_settings for an a single
2440
+ request; this effectively ignores the
2441
+ authentication in the spec for a single request.
2442
+ :type _request_auth: dict, optional
2443
+ :param _content_type: force content-type for the request.
2444
+ :type _content_type: str, Optional
2445
+ :param _headers: set to override the headers for a single
2446
+ request; this effectively ignores the headers
2447
+ in the spec for a single request.
2448
+ :type _headers: dict, optional
2449
+ :param _host_index: set to override the host_index for a single
2450
+ request; this effectively ignores the host_index
2451
+ in the spec for a single request.
2452
+ :type _host_index: int, optional
2453
+ :return: Returns the result object.
2454
+ """ # noqa: E501
2455
+
2456
+ _param = self._get_rig_serialize(
2457
+ rig_id=rig_id,
2458
+ partial_match=partial_match,
2459
+ _request_auth=_request_auth,
2460
+ _content_type=_content_type,
2461
+ _headers=_headers,
2462
+ _host_index=_host_index
2463
+ )
2464
+
2465
+ _response_types_map: Dict[str, Optional[str]] = {
2466
+ '200': "object",
2467
+ '422': "HTTPValidationError",
2468
+ }
2469
+ response_data = await self.api_client.call_api(
2470
+ *_param,
2471
+ _request_timeout=_request_timeout
2472
+ )
2473
+ await response_data.read()
2474
+ return self.api_client.response_deserialize(
2475
+ response_data=response_data,
2476
+ response_types_map=_response_types_map,
2477
+ ).data
2478
+
2479
+
2480
+ @validate_call
2481
+ async def get_rig_with_http_info(
2482
+ self,
2483
+ rig_id: StrictStr,
2484
+ partial_match: Optional[StrictBool] = None,
2485
+ _request_timeout: Union[
2486
+ None,
2487
+ Annotated[StrictFloat, Field(gt=0)],
2488
+ Tuple[
2489
+ Annotated[StrictFloat, Field(gt=0)],
2490
+ Annotated[StrictFloat, Field(gt=0)]
2491
+ ]
2492
+ ] = None,
2493
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2494
+ _content_type: Optional[StrictStr] = None,
2495
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2496
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2497
+ ) -> ApiResponse[object]:
2498
+ """Get Rig
2499
+
2500
+ ## Rig Return a Rig.
2501
+
2502
+ :param rig_id: (required)
2503
+ :type rig_id: str
2504
+ :param partial_match:
2505
+ :type partial_match: bool
2506
+ :param _request_timeout: timeout setting for this request. If one
2507
+ number provided, it will be total request
2508
+ timeout. It can also be a pair (tuple) of
2509
+ (connection, read) timeouts.
2510
+ :type _request_timeout: int, tuple(int, int), optional
2511
+ :param _request_auth: set to override the auth_settings for an a single
2512
+ request; this effectively ignores the
2513
+ authentication in the spec for a single request.
2514
+ :type _request_auth: dict, optional
2515
+ :param _content_type: force content-type for the request.
2516
+ :type _content_type: str, Optional
2517
+ :param _headers: set to override the headers for a single
2518
+ request; this effectively ignores the headers
2519
+ in the spec for a single request.
2520
+ :type _headers: dict, optional
2521
+ :param _host_index: set to override the host_index for a single
2522
+ request; this effectively ignores the host_index
2523
+ in the spec for a single request.
2524
+ :type _host_index: int, optional
2525
+ :return: Returns the result object.
2526
+ """ # noqa: E501
2527
+
2528
+ _param = self._get_rig_serialize(
2529
+ rig_id=rig_id,
2530
+ partial_match=partial_match,
2531
+ _request_auth=_request_auth,
2532
+ _content_type=_content_type,
2533
+ _headers=_headers,
2534
+ _host_index=_host_index
2535
+ )
2536
+
2537
+ _response_types_map: Dict[str, Optional[str]] = {
2538
+ '200': "object",
2539
+ '422': "HTTPValidationError",
2540
+ }
2541
+ response_data = await self.api_client.call_api(
2542
+ *_param,
2543
+ _request_timeout=_request_timeout
2544
+ )
2545
+ await response_data.read()
2546
+ return self.api_client.response_deserialize(
2547
+ response_data=response_data,
2548
+ response_types_map=_response_types_map,
2549
+ )
2550
+
2551
+
2552
+ @validate_call
2553
+ async def get_rig_without_preload_content(
2554
+ self,
2555
+ rig_id: StrictStr,
2556
+ partial_match: Optional[StrictBool] = None,
2557
+ _request_timeout: Union[
2558
+ None,
2559
+ Annotated[StrictFloat, Field(gt=0)],
2560
+ Tuple[
2561
+ Annotated[StrictFloat, Field(gt=0)],
2562
+ Annotated[StrictFloat, Field(gt=0)]
2563
+ ]
2564
+ ] = None,
2565
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2566
+ _content_type: Optional[StrictStr] = None,
2567
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2568
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2569
+ ) -> RESTResponseType:
2570
+ """Get Rig
2571
+
2572
+ ## Rig Return a Rig.
2573
+
2574
+ :param rig_id: (required)
2575
+ :type rig_id: str
2576
+ :param partial_match:
2577
+ :type partial_match: bool
2578
+ :param _request_timeout: timeout setting for this request. If one
2579
+ number provided, it will be total request
2580
+ timeout. It can also be a pair (tuple) of
2581
+ (connection, read) timeouts.
2582
+ :type _request_timeout: int, tuple(int, int), optional
2583
+ :param _request_auth: set to override the auth_settings for an a single
2584
+ request; this effectively ignores the
2585
+ authentication in the spec for a single request.
2586
+ :type _request_auth: dict, optional
2587
+ :param _content_type: force content-type for the request.
2588
+ :type _content_type: str, Optional
2589
+ :param _headers: set to override the headers for a single
2590
+ request; this effectively ignores the headers
2591
+ in the spec for a single request.
2592
+ :type _headers: dict, optional
2593
+ :param _host_index: set to override the host_index for a single
2594
+ request; this effectively ignores the host_index
2595
+ in the spec for a single request.
2596
+ :type _host_index: int, optional
2597
+ :return: Returns the result object.
2598
+ """ # noqa: E501
2599
+
2600
+ _param = self._get_rig_serialize(
2601
+ rig_id=rig_id,
2602
+ partial_match=partial_match,
2603
+ _request_auth=_request_auth,
2604
+ _content_type=_content_type,
2605
+ _headers=_headers,
2606
+ _host_index=_host_index
2607
+ )
2608
+
2609
+ _response_types_map: Dict[str, Optional[str]] = {
2610
+ '200': "object",
2611
+ '422': "HTTPValidationError",
2612
+ }
2613
+ response_data = await self.api_client.call_api(
2614
+ *_param,
2615
+ _request_timeout=_request_timeout
2616
+ )
2617
+ return response_data.response
2618
+
2619
+
2620
+ def _get_rig_serialize(
2621
+ self,
2622
+ rig_id,
2623
+ partial_match,
2624
+ _request_auth,
2625
+ _content_type,
2626
+ _headers,
2627
+ _host_index,
2628
+ ) -> RequestSerialized:
2629
+
2630
+ _host = None
2631
+
2632
+ _collection_formats: Dict[str, str] = {
2633
+ }
2634
+
2635
+ _path_params: Dict[str, str] = {}
2636
+ _query_params: List[Tuple[str, str]] = []
2637
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2638
+ _form_params: List[Tuple[str, str]] = []
2639
+ _files: Dict[
2640
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2641
+ ] = {}
2642
+ _body_params: Optional[bytes] = None
2643
+
2644
+ # process the path parameters
2645
+ if rig_id is not None:
2646
+ _path_params['rig_id'] = rig_id
2647
+ # process the query parameters
2648
+ if partial_match is not None:
2649
+
2650
+ _query_params.append(('partial_match', partial_match))
2651
+
2652
+ # process the header parameters
2653
+ # process the form parameters
2654
+ # process the body parameter
2655
+
2656
+
2657
+ # set the HTTP header `Accept`
2658
+ if 'Accept' not in _header_params:
2659
+ _header_params['Accept'] = self.api_client.select_header_accept(
2660
+ [
2661
+ 'application/json'
2662
+ ]
2663
+ )
2664
+
2665
+
2666
+ # authentication setting
2667
+ _auth_settings: List[str] = [
2668
+ ]
2669
+
2670
+ return self.api_client.param_serialize(
2671
+ method='GET',
2672
+ resource_path='/api/v2/rig/{rig_id}',
2673
+ path_params=_path_params,
2674
+ query_params=_query_params,
2675
+ header_params=_header_params,
2676
+ body=_body_params,
2677
+ post_params=_form_params,
2678
+ files=_files,
2679
+ auth_settings=_auth_settings,
2680
+ collection_formats=_collection_formats,
2681
+ _host=_host,
2682
+ _request_auth=_request_auth
2683
+ )
2684
+
2685
+
2686
+
2687
+
2688
+ @validate_call
2689
+ async def get_slims_workflow(
2690
+ self,
2691
+ workflow: Annotated[AindMetadataServiceServerRoutesSlimsSlimsWorkflow, Field(description="The SLIMS workflow to query.")],
2692
+ subject_id: Annotated[Optional[StrictStr], Field(description="Subject ID to filter the data.")] = None,
2693
+ session_name: Annotated[Optional[StrictStr], Field(description="Name of the session (only for ecephys sessions).")] = None,
2694
+ start_date_gte: Annotated[Optional[StrictStr], Field(description="Experiment run created on or after. (ISO format)")] = None,
2695
+ end_date_lte: Annotated[Optional[StrictStr], Field(description="Experiment run created on or before. (ISO format)")] = None,
46
2696
  _request_timeout: Union[
47
2697
  None,
48
2698
  Annotated[StrictFloat, Field(gt=0)],
@@ -56,12 +2706,20 @@ class DefaultApi:
56
2706
  _headers: Optional[Dict[StrictStr, Any]] = None,
57
2707
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
58
2708
  ) -> object:
59
- """Get Procedures
2709
+ """Get Slims Workflow
60
2710
 
61
- ## Procedures Return Procedure metadata.
2711
+ ## SLIMS Return information from SLIMS.
62
2712
 
63
- :param subject_id: (required)
2713
+ :param workflow: The SLIMS workflow to query. (required)
2714
+ :type workflow: AindMetadataServiceServerRoutesSlimsSlimsWorkflow
2715
+ :param subject_id: Subject ID to filter the data.
64
2716
  :type subject_id: str
2717
+ :param session_name: Name of the session (only for ecephys sessions).
2718
+ :type session_name: str
2719
+ :param start_date_gte: Experiment run created on or after. (ISO format)
2720
+ :type start_date_gte: str
2721
+ :param end_date_lte: Experiment run created on or before. (ISO format)
2722
+ :type end_date_lte: str
65
2723
  :param _request_timeout: timeout setting for this request. If one
66
2724
  number provided, it will be total request
67
2725
  timeout. It can also be a pair (tuple) of
@@ -84,8 +2742,12 @@ class DefaultApi:
84
2742
  :return: Returns the result object.
85
2743
  """ # noqa: E501
86
2744
 
87
- _param = self._get_procedures_serialize(
2745
+ _param = self._get_slims_workflow_serialize(
2746
+ workflow=workflow,
88
2747
  subject_id=subject_id,
2748
+ session_name=session_name,
2749
+ start_date_gte=start_date_gte,
2750
+ end_date_lte=end_date_lte,
89
2751
  _request_auth=_request_auth,
90
2752
  _content_type=_content_type,
91
2753
  _headers=_headers,
@@ -108,9 +2770,13 @@ class DefaultApi:
108
2770
 
109
2771
 
110
2772
  @validate_call
111
- async def get_procedures_with_http_info(
2773
+ async def get_slims_workflow_with_http_info(
112
2774
  self,
113
- subject_id: StrictStr,
2775
+ workflow: Annotated[AindMetadataServiceServerRoutesSlimsSlimsWorkflow, Field(description="The SLIMS workflow to query.")],
2776
+ subject_id: Annotated[Optional[StrictStr], Field(description="Subject ID to filter the data.")] = None,
2777
+ session_name: Annotated[Optional[StrictStr], Field(description="Name of the session (only for ecephys sessions).")] = None,
2778
+ start_date_gte: Annotated[Optional[StrictStr], Field(description="Experiment run created on or after. (ISO format)")] = None,
2779
+ end_date_lte: Annotated[Optional[StrictStr], Field(description="Experiment run created on or before. (ISO format)")] = None,
114
2780
  _request_timeout: Union[
115
2781
  None,
116
2782
  Annotated[StrictFloat, Field(gt=0)],
@@ -124,12 +2790,20 @@ class DefaultApi:
124
2790
  _headers: Optional[Dict[StrictStr, Any]] = None,
125
2791
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
126
2792
  ) -> ApiResponse[object]:
127
- """Get Procedures
2793
+ """Get Slims Workflow
128
2794
 
129
- ## Procedures Return Procedure metadata.
2795
+ ## SLIMS Return information from SLIMS.
130
2796
 
131
- :param subject_id: (required)
2797
+ :param workflow: The SLIMS workflow to query. (required)
2798
+ :type workflow: AindMetadataServiceServerRoutesSlimsSlimsWorkflow
2799
+ :param subject_id: Subject ID to filter the data.
132
2800
  :type subject_id: str
2801
+ :param session_name: Name of the session (only for ecephys sessions).
2802
+ :type session_name: str
2803
+ :param start_date_gte: Experiment run created on or after. (ISO format)
2804
+ :type start_date_gte: str
2805
+ :param end_date_lte: Experiment run created on or before. (ISO format)
2806
+ :type end_date_lte: str
133
2807
  :param _request_timeout: timeout setting for this request. If one
134
2808
  number provided, it will be total request
135
2809
  timeout. It can also be a pair (tuple) of
@@ -152,8 +2826,12 @@ class DefaultApi:
152
2826
  :return: Returns the result object.
153
2827
  """ # noqa: E501
154
2828
 
155
- _param = self._get_procedures_serialize(
2829
+ _param = self._get_slims_workflow_serialize(
2830
+ workflow=workflow,
156
2831
  subject_id=subject_id,
2832
+ session_name=session_name,
2833
+ start_date_gte=start_date_gte,
2834
+ end_date_lte=end_date_lte,
157
2835
  _request_auth=_request_auth,
158
2836
  _content_type=_content_type,
159
2837
  _headers=_headers,
@@ -176,9 +2854,13 @@ class DefaultApi:
176
2854
 
177
2855
 
178
2856
  @validate_call
179
- async def get_procedures_without_preload_content(
2857
+ async def get_slims_workflow_without_preload_content(
180
2858
  self,
181
- subject_id: StrictStr,
2859
+ workflow: Annotated[AindMetadataServiceServerRoutesSlimsSlimsWorkflow, Field(description="The SLIMS workflow to query.")],
2860
+ subject_id: Annotated[Optional[StrictStr], Field(description="Subject ID to filter the data.")] = None,
2861
+ session_name: Annotated[Optional[StrictStr], Field(description="Name of the session (only for ecephys sessions).")] = None,
2862
+ start_date_gte: Annotated[Optional[StrictStr], Field(description="Experiment run created on or after. (ISO format)")] = None,
2863
+ end_date_lte: Annotated[Optional[StrictStr], Field(description="Experiment run created on or before. (ISO format)")] = None,
182
2864
  _request_timeout: Union[
183
2865
  None,
184
2866
  Annotated[StrictFloat, Field(gt=0)],
@@ -192,12 +2874,20 @@ class DefaultApi:
192
2874
  _headers: Optional[Dict[StrictStr, Any]] = None,
193
2875
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
194
2876
  ) -> RESTResponseType:
195
- """Get Procedures
2877
+ """Get Slims Workflow
196
2878
 
197
- ## Procedures Return Procedure metadata.
2879
+ ## SLIMS Return information from SLIMS.
198
2880
 
199
- :param subject_id: (required)
2881
+ :param workflow: The SLIMS workflow to query. (required)
2882
+ :type workflow: AindMetadataServiceServerRoutesSlimsSlimsWorkflow
2883
+ :param subject_id: Subject ID to filter the data.
200
2884
  :type subject_id: str
2885
+ :param session_name: Name of the session (only for ecephys sessions).
2886
+ :type session_name: str
2887
+ :param start_date_gte: Experiment run created on or after. (ISO format)
2888
+ :type start_date_gte: str
2889
+ :param end_date_lte: Experiment run created on or before. (ISO format)
2890
+ :type end_date_lte: str
201
2891
  :param _request_timeout: timeout setting for this request. If one
202
2892
  number provided, it will be total request
203
2893
  timeout. It can also be a pair (tuple) of
@@ -220,8 +2910,12 @@ class DefaultApi:
220
2910
  :return: Returns the result object.
221
2911
  """ # noqa: E501
222
2912
 
223
- _param = self._get_procedures_serialize(
2913
+ _param = self._get_slims_workflow_serialize(
2914
+ workflow=workflow,
224
2915
  subject_id=subject_id,
2916
+ session_name=session_name,
2917
+ start_date_gte=start_date_gte,
2918
+ end_date_lte=end_date_lte,
225
2919
  _request_auth=_request_auth,
226
2920
  _content_type=_content_type,
227
2921
  _headers=_headers,
@@ -239,9 +2933,13 @@ class DefaultApi:
239
2933
  return response_data.response
240
2934
 
241
2935
 
242
- def _get_procedures_serialize(
2936
+ def _get_slims_workflow_serialize(
243
2937
  self,
2938
+ workflow,
244
2939
  subject_id,
2940
+ session_name,
2941
+ start_date_gte,
2942
+ end_date_lte,
245
2943
  _request_auth,
246
2944
  _content_type,
247
2945
  _headers,
@@ -263,9 +2961,25 @@ class DefaultApi:
263
2961
  _body_params: Optional[bytes] = None
264
2962
 
265
2963
  # process the path parameters
266
- if subject_id is not None:
267
- _path_params['subject_id'] = subject_id
2964
+ if workflow is not None:
2965
+ _path_params['workflow'] = workflow.value
268
2966
  # process the query parameters
2967
+ if subject_id is not None:
2968
+
2969
+ _query_params.append(('subject_id', subject_id))
2970
+
2971
+ if session_name is not None:
2972
+
2973
+ _query_params.append(('session_name', session_name))
2974
+
2975
+ if start_date_gte is not None:
2976
+
2977
+ _query_params.append(('start_date_gte', start_date_gte))
2978
+
2979
+ if end_date_lte is not None:
2980
+
2981
+ _query_params.append(('end_date_lte', end_date_lte))
2982
+
269
2983
  # process the header parameters
270
2984
  # process the form parameters
271
2985
  # process the body parameter
@@ -286,7 +3000,7 @@ class DefaultApi:
286
3000
 
287
3001
  return self.api_client.param_serialize(
288
3002
  method='GET',
289
- resource_path='/api/v2/procedures/{subject_id}',
3003
+ resource_path='/api/v2/slims/{workflow}',
290
3004
  path_params=_path_params,
291
3005
  query_params=_query_params,
292
3006
  header_params=_header_params,
@@ -3490,7 +6204,7 @@ class DefaultApi:
3490
6204
  @validate_call
3491
6205
  async def get_v1_slims_workflow(
3492
6206
  self,
3493
- workflow: Annotated[SlimsWorkflow, Field(description="The SLIMS workflow to query.")],
6207
+ workflow: Annotated[AindMetadataServiceServerRoutesSlimsSlimsWorkflow, Field(description="The SLIMS workflow to query.")],
3494
6208
  subject_id: Annotated[Optional[StrictStr], Field(description="Subject ID to filter the data.")] = None,
3495
6209
  session_name: Annotated[Optional[StrictStr], Field(description="Name of the session (only for ecephys sessions).")] = None,
3496
6210
  start_date_gte: Annotated[Optional[StrictStr], Field(description="Experiment run created on or after. (ISO format)")] = None,
@@ -3513,7 +6227,7 @@ class DefaultApi:
3513
6227
  ## SLIMS V1 Return information from SLIMS.
3514
6228
 
3515
6229
  :param workflow: The SLIMS workflow to query. (required)
3516
- :type workflow: SlimsWorkflow
6230
+ :type workflow: AindMetadataServiceServerRoutesSlimsSlimsWorkflow
3517
6231
  :param subject_id: Subject ID to filter the data.
3518
6232
  :type subject_id: str
3519
6233
  :param session_name: Name of the session (only for ecephys sessions).
@@ -3574,7 +6288,7 @@ class DefaultApi:
3574
6288
  @validate_call
3575
6289
  async def get_v1_slims_workflow_with_http_info(
3576
6290
  self,
3577
- workflow: Annotated[SlimsWorkflow, Field(description="The SLIMS workflow to query.")],
6291
+ workflow: Annotated[AindMetadataServiceServerRoutesSlimsSlimsWorkflow, Field(description="The SLIMS workflow to query.")],
3578
6292
  subject_id: Annotated[Optional[StrictStr], Field(description="Subject ID to filter the data.")] = None,
3579
6293
  session_name: Annotated[Optional[StrictStr], Field(description="Name of the session (only for ecephys sessions).")] = None,
3580
6294
  start_date_gte: Annotated[Optional[StrictStr], Field(description="Experiment run created on or after. (ISO format)")] = None,
@@ -3597,7 +6311,7 @@ class DefaultApi:
3597
6311
  ## SLIMS V1 Return information from SLIMS.
3598
6312
 
3599
6313
  :param workflow: The SLIMS workflow to query. (required)
3600
- :type workflow: SlimsWorkflow
6314
+ :type workflow: AindMetadataServiceServerRoutesSlimsSlimsWorkflow
3601
6315
  :param subject_id: Subject ID to filter the data.
3602
6316
  :type subject_id: str
3603
6317
  :param session_name: Name of the session (only for ecephys sessions).
@@ -3658,7 +6372,7 @@ class DefaultApi:
3658
6372
  @validate_call
3659
6373
  async def get_v1_slims_workflow_without_preload_content(
3660
6374
  self,
3661
- workflow: Annotated[SlimsWorkflow, Field(description="The SLIMS workflow to query.")],
6375
+ workflow: Annotated[AindMetadataServiceServerRoutesSlimsSlimsWorkflow, Field(description="The SLIMS workflow to query.")],
3662
6376
  subject_id: Annotated[Optional[StrictStr], Field(description="Subject ID to filter the data.")] = None,
3663
6377
  session_name: Annotated[Optional[StrictStr], Field(description="Name of the session (only for ecephys sessions).")] = None,
3664
6378
  start_date_gte: Annotated[Optional[StrictStr], Field(description="Experiment run created on or after. (ISO format)")] = None,
@@ -3681,7 +6395,7 @@ class DefaultApi:
3681
6395
  ## SLIMS V1 Return information from SLIMS.
3682
6396
 
3683
6397
  :param workflow: The SLIMS workflow to query. (required)
3684
- :type workflow: SlimsWorkflow
6398
+ :type workflow: AindMetadataServiceServerRoutesSlimsSlimsWorkflow
3685
6399
  :param subject_id: Subject ID to filter the data.
3686
6400
  :type subject_id: str
3687
6401
  :param session_name: Name of the session (only for ecephys sessions).