rapidata 2.22.0__py3-none-any.whl → 2.23.1__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 rapidata might be problematic. Click here for more details.

@@ -1,2480 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- Rapidata.Dataset
5
-
6
- No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
-
8
- The version of the OpenAPI document: v1
9
- Generated by OpenAPI Generator (https://openapi-generator.tech)
10
-
11
- Do not edit the class manually.
12
- """ # noqa: E501
13
-
14
- import warnings
15
- from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
16
- from typing import Any, Dict, List, Optional, Tuple, Union
17
- from typing_extensions import Annotated
18
-
19
- from pydantic import Field, StrictBytes, StrictStr
20
- from typing import List, Optional, Tuple, Union
21
- from typing_extensions import Annotated
22
- from rapidata.api_client.models.add_validation_rapid_model import AddValidationRapidModel
23
- from rapidata.api_client.models.add_validation_rapid_result import AddValidationRapidResult
24
- from rapidata.api_client.models.add_validation_text_rapid_model import AddValidationTextRapidModel
25
- from rapidata.api_client.models.create_empty_validation_set_result import CreateEmptyValidationSetResult
26
- from rapidata.api_client.models.get_available_validation_sets_result import GetAvailableValidationSetsResult
27
- from rapidata.api_client.models.get_validation_set_by_id_result import GetValidationSetByIdResult
28
- from rapidata.api_client.models.import_validation_set_from_file_result import ImportValidationSetFromFileResult
29
- from rapidata.api_client.models.query_model import QueryModel
30
- from rapidata.api_client.models.update_dimensions_model import UpdateDimensionsModel
31
- from rapidata.api_client.models.validation_import_post_request_blueprint import ValidationImportPostRequestBlueprint
32
- from rapidata.api_client.models.validation_set_model_paged_result import ValidationSetModelPagedResult
33
-
34
- from rapidata.api_client.api_client import ApiClient, RequestSerialized
35
- from rapidata.api_client.api_response import ApiResponse
36
- from rapidata.api_client.rest import RESTResponseType
37
-
38
-
39
- class ValidationApi:
40
- """NOTE: This class is auto generated by OpenAPI Generator
41
- Ref: https://openapi-generator.tech
42
-
43
- Do not edit the class manually.
44
- """
45
-
46
- def __init__(self, api_client=None) -> None:
47
- if api_client is None:
48
- api_client = ApiClient.get_default()
49
- self.api_client = api_client
50
-
51
-
52
- @validate_call
53
- def validation_add_validation_rapid_post(
54
- self,
55
- model: Optional[AddValidationRapidModel] = None,
56
- files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
57
- _request_timeout: Union[
58
- None,
59
- Annotated[StrictFloat, Field(gt=0)],
60
- Tuple[
61
- Annotated[StrictFloat, Field(gt=0)],
62
- Annotated[StrictFloat, Field(gt=0)]
63
- ]
64
- ] = None,
65
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
66
- _content_type: Optional[StrictStr] = None,
67
- _headers: Optional[Dict[StrictStr, Any]] = None,
68
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
69
- ) -> AddValidationRapidResult:
70
- """Adds a new validation rapid to the specified validation set.
71
-
72
-
73
- :param model:
74
- :type model: AddValidationRapidModel
75
- :param files:
76
- :type files: List[bytearray]
77
- :param _request_timeout: timeout setting for this request. If one
78
- number provided, it will be total request
79
- timeout. It can also be a pair (tuple) of
80
- (connection, read) timeouts.
81
- :type _request_timeout: int, tuple(int, int), optional
82
- :param _request_auth: set to override the auth_settings for an a single
83
- request; this effectively ignores the
84
- authentication in the spec for a single request.
85
- :type _request_auth: dict, optional
86
- :param _content_type: force content-type for the request.
87
- :type _content_type: str, Optional
88
- :param _headers: set to override the headers for a single
89
- request; this effectively ignores the headers
90
- in the spec for a single request.
91
- :type _headers: dict, optional
92
- :param _host_index: set to override the host_index for a single
93
- request; this effectively ignores the host_index
94
- in the spec for a single request.
95
- :type _host_index: int, optional
96
- :return: Returns the result object.
97
- """ # noqa: E501
98
-
99
- _param = self._validation_add_validation_rapid_post_serialize(
100
- model=model,
101
- files=files,
102
- _request_auth=_request_auth,
103
- _content_type=_content_type,
104
- _headers=_headers,
105
- _host_index=_host_index
106
- )
107
-
108
- _response_types_map: Dict[str, Optional[str]] = {
109
- '200': "AddValidationRapidResult",
110
- }
111
- response_data = self.api_client.call_api(
112
- *_param,
113
- _request_timeout=_request_timeout
114
- )
115
- response_data.read()
116
- return self.api_client.response_deserialize(
117
- response_data=response_data,
118
- response_types_map=_response_types_map,
119
- ).data
120
-
121
-
122
- @validate_call
123
- def validation_add_validation_rapid_post_with_http_info(
124
- self,
125
- model: Optional[AddValidationRapidModel] = None,
126
- files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
127
- _request_timeout: Union[
128
- None,
129
- Annotated[StrictFloat, Field(gt=0)],
130
- Tuple[
131
- Annotated[StrictFloat, Field(gt=0)],
132
- Annotated[StrictFloat, Field(gt=0)]
133
- ]
134
- ] = None,
135
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
136
- _content_type: Optional[StrictStr] = None,
137
- _headers: Optional[Dict[StrictStr, Any]] = None,
138
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
139
- ) -> ApiResponse[AddValidationRapidResult]:
140
- """Adds a new validation rapid to the specified validation set.
141
-
142
-
143
- :param model:
144
- :type model: AddValidationRapidModel
145
- :param files:
146
- :type files: List[bytearray]
147
- :param _request_timeout: timeout setting for this request. If one
148
- number provided, it will be total request
149
- timeout. It can also be a pair (tuple) of
150
- (connection, read) timeouts.
151
- :type _request_timeout: int, tuple(int, int), optional
152
- :param _request_auth: set to override the auth_settings for an a single
153
- request; this effectively ignores the
154
- authentication in the spec for a single request.
155
- :type _request_auth: dict, optional
156
- :param _content_type: force content-type for the request.
157
- :type _content_type: str, Optional
158
- :param _headers: set to override the headers for a single
159
- request; this effectively ignores the headers
160
- in the spec for a single request.
161
- :type _headers: dict, optional
162
- :param _host_index: set to override the host_index for a single
163
- request; this effectively ignores the host_index
164
- in the spec for a single request.
165
- :type _host_index: int, optional
166
- :return: Returns the result object.
167
- """ # noqa: E501
168
-
169
- _param = self._validation_add_validation_rapid_post_serialize(
170
- model=model,
171
- files=files,
172
- _request_auth=_request_auth,
173
- _content_type=_content_type,
174
- _headers=_headers,
175
- _host_index=_host_index
176
- )
177
-
178
- _response_types_map: Dict[str, Optional[str]] = {
179
- '200': "AddValidationRapidResult",
180
- }
181
- response_data = self.api_client.call_api(
182
- *_param,
183
- _request_timeout=_request_timeout
184
- )
185
- response_data.read()
186
- return self.api_client.response_deserialize(
187
- response_data=response_data,
188
- response_types_map=_response_types_map,
189
- )
190
-
191
-
192
- @validate_call
193
- def validation_add_validation_rapid_post_without_preload_content(
194
- self,
195
- model: Optional[AddValidationRapidModel] = None,
196
- files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
197
- _request_timeout: Union[
198
- None,
199
- Annotated[StrictFloat, Field(gt=0)],
200
- Tuple[
201
- Annotated[StrictFloat, Field(gt=0)],
202
- Annotated[StrictFloat, Field(gt=0)]
203
- ]
204
- ] = None,
205
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
206
- _content_type: Optional[StrictStr] = None,
207
- _headers: Optional[Dict[StrictStr, Any]] = None,
208
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
209
- ) -> RESTResponseType:
210
- """Adds a new validation rapid to the specified validation set.
211
-
212
-
213
- :param model:
214
- :type model: AddValidationRapidModel
215
- :param files:
216
- :type files: List[bytearray]
217
- :param _request_timeout: timeout setting for this request. If one
218
- number provided, it will be total request
219
- timeout. It can also be a pair (tuple) of
220
- (connection, read) timeouts.
221
- :type _request_timeout: int, tuple(int, int), optional
222
- :param _request_auth: set to override the auth_settings for an a single
223
- request; this effectively ignores the
224
- authentication in the spec for a single request.
225
- :type _request_auth: dict, optional
226
- :param _content_type: force content-type for the request.
227
- :type _content_type: str, Optional
228
- :param _headers: set to override the headers for a single
229
- request; this effectively ignores the headers
230
- in the spec for a single request.
231
- :type _headers: dict, optional
232
- :param _host_index: set to override the host_index for a single
233
- request; this effectively ignores the host_index
234
- in the spec for a single request.
235
- :type _host_index: int, optional
236
- :return: Returns the result object.
237
- """ # noqa: E501
238
-
239
- _param = self._validation_add_validation_rapid_post_serialize(
240
- model=model,
241
- files=files,
242
- _request_auth=_request_auth,
243
- _content_type=_content_type,
244
- _headers=_headers,
245
- _host_index=_host_index
246
- )
247
-
248
- _response_types_map: Dict[str, Optional[str]] = {
249
- '200': "AddValidationRapidResult",
250
- }
251
- response_data = self.api_client.call_api(
252
- *_param,
253
- _request_timeout=_request_timeout
254
- )
255
- return response_data.response
256
-
257
-
258
- def _validation_add_validation_rapid_post_serialize(
259
- self,
260
- model,
261
- files,
262
- _request_auth,
263
- _content_type,
264
- _headers,
265
- _host_index,
266
- ) -> RequestSerialized:
267
-
268
- _host = None
269
-
270
- _collection_formats: Dict[str, str] = {
271
- 'files': 'multi',
272
- }
273
-
274
- _path_params: Dict[str, str] = {}
275
- _query_params: List[Tuple[str, str]] = []
276
- _header_params: Dict[str, Optional[str]] = _headers or {}
277
- _form_params: List[Tuple[str, str]] = []
278
- _files: Dict[
279
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
280
- ] = {}
281
- _body_params: Optional[bytes] = None
282
-
283
- # process the path parameters
284
- # process the query parameters
285
- # process the header parameters
286
- # process the form parameters
287
- if model is not None:
288
- _form_params.append(('model', model))
289
- if files is not None:
290
- _files['files'] = files
291
- # process the body parameter
292
-
293
-
294
- # set the HTTP header `Accept`
295
- if 'Accept' not in _header_params:
296
- _header_params['Accept'] = self.api_client.select_header_accept(
297
- [
298
- 'text/plain',
299
- 'application/json',
300
- 'text/json'
301
- ]
302
- )
303
-
304
- # set the HTTP header `Content-Type`
305
- if _content_type:
306
- _header_params['Content-Type'] = _content_type
307
- else:
308
- _default_content_type = (
309
- self.api_client.select_header_content_type(
310
- [
311
- 'multipart/form-data'
312
- ]
313
- )
314
- )
315
- if _default_content_type is not None:
316
- _header_params['Content-Type'] = _default_content_type
317
-
318
- # authentication setting
319
- _auth_settings: List[str] = [
320
- 'bearer',
321
- 'oauth2'
322
- ]
323
-
324
- return self.api_client.param_serialize(
325
- method='POST',
326
- resource_path='/Validation/AddValidationRapid',
327
- path_params=_path_params,
328
- query_params=_query_params,
329
- header_params=_header_params,
330
- body=_body_params,
331
- post_params=_form_params,
332
- files=_files,
333
- auth_settings=_auth_settings,
334
- collection_formats=_collection_formats,
335
- _host=_host,
336
- _request_auth=_request_auth
337
- )
338
-
339
-
340
-
341
-
342
- @validate_call
343
- def validation_add_validation_text_rapid_post(
344
- self,
345
- add_validation_text_rapid_model: Annotated[Optional[AddValidationTextRapidModel], Field(description="The model containing the information needed to add the validation rapid.")] = None,
346
- _request_timeout: Union[
347
- None,
348
- Annotated[StrictFloat, Field(gt=0)],
349
- Tuple[
350
- Annotated[StrictFloat, Field(gt=0)],
351
- Annotated[StrictFloat, Field(gt=0)]
352
- ]
353
- ] = None,
354
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
355
- _content_type: Optional[StrictStr] = None,
356
- _headers: Optional[Dict[StrictStr, Any]] = None,
357
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
358
- ) -> AddValidationRapidResult:
359
- """Adds a new validation rapid to the specified validation set.
360
-
361
-
362
- :param add_validation_text_rapid_model: The model containing the information needed to add the validation rapid.
363
- :type add_validation_text_rapid_model: AddValidationTextRapidModel
364
- :param _request_timeout: timeout setting for this request. If one
365
- number provided, it will be total request
366
- timeout. It can also be a pair (tuple) of
367
- (connection, read) timeouts.
368
- :type _request_timeout: int, tuple(int, int), optional
369
- :param _request_auth: set to override the auth_settings for an a single
370
- request; this effectively ignores the
371
- authentication in the spec for a single request.
372
- :type _request_auth: dict, optional
373
- :param _content_type: force content-type for the request.
374
- :type _content_type: str, Optional
375
- :param _headers: set to override the headers for a single
376
- request; this effectively ignores the headers
377
- in the spec for a single request.
378
- :type _headers: dict, optional
379
- :param _host_index: set to override the host_index for a single
380
- request; this effectively ignores the host_index
381
- in the spec for a single request.
382
- :type _host_index: int, optional
383
- :return: Returns the result object.
384
- """ # noqa: E501
385
-
386
- _param = self._validation_add_validation_text_rapid_post_serialize(
387
- add_validation_text_rapid_model=add_validation_text_rapid_model,
388
- _request_auth=_request_auth,
389
- _content_type=_content_type,
390
- _headers=_headers,
391
- _host_index=_host_index
392
- )
393
-
394
- _response_types_map: Dict[str, Optional[str]] = {
395
- '200': "AddValidationRapidResult",
396
- }
397
- response_data = self.api_client.call_api(
398
- *_param,
399
- _request_timeout=_request_timeout
400
- )
401
- response_data.read()
402
- return self.api_client.response_deserialize(
403
- response_data=response_data,
404
- response_types_map=_response_types_map,
405
- ).data
406
-
407
-
408
- @validate_call
409
- def validation_add_validation_text_rapid_post_with_http_info(
410
- self,
411
- add_validation_text_rapid_model: Annotated[Optional[AddValidationTextRapidModel], Field(description="The model containing the information needed to add the validation rapid.")] = None,
412
- _request_timeout: Union[
413
- None,
414
- Annotated[StrictFloat, Field(gt=0)],
415
- Tuple[
416
- Annotated[StrictFloat, Field(gt=0)],
417
- Annotated[StrictFloat, Field(gt=0)]
418
- ]
419
- ] = None,
420
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
421
- _content_type: Optional[StrictStr] = None,
422
- _headers: Optional[Dict[StrictStr, Any]] = None,
423
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
424
- ) -> ApiResponse[AddValidationRapidResult]:
425
- """Adds a new validation rapid to the specified validation set.
426
-
427
-
428
- :param add_validation_text_rapid_model: The model containing the information needed to add the validation rapid.
429
- :type add_validation_text_rapid_model: AddValidationTextRapidModel
430
- :param _request_timeout: timeout setting for this request. If one
431
- number provided, it will be total request
432
- timeout. It can also be a pair (tuple) of
433
- (connection, read) timeouts.
434
- :type _request_timeout: int, tuple(int, int), optional
435
- :param _request_auth: set to override the auth_settings for an a single
436
- request; this effectively ignores the
437
- authentication in the spec for a single request.
438
- :type _request_auth: dict, optional
439
- :param _content_type: force content-type for the request.
440
- :type _content_type: str, Optional
441
- :param _headers: set to override the headers for a single
442
- request; this effectively ignores the headers
443
- in the spec for a single request.
444
- :type _headers: dict, optional
445
- :param _host_index: set to override the host_index for a single
446
- request; this effectively ignores the host_index
447
- in the spec for a single request.
448
- :type _host_index: int, optional
449
- :return: Returns the result object.
450
- """ # noqa: E501
451
-
452
- _param = self._validation_add_validation_text_rapid_post_serialize(
453
- add_validation_text_rapid_model=add_validation_text_rapid_model,
454
- _request_auth=_request_auth,
455
- _content_type=_content_type,
456
- _headers=_headers,
457
- _host_index=_host_index
458
- )
459
-
460
- _response_types_map: Dict[str, Optional[str]] = {
461
- '200': "AddValidationRapidResult",
462
- }
463
- response_data = self.api_client.call_api(
464
- *_param,
465
- _request_timeout=_request_timeout
466
- )
467
- response_data.read()
468
- return self.api_client.response_deserialize(
469
- response_data=response_data,
470
- response_types_map=_response_types_map,
471
- )
472
-
473
-
474
- @validate_call
475
- def validation_add_validation_text_rapid_post_without_preload_content(
476
- self,
477
- add_validation_text_rapid_model: Annotated[Optional[AddValidationTextRapidModel], Field(description="The model containing the information needed to add the validation rapid.")] = None,
478
- _request_timeout: Union[
479
- None,
480
- Annotated[StrictFloat, Field(gt=0)],
481
- Tuple[
482
- Annotated[StrictFloat, Field(gt=0)],
483
- Annotated[StrictFloat, Field(gt=0)]
484
- ]
485
- ] = None,
486
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
487
- _content_type: Optional[StrictStr] = None,
488
- _headers: Optional[Dict[StrictStr, Any]] = None,
489
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
490
- ) -> RESTResponseType:
491
- """Adds a new validation rapid to the specified validation set.
492
-
493
-
494
- :param add_validation_text_rapid_model: The model containing the information needed to add the validation rapid.
495
- :type add_validation_text_rapid_model: AddValidationTextRapidModel
496
- :param _request_timeout: timeout setting for this request. If one
497
- number provided, it will be total request
498
- timeout. It can also be a pair (tuple) of
499
- (connection, read) timeouts.
500
- :type _request_timeout: int, tuple(int, int), optional
501
- :param _request_auth: set to override the auth_settings for an a single
502
- request; this effectively ignores the
503
- authentication in the spec for a single request.
504
- :type _request_auth: dict, optional
505
- :param _content_type: force content-type for the request.
506
- :type _content_type: str, Optional
507
- :param _headers: set to override the headers for a single
508
- request; this effectively ignores the headers
509
- in the spec for a single request.
510
- :type _headers: dict, optional
511
- :param _host_index: set to override the host_index for a single
512
- request; this effectively ignores the host_index
513
- in the spec for a single request.
514
- :type _host_index: int, optional
515
- :return: Returns the result object.
516
- """ # noqa: E501
517
-
518
- _param = self._validation_add_validation_text_rapid_post_serialize(
519
- add_validation_text_rapid_model=add_validation_text_rapid_model,
520
- _request_auth=_request_auth,
521
- _content_type=_content_type,
522
- _headers=_headers,
523
- _host_index=_host_index
524
- )
525
-
526
- _response_types_map: Dict[str, Optional[str]] = {
527
- '200': "AddValidationRapidResult",
528
- }
529
- response_data = self.api_client.call_api(
530
- *_param,
531
- _request_timeout=_request_timeout
532
- )
533
- return response_data.response
534
-
535
-
536
- def _validation_add_validation_text_rapid_post_serialize(
537
- self,
538
- add_validation_text_rapid_model,
539
- _request_auth,
540
- _content_type,
541
- _headers,
542
- _host_index,
543
- ) -> RequestSerialized:
544
-
545
- _host = None
546
-
547
- _collection_formats: Dict[str, str] = {
548
- }
549
-
550
- _path_params: Dict[str, str] = {}
551
- _query_params: List[Tuple[str, str]] = []
552
- _header_params: Dict[str, Optional[str]] = _headers or {}
553
- _form_params: List[Tuple[str, str]] = []
554
- _files: Dict[
555
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
556
- ] = {}
557
- _body_params: Optional[bytes] = None
558
-
559
- # process the path parameters
560
- # process the query parameters
561
- # process the header parameters
562
- # process the form parameters
563
- # process the body parameter
564
- if add_validation_text_rapid_model is not None:
565
- _body_params = add_validation_text_rapid_model
566
-
567
-
568
- # set the HTTP header `Accept`
569
- if 'Accept' not in _header_params:
570
- _header_params['Accept'] = self.api_client.select_header_accept(
571
- [
572
- 'text/plain',
573
- 'application/json',
574
- 'text/json'
575
- ]
576
- )
577
-
578
- # set the HTTP header `Content-Type`
579
- if _content_type:
580
- _header_params['Content-Type'] = _content_type
581
- else:
582
- _default_content_type = (
583
- self.api_client.select_header_content_type(
584
- [
585
- 'application/json',
586
- 'text/json',
587
- 'application/*+json'
588
- ]
589
- )
590
- )
591
- if _default_content_type is not None:
592
- _header_params['Content-Type'] = _default_content_type
593
-
594
- # authentication setting
595
- _auth_settings: List[str] = [
596
- 'bearer',
597
- 'oauth2'
598
- ]
599
-
600
- return self.api_client.param_serialize(
601
- method='POST',
602
- resource_path='/Validation/AddValidationTextRapid',
603
- path_params=_path_params,
604
- query_params=_query_params,
605
- header_params=_header_params,
606
- body=_body_params,
607
- post_params=_form_params,
608
- files=_files,
609
- auth_settings=_auth_settings,
610
- collection_formats=_collection_formats,
611
- _host=_host,
612
- _request_auth=_request_auth
613
- )
614
-
615
-
616
-
617
-
618
- @validate_call
619
- def validation_create_validation_set_post(
620
- self,
621
- name: Annotated[Optional[StrictStr], Field(description="The name to give the new validation set.")] = None,
622
- _request_timeout: Union[
623
- None,
624
- Annotated[StrictFloat, Field(gt=0)],
625
- Tuple[
626
- Annotated[StrictFloat, Field(gt=0)],
627
- Annotated[StrictFloat, Field(gt=0)]
628
- ]
629
- ] = None,
630
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
631
- _content_type: Optional[StrictStr] = None,
632
- _headers: Optional[Dict[StrictStr, Any]] = None,
633
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
634
- ) -> CreateEmptyValidationSetResult:
635
- """Creates a new empty validation set.
636
-
637
-
638
- :param name: The name to give the new validation set.
639
- :type name: str
640
- :param _request_timeout: timeout setting for this request. If one
641
- number provided, it will be total request
642
- timeout. It can also be a pair (tuple) of
643
- (connection, read) timeouts.
644
- :type _request_timeout: int, tuple(int, int), optional
645
- :param _request_auth: set to override the auth_settings for an a single
646
- request; this effectively ignores the
647
- authentication in the spec for a single request.
648
- :type _request_auth: dict, optional
649
- :param _content_type: force content-type for the request.
650
- :type _content_type: str, Optional
651
- :param _headers: set to override the headers for a single
652
- request; this effectively ignores the headers
653
- in the spec for a single request.
654
- :type _headers: dict, optional
655
- :param _host_index: set to override the host_index for a single
656
- request; this effectively ignores the host_index
657
- in the spec for a single request.
658
- :type _host_index: int, optional
659
- :return: Returns the result object.
660
- """ # noqa: E501
661
-
662
- _param = self._validation_create_validation_set_post_serialize(
663
- name=name,
664
- _request_auth=_request_auth,
665
- _content_type=_content_type,
666
- _headers=_headers,
667
- _host_index=_host_index
668
- )
669
-
670
- _response_types_map: Dict[str, Optional[str]] = {
671
- '200': "CreateEmptyValidationSetResult",
672
- }
673
- response_data = self.api_client.call_api(
674
- *_param,
675
- _request_timeout=_request_timeout
676
- )
677
- response_data.read()
678
- return self.api_client.response_deserialize(
679
- response_data=response_data,
680
- response_types_map=_response_types_map,
681
- ).data
682
-
683
-
684
- @validate_call
685
- def validation_create_validation_set_post_with_http_info(
686
- self,
687
- name: Annotated[Optional[StrictStr], Field(description="The name to give the new validation set.")] = None,
688
- _request_timeout: Union[
689
- None,
690
- Annotated[StrictFloat, Field(gt=0)],
691
- Tuple[
692
- Annotated[StrictFloat, Field(gt=0)],
693
- Annotated[StrictFloat, Field(gt=0)]
694
- ]
695
- ] = None,
696
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
697
- _content_type: Optional[StrictStr] = None,
698
- _headers: Optional[Dict[StrictStr, Any]] = None,
699
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
700
- ) -> ApiResponse[CreateEmptyValidationSetResult]:
701
- """Creates a new empty validation set.
702
-
703
-
704
- :param name: The name to give the new validation set.
705
- :type name: str
706
- :param _request_timeout: timeout setting for this request. If one
707
- number provided, it will be total request
708
- timeout. It can also be a pair (tuple) of
709
- (connection, read) timeouts.
710
- :type _request_timeout: int, tuple(int, int), optional
711
- :param _request_auth: set to override the auth_settings for an a single
712
- request; this effectively ignores the
713
- authentication in the spec for a single request.
714
- :type _request_auth: dict, optional
715
- :param _content_type: force content-type for the request.
716
- :type _content_type: str, Optional
717
- :param _headers: set to override the headers for a single
718
- request; this effectively ignores the headers
719
- in the spec for a single request.
720
- :type _headers: dict, optional
721
- :param _host_index: set to override the host_index for a single
722
- request; this effectively ignores the host_index
723
- in the spec for a single request.
724
- :type _host_index: int, optional
725
- :return: Returns the result object.
726
- """ # noqa: E501
727
-
728
- _param = self._validation_create_validation_set_post_serialize(
729
- name=name,
730
- _request_auth=_request_auth,
731
- _content_type=_content_type,
732
- _headers=_headers,
733
- _host_index=_host_index
734
- )
735
-
736
- _response_types_map: Dict[str, Optional[str]] = {
737
- '200': "CreateEmptyValidationSetResult",
738
- }
739
- response_data = self.api_client.call_api(
740
- *_param,
741
- _request_timeout=_request_timeout
742
- )
743
- response_data.read()
744
- return self.api_client.response_deserialize(
745
- response_data=response_data,
746
- response_types_map=_response_types_map,
747
- )
748
-
749
-
750
- @validate_call
751
- def validation_create_validation_set_post_without_preload_content(
752
- self,
753
- name: Annotated[Optional[StrictStr], Field(description="The name to give the new validation set.")] = None,
754
- _request_timeout: Union[
755
- None,
756
- Annotated[StrictFloat, Field(gt=0)],
757
- Tuple[
758
- Annotated[StrictFloat, Field(gt=0)],
759
- Annotated[StrictFloat, Field(gt=0)]
760
- ]
761
- ] = None,
762
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
763
- _content_type: Optional[StrictStr] = None,
764
- _headers: Optional[Dict[StrictStr, Any]] = None,
765
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
766
- ) -> RESTResponseType:
767
- """Creates a new empty validation set.
768
-
769
-
770
- :param name: The name to give the new validation set.
771
- :type name: str
772
- :param _request_timeout: timeout setting for this request. If one
773
- number provided, it will be total request
774
- timeout. It can also be a pair (tuple) of
775
- (connection, read) timeouts.
776
- :type _request_timeout: int, tuple(int, int), optional
777
- :param _request_auth: set to override the auth_settings for an a single
778
- request; this effectively ignores the
779
- authentication in the spec for a single request.
780
- :type _request_auth: dict, optional
781
- :param _content_type: force content-type for the request.
782
- :type _content_type: str, Optional
783
- :param _headers: set to override the headers for a single
784
- request; this effectively ignores the headers
785
- in the spec for a single request.
786
- :type _headers: dict, optional
787
- :param _host_index: set to override the host_index for a single
788
- request; this effectively ignores the host_index
789
- in the spec for a single request.
790
- :type _host_index: int, optional
791
- :return: Returns the result object.
792
- """ # noqa: E501
793
-
794
- _param = self._validation_create_validation_set_post_serialize(
795
- name=name,
796
- _request_auth=_request_auth,
797
- _content_type=_content_type,
798
- _headers=_headers,
799
- _host_index=_host_index
800
- )
801
-
802
- _response_types_map: Dict[str, Optional[str]] = {
803
- '200': "CreateEmptyValidationSetResult",
804
- }
805
- response_data = self.api_client.call_api(
806
- *_param,
807
- _request_timeout=_request_timeout
808
- )
809
- return response_data.response
810
-
811
-
812
- def _validation_create_validation_set_post_serialize(
813
- self,
814
- name,
815
- _request_auth,
816
- _content_type,
817
- _headers,
818
- _host_index,
819
- ) -> RequestSerialized:
820
-
821
- _host = None
822
-
823
- _collection_formats: Dict[str, str] = {
824
- }
825
-
826
- _path_params: Dict[str, str] = {}
827
- _query_params: List[Tuple[str, str]] = []
828
- _header_params: Dict[str, Optional[str]] = _headers or {}
829
- _form_params: List[Tuple[str, str]] = []
830
- _files: Dict[
831
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
832
- ] = {}
833
- _body_params: Optional[bytes] = None
834
-
835
- # process the path parameters
836
- # process the query parameters
837
- if name is not None:
838
-
839
- _query_params.append(('name', name))
840
-
841
- # process the header parameters
842
- # process the form parameters
843
- # process the body parameter
844
-
845
-
846
- # set the HTTP header `Accept`
847
- if 'Accept' not in _header_params:
848
- _header_params['Accept'] = self.api_client.select_header_accept(
849
- [
850
- 'text/plain',
851
- 'application/json',
852
- 'text/json'
853
- ]
854
- )
855
-
856
-
857
- # authentication setting
858
- _auth_settings: List[str] = [
859
- 'bearer',
860
- 'oauth2'
861
- ]
862
-
863
- return self.api_client.param_serialize(
864
- method='POST',
865
- resource_path='/Validation/CreateValidationSet',
866
- path_params=_path_params,
867
- query_params=_query_params,
868
- header_params=_header_params,
869
- body=_body_params,
870
- post_params=_form_params,
871
- files=_files,
872
- auth_settings=_auth_settings,
873
- collection_formats=_collection_formats,
874
- _host=_host,
875
- _request_auth=_request_auth
876
- )
877
-
878
-
879
-
880
-
881
- @validate_call
882
- def validation_get_available_validation_sets_get(
883
- self,
884
- _request_timeout: Union[
885
- None,
886
- Annotated[StrictFloat, Field(gt=0)],
887
- Tuple[
888
- Annotated[StrictFloat, Field(gt=0)],
889
- Annotated[StrictFloat, Field(gt=0)]
890
- ]
891
- ] = None,
892
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
893
- _content_type: Optional[StrictStr] = None,
894
- _headers: Optional[Dict[StrictStr, Any]] = None,
895
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
896
- ) -> GetAvailableValidationSetsResult:
897
- """Gets the available validation sets for the current user.
898
-
899
-
900
- :param _request_timeout: timeout setting for this request. If one
901
- number provided, it will be total request
902
- timeout. It can also be a pair (tuple) of
903
- (connection, read) timeouts.
904
- :type _request_timeout: int, tuple(int, int), optional
905
- :param _request_auth: set to override the auth_settings for an a single
906
- request; this effectively ignores the
907
- authentication in the spec for a single request.
908
- :type _request_auth: dict, optional
909
- :param _content_type: force content-type for the request.
910
- :type _content_type: str, Optional
911
- :param _headers: set to override the headers for a single
912
- request; this effectively ignores the headers
913
- in the spec for a single request.
914
- :type _headers: dict, optional
915
- :param _host_index: set to override the host_index for a single
916
- request; this effectively ignores the host_index
917
- in the spec for a single request.
918
- :type _host_index: int, optional
919
- :return: Returns the result object.
920
- """ # noqa: E501
921
-
922
- _param = self._validation_get_available_validation_sets_get_serialize(
923
- _request_auth=_request_auth,
924
- _content_type=_content_type,
925
- _headers=_headers,
926
- _host_index=_host_index
927
- )
928
-
929
- _response_types_map: Dict[str, Optional[str]] = {
930
- '200': "GetAvailableValidationSetsResult",
931
- }
932
- response_data = self.api_client.call_api(
933
- *_param,
934
- _request_timeout=_request_timeout
935
- )
936
- response_data.read()
937
- return self.api_client.response_deserialize(
938
- response_data=response_data,
939
- response_types_map=_response_types_map,
940
- ).data
941
-
942
-
943
- @validate_call
944
- def validation_get_available_validation_sets_get_with_http_info(
945
- self,
946
- _request_timeout: Union[
947
- None,
948
- Annotated[StrictFloat, Field(gt=0)],
949
- Tuple[
950
- Annotated[StrictFloat, Field(gt=0)],
951
- Annotated[StrictFloat, Field(gt=0)]
952
- ]
953
- ] = None,
954
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
955
- _content_type: Optional[StrictStr] = None,
956
- _headers: Optional[Dict[StrictStr, Any]] = None,
957
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
958
- ) -> ApiResponse[GetAvailableValidationSetsResult]:
959
- """Gets the available validation sets for the current user.
960
-
961
-
962
- :param _request_timeout: timeout setting for this request. If one
963
- number provided, it will be total request
964
- timeout. It can also be a pair (tuple) of
965
- (connection, read) timeouts.
966
- :type _request_timeout: int, tuple(int, int), optional
967
- :param _request_auth: set to override the auth_settings for an a single
968
- request; this effectively ignores the
969
- authentication in the spec for a single request.
970
- :type _request_auth: dict, optional
971
- :param _content_type: force content-type for the request.
972
- :type _content_type: str, Optional
973
- :param _headers: set to override the headers for a single
974
- request; this effectively ignores the headers
975
- in the spec for a single request.
976
- :type _headers: dict, optional
977
- :param _host_index: set to override the host_index for a single
978
- request; this effectively ignores the host_index
979
- in the spec for a single request.
980
- :type _host_index: int, optional
981
- :return: Returns the result object.
982
- """ # noqa: E501
983
-
984
- _param = self._validation_get_available_validation_sets_get_serialize(
985
- _request_auth=_request_auth,
986
- _content_type=_content_type,
987
- _headers=_headers,
988
- _host_index=_host_index
989
- )
990
-
991
- _response_types_map: Dict[str, Optional[str]] = {
992
- '200': "GetAvailableValidationSetsResult",
993
- }
994
- response_data = self.api_client.call_api(
995
- *_param,
996
- _request_timeout=_request_timeout
997
- )
998
- response_data.read()
999
- return self.api_client.response_deserialize(
1000
- response_data=response_data,
1001
- response_types_map=_response_types_map,
1002
- )
1003
-
1004
-
1005
- @validate_call
1006
- def validation_get_available_validation_sets_get_without_preload_content(
1007
- self,
1008
- _request_timeout: Union[
1009
- None,
1010
- Annotated[StrictFloat, Field(gt=0)],
1011
- Tuple[
1012
- Annotated[StrictFloat, Field(gt=0)],
1013
- Annotated[StrictFloat, Field(gt=0)]
1014
- ]
1015
- ] = None,
1016
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1017
- _content_type: Optional[StrictStr] = None,
1018
- _headers: Optional[Dict[StrictStr, Any]] = None,
1019
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1020
- ) -> RESTResponseType:
1021
- """Gets the available validation sets for the current user.
1022
-
1023
-
1024
- :param _request_timeout: timeout setting for this request. If one
1025
- number provided, it will be total request
1026
- timeout. It can also be a pair (tuple) of
1027
- (connection, read) timeouts.
1028
- :type _request_timeout: int, tuple(int, int), optional
1029
- :param _request_auth: set to override the auth_settings for an a single
1030
- request; this effectively ignores the
1031
- authentication in the spec for a single request.
1032
- :type _request_auth: dict, optional
1033
- :param _content_type: force content-type for the request.
1034
- :type _content_type: str, Optional
1035
- :param _headers: set to override the headers for a single
1036
- request; this effectively ignores the headers
1037
- in the spec for a single request.
1038
- :type _headers: dict, optional
1039
- :param _host_index: set to override the host_index for a single
1040
- request; this effectively ignores the host_index
1041
- in the spec for a single request.
1042
- :type _host_index: int, optional
1043
- :return: Returns the result object.
1044
- """ # noqa: E501
1045
-
1046
- _param = self._validation_get_available_validation_sets_get_serialize(
1047
- _request_auth=_request_auth,
1048
- _content_type=_content_type,
1049
- _headers=_headers,
1050
- _host_index=_host_index
1051
- )
1052
-
1053
- _response_types_map: Dict[str, Optional[str]] = {
1054
- '200': "GetAvailableValidationSetsResult",
1055
- }
1056
- response_data = self.api_client.call_api(
1057
- *_param,
1058
- _request_timeout=_request_timeout
1059
- )
1060
- return response_data.response
1061
-
1062
-
1063
- def _validation_get_available_validation_sets_get_serialize(
1064
- self,
1065
- _request_auth,
1066
- _content_type,
1067
- _headers,
1068
- _host_index,
1069
- ) -> RequestSerialized:
1070
-
1071
- _host = None
1072
-
1073
- _collection_formats: Dict[str, str] = {
1074
- }
1075
-
1076
- _path_params: Dict[str, str] = {}
1077
- _query_params: List[Tuple[str, str]] = []
1078
- _header_params: Dict[str, Optional[str]] = _headers or {}
1079
- _form_params: List[Tuple[str, str]] = []
1080
- _files: Dict[
1081
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1082
- ] = {}
1083
- _body_params: Optional[bytes] = None
1084
-
1085
- # process the path parameters
1086
- # process the query parameters
1087
- # process the header parameters
1088
- # process the form parameters
1089
- # process the body parameter
1090
-
1091
-
1092
- # set the HTTP header `Accept`
1093
- if 'Accept' not in _header_params:
1094
- _header_params['Accept'] = self.api_client.select_header_accept(
1095
- [
1096
- 'text/plain',
1097
- 'application/json',
1098
- 'text/json'
1099
- ]
1100
- )
1101
-
1102
-
1103
- # authentication setting
1104
- _auth_settings: List[str] = [
1105
- 'bearer',
1106
- 'oauth2'
1107
- ]
1108
-
1109
- return self.api_client.param_serialize(
1110
- method='GET',
1111
- resource_path='/Validation/GetAvailableValidationSets',
1112
- path_params=_path_params,
1113
- query_params=_query_params,
1114
- header_params=_header_params,
1115
- body=_body_params,
1116
- post_params=_form_params,
1117
- files=_files,
1118
- auth_settings=_auth_settings,
1119
- collection_formats=_collection_formats,
1120
- _host=_host,
1121
- _request_auth=_request_auth
1122
- )
1123
-
1124
-
1125
-
1126
-
1127
- @validate_call
1128
- def validation_get_by_id_get(
1129
- self,
1130
- id: Annotated[Optional[StrictStr], Field(description="The id of the validation set to get.")] = None,
1131
- _request_timeout: Union[
1132
- None,
1133
- Annotated[StrictFloat, Field(gt=0)],
1134
- Tuple[
1135
- Annotated[StrictFloat, Field(gt=0)],
1136
- Annotated[StrictFloat, Field(gt=0)]
1137
- ]
1138
- ] = None,
1139
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1140
- _content_type: Optional[StrictStr] = None,
1141
- _headers: Optional[Dict[StrictStr, Any]] = None,
1142
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1143
- ) -> GetValidationSetByIdResult:
1144
- """Gets a validation set by the id.
1145
-
1146
-
1147
- :param id: The id of the validation set to get.
1148
- :type id: str
1149
- :param _request_timeout: timeout setting for this request. If one
1150
- number provided, it will be total request
1151
- timeout. It can also be a pair (tuple) of
1152
- (connection, read) timeouts.
1153
- :type _request_timeout: int, tuple(int, int), optional
1154
- :param _request_auth: set to override the auth_settings for an a single
1155
- request; this effectively ignores the
1156
- authentication in the spec for a single request.
1157
- :type _request_auth: dict, optional
1158
- :param _content_type: force content-type for the request.
1159
- :type _content_type: str, Optional
1160
- :param _headers: set to override the headers for a single
1161
- request; this effectively ignores the headers
1162
- in the spec for a single request.
1163
- :type _headers: dict, optional
1164
- :param _host_index: set to override the host_index for a single
1165
- request; this effectively ignores the host_index
1166
- in the spec for a single request.
1167
- :type _host_index: int, optional
1168
- :return: Returns the result object.
1169
- """ # noqa: E501
1170
-
1171
- _param = self._validation_get_by_id_get_serialize(
1172
- id=id,
1173
- _request_auth=_request_auth,
1174
- _content_type=_content_type,
1175
- _headers=_headers,
1176
- _host_index=_host_index
1177
- )
1178
-
1179
- _response_types_map: Dict[str, Optional[str]] = {
1180
- '200': "GetValidationSetByIdResult",
1181
- }
1182
- response_data = self.api_client.call_api(
1183
- *_param,
1184
- _request_timeout=_request_timeout
1185
- )
1186
- response_data.read()
1187
- return self.api_client.response_deserialize(
1188
- response_data=response_data,
1189
- response_types_map=_response_types_map,
1190
- ).data
1191
-
1192
-
1193
- @validate_call
1194
- def validation_get_by_id_get_with_http_info(
1195
- self,
1196
- id: Annotated[Optional[StrictStr], Field(description="The id of the validation set to get.")] = None,
1197
- _request_timeout: Union[
1198
- None,
1199
- Annotated[StrictFloat, Field(gt=0)],
1200
- Tuple[
1201
- Annotated[StrictFloat, Field(gt=0)],
1202
- Annotated[StrictFloat, Field(gt=0)]
1203
- ]
1204
- ] = None,
1205
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1206
- _content_type: Optional[StrictStr] = None,
1207
- _headers: Optional[Dict[StrictStr, Any]] = None,
1208
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1209
- ) -> ApiResponse[GetValidationSetByIdResult]:
1210
- """Gets a validation set by the id.
1211
-
1212
-
1213
- :param id: The id of the validation set to get.
1214
- :type id: str
1215
- :param _request_timeout: timeout setting for this request. If one
1216
- number provided, it will be total request
1217
- timeout. It can also be a pair (tuple) of
1218
- (connection, read) timeouts.
1219
- :type _request_timeout: int, tuple(int, int), optional
1220
- :param _request_auth: set to override the auth_settings for an a single
1221
- request; this effectively ignores the
1222
- authentication in the spec for a single request.
1223
- :type _request_auth: dict, optional
1224
- :param _content_type: force content-type for the request.
1225
- :type _content_type: str, Optional
1226
- :param _headers: set to override the headers for a single
1227
- request; this effectively ignores the headers
1228
- in the spec for a single request.
1229
- :type _headers: dict, optional
1230
- :param _host_index: set to override the host_index for a single
1231
- request; this effectively ignores the host_index
1232
- in the spec for a single request.
1233
- :type _host_index: int, optional
1234
- :return: Returns the result object.
1235
- """ # noqa: E501
1236
-
1237
- _param = self._validation_get_by_id_get_serialize(
1238
- id=id,
1239
- _request_auth=_request_auth,
1240
- _content_type=_content_type,
1241
- _headers=_headers,
1242
- _host_index=_host_index
1243
- )
1244
-
1245
- _response_types_map: Dict[str, Optional[str]] = {
1246
- '200': "GetValidationSetByIdResult",
1247
- }
1248
- response_data = self.api_client.call_api(
1249
- *_param,
1250
- _request_timeout=_request_timeout
1251
- )
1252
- response_data.read()
1253
- return self.api_client.response_deserialize(
1254
- response_data=response_data,
1255
- response_types_map=_response_types_map,
1256
- )
1257
-
1258
-
1259
- @validate_call
1260
- def validation_get_by_id_get_without_preload_content(
1261
- self,
1262
- id: Annotated[Optional[StrictStr], Field(description="The id of the validation set to get.")] = None,
1263
- _request_timeout: Union[
1264
- None,
1265
- Annotated[StrictFloat, Field(gt=0)],
1266
- Tuple[
1267
- Annotated[StrictFloat, Field(gt=0)],
1268
- Annotated[StrictFloat, Field(gt=0)]
1269
- ]
1270
- ] = None,
1271
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1272
- _content_type: Optional[StrictStr] = None,
1273
- _headers: Optional[Dict[StrictStr, Any]] = None,
1274
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1275
- ) -> RESTResponseType:
1276
- """Gets a validation set by the id.
1277
-
1278
-
1279
- :param id: The id of the validation set to get.
1280
- :type id: str
1281
- :param _request_timeout: timeout setting for this request. If one
1282
- number provided, it will be total request
1283
- timeout. It can also be a pair (tuple) of
1284
- (connection, read) timeouts.
1285
- :type _request_timeout: int, tuple(int, int), optional
1286
- :param _request_auth: set to override the auth_settings for an a single
1287
- request; this effectively ignores the
1288
- authentication in the spec for a single request.
1289
- :type _request_auth: dict, optional
1290
- :param _content_type: force content-type for the request.
1291
- :type _content_type: str, Optional
1292
- :param _headers: set to override the headers for a single
1293
- request; this effectively ignores the headers
1294
- in the spec for a single request.
1295
- :type _headers: dict, optional
1296
- :param _host_index: set to override the host_index for a single
1297
- request; this effectively ignores the host_index
1298
- in the spec for a single request.
1299
- :type _host_index: int, optional
1300
- :return: Returns the result object.
1301
- """ # noqa: E501
1302
-
1303
- _param = self._validation_get_by_id_get_serialize(
1304
- id=id,
1305
- _request_auth=_request_auth,
1306
- _content_type=_content_type,
1307
- _headers=_headers,
1308
- _host_index=_host_index
1309
- )
1310
-
1311
- _response_types_map: Dict[str, Optional[str]] = {
1312
- '200': "GetValidationSetByIdResult",
1313
- }
1314
- response_data = self.api_client.call_api(
1315
- *_param,
1316
- _request_timeout=_request_timeout
1317
- )
1318
- return response_data.response
1319
-
1320
-
1321
- def _validation_get_by_id_get_serialize(
1322
- self,
1323
- id,
1324
- _request_auth,
1325
- _content_type,
1326
- _headers,
1327
- _host_index,
1328
- ) -> RequestSerialized:
1329
-
1330
- _host = None
1331
-
1332
- _collection_formats: Dict[str, str] = {
1333
- }
1334
-
1335
- _path_params: Dict[str, str] = {}
1336
- _query_params: List[Tuple[str, str]] = []
1337
- _header_params: Dict[str, Optional[str]] = _headers or {}
1338
- _form_params: List[Tuple[str, str]] = []
1339
- _files: Dict[
1340
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1341
- ] = {}
1342
- _body_params: Optional[bytes] = None
1343
-
1344
- # process the path parameters
1345
- # process the query parameters
1346
- if id is not None:
1347
-
1348
- _query_params.append(('id', id))
1349
-
1350
- # process the header parameters
1351
- # process the form parameters
1352
- # process the body parameter
1353
-
1354
-
1355
- # set the HTTP header `Accept`
1356
- if 'Accept' not in _header_params:
1357
- _header_params['Accept'] = self.api_client.select_header_accept(
1358
- [
1359
- 'text/plain',
1360
- 'application/json',
1361
- 'text/json'
1362
- ]
1363
- )
1364
-
1365
-
1366
- # authentication setting
1367
- _auth_settings: List[str] = [
1368
- 'bearer',
1369
- 'oauth2'
1370
- ]
1371
-
1372
- return self.api_client.param_serialize(
1373
- method='GET',
1374
- resource_path='/Validation/GetById',
1375
- path_params=_path_params,
1376
- query_params=_query_params,
1377
- header_params=_header_params,
1378
- body=_body_params,
1379
- post_params=_form_params,
1380
- files=_files,
1381
- auth_settings=_auth_settings,
1382
- collection_formats=_collection_formats,
1383
- _host=_host,
1384
- _request_auth=_request_auth
1385
- )
1386
-
1387
-
1388
-
1389
-
1390
- @validate_call
1391
- def validation_import_compare_post(
1392
- self,
1393
- criteria: Optional[StrictStr] = None,
1394
- _request_timeout: Union[
1395
- None,
1396
- Annotated[StrictFloat, Field(gt=0)],
1397
- Tuple[
1398
- Annotated[StrictFloat, Field(gt=0)],
1399
- Annotated[StrictFloat, Field(gt=0)]
1400
- ]
1401
- ] = None,
1402
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1403
- _content_type: Optional[StrictStr] = None,
1404
- _headers: Optional[Dict[StrictStr, Any]] = None,
1405
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1406
- ) -> ImportValidationSetFromFileResult:
1407
- """Imports a compare validation set from a zip file.
1408
-
1409
-
1410
- :param criteria:
1411
- :type criteria: str
1412
- :param _request_timeout: timeout setting for this request. If one
1413
- number provided, it will be total request
1414
- timeout. It can also be a pair (tuple) of
1415
- (connection, read) timeouts.
1416
- :type _request_timeout: int, tuple(int, int), optional
1417
- :param _request_auth: set to override the auth_settings for an a single
1418
- request; this effectively ignores the
1419
- authentication in the spec for a single request.
1420
- :type _request_auth: dict, optional
1421
- :param _content_type: force content-type for the request.
1422
- :type _content_type: str, Optional
1423
- :param _headers: set to override the headers for a single
1424
- request; this effectively ignores the headers
1425
- in the spec for a single request.
1426
- :type _headers: dict, optional
1427
- :param _host_index: set to override the host_index for a single
1428
- request; this effectively ignores the host_index
1429
- in the spec for a single request.
1430
- :type _host_index: int, optional
1431
- :return: Returns the result object.
1432
- """ # noqa: E501
1433
-
1434
- _param = self._validation_import_compare_post_serialize(
1435
- criteria=criteria,
1436
- _request_auth=_request_auth,
1437
- _content_type=_content_type,
1438
- _headers=_headers,
1439
- _host_index=_host_index
1440
- )
1441
-
1442
- _response_types_map: Dict[str, Optional[str]] = {
1443
- '200': "ImportValidationSetFromFileResult",
1444
- }
1445
- response_data = self.api_client.call_api(
1446
- *_param,
1447
- _request_timeout=_request_timeout
1448
- )
1449
- response_data.read()
1450
- return self.api_client.response_deserialize(
1451
- response_data=response_data,
1452
- response_types_map=_response_types_map,
1453
- ).data
1454
-
1455
-
1456
- @validate_call
1457
- def validation_import_compare_post_with_http_info(
1458
- self,
1459
- criteria: Optional[StrictStr] = None,
1460
- _request_timeout: Union[
1461
- None,
1462
- Annotated[StrictFloat, Field(gt=0)],
1463
- Tuple[
1464
- Annotated[StrictFloat, Field(gt=0)],
1465
- Annotated[StrictFloat, Field(gt=0)]
1466
- ]
1467
- ] = None,
1468
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1469
- _content_type: Optional[StrictStr] = None,
1470
- _headers: Optional[Dict[StrictStr, Any]] = None,
1471
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1472
- ) -> ApiResponse[ImportValidationSetFromFileResult]:
1473
- """Imports a compare validation set from a zip file.
1474
-
1475
-
1476
- :param criteria:
1477
- :type criteria: str
1478
- :param _request_timeout: timeout setting for this request. If one
1479
- number provided, it will be total request
1480
- timeout. It can also be a pair (tuple) of
1481
- (connection, read) timeouts.
1482
- :type _request_timeout: int, tuple(int, int), optional
1483
- :param _request_auth: set to override the auth_settings for an a single
1484
- request; this effectively ignores the
1485
- authentication in the spec for a single request.
1486
- :type _request_auth: dict, optional
1487
- :param _content_type: force content-type for the request.
1488
- :type _content_type: str, Optional
1489
- :param _headers: set to override the headers for a single
1490
- request; this effectively ignores the headers
1491
- in the spec for a single request.
1492
- :type _headers: dict, optional
1493
- :param _host_index: set to override the host_index for a single
1494
- request; this effectively ignores the host_index
1495
- in the spec for a single request.
1496
- :type _host_index: int, optional
1497
- :return: Returns the result object.
1498
- """ # noqa: E501
1499
-
1500
- _param = self._validation_import_compare_post_serialize(
1501
- criteria=criteria,
1502
- _request_auth=_request_auth,
1503
- _content_type=_content_type,
1504
- _headers=_headers,
1505
- _host_index=_host_index
1506
- )
1507
-
1508
- _response_types_map: Dict[str, Optional[str]] = {
1509
- '200': "ImportValidationSetFromFileResult",
1510
- }
1511
- response_data = self.api_client.call_api(
1512
- *_param,
1513
- _request_timeout=_request_timeout
1514
- )
1515
- response_data.read()
1516
- return self.api_client.response_deserialize(
1517
- response_data=response_data,
1518
- response_types_map=_response_types_map,
1519
- )
1520
-
1521
-
1522
- @validate_call
1523
- def validation_import_compare_post_without_preload_content(
1524
- self,
1525
- criteria: Optional[StrictStr] = None,
1526
- _request_timeout: Union[
1527
- None,
1528
- Annotated[StrictFloat, Field(gt=0)],
1529
- Tuple[
1530
- Annotated[StrictFloat, Field(gt=0)],
1531
- Annotated[StrictFloat, Field(gt=0)]
1532
- ]
1533
- ] = None,
1534
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1535
- _content_type: Optional[StrictStr] = None,
1536
- _headers: Optional[Dict[StrictStr, Any]] = None,
1537
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1538
- ) -> RESTResponseType:
1539
- """Imports a compare validation set from a zip file.
1540
-
1541
-
1542
- :param criteria:
1543
- :type criteria: str
1544
- :param _request_timeout: timeout setting for this request. If one
1545
- number provided, it will be total request
1546
- timeout. It can also be a pair (tuple) of
1547
- (connection, read) timeouts.
1548
- :type _request_timeout: int, tuple(int, int), optional
1549
- :param _request_auth: set to override the auth_settings for an a single
1550
- request; this effectively ignores the
1551
- authentication in the spec for a single request.
1552
- :type _request_auth: dict, optional
1553
- :param _content_type: force content-type for the request.
1554
- :type _content_type: str, Optional
1555
- :param _headers: set to override the headers for a single
1556
- request; this effectively ignores the headers
1557
- in the spec for a single request.
1558
- :type _headers: dict, optional
1559
- :param _host_index: set to override the host_index for a single
1560
- request; this effectively ignores the host_index
1561
- in the spec for a single request.
1562
- :type _host_index: int, optional
1563
- :return: Returns the result object.
1564
- """ # noqa: E501
1565
-
1566
- _param = self._validation_import_compare_post_serialize(
1567
- criteria=criteria,
1568
- _request_auth=_request_auth,
1569
- _content_type=_content_type,
1570
- _headers=_headers,
1571
- _host_index=_host_index
1572
- )
1573
-
1574
- _response_types_map: Dict[str, Optional[str]] = {
1575
- '200': "ImportValidationSetFromFileResult",
1576
- }
1577
- response_data = self.api_client.call_api(
1578
- *_param,
1579
- _request_timeout=_request_timeout
1580
- )
1581
- return response_data.response
1582
-
1583
-
1584
- def _validation_import_compare_post_serialize(
1585
- self,
1586
- criteria,
1587
- _request_auth,
1588
- _content_type,
1589
- _headers,
1590
- _host_index,
1591
- ) -> RequestSerialized:
1592
-
1593
- _host = None
1594
-
1595
- _collection_formats: Dict[str, str] = {
1596
- }
1597
-
1598
- _path_params: Dict[str, str] = {}
1599
- _query_params: List[Tuple[str, str]] = []
1600
- _header_params: Dict[str, Optional[str]] = _headers or {}
1601
- _form_params: List[Tuple[str, str]] = []
1602
- _files: Dict[
1603
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1604
- ] = {}
1605
- _body_params: Optional[bytes] = None
1606
-
1607
- # process the path parameters
1608
- # process the query parameters
1609
- # process the header parameters
1610
- # process the form parameters
1611
- if criteria is not None:
1612
- _form_params.append(('Criteria', criteria))
1613
- # process the body parameter
1614
-
1615
-
1616
- # set the HTTP header `Accept`
1617
- if 'Accept' not in _header_params:
1618
- _header_params['Accept'] = self.api_client.select_header_accept(
1619
- [
1620
- 'text/plain',
1621
- 'application/json',
1622
- 'text/json'
1623
- ]
1624
- )
1625
-
1626
- # set the HTTP header `Content-Type`
1627
- if _content_type:
1628
- _header_params['Content-Type'] = _content_type
1629
- else:
1630
- _default_content_type = (
1631
- self.api_client.select_header_content_type(
1632
- [
1633
- 'multipart/form-data'
1634
- ]
1635
- )
1636
- )
1637
- if _default_content_type is not None:
1638
- _header_params['Content-Type'] = _default_content_type
1639
-
1640
- # authentication setting
1641
- _auth_settings: List[str] = [
1642
- 'bearer',
1643
- 'oauth2'
1644
- ]
1645
-
1646
- return self.api_client.param_serialize(
1647
- method='POST',
1648
- resource_path='/Validation/ImportCompare',
1649
- path_params=_path_params,
1650
- query_params=_query_params,
1651
- header_params=_header_params,
1652
- body=_body_params,
1653
- post_params=_form_params,
1654
- files=_files,
1655
- auth_settings=_auth_settings,
1656
- collection_formats=_collection_formats,
1657
- _host=_host,
1658
- _request_auth=_request_auth
1659
- )
1660
-
1661
-
1662
-
1663
-
1664
- @validate_call
1665
- def validation_import_post(
1666
- self,
1667
- blueprint: Optional[ValidationImportPostRequestBlueprint] = None,
1668
- _request_timeout: Union[
1669
- None,
1670
- Annotated[StrictFloat, Field(gt=0)],
1671
- Tuple[
1672
- Annotated[StrictFloat, Field(gt=0)],
1673
- Annotated[StrictFloat, Field(gt=0)]
1674
- ]
1675
- ] = None,
1676
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1677
- _content_type: Optional[StrictStr] = None,
1678
- _headers: Optional[Dict[StrictStr, Any]] = None,
1679
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1680
- ) -> ImportValidationSetFromFileResult:
1681
- """Imports a validation set from a zip file.
1682
-
1683
-
1684
- :param blueprint:
1685
- :type blueprint: ValidationImportPostRequestBlueprint
1686
- :param _request_timeout: timeout setting for this request. If one
1687
- number provided, it will be total request
1688
- timeout. It can also be a pair (tuple) of
1689
- (connection, read) timeouts.
1690
- :type _request_timeout: int, tuple(int, int), optional
1691
- :param _request_auth: set to override the auth_settings for an a single
1692
- request; this effectively ignores the
1693
- authentication in the spec for a single request.
1694
- :type _request_auth: dict, optional
1695
- :param _content_type: force content-type for the request.
1696
- :type _content_type: str, Optional
1697
- :param _headers: set to override the headers for a single
1698
- request; this effectively ignores the headers
1699
- in the spec for a single request.
1700
- :type _headers: dict, optional
1701
- :param _host_index: set to override the host_index for a single
1702
- request; this effectively ignores the host_index
1703
- in the spec for a single request.
1704
- :type _host_index: int, optional
1705
- :return: Returns the result object.
1706
- """ # noqa: E501
1707
-
1708
- _param = self._validation_import_post_serialize(
1709
- blueprint=blueprint,
1710
- _request_auth=_request_auth,
1711
- _content_type=_content_type,
1712
- _headers=_headers,
1713
- _host_index=_host_index
1714
- )
1715
-
1716
- _response_types_map: Dict[str, Optional[str]] = {
1717
- '200': "ImportValidationSetFromFileResult",
1718
- }
1719
- response_data = self.api_client.call_api(
1720
- *_param,
1721
- _request_timeout=_request_timeout
1722
- )
1723
- response_data.read()
1724
- return self.api_client.response_deserialize(
1725
- response_data=response_data,
1726
- response_types_map=_response_types_map,
1727
- ).data
1728
-
1729
-
1730
- @validate_call
1731
- def validation_import_post_with_http_info(
1732
- self,
1733
- blueprint: Optional[ValidationImportPostRequestBlueprint] = None,
1734
- _request_timeout: Union[
1735
- None,
1736
- Annotated[StrictFloat, Field(gt=0)],
1737
- Tuple[
1738
- Annotated[StrictFloat, Field(gt=0)],
1739
- Annotated[StrictFloat, Field(gt=0)]
1740
- ]
1741
- ] = None,
1742
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1743
- _content_type: Optional[StrictStr] = None,
1744
- _headers: Optional[Dict[StrictStr, Any]] = None,
1745
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1746
- ) -> ApiResponse[ImportValidationSetFromFileResult]:
1747
- """Imports a validation set from a zip file.
1748
-
1749
-
1750
- :param blueprint:
1751
- :type blueprint: ValidationImportPostRequestBlueprint
1752
- :param _request_timeout: timeout setting for this request. If one
1753
- number provided, it will be total request
1754
- timeout. It can also be a pair (tuple) of
1755
- (connection, read) timeouts.
1756
- :type _request_timeout: int, tuple(int, int), optional
1757
- :param _request_auth: set to override the auth_settings for an a single
1758
- request; this effectively ignores the
1759
- authentication in the spec for a single request.
1760
- :type _request_auth: dict, optional
1761
- :param _content_type: force content-type for the request.
1762
- :type _content_type: str, Optional
1763
- :param _headers: set to override the headers for a single
1764
- request; this effectively ignores the headers
1765
- in the spec for a single request.
1766
- :type _headers: dict, optional
1767
- :param _host_index: set to override the host_index for a single
1768
- request; this effectively ignores the host_index
1769
- in the spec for a single request.
1770
- :type _host_index: int, optional
1771
- :return: Returns the result object.
1772
- """ # noqa: E501
1773
-
1774
- _param = self._validation_import_post_serialize(
1775
- blueprint=blueprint,
1776
- _request_auth=_request_auth,
1777
- _content_type=_content_type,
1778
- _headers=_headers,
1779
- _host_index=_host_index
1780
- )
1781
-
1782
- _response_types_map: Dict[str, Optional[str]] = {
1783
- '200': "ImportValidationSetFromFileResult",
1784
- }
1785
- response_data = self.api_client.call_api(
1786
- *_param,
1787
- _request_timeout=_request_timeout
1788
- )
1789
- response_data.read()
1790
- return self.api_client.response_deserialize(
1791
- response_data=response_data,
1792
- response_types_map=_response_types_map,
1793
- )
1794
-
1795
-
1796
- @validate_call
1797
- def validation_import_post_without_preload_content(
1798
- self,
1799
- blueprint: Optional[ValidationImportPostRequestBlueprint] = None,
1800
- _request_timeout: Union[
1801
- None,
1802
- Annotated[StrictFloat, Field(gt=0)],
1803
- Tuple[
1804
- Annotated[StrictFloat, Field(gt=0)],
1805
- Annotated[StrictFloat, Field(gt=0)]
1806
- ]
1807
- ] = None,
1808
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1809
- _content_type: Optional[StrictStr] = None,
1810
- _headers: Optional[Dict[StrictStr, Any]] = None,
1811
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1812
- ) -> RESTResponseType:
1813
- """Imports a validation set from a zip file.
1814
-
1815
-
1816
- :param blueprint:
1817
- :type blueprint: ValidationImportPostRequestBlueprint
1818
- :param _request_timeout: timeout setting for this request. If one
1819
- number provided, it will be total request
1820
- timeout. It can also be a pair (tuple) of
1821
- (connection, read) timeouts.
1822
- :type _request_timeout: int, tuple(int, int), optional
1823
- :param _request_auth: set to override the auth_settings for an a single
1824
- request; this effectively ignores the
1825
- authentication in the spec for a single request.
1826
- :type _request_auth: dict, optional
1827
- :param _content_type: force content-type for the request.
1828
- :type _content_type: str, Optional
1829
- :param _headers: set to override the headers for a single
1830
- request; this effectively ignores the headers
1831
- in the spec for a single request.
1832
- :type _headers: dict, optional
1833
- :param _host_index: set to override the host_index for a single
1834
- request; this effectively ignores the host_index
1835
- in the spec for a single request.
1836
- :type _host_index: int, optional
1837
- :return: Returns the result object.
1838
- """ # noqa: E501
1839
-
1840
- _param = self._validation_import_post_serialize(
1841
- blueprint=blueprint,
1842
- _request_auth=_request_auth,
1843
- _content_type=_content_type,
1844
- _headers=_headers,
1845
- _host_index=_host_index
1846
- )
1847
-
1848
- _response_types_map: Dict[str, Optional[str]] = {
1849
- '200': "ImportValidationSetFromFileResult",
1850
- }
1851
- response_data = self.api_client.call_api(
1852
- *_param,
1853
- _request_timeout=_request_timeout
1854
- )
1855
- return response_data.response
1856
-
1857
-
1858
- def _validation_import_post_serialize(
1859
- self,
1860
- blueprint,
1861
- _request_auth,
1862
- _content_type,
1863
- _headers,
1864
- _host_index,
1865
- ) -> RequestSerialized:
1866
-
1867
- _host = None
1868
-
1869
- _collection_formats: Dict[str, str] = {
1870
- }
1871
-
1872
- _path_params: Dict[str, str] = {}
1873
- _query_params: List[Tuple[str, str]] = []
1874
- _header_params: Dict[str, Optional[str]] = _headers or {}
1875
- _form_params: List[Tuple[str, str]] = []
1876
- _files: Dict[
1877
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1878
- ] = {}
1879
- _body_params: Optional[bytes] = None
1880
-
1881
- # process the path parameters
1882
- # process the query parameters
1883
- # process the header parameters
1884
- # process the form parameters
1885
- if blueprint is not None:
1886
- _form_params.append(('Blueprint', blueprint))
1887
- # process the body parameter
1888
-
1889
-
1890
- # set the HTTP header `Accept`
1891
- if 'Accept' not in _header_params:
1892
- _header_params['Accept'] = self.api_client.select_header_accept(
1893
- [
1894
- 'text/plain',
1895
- 'application/json',
1896
- 'text/json'
1897
- ]
1898
- )
1899
-
1900
- # set the HTTP header `Content-Type`
1901
- if _content_type:
1902
- _header_params['Content-Type'] = _content_type
1903
- else:
1904
- _default_content_type = (
1905
- self.api_client.select_header_content_type(
1906
- [
1907
- 'multipart/form-data'
1908
- ]
1909
- )
1910
- )
1911
- if _default_content_type is not None:
1912
- _header_params['Content-Type'] = _default_content_type
1913
-
1914
- # authentication setting
1915
- _auth_settings: List[str] = [
1916
- 'bearer',
1917
- 'oauth2'
1918
- ]
1919
-
1920
- return self.api_client.param_serialize(
1921
- method='POST',
1922
- resource_path='/Validation/Import',
1923
- path_params=_path_params,
1924
- query_params=_query_params,
1925
- header_params=_header_params,
1926
- body=_body_params,
1927
- post_params=_form_params,
1928
- files=_files,
1929
- auth_settings=_auth_settings,
1930
- collection_formats=_collection_formats,
1931
- _host=_host,
1932
- _request_auth=_request_auth
1933
- )
1934
-
1935
-
1936
-
1937
-
1938
- @validate_call
1939
- def validation_query_validation_sets_get(
1940
- self,
1941
- model: Annotated[Optional[QueryModel], Field(description="The model containing the query parameters.")] = None,
1942
- _request_timeout: Union[
1943
- None,
1944
- Annotated[StrictFloat, Field(gt=0)],
1945
- Tuple[
1946
- Annotated[StrictFloat, Field(gt=0)],
1947
- Annotated[StrictFloat, Field(gt=0)]
1948
- ]
1949
- ] = None,
1950
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1951
- _content_type: Optional[StrictStr] = None,
1952
- _headers: Optional[Dict[StrictStr, Any]] = None,
1953
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1954
- ) -> ValidationSetModelPagedResult:
1955
- """Queries validation sets based on the provided filter, paging and sorting criteria.
1956
-
1957
-
1958
- :param model: The model containing the query parameters.
1959
- :type model: QueryModel
1960
- :param _request_timeout: timeout setting for this request. If one
1961
- number provided, it will be total request
1962
- timeout. It can also be a pair (tuple) of
1963
- (connection, read) timeouts.
1964
- :type _request_timeout: int, tuple(int, int), optional
1965
- :param _request_auth: set to override the auth_settings for an a single
1966
- request; this effectively ignores the
1967
- authentication in the spec for a single request.
1968
- :type _request_auth: dict, optional
1969
- :param _content_type: force content-type for the request.
1970
- :type _content_type: str, Optional
1971
- :param _headers: set to override the headers for a single
1972
- request; this effectively ignores the headers
1973
- in the spec for a single request.
1974
- :type _headers: dict, optional
1975
- :param _host_index: set to override the host_index for a single
1976
- request; this effectively ignores the host_index
1977
- in the spec for a single request.
1978
- :type _host_index: int, optional
1979
- :return: Returns the result object.
1980
- """ # noqa: E501
1981
-
1982
- _param = self._validation_query_validation_sets_get_serialize(
1983
- model=model,
1984
- _request_auth=_request_auth,
1985
- _content_type=_content_type,
1986
- _headers=_headers,
1987
- _host_index=_host_index
1988
- )
1989
-
1990
- _response_types_map: Dict[str, Optional[str]] = {
1991
- '200': "ValidationSetModelPagedResult",
1992
- }
1993
- response_data = self.api_client.call_api(
1994
- *_param,
1995
- _request_timeout=_request_timeout
1996
- )
1997
- response_data.read()
1998
- return self.api_client.response_deserialize(
1999
- response_data=response_data,
2000
- response_types_map=_response_types_map,
2001
- ).data
2002
-
2003
-
2004
- @validate_call
2005
- def validation_query_validation_sets_get_with_http_info(
2006
- self,
2007
- model: Annotated[Optional[QueryModel], Field(description="The model containing the query parameters.")] = None,
2008
- _request_timeout: Union[
2009
- None,
2010
- Annotated[StrictFloat, Field(gt=0)],
2011
- Tuple[
2012
- Annotated[StrictFloat, Field(gt=0)],
2013
- Annotated[StrictFloat, Field(gt=0)]
2014
- ]
2015
- ] = None,
2016
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2017
- _content_type: Optional[StrictStr] = None,
2018
- _headers: Optional[Dict[StrictStr, Any]] = None,
2019
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2020
- ) -> ApiResponse[ValidationSetModelPagedResult]:
2021
- """Queries validation sets based on the provided filter, paging and sorting criteria.
2022
-
2023
-
2024
- :param model: The model containing the query parameters.
2025
- :type model: QueryModel
2026
- :param _request_timeout: timeout setting for this request. If one
2027
- number provided, it will be total request
2028
- timeout. It can also be a pair (tuple) of
2029
- (connection, read) timeouts.
2030
- :type _request_timeout: int, tuple(int, int), optional
2031
- :param _request_auth: set to override the auth_settings for an a single
2032
- request; this effectively ignores the
2033
- authentication in the spec for a single request.
2034
- :type _request_auth: dict, optional
2035
- :param _content_type: force content-type for the request.
2036
- :type _content_type: str, Optional
2037
- :param _headers: set to override the headers for a single
2038
- request; this effectively ignores the headers
2039
- in the spec for a single request.
2040
- :type _headers: dict, optional
2041
- :param _host_index: set to override the host_index for a single
2042
- request; this effectively ignores the host_index
2043
- in the spec for a single request.
2044
- :type _host_index: int, optional
2045
- :return: Returns the result object.
2046
- """ # noqa: E501
2047
-
2048
- _param = self._validation_query_validation_sets_get_serialize(
2049
- model=model,
2050
- _request_auth=_request_auth,
2051
- _content_type=_content_type,
2052
- _headers=_headers,
2053
- _host_index=_host_index
2054
- )
2055
-
2056
- _response_types_map: Dict[str, Optional[str]] = {
2057
- '200': "ValidationSetModelPagedResult",
2058
- }
2059
- response_data = self.api_client.call_api(
2060
- *_param,
2061
- _request_timeout=_request_timeout
2062
- )
2063
- response_data.read()
2064
- return self.api_client.response_deserialize(
2065
- response_data=response_data,
2066
- response_types_map=_response_types_map,
2067
- )
2068
-
2069
-
2070
- @validate_call
2071
- def validation_query_validation_sets_get_without_preload_content(
2072
- self,
2073
- model: Annotated[Optional[QueryModel], Field(description="The model containing the query parameters.")] = None,
2074
- _request_timeout: Union[
2075
- None,
2076
- Annotated[StrictFloat, Field(gt=0)],
2077
- Tuple[
2078
- Annotated[StrictFloat, Field(gt=0)],
2079
- Annotated[StrictFloat, Field(gt=0)]
2080
- ]
2081
- ] = None,
2082
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2083
- _content_type: Optional[StrictStr] = None,
2084
- _headers: Optional[Dict[StrictStr, Any]] = None,
2085
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2086
- ) -> RESTResponseType:
2087
- """Queries validation sets based on the provided filter, paging and sorting criteria.
2088
-
2089
-
2090
- :param model: The model containing the query parameters.
2091
- :type model: QueryModel
2092
- :param _request_timeout: timeout setting for this request. If one
2093
- number provided, it will be total request
2094
- timeout. It can also be a pair (tuple) of
2095
- (connection, read) timeouts.
2096
- :type _request_timeout: int, tuple(int, int), optional
2097
- :param _request_auth: set to override the auth_settings for an a single
2098
- request; this effectively ignores the
2099
- authentication in the spec for a single request.
2100
- :type _request_auth: dict, optional
2101
- :param _content_type: force content-type for the request.
2102
- :type _content_type: str, Optional
2103
- :param _headers: set to override the headers for a single
2104
- request; this effectively ignores the headers
2105
- in the spec for a single request.
2106
- :type _headers: dict, optional
2107
- :param _host_index: set to override the host_index for a single
2108
- request; this effectively ignores the host_index
2109
- in the spec for a single request.
2110
- :type _host_index: int, optional
2111
- :return: Returns the result object.
2112
- """ # noqa: E501
2113
-
2114
- _param = self._validation_query_validation_sets_get_serialize(
2115
- model=model,
2116
- _request_auth=_request_auth,
2117
- _content_type=_content_type,
2118
- _headers=_headers,
2119
- _host_index=_host_index
2120
- )
2121
-
2122
- _response_types_map: Dict[str, Optional[str]] = {
2123
- '200': "ValidationSetModelPagedResult",
2124
- }
2125
- response_data = self.api_client.call_api(
2126
- *_param,
2127
- _request_timeout=_request_timeout
2128
- )
2129
- return response_data.response
2130
-
2131
-
2132
- def _validation_query_validation_sets_get_serialize(
2133
- self,
2134
- model,
2135
- _request_auth,
2136
- _content_type,
2137
- _headers,
2138
- _host_index,
2139
- ) -> RequestSerialized:
2140
-
2141
- _host = None
2142
-
2143
- _collection_formats: Dict[str, str] = {
2144
- }
2145
-
2146
- _path_params: Dict[str, str] = {}
2147
- _query_params: List[Tuple[str, str]] = []
2148
- _header_params: Dict[str, Optional[str]] = _headers or {}
2149
- _form_params: List[Tuple[str, str]] = []
2150
- _files: Dict[
2151
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2152
- ] = {}
2153
- _body_params: Optional[bytes] = None
2154
-
2155
- # process the path parameters
2156
- # process the query parameters
2157
- if model is not None:
2158
-
2159
- _query_params.append(('model', model))
2160
-
2161
- # process the header parameters
2162
- # process the form parameters
2163
- # process the body parameter
2164
-
2165
-
2166
- # set the HTTP header `Accept`
2167
- if 'Accept' not in _header_params:
2168
- _header_params['Accept'] = self.api_client.select_header_accept(
2169
- [
2170
- 'text/plain',
2171
- 'application/json',
2172
- 'text/json'
2173
- ]
2174
- )
2175
-
2176
-
2177
- # authentication setting
2178
- _auth_settings: List[str] = [
2179
- 'bearer',
2180
- 'oauth2'
2181
- ]
2182
-
2183
- return self.api_client.param_serialize(
2184
- method='GET',
2185
- resource_path='/Validation/QueryValidationSets',
2186
- path_params=_path_params,
2187
- query_params=_query_params,
2188
- header_params=_header_params,
2189
- body=_body_params,
2190
- post_params=_form_params,
2191
- files=_files,
2192
- auth_settings=_auth_settings,
2193
- collection_formats=_collection_formats,
2194
- _host=_host,
2195
- _request_auth=_request_auth
2196
- )
2197
-
2198
-
2199
-
2200
-
2201
- @validate_call
2202
- def validation_validation_set_id_dimensions_patch(
2203
- self,
2204
- validation_set_id: StrictStr,
2205
- update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The model containing the dimensions")] = None,
2206
- _request_timeout: Union[
2207
- None,
2208
- Annotated[StrictFloat, Field(gt=0)],
2209
- Tuple[
2210
- Annotated[StrictFloat, Field(gt=0)],
2211
- Annotated[StrictFloat, Field(gt=0)]
2212
- ]
2213
- ] = None,
2214
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2215
- _content_type: Optional[StrictStr] = None,
2216
- _headers: Optional[Dict[StrictStr, Any]] = None,
2217
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2218
- ) -> None:
2219
- """Updates the dimensions of all rapids within a validation set.
2220
-
2221
-
2222
- :param validation_set_id: (required)
2223
- :type validation_set_id: str
2224
- :param update_dimensions_model: The model containing the dimensions
2225
- :type update_dimensions_model: UpdateDimensionsModel
2226
- :param _request_timeout: timeout setting for this request. If one
2227
- number provided, it will be total request
2228
- timeout. It can also be a pair (tuple) of
2229
- (connection, read) timeouts.
2230
- :type _request_timeout: int, tuple(int, int), optional
2231
- :param _request_auth: set to override the auth_settings for an a single
2232
- request; this effectively ignores the
2233
- authentication in the spec for a single request.
2234
- :type _request_auth: dict, optional
2235
- :param _content_type: force content-type for the request.
2236
- :type _content_type: str, Optional
2237
- :param _headers: set to override the headers for a single
2238
- request; this effectively ignores the headers
2239
- in the spec for a single request.
2240
- :type _headers: dict, optional
2241
- :param _host_index: set to override the host_index for a single
2242
- request; this effectively ignores the host_index
2243
- in the spec for a single request.
2244
- :type _host_index: int, optional
2245
- :return: Returns the result object.
2246
- """ # noqa: E501
2247
-
2248
- _param = self._validation_validation_set_id_dimensions_patch_serialize(
2249
- validation_set_id=validation_set_id,
2250
- update_dimensions_model=update_dimensions_model,
2251
- _request_auth=_request_auth,
2252
- _content_type=_content_type,
2253
- _headers=_headers,
2254
- _host_index=_host_index
2255
- )
2256
-
2257
- _response_types_map: Dict[str, Optional[str]] = {
2258
- '200': None,
2259
- }
2260
- response_data = self.api_client.call_api(
2261
- *_param,
2262
- _request_timeout=_request_timeout
2263
- )
2264
- response_data.read()
2265
- return self.api_client.response_deserialize(
2266
- response_data=response_data,
2267
- response_types_map=_response_types_map,
2268
- ).data
2269
-
2270
-
2271
- @validate_call
2272
- def validation_validation_set_id_dimensions_patch_with_http_info(
2273
- self,
2274
- validation_set_id: StrictStr,
2275
- update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The model containing the dimensions")] = None,
2276
- _request_timeout: Union[
2277
- None,
2278
- Annotated[StrictFloat, Field(gt=0)],
2279
- Tuple[
2280
- Annotated[StrictFloat, Field(gt=0)],
2281
- Annotated[StrictFloat, Field(gt=0)]
2282
- ]
2283
- ] = None,
2284
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2285
- _content_type: Optional[StrictStr] = None,
2286
- _headers: Optional[Dict[StrictStr, Any]] = None,
2287
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2288
- ) -> ApiResponse[None]:
2289
- """Updates the dimensions of all rapids within a validation set.
2290
-
2291
-
2292
- :param validation_set_id: (required)
2293
- :type validation_set_id: str
2294
- :param update_dimensions_model: The model containing the dimensions
2295
- :type update_dimensions_model: UpdateDimensionsModel
2296
- :param _request_timeout: timeout setting for this request. If one
2297
- number provided, it will be total request
2298
- timeout. It can also be a pair (tuple) of
2299
- (connection, read) timeouts.
2300
- :type _request_timeout: int, tuple(int, int), optional
2301
- :param _request_auth: set to override the auth_settings for an a single
2302
- request; this effectively ignores the
2303
- authentication in the spec for a single request.
2304
- :type _request_auth: dict, optional
2305
- :param _content_type: force content-type for the request.
2306
- :type _content_type: str, Optional
2307
- :param _headers: set to override the headers for a single
2308
- request; this effectively ignores the headers
2309
- in the spec for a single request.
2310
- :type _headers: dict, optional
2311
- :param _host_index: set to override the host_index for a single
2312
- request; this effectively ignores the host_index
2313
- in the spec for a single request.
2314
- :type _host_index: int, optional
2315
- :return: Returns the result object.
2316
- """ # noqa: E501
2317
-
2318
- _param = self._validation_validation_set_id_dimensions_patch_serialize(
2319
- validation_set_id=validation_set_id,
2320
- update_dimensions_model=update_dimensions_model,
2321
- _request_auth=_request_auth,
2322
- _content_type=_content_type,
2323
- _headers=_headers,
2324
- _host_index=_host_index
2325
- )
2326
-
2327
- _response_types_map: Dict[str, Optional[str]] = {
2328
- '200': None,
2329
- }
2330
- response_data = self.api_client.call_api(
2331
- *_param,
2332
- _request_timeout=_request_timeout
2333
- )
2334
- response_data.read()
2335
- return self.api_client.response_deserialize(
2336
- response_data=response_data,
2337
- response_types_map=_response_types_map,
2338
- )
2339
-
2340
-
2341
- @validate_call
2342
- def validation_validation_set_id_dimensions_patch_without_preload_content(
2343
- self,
2344
- validation_set_id: StrictStr,
2345
- update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The model containing the dimensions")] = None,
2346
- _request_timeout: Union[
2347
- None,
2348
- Annotated[StrictFloat, Field(gt=0)],
2349
- Tuple[
2350
- Annotated[StrictFloat, Field(gt=0)],
2351
- Annotated[StrictFloat, Field(gt=0)]
2352
- ]
2353
- ] = None,
2354
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
2355
- _content_type: Optional[StrictStr] = None,
2356
- _headers: Optional[Dict[StrictStr, Any]] = None,
2357
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2358
- ) -> RESTResponseType:
2359
- """Updates the dimensions of all rapids within a validation set.
2360
-
2361
-
2362
- :param validation_set_id: (required)
2363
- :type validation_set_id: str
2364
- :param update_dimensions_model: The model containing the dimensions
2365
- :type update_dimensions_model: UpdateDimensionsModel
2366
- :param _request_timeout: timeout setting for this request. If one
2367
- number provided, it will be total request
2368
- timeout. It can also be a pair (tuple) of
2369
- (connection, read) timeouts.
2370
- :type _request_timeout: int, tuple(int, int), optional
2371
- :param _request_auth: set to override the auth_settings for an a single
2372
- request; this effectively ignores the
2373
- authentication in the spec for a single request.
2374
- :type _request_auth: dict, optional
2375
- :param _content_type: force content-type for the request.
2376
- :type _content_type: str, Optional
2377
- :param _headers: set to override the headers for a single
2378
- request; this effectively ignores the headers
2379
- in the spec for a single request.
2380
- :type _headers: dict, optional
2381
- :param _host_index: set to override the host_index for a single
2382
- request; this effectively ignores the host_index
2383
- in the spec for a single request.
2384
- :type _host_index: int, optional
2385
- :return: Returns the result object.
2386
- """ # noqa: E501
2387
-
2388
- _param = self._validation_validation_set_id_dimensions_patch_serialize(
2389
- validation_set_id=validation_set_id,
2390
- update_dimensions_model=update_dimensions_model,
2391
- _request_auth=_request_auth,
2392
- _content_type=_content_type,
2393
- _headers=_headers,
2394
- _host_index=_host_index
2395
- )
2396
-
2397
- _response_types_map: Dict[str, Optional[str]] = {
2398
- '200': None,
2399
- }
2400
- response_data = self.api_client.call_api(
2401
- *_param,
2402
- _request_timeout=_request_timeout
2403
- )
2404
- return response_data.response
2405
-
2406
-
2407
- def _validation_validation_set_id_dimensions_patch_serialize(
2408
- self,
2409
- validation_set_id,
2410
- update_dimensions_model,
2411
- _request_auth,
2412
- _content_type,
2413
- _headers,
2414
- _host_index,
2415
- ) -> RequestSerialized:
2416
-
2417
- _host = None
2418
-
2419
- _collection_formats: Dict[str, str] = {
2420
- }
2421
-
2422
- _path_params: Dict[str, str] = {}
2423
- _query_params: List[Tuple[str, str]] = []
2424
- _header_params: Dict[str, Optional[str]] = _headers or {}
2425
- _form_params: List[Tuple[str, str]] = []
2426
- _files: Dict[
2427
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2428
- ] = {}
2429
- _body_params: Optional[bytes] = None
2430
-
2431
- # process the path parameters
2432
- if validation_set_id is not None:
2433
- _path_params['validationSetId'] = validation_set_id
2434
- # process the query parameters
2435
- # process the header parameters
2436
- # process the form parameters
2437
- # process the body parameter
2438
- if update_dimensions_model is not None:
2439
- _body_params = update_dimensions_model
2440
-
2441
-
2442
-
2443
- # set the HTTP header `Content-Type`
2444
- if _content_type:
2445
- _header_params['Content-Type'] = _content_type
2446
- else:
2447
- _default_content_type = (
2448
- self.api_client.select_header_content_type(
2449
- [
2450
- 'application/json',
2451
- 'text/json',
2452
- 'application/*+json'
2453
- ]
2454
- )
2455
- )
2456
- if _default_content_type is not None:
2457
- _header_params['Content-Type'] = _default_content_type
2458
-
2459
- # authentication setting
2460
- _auth_settings: List[str] = [
2461
- 'bearer',
2462
- 'oauth2'
2463
- ]
2464
-
2465
- return self.api_client.param_serialize(
2466
- method='PATCH',
2467
- resource_path='/validation/{validationSetId}/dimensions',
2468
- path_params=_path_params,
2469
- query_params=_query_params,
2470
- header_params=_header_params,
2471
- body=_body_params,
2472
- post_params=_form_params,
2473
- files=_files,
2474
- auth_settings=_auth_settings,
2475
- collection_formats=_collection_formats,
2476
- _host=_host,
2477
- _request_auth=_request_auth
2478
- )
2479
-
2480
-