regula-documentreader-webclient 8.1.355rc0__py3-none-any.whl → 8.1.357.dev0__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 regula-documentreader-webclient might be problematic. Click here for more details.

Files changed (289) hide show
  1. regula/documentreader/webclient/ext/__init__.py +0 -1
  2. regula/documentreader/webclient/ext/api/document_reader_api.py +2 -2
  3. regula/documentreader/webclient/ext/models/__init__.py +0 -2
  4. regula/documentreader/webclient/ext/models/authenticity/authenticity_check_list.py +64 -19
  5. regula/documentreader/webclient/ext/models/authenticity/fiber.py +7 -7
  6. regula/documentreader/webclient/ext/models/authenticity/ident.py +10 -9
  7. regula/documentreader/webclient/ext/models/authenticity/image_ident.py +8 -7
  8. regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py +7 -7
  9. regula/documentreader/webclient/ext/models/authenticity/security_feature.py +10 -8
  10. regula/documentreader/webclient/ext/models/images.py +4 -4
  11. regula/documentreader/webclient/ext/models/recognition_request.py +23 -24
  12. regula/documentreader/webclient/ext/models/recognition_response.py +6 -8
  13. regula/documentreader/webclient/ext/models/text.py +7 -12
  14. regula/documentreader/webclient/gen/__init__.py +100 -26
  15. regula/documentreader/webclient/gen/api/__init__.py +1 -2
  16. regula/documentreader/webclient/gen/api/healthcheck_api.py +687 -298
  17. regula/documentreader/webclient/gen/api/process_api.py +270 -125
  18. regula/documentreader/webclient/gen/api/transaction_api.py +1472 -673
  19. regula/documentreader/webclient/gen/api_client.py +583 -462
  20. regula/documentreader/webclient/gen/api_response.py +21 -0
  21. regula/documentreader/webclient/gen/configuration.py +222 -99
  22. regula/documentreader/webclient/gen/exceptions.py +81 -30
  23. regula/documentreader/webclient/gen/models/__init__.py +98 -25
  24. regula/documentreader/webclient/gen/models/area_array.py +85 -131
  25. regula/documentreader/webclient/gen/models/area_container.py +85 -157
  26. regula/documentreader/webclient/gen/models/auth_params.py +100 -526
  27. regula/documentreader/webclient/gen/models/authenticity_check_list.py +75 -136
  28. regula/documentreader/webclient/gen/models/authenticity_check_list_item.py +83 -0
  29. regula/documentreader/webclient/gen/models/authenticity_check_result.py +81 -160
  30. regula/documentreader/webclient/gen/models/authenticity_check_result_item.py +154 -217
  31. regula/documentreader/webclient/gen/models/authenticity_check_result_list_inner.py +174 -0
  32. regula/documentreader/webclient/gen/models/authenticity_result.py +68 -231
  33. regula/documentreader/webclient/gen/models/authenticity_result_type.py +35 -123
  34. regula/documentreader/webclient/gen/models/bar_code_module_type.py +32 -0
  35. regula/documentreader/webclient/gen/models/barcode_type.py +47 -0
  36. regula/documentreader/webclient/gen/models/bc_pdf417_info.py +75 -235
  37. regula/documentreader/webclient/gen/models/bc_roidetect.py +71 -183
  38. regula/documentreader/webclient/gen/models/binary_data.py +218 -0
  39. regula/documentreader/webclient/gen/models/byte_array_item.py +79 -0
  40. regula/documentreader/webclient/gen/models/byte_array_result.py +64 -233
  41. regula/documentreader/webclient/gen/models/candidates_list_item.py +83 -0
  42. regula/documentreader/webclient/gen/models/certificate_data.py +81 -0
  43. regula/documentreader/webclient/gen/models/check_diagnose.py +138 -329
  44. regula/documentreader/webclient/gen/models/check_result.py +15 -84
  45. regula/documentreader/webclient/gen/models/chosen_document_type.py +94 -334
  46. regula/documentreader/webclient/gen/models/chosen_document_type_result.py +80 -264
  47. regula/documentreader/webclient/gen/models/container_list.py +75 -134
  48. regula/documentreader/webclient/gen/models/container_list_list_inner.py +426 -0
  49. regula/documentreader/webclient/gen/models/critical.py +14 -82
  50. regula/documentreader/webclient/gen/models/cross_source_value_comparison.py +67 -156
  51. regula/documentreader/webclient/gen/models/data_module.py +74 -209
  52. regula/documentreader/webclient/gen/models/details_optical.py +83 -298
  53. regula/documentreader/webclient/gen/models/details_rfid.py +78 -268
  54. regula/documentreader/webclient/gen/models/device_info.py +76 -235
  55. regula/documentreader/webclient/gen/models/doc_bar_code_info.py +68 -230
  56. regula/documentreader/webclient/gen/models/doc_bar_code_info_fields_list.py +75 -135
  57. regula/documentreader/webclient/gen/models/doc_bar_code_info_item.py +83 -0
  58. regula/documentreader/webclient/gen/models/doc_graphics_info_item.py +83 -0
  59. regula/documentreader/webclient/gen/models/doc_visual_extended_field.py +105 -301
  60. regula/documentreader/webclient/gen/models/doc_visual_extended_field_item.py +83 -0
  61. regula/documentreader/webclient/gen/models/doc_visual_extended_info.py +75 -106
  62. regula/documentreader/webclient/gen/models/doc_visual_extended_info_item.py +83 -0
  63. regula/documentreader/webclient/gen/models/document_binary_info_result.py +90 -0
  64. regula/documentreader/webclient/gen/models/document_format.py +27 -105
  65. regula/documentreader/webclient/gen/models/document_image.py +63 -132
  66. regula/documentreader/webclient/gen/models/document_image_result.py +68 -231
  67. regula/documentreader/webclient/gen/models/document_position.py +111 -340
  68. regula/documentreader/webclient/gen/models/document_position_item.py +83 -0
  69. regula/documentreader/webclient/gen/models/document_position_result.py +68 -230
  70. regula/documentreader/webclient/gen/models/document_type.py +243 -539
  71. regula/documentreader/webclient/gen/models/document_type_recognition_result.py +15 -84
  72. regula/documentreader/webclient/gen/models/document_types_candidates.py +76 -131
  73. regula/documentreader/webclient/gen/models/document_types_candidates_list.py +76 -131
  74. regula/documentreader/webclient/gen/models/document_types_candidates_result.py +68 -230
  75. regula/documentreader/webclient/gen/models/documents_database.py +71 -191
  76. regula/documentreader/webclient/gen/models/encrypted_rcl_item.py +79 -0
  77. regula/documentreader/webclient/gen/models/encrypted_rcl_result.py +64 -233
  78. regula/documentreader/webclient/gen/models/error_coordinates.py +85 -0
  79. regula/documentreader/webclient/gen/models/face_api.py +88 -358
  80. regula/documentreader/webclient/gen/models/face_api_search.py +65 -159
  81. regula/documentreader/webclient/gen/models/face_detection.py +95 -0
  82. regula/documentreader/webclient/gen/models/face_detection_item.py +83 -0
  83. regula/documentreader/webclient/gen/models/face_detection_result.py +90 -0
  84. regula/documentreader/webclient/gen/models/face_item.py +109 -0
  85. regula/documentreader/webclient/gen/models/fdsid_list.py +91 -390
  86. regula/documentreader/webclient/gen/models/fiber_item.py +106 -0
  87. regula/documentreader/webclient/gen/models/fiber_result.py +103 -439
  88. regula/documentreader/webclient/gen/models/field_item.py +89 -0
  89. regula/documentreader/webclient/gen/models/file_image.py +81 -0
  90. regula/documentreader/webclient/gen/models/get_transactions_by_tag_response.py +66 -159
  91. regula/documentreader/webclient/gen/models/graph_data.py +95 -0
  92. regula/documentreader/webclient/gen/models/graphic_field.py +80 -271
  93. regula/documentreader/webclient/gen/models/graphic_field_type.py +40 -131
  94. regula/documentreader/webclient/gen/models/graphic_fields_list.py +75 -106
  95. regula/documentreader/webclient/gen/models/graphics_result.py +68 -231
  96. regula/documentreader/webclient/gen/models/healthcheck.py +117 -297
  97. regula/documentreader/webclient/gen/models/healthcheck_documents_database.py +91 -187
  98. regula/documentreader/webclient/gen/models/ident_item.py +110 -0
  99. regula/documentreader/webclient/gen/models/ident_result.py +107 -345
  100. regula/documentreader/webclient/gen/models/image_data.py +63 -132
  101. regula/documentreader/webclient/gen/models/image_qa.py +83 -304
  102. regula/documentreader/webclient/gen/models/image_quality_check.py +86 -263
  103. regula/documentreader/webclient/gen/models/image_quality_check_list.py +78 -133
  104. regula/documentreader/webclient/gen/models/image_quality_check_list_item.py +83 -0
  105. regula/documentreader/webclient/gen/models/image_quality_check_type.py +22 -97
  106. regula/documentreader/webclient/gen/models/image_quality_result.py +68 -231
  107. regula/documentreader/webclient/gen/models/image_transaction_data.py +61 -97
  108. regula/documentreader/webclient/gen/models/images.py +87 -133
  109. regula/documentreader/webclient/gen/models/images_available_source.py +64 -130
  110. regula/documentreader/webclient/gen/models/images_field.py +80 -162
  111. regula/documentreader/webclient/gen/models/images_field_value.py +94 -331
  112. regula/documentreader/webclient/gen/models/images_item.py +83 -0
  113. regula/documentreader/webclient/gen/models/images_result.py +68 -231
  114. regula/documentreader/webclient/gen/models/in_data.py +79 -131
  115. regula/documentreader/webclient/gen/models/in_data_transaction_images_field_value.py +72 -187
  116. regula/documentreader/webclient/gen/models/in_data_video.py +63 -131
  117. regula/documentreader/webclient/gen/models/input_barcode_type.py +33 -119
  118. regula/documentreader/webclient/gen/models/input_image_quality_checks.py +22 -97
  119. regula/documentreader/webclient/gen/models/lcid.py +179 -402
  120. regula/documentreader/webclient/gen/models/lexical_analysis_result.py +68 -234
  121. regula/documentreader/webclient/gen/models/license_item.py +79 -0
  122. regula/documentreader/webclient/gen/models/license_result.py +64 -233
  123. regula/documentreader/webclient/gen/models/light.py +61 -87
  124. regula/documentreader/webclient/gen/models/list_transactions_by_tag_response.py +75 -131
  125. regula/documentreader/webclient/gen/models/list_verified_fields.py +77 -105
  126. regula/documentreader/webclient/gen/models/list_verified_fields_item.py +83 -0
  127. regula/documentreader/webclient/gen/models/liveness_params.py +77 -247
  128. regula/documentreader/webclient/gen/models/log_level.py +17 -88
  129. regula/documentreader/webclient/gen/models/measure_system.py +14 -82
  130. regula/documentreader/webclient/gen/models/mrz_detect_mode_enum.py +15 -84
  131. regula/documentreader/webclient/gen/models/mrz_detector_result.py +90 -0
  132. regula/documentreader/webclient/gen/models/mrz_format.py +18 -90
  133. regula/documentreader/webclient/gen/models/mrz_position.py +124 -0
  134. regula/documentreader/webclient/gen/models/mrz_position_item.py +83 -0
  135. regula/documentreader/webclient/gen/models/mrz_position_result.py +90 -0
  136. regula/documentreader/webclient/gen/models/mrz_rows_item.py +91 -0
  137. regula/documentreader/webclient/gen/models/mrz_test_quality.py +105 -0
  138. regula/documentreader/webclient/gen/models/mrz_test_quality_item.py +83 -0
  139. regula/documentreader/webclient/gen/models/mrz_test_quality_result.py +90 -0
  140. regula/documentreader/webclient/gen/models/ocr_security_text_item.py +110 -0
  141. regula/documentreader/webclient/gen/models/ocr_security_text_result.py +107 -449
  142. regula/documentreader/webclient/gen/models/one_candidate.py +94 -334
  143. regula/documentreader/webclient/gen/models/one_candidate_item.py +87 -0
  144. regula/documentreader/webclient/gen/models/original_symbol.py +74 -167
  145. regula/documentreader/webclient/gen/models/out_data.py +75 -133
  146. regula/documentreader/webclient/gen/models/out_data_transaction_images_field_value.py +75 -213
  147. regula/documentreader/webclient/gen/models/p_array_field.py +103 -342
  148. regula/documentreader/webclient/gen/models/parsed_data.py +79 -0
  149. regula/documentreader/webclient/gen/models/parsing_error_codes.py +153 -0
  150. regula/documentreader/webclient/gen/models/parsing_notification_codes.py +237 -523
  151. regula/documentreader/webclient/gen/models/per_document_config.py +63 -131
  152. regula/documentreader/webclient/gen/models/photo_ident_item.py +110 -0
  153. regula/documentreader/webclient/gen/models/photo_ident_result.py +107 -423
  154. regula/documentreader/webclient/gen/models/point.py +63 -127
  155. regula/documentreader/webclient/gen/models/point_array.py +65 -97
  156. regula/documentreader/webclient/gen/models/points_container.py +75 -131
  157. regula/documentreader/webclient/gen/models/process_params.py +229 -1743
  158. regula/documentreader/webclient/gen/models/process_params_rfid.py +56 -97
  159. regula/documentreader/webclient/gen/models/process_request.py +113 -411
  160. regula/documentreader/webclient/gen/models/process_request_image.py +74 -159
  161. regula/documentreader/webclient/gen/models/process_response.py +96 -299
  162. regula/documentreader/webclient/gen/models/process_system_info.py +63 -131
  163. regula/documentreader/webclient/gen/models/processing_status.py +15 -84
  164. regula/documentreader/webclient/gen/models/raw_image_container_item.py +83 -0
  165. regula/documentreader/webclient/gen/models/raw_image_container_list.py +75 -131
  166. regula/documentreader/webclient/gen/models/rectangle_coordinates.py +71 -187
  167. regula/documentreader/webclient/gen/models/result.py +49 -133
  168. regula/documentreader/webclient/gen/models/result_item.py +195 -245
  169. regula/documentreader/webclient/gen/models/result_mrz_detector.py +93 -0
  170. regula/documentreader/webclient/gen/models/result_mrz_detector_item.py +83 -0
  171. regula/documentreader/webclient/gen/models/rfid_a_chip.py +33 -0
  172. regula/documentreader/webclient/gen/models/rfid_access_control_info.py +90 -0
  173. regula/documentreader/webclient/gen/models/rfid_access_control_procedure_type.py +35 -0
  174. regula/documentreader/webclient/gen/models/rfid_access_key.py +87 -0
  175. regula/documentreader/webclient/gen/models/rfid_application.py +101 -0
  176. regula/documentreader/webclient/gen/models/rfid_application_type.py +37 -0
  177. regula/documentreader/webclient/gen/models/rfid_attribute_data.py +81 -0
  178. regula/documentreader/webclient/gen/models/rfid_attribute_name.py +85 -0
  179. regula/documentreader/webclient/gen/models/rfid_authentication_procedure_type.py +31 -0
  180. regula/documentreader/webclient/gen/models/rfid_baud_rate.py +32 -0
  181. regula/documentreader/webclient/gen/models/rfid_card_properties_ext.py +123 -0
  182. regula/documentreader/webclient/gen/models/rfid_certificate_ex.py +130 -0
  183. regula/documentreader/webclient/gen/models/rfid_certificate_origin.py +36 -0
  184. regula/documentreader/webclient/gen/models/rfid_certificate_type.py +35 -0
  185. regula/documentreader/webclient/gen/models/rfid_data_file.py +118 -0
  186. regula/documentreader/webclient/gen/models/rfid_data_file_type.py +119 -0
  187. regula/documentreader/webclient/gen/models/rfid_data_group_type_tag.py +82 -0
  188. regula/documentreader/webclient/gen/models/rfid_dg1.py +111 -0
  189. regula/documentreader/webclient/gen/models/rfid_distinguished_name.py +95 -0
  190. regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_field.py +120 -0
  191. regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_field_item.py +85 -0
  192. regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_info.py +89 -0
  193. regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_info_item.py +83 -0
  194. regula/documentreader/webclient/gen/models/rfid_error_codes.py +141 -0
  195. regula/documentreader/webclient/gen/models/rfid_graphics_info_result.py +90 -0
  196. regula/documentreader/webclient/gen/models/rfid_location.py +15 -84
  197. regula/documentreader/webclient/gen/models/rfid_origin.py +71 -192
  198. regula/documentreader/webclient/gen/models/rfid_password_type.py +34 -0
  199. regula/documentreader/webclient/gen/models/rfid_pki_extension.py +81 -0
  200. regula/documentreader/webclient/gen/models/rfid_raw_data.py +81 -0
  201. regula/documentreader/webclient/gen/models/rfid_security_object.py +96 -0
  202. regula/documentreader/webclient/gen/models/rfid_session_data.py +150 -0
  203. regula/documentreader/webclient/gen/models/rfid_signer_info_ex.py +133 -0
  204. regula/documentreader/webclient/gen/models/rfid_terminal.py +84 -0
  205. regula/documentreader/webclient/gen/models/rfid_terminal_type.py +32 -0
  206. regula/documentreader/webclient/gen/models/rfid_text_data_result.py +90 -0
  207. regula/documentreader/webclient/gen/models/rfid_type.py +30 -0
  208. regula/documentreader/webclient/gen/models/rfid_validity.py +88 -0
  209. regula/documentreader/webclient/gen/models/rfidpkd_resource_type.py +35 -0
  210. regula/documentreader/webclient/gen/models/scenario.py +33 -117
  211. regula/documentreader/webclient/gen/models/security_feature_item.py +102 -0
  212. regula/documentreader/webclient/gen/models/security_feature_result.py +99 -345
  213. regula/documentreader/webclient/gen/models/security_feature_type.py +68 -185
  214. regula/documentreader/webclient/gen/models/security_object_certificates.py +83 -0
  215. regula/documentreader/webclient/gen/models/source.py +18 -88
  216. regula/documentreader/webclient/gen/models/source_validity.py +65 -129
  217. regula/documentreader/webclient/gen/models/status.py +86 -264
  218. regula/documentreader/webclient/gen/models/status_item.py +83 -0
  219. regula/documentreader/webclient/gen/models/status_result.py +68 -231
  220. regula/documentreader/webclient/gen/models/string_item.py +135 -0
  221. regula/documentreader/webclient/gen/models/string_recognition_result.py +81 -108
  222. regula/documentreader/webclient/gen/models/symbol.py +79 -0
  223. regula/documentreader/webclient/gen/models/symbol_candidate.py +72 -143
  224. regula/documentreader/webclient/gen/models/symbol_estimation_item.py +115 -0
  225. regula/documentreader/webclient/gen/models/symbol_recognition_result.py +87 -135
  226. regula/documentreader/webclient/gen/models/t_doc_binary_info.py +93 -0
  227. regula/documentreader/webclient/gen/models/t_doc_binary_info_item.py +83 -0
  228. regula/documentreader/webclient/gen/models/t_original_rfid_graphics_info.py +87 -0
  229. regula/documentreader/webclient/gen/models/t_original_rfid_graphics_info_item.py +83 -0
  230. regula/documentreader/webclient/gen/models/text.py +92 -214
  231. regula/documentreader/webclient/gen/models/text_available_source.py +67 -157
  232. regula/documentreader/webclient/gen/models/text_data_result.py +68 -230
  233. regula/documentreader/webclient/gen/models/text_field.py +115 -357
  234. regula/documentreader/webclient/gen/models/text_field_type.py +661 -1368
  235. regula/documentreader/webclient/gen/models/text_field_value.py +105 -307
  236. regula/documentreader/webclient/gen/models/text_item.py +83 -0
  237. regula/documentreader/webclient/gen/models/text_post_processing.py +16 -86
  238. regula/documentreader/webclient/gen/models/text_result.py +68 -231
  239. regula/documentreader/webclient/gen/models/transaction_image.py +61 -97
  240. regula/documentreader/webclient/gen/models/transaction_info.py +84 -302
  241. regula/documentreader/webclient/gen/models/transaction_process_get_response.py +79 -183
  242. regula/documentreader/webclient/gen/models/transaction_process_request.py +108 -299
  243. regula/documentreader/webclient/gen/models/transaction_process_response.py +107 -0
  244. regula/documentreader/webclient/gen/models/transaction_process_response_item.py +79 -0
  245. regula/documentreader/webclient/gen/models/transaction_process_result.py +93 -0
  246. regula/documentreader/webclient/gen/models/trf_ft_bytes.py +90 -0
  247. regula/documentreader/webclient/gen/models/trf_ft_string.py +85 -0
  248. regula/documentreader/webclient/gen/models/verification_result.py +17 -88
  249. regula/documentreader/webclient/gen/models/verified_field_map.py +85 -273
  250. regula/documentreader/webclient/gen/models/visibility.py +17 -88
  251. regula/documentreader/webclient/gen/models/visual_extended_field_item.py +112 -0
  252. regula/documentreader/webclient/gen/py.typed +0 -0
  253. regula/documentreader/webclient/gen/rest.py +132 -174
  254. {regula_documentreader_webclient-8.1.355rc0.dist-info → regula_documentreader_webclient-8.1.357.dev0.dist-info}/METADATA +17 -6
  255. regula_documentreader_webclient-8.1.357.dev0.dist-info/RECORD +263 -0
  256. {regula_documentreader_webclient-8.1.355rc0.dist-info → regula_documentreader_webclient-8.1.357.dev0.dist-info}/WHEEL +1 -1
  257. regula/documentreader/webclient/ext/models/raw_authenticity_result_item.py +0 -27
  258. regula/documentreader/webclient/ext/models/raw_result_item.py +0 -26
  259. regula/documentreader/webclient/gen/api/default_api.py +0 -160
  260. regula/documentreader/webclient/gen/models/authenticity_result_all_of.py +0 -120
  261. regula/documentreader/webclient/gen/models/byte_array_result_all_of.py +0 -122
  262. regula/documentreader/webclient/gen/models/chosen_document_type_result_all_of.py +0 -145
  263. regula/documentreader/webclient/gen/models/device_info2.py +0 -275
  264. regula/documentreader/webclient/gen/models/doc_bar_code_info_all_of.py +0 -119
  265. regula/documentreader/webclient/gen/models/document_image_result_all_of.py +0 -120
  266. regula/documentreader/webclient/gen/models/document_position_result_all_of.py +0 -119
  267. regula/documentreader/webclient/gen/models/document_types_candidates_result_all_of.py +0 -119
  268. regula/documentreader/webclient/gen/models/encrypted_rcl_result_all_of.py +0 -122
  269. regula/documentreader/webclient/gen/models/fiber_result_all_of.py +0 -343
  270. regula/documentreader/webclient/gen/models/graphics_result_all_of.py +0 -119
  271. regula/documentreader/webclient/gen/models/ident_result_all_of.py +0 -249
  272. regula/documentreader/webclient/gen/models/image_quality_result_all_of.py +0 -120
  273. regula/documentreader/webclient/gen/models/images_result_all_of.py +0 -120
  274. regula/documentreader/webclient/gen/models/in_data_rfid_session.py +0 -121
  275. regula/documentreader/webclient/gen/models/inline_response200.py +0 -197
  276. regula/documentreader/webclient/gen/models/inline_response2001.py +0 -333
  277. regula/documentreader/webclient/gen/models/lexical_analysis_result_all_of.py +0 -119
  278. regula/documentreader/webclient/gen/models/license_result_all_of.py +0 -122
  279. regula/documentreader/webclient/gen/models/ocr_security_text_result_all_of.py +0 -353
  280. regula/documentreader/webclient/gen/models/photo_ident_result_all_of.py +0 -327
  281. regula/documentreader/webclient/gen/models/security_feature_result_all_of.py +0 -249
  282. regula/documentreader/webclient/gen/models/status_result_all_of.py +0 -120
  283. regula/documentreader/webclient/gen/models/text_data_result_all_of.py +0 -119
  284. regula/documentreader/webclient/gen/models/text_result_all_of.py +0 -120
  285. regula/documentreader/webclient/gen/models/tfdsid_list.py +0 -372
  286. regula/documentreader/webclient/gen/models/transaction_images_field_value.py +0 -227
  287. regula/documentreader/webclient/gen/models/transaction_scenario_request.py +0 -119
  288. regula_documentreader_webclient-8.1.355rc0.dist-info/RECORD +0 -192
  289. {regula_documentreader_webclient-8.1.355rc0.dist-info → regula_documentreader_webclient-8.1.357.dev0.dist-info}/top_level.txt +0 -0
@@ -3,410 +3,799 @@
3
3
  """
4
4
  Generated by: https://openapi-generator.tech
5
5
  """
6
+ import warnings
7
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
8
+ from typing import Any, Dict, List, Optional, Tuple, Union
9
+ from typing_extensions import Annotated
6
10
 
7
- from __future__ import absolute_import
11
+ from pydantic import StrictStr
12
+ from typing import Optional
13
+ from regula.documentreader.webclient.gen.models.device_info import DeviceInfo
14
+ from regula.documentreader.webclient.gen.models.healthcheck import Healthcheck
8
15
 
9
- import re # noqa: F401
16
+ from regula.documentreader.webclient.gen.api_client import ApiClient, RequestSerialized
17
+ from regula.documentreader.webclient.gen.api_response import ApiResponse
18
+ from regula.documentreader.webclient.gen.rest import RESTResponseType
10
19
 
11
- # python 2 and python 3 compatibility library
12
- import six
13
20
 
14
- from regula.documentreader.webclient.gen.api_client import ApiClient
15
- from regula.documentreader.webclient.gen.exceptions import ( # noqa: F401
16
- ApiTypeError,
17
- ApiValueError
18
- )
19
-
20
-
21
- class HealthcheckApi(object):
21
+ class HealthcheckApi:
22
22
  """NOTE: This class is auto generated by OpenAPI Generator
23
23
  Ref: https://openapi-generator.tech
24
24
 
25
25
  Do not edit the class manually.
26
26
  """
27
27
 
28
- def __init__(self, api_client=None):
28
+ def __init__(self, api_client=None) -> None:
29
29
  if api_client is None:
30
- api_client = ApiClient()
30
+ api_client = ApiClient.get_default()
31
31
  self.api_client = api_client
32
32
 
33
- def healthz(self, **kwargs): # noqa: E501
34
- """Server health check # noqa: E501
35
33
 
36
- This method makes a synchronous HTTP request by default. To make an
37
- asynchronous HTTP request, please pass async_req=True
34
+ @validate_call
35
+ def healthz(
36
+ self,
37
+ x_request_id: Optional[StrictStr] = None,
38
+ _request_timeout: Union[
39
+ None,
40
+ Annotated[StrictFloat, Field(gt=0)],
41
+ Tuple[
42
+ Annotated[StrictFloat, Field(gt=0)],
43
+ Annotated[StrictFloat, Field(gt=0)]
44
+ ]
45
+ ] = None,
46
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
47
+ _content_type: Optional[StrictStr] = None,
48
+ _headers: Optional[Dict[StrictStr, Any]] = None,
49
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
50
+ ) -> Healthcheck:
51
+ """Server health check
38
52
 
39
- >>> thread = api.healthz(async_req=True)
40
- >>> result = thread.get()
41
53
 
42
54
  :param x_request_id:
43
55
  :type x_request_id: str
44
- :param async_req: Whether to execute the request asynchronously.
45
- :type async_req: bool, optional
46
- :param _preload_content: if False, the urllib3.HTTPResponse object will
47
- be returned without reading/decoding response
48
- data. Default is True.
49
- :type _preload_content: bool, optional
50
56
  :param _request_timeout: timeout setting for this request. If one
51
57
  number provided, it will be total request
52
58
  timeout. It can also be a pair (tuple) of
53
59
  (connection, read) timeouts.
60
+ :type _request_timeout: int, tuple(int, int), optional
61
+ :param _request_auth: set to override the auth_settings for an a single
62
+ request; this effectively ignores the
63
+ authentication in the spec for a single request.
64
+ :type _request_auth: dict, optional
65
+ :param _content_type: force content-type for the request.
66
+ :type _content_type: str, Optional
67
+ :param _headers: set to override the headers for a single
68
+ request; this effectively ignores the headers
69
+ in the spec for a single request.
70
+ :type _headers: dict, optional
71
+ :param _host_index: set to override the host_index for a single
72
+ request; this effectively ignores the host_index
73
+ in the spec for a single request.
74
+ :type _host_index: int, optional
54
75
  :return: Returns the result object.
55
- If the method is called asynchronously,
56
- returns the request thread.
57
- :rtype: Healthcheck
58
- """
59
- kwargs['_return_http_data_only'] = True
60
- return self.healthz_with_http_info(**kwargs) # noqa: E501
61
-
62
- def healthz_with_http_info(self, **kwargs): # noqa: E501
63
- """Server health check # noqa: E501
76
+ """ # noqa: E501
77
+
78
+ _param = self._healthz_serialize(
79
+ x_request_id=x_request_id,
80
+ _request_auth=_request_auth,
81
+ _content_type=_content_type,
82
+ _headers=_headers,
83
+ _host_index=_host_index
84
+ )
64
85
 
65
- This method makes a synchronous HTTP request by default. To make an
66
- asynchronous HTTP request, please pass async_req=True
86
+ _response_types_map: Dict[str, Optional[str]] = {
87
+ '200': "Healthcheck",
88
+ }
89
+ response_data = self.api_client.call_api(
90
+ *_param,
91
+ _request_timeout=_request_timeout
92
+ )
93
+ response_data.read()
94
+ return self.api_client.response_deserialize(
95
+ response_data=response_data,
96
+ response_types_map=_response_types_map,
97
+ ).data
98
+
99
+
100
+ @validate_call
101
+ def healthz_with_http_info(
102
+ self,
103
+ x_request_id: Optional[StrictStr] = None,
104
+ _request_timeout: Union[
105
+ None,
106
+ Annotated[StrictFloat, Field(gt=0)],
107
+ Tuple[
108
+ Annotated[StrictFloat, Field(gt=0)],
109
+ Annotated[StrictFloat, Field(gt=0)]
110
+ ]
111
+ ] = None,
112
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
113
+ _content_type: Optional[StrictStr] = None,
114
+ _headers: Optional[Dict[StrictStr, Any]] = None,
115
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
116
+ ) -> ApiResponse[Healthcheck]:
117
+ """Server health check
67
118
 
68
- >>> thread = api.healthz_with_http_info(async_req=True)
69
- >>> result = thread.get()
70
119
 
71
120
  :param x_request_id:
72
121
  :type x_request_id: str
73
- :param async_req: Whether to execute the request asynchronously.
74
- :type async_req: bool, optional
75
- :param _return_http_data_only: response data without head status code
76
- and headers
77
- :type _return_http_data_only: bool, optional
78
- :param _preload_content: if False, the urllib3.HTTPResponse object will
79
- be returned without reading/decoding response
80
- data. Default is True.
81
- :type _preload_content: bool, optional
82
122
  :param _request_timeout: timeout setting for this request. If one
83
123
  number provided, it will be total request
84
124
  timeout. It can also be a pair (tuple) of
85
125
  (connection, read) timeouts.
126
+ :type _request_timeout: int, tuple(int, int), optional
86
127
  :param _request_auth: set to override the auth_settings for an a single
87
- request; this effectively ignores the authentication
88
- in the spec for a single request.
128
+ request; this effectively ignores the
129
+ authentication in the spec for a single request.
89
130
  :type _request_auth: dict, optional
131
+ :param _content_type: force content-type for the request.
132
+ :type _content_type: str, Optional
133
+ :param _headers: set to override the headers for a single
134
+ request; this effectively ignores the headers
135
+ in the spec for a single request.
136
+ :type _headers: dict, optional
137
+ :param _host_index: set to override the host_index for a single
138
+ request; this effectively ignores the host_index
139
+ in the spec for a single request.
140
+ :type _host_index: int, optional
90
141
  :return: Returns the result object.
91
- If the method is called asynchronously,
92
- returns the request thread.
93
- :rtype: tuple(Healthcheck, status_code(int), headers(HTTPHeaderDict))
94
- """
142
+ """ # noqa: E501
143
+
144
+ _param = self._healthz_serialize(
145
+ x_request_id=x_request_id,
146
+ _request_auth=_request_auth,
147
+ _content_type=_content_type,
148
+ _headers=_headers,
149
+ _host_index=_host_index
150
+ )
95
151
 
96
- local_var_params = locals()
152
+ _response_types_map: Dict[str, Optional[str]] = {
153
+ '200': "Healthcheck",
154
+ }
155
+ response_data = self.api_client.call_api(
156
+ *_param,
157
+ _request_timeout=_request_timeout
158
+ )
159
+ response_data.read()
160
+ return self.api_client.response_deserialize(
161
+ response_data=response_data,
162
+ response_types_map=_response_types_map,
163
+ )
97
164
 
98
- all_params = [
99
- 'x_request_id'
100
- ]
101
- all_params.extend(
102
- [
103
- 'async_req',
104
- '_return_http_data_only',
105
- '_preload_content',
106
- '_request_timeout',
107
- '_request_auth'
165
+
166
+ @validate_call
167
+ def healthz_without_preload_content(
168
+ self,
169
+ x_request_id: Optional[StrictStr] = None,
170
+ _request_timeout: Union[
171
+ None,
172
+ Annotated[StrictFloat, Field(gt=0)],
173
+ Tuple[
174
+ Annotated[StrictFloat, Field(gt=0)],
175
+ Annotated[StrictFloat, Field(gt=0)]
108
176
  ]
177
+ ] = None,
178
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
179
+ _content_type: Optional[StrictStr] = None,
180
+ _headers: Optional[Dict[StrictStr, Any]] = None,
181
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
182
+ ) -> RESTResponseType:
183
+ """Server health check
184
+
185
+
186
+ :param x_request_id:
187
+ :type x_request_id: str
188
+ :param _request_timeout: timeout setting for this request. If one
189
+ number provided, it will be total request
190
+ timeout. It can also be a pair (tuple) of
191
+ (connection, read) timeouts.
192
+ :type _request_timeout: int, tuple(int, int), optional
193
+ :param _request_auth: set to override the auth_settings for an a single
194
+ request; this effectively ignores the
195
+ authentication in the spec for a single request.
196
+ :type _request_auth: dict, optional
197
+ :param _content_type: force content-type for the request.
198
+ :type _content_type: str, Optional
199
+ :param _headers: set to override the headers for a single
200
+ request; this effectively ignores the headers
201
+ in the spec for a single request.
202
+ :type _headers: dict, optional
203
+ :param _host_index: set to override the host_index for a single
204
+ request; this effectively ignores the host_index
205
+ in the spec for a single request.
206
+ :type _host_index: int, optional
207
+ :return: Returns the result object.
208
+ """ # noqa: E501
209
+
210
+ _param = self._healthz_serialize(
211
+ x_request_id=x_request_id,
212
+ _request_auth=_request_auth,
213
+ _content_type=_content_type,
214
+ _headers=_headers,
215
+ _host_index=_host_index
109
216
  )
110
217
 
111
- for key, val in six.iteritems(local_var_params['kwargs']):
112
- if key not in all_params:
113
- raise ApiTypeError(
114
- "Got an unexpected keyword argument '%s'"
115
- " to method healthz" % key
116
- )
117
- local_var_params[key] = val
118
- del local_var_params['kwargs']
218
+ _response_types_map: Dict[str, Optional[str]] = {
219
+ '200': "Healthcheck",
220
+ }
221
+ response_data = self.api_client.call_api(
222
+ *_param,
223
+ _request_timeout=_request_timeout
224
+ )
225
+ return response_data.response
226
+
227
+
228
+ def _healthz_serialize(
229
+ self,
230
+ x_request_id,
231
+ _request_auth,
232
+ _content_type,
233
+ _headers,
234
+ _host_index,
235
+ ) -> RequestSerialized:
236
+
237
+ _host = None
238
+
239
+ _collection_formats: Dict[str, str] = {
240
+ }
119
241
 
120
- collection_formats = {}
242
+ _path_params: Dict[str, str] = {}
243
+ _query_params: List[Tuple[str, str]] = []
244
+ _header_params: Dict[str, Optional[str]] = _headers or {}
245
+ _form_params: List[Tuple[str, str]] = []
246
+ _files: Dict[
247
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
248
+ ] = {}
249
+ _body_params: Optional[bytes] = None
250
+
251
+ # process the path parameters
252
+ # process the query parameters
253
+ # process the header parameters
254
+ if x_request_id is not None:
255
+ _header_params['X-RequestID'] = x_request_id
256
+ # process the form parameters
257
+ # process the body parameter
258
+
259
+
260
+ # set the HTTP header `Accept`
261
+ if 'Accept' not in _header_params:
262
+ _header_params['Accept'] = self.api_client.select_header_accept(
263
+ [
264
+ 'application/json'
265
+ ]
266
+ )
267
+
268
+
269
+ # authentication setting
270
+ _auth_settings: List[str] = [
271
+ ]
272
+
273
+ return self.api_client.param_serialize(
274
+ method='GET',
275
+ resource_path='/api/healthz',
276
+ path_params=_path_params,
277
+ query_params=_query_params,
278
+ header_params=_header_params,
279
+ body=_body_params,
280
+ post_params=_form_params,
281
+ files=_files,
282
+ auth_settings=_auth_settings,
283
+ collection_formats=_collection_formats,
284
+ _host=_host,
285
+ _request_auth=_request_auth
286
+ )
121
287
 
122
- path_params = {}
123
288
 
124
- query_params = []
125
289
 
126
- header_params = {}
127
- if 'x_request_id' in local_var_params:
128
- header_params['X-RequestID'] = local_var_params['x_request_id'] # noqa: E501
129
290
 
130
- form_params = []
131
- local_var_files = {}
291
+ @validate_call
292
+ def ping(
293
+ self,
294
+ x_request_id: Optional[StrictStr] = None,
295
+ _request_timeout: Union[
296
+ None,
297
+ Annotated[StrictFloat, Field(gt=0)],
298
+ Tuple[
299
+ Annotated[StrictFloat, Field(gt=0)],
300
+ Annotated[StrictFloat, Field(gt=0)]
301
+ ]
302
+ ] = None,
303
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
304
+ _content_type: Optional[StrictStr] = None,
305
+ _headers: Optional[Dict[StrictStr, Any]] = None,
306
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
307
+ ) -> DeviceInfo:
308
+ """(Deprecated) Server health check
132
309
 
133
- body_params = None
134
- # HTTP header `Accept`
135
- header_params['Accept'] = self.api_client.select_header_accept(
136
- ['application/json']) # noqa: E501
137
310
 
138
- # Authentication setting
139
- auth_settings = [] # noqa: E501
140
-
141
- response_types_map = {
142
- 200: "Healthcheck",
311
+ :param x_request_id:
312
+ :type x_request_id: str
313
+ :param _request_timeout: timeout setting for this request. If one
314
+ number provided, it will be total request
315
+ timeout. It can also be a pair (tuple) of
316
+ (connection, read) timeouts.
317
+ :type _request_timeout: int, tuple(int, int), optional
318
+ :param _request_auth: set to override the auth_settings for an a single
319
+ request; this effectively ignores the
320
+ authentication in the spec for a single request.
321
+ :type _request_auth: dict, optional
322
+ :param _content_type: force content-type for the request.
323
+ :type _content_type: str, Optional
324
+ :param _headers: set to override the headers for a single
325
+ request; this effectively ignores the headers
326
+ in the spec for a single request.
327
+ :type _headers: dict, optional
328
+ :param _host_index: set to override the host_index for a single
329
+ request; this effectively ignores the host_index
330
+ in the spec for a single request.
331
+ :type _host_index: int, optional
332
+ :return: Returns the result object.
333
+ """ # noqa: E501
334
+ warnings.warn("GET /api/ping is deprecated.", DeprecationWarning)
335
+
336
+ _param = self._ping_serialize(
337
+ x_request_id=x_request_id,
338
+ _request_auth=_request_auth,
339
+ _content_type=_content_type,
340
+ _headers=_headers,
341
+ _host_index=_host_index
342
+ )
343
+
344
+ _response_types_map: Dict[str, Optional[str]] = {
345
+ '200': "DeviceInfo",
143
346
  }
347
+ response_data = self.api_client.call_api(
348
+ *_param,
349
+ _request_timeout=_request_timeout
350
+ )
351
+ response_data.read()
352
+ return self.api_client.response_deserialize(
353
+ response_data=response_data,
354
+ response_types_map=_response_types_map,
355
+ ).data
356
+
357
+
358
+ @validate_call
359
+ def ping_with_http_info(
360
+ self,
361
+ x_request_id: Optional[StrictStr] = None,
362
+ _request_timeout: Union[
363
+ None,
364
+ Annotated[StrictFloat, Field(gt=0)],
365
+ Tuple[
366
+ Annotated[StrictFloat, Field(gt=0)],
367
+ Annotated[StrictFloat, Field(gt=0)]
368
+ ]
369
+ ] = None,
370
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
371
+ _content_type: Optional[StrictStr] = None,
372
+ _headers: Optional[Dict[StrictStr, Any]] = None,
373
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
374
+ ) -> ApiResponse[DeviceInfo]:
375
+ """(Deprecated) Server health check
144
376
 
145
- return self.api_client.call_api(
146
- '/api/healthz', 'GET',
147
- path_params,
148
- query_params,
149
- header_params,
150
- body=body_params,
151
- post_params=form_params,
152
- files=local_var_files,
153
- response_types_map=response_types_map,
154
- auth_settings=auth_settings,
155
- async_req=local_var_params.get('async_req'),
156
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
157
- _preload_content=local_var_params.get('_preload_content', True),
158
- _request_timeout=local_var_params.get('_request_timeout'),
159
- collection_formats=collection_formats,
160
- _request_auth=local_var_params.get('_request_auth'))
161
-
162
- def ping(self, **kwargs): # noqa: E501
163
- """Server health check # noqa: E501
164
-
165
- This method makes a synchronous HTTP request by default. To make an
166
- asynchronous HTTP request, please pass async_req=True
167
-
168
- >>> thread = api.ping(async_req=True)
169
- >>> result = thread.get()
170
377
 
171
378
  :param x_request_id:
172
379
  :type x_request_id: str
173
- :param async_req: Whether to execute the request asynchronously.
174
- :type async_req: bool, optional
175
- :param _preload_content: if False, the urllib3.HTTPResponse object will
176
- be returned without reading/decoding response
177
- data. Default is True.
178
- :type _preload_content: bool, optional
179
380
  :param _request_timeout: timeout setting for this request. If one
180
381
  number provided, it will be total request
181
382
  timeout. It can also be a pair (tuple) of
182
383
  (connection, read) timeouts.
384
+ :type _request_timeout: int, tuple(int, int), optional
385
+ :param _request_auth: set to override the auth_settings for an a single
386
+ request; this effectively ignores the
387
+ authentication in the spec for a single request.
388
+ :type _request_auth: dict, optional
389
+ :param _content_type: force content-type for the request.
390
+ :type _content_type: str, Optional
391
+ :param _headers: set to override the headers for a single
392
+ request; this effectively ignores the headers
393
+ in the spec for a single request.
394
+ :type _headers: dict, optional
395
+ :param _host_index: set to override the host_index for a single
396
+ request; this effectively ignores the host_index
397
+ in the spec for a single request.
398
+ :type _host_index: int, optional
183
399
  :return: Returns the result object.
184
- If the method is called asynchronously,
185
- returns the request thread.
186
- :rtype: DeviceInfo
187
- """
188
- kwargs['_return_http_data_only'] = True
189
- return self.ping_with_http_info(**kwargs) # noqa: E501
400
+ """ # noqa: E501
401
+ warnings.warn("GET /api/ping is deprecated.", DeprecationWarning)
402
+
403
+ _param = self._ping_serialize(
404
+ x_request_id=x_request_id,
405
+ _request_auth=_request_auth,
406
+ _content_type=_content_type,
407
+ _headers=_headers,
408
+ _host_index=_host_index
409
+ )
190
410
 
191
- def ping_with_http_info(self, **kwargs): # noqa: E501
192
- """Server health check # noqa: E501
411
+ _response_types_map: Dict[str, Optional[str]] = {
412
+ '200': "DeviceInfo",
413
+ }
414
+ response_data = self.api_client.call_api(
415
+ *_param,
416
+ _request_timeout=_request_timeout
417
+ )
418
+ response_data.read()
419
+ return self.api_client.response_deserialize(
420
+ response_data=response_data,
421
+ response_types_map=_response_types_map,
422
+ )
193
423
 
194
- This method makes a synchronous HTTP request by default. To make an
195
- asynchronous HTTP request, please pass async_req=True
196
424
 
197
- >>> thread = api.ping_with_http_info(async_req=True)
198
- >>> result = thread.get()
425
+ @validate_call
426
+ def ping_without_preload_content(
427
+ self,
428
+ x_request_id: Optional[StrictStr] = None,
429
+ _request_timeout: Union[
430
+ None,
431
+ Annotated[StrictFloat, Field(gt=0)],
432
+ Tuple[
433
+ Annotated[StrictFloat, Field(gt=0)],
434
+ Annotated[StrictFloat, Field(gt=0)]
435
+ ]
436
+ ] = None,
437
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
438
+ _content_type: Optional[StrictStr] = None,
439
+ _headers: Optional[Dict[StrictStr, Any]] = None,
440
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
441
+ ) -> RESTResponseType:
442
+ """(Deprecated) Server health check
443
+
199
444
 
200
445
  :param x_request_id:
201
446
  :type x_request_id: str
202
- :param async_req: Whether to execute the request asynchronously.
203
- :type async_req: bool, optional
204
- :param _return_http_data_only: response data without head status code
205
- and headers
206
- :type _return_http_data_only: bool, optional
207
- :param _preload_content: if False, the urllib3.HTTPResponse object will
208
- be returned without reading/decoding response
209
- data. Default is True.
210
- :type _preload_content: bool, optional
211
447
  :param _request_timeout: timeout setting for this request. If one
212
448
  number provided, it will be total request
213
449
  timeout. It can also be a pair (tuple) of
214
450
  (connection, read) timeouts.
451
+ :type _request_timeout: int, tuple(int, int), optional
215
452
  :param _request_auth: set to override the auth_settings for an a single
216
- request; this effectively ignores the authentication
217
- in the spec for a single request.
453
+ request; this effectively ignores the
454
+ authentication in the spec for a single request.
218
455
  :type _request_auth: dict, optional
456
+ :param _content_type: force content-type for the request.
457
+ :type _content_type: str, Optional
458
+ :param _headers: set to override the headers for a single
459
+ request; this effectively ignores the headers
460
+ in the spec for a single request.
461
+ :type _headers: dict, optional
462
+ :param _host_index: set to override the host_index for a single
463
+ request; this effectively ignores the host_index
464
+ in the spec for a single request.
465
+ :type _host_index: int, optional
219
466
  :return: Returns the result object.
220
- If the method is called asynchronously,
221
- returns the request thread.
222
- :rtype: tuple(DeviceInfo, status_code(int), headers(HTTPHeaderDict))
223
- """
467
+ """ # noqa: E501
468
+ warnings.warn("GET /api/ping is deprecated.", DeprecationWarning)
469
+
470
+ _param = self._ping_serialize(
471
+ x_request_id=x_request_id,
472
+ _request_auth=_request_auth,
473
+ _content_type=_content_type,
474
+ _headers=_headers,
475
+ _host_index=_host_index
476
+ )
477
+
478
+ _response_types_map: Dict[str, Optional[str]] = {
479
+ '200': "DeviceInfo",
480
+ }
481
+ response_data = self.api_client.call_api(
482
+ *_param,
483
+ _request_timeout=_request_timeout
484
+ )
485
+ return response_data.response
486
+
487
+
488
+ def _ping_serialize(
489
+ self,
490
+ x_request_id,
491
+ _request_auth,
492
+ _content_type,
493
+ _headers,
494
+ _host_index,
495
+ ) -> RequestSerialized:
224
496
 
225
- local_var_params = locals()
497
+ _host = None
226
498
 
227
- all_params = [
228
- 'x_request_id'
499
+ _collection_formats: Dict[str, str] = {
500
+ }
501
+
502
+ _path_params: Dict[str, str] = {}
503
+ _query_params: List[Tuple[str, str]] = []
504
+ _header_params: Dict[str, Optional[str]] = _headers or {}
505
+ _form_params: List[Tuple[str, str]] = []
506
+ _files: Dict[
507
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
508
+ ] = {}
509
+ _body_params: Optional[bytes] = None
510
+
511
+ # process the path parameters
512
+ # process the query parameters
513
+ # process the header parameters
514
+ if x_request_id is not None:
515
+ _header_params['X-RequestID'] = x_request_id
516
+ # process the form parameters
517
+ # process the body parameter
518
+
519
+
520
+ # set the HTTP header `Accept`
521
+ if 'Accept' not in _header_params:
522
+ _header_params['Accept'] = self.api_client.select_header_accept(
523
+ [
524
+ 'application/json'
525
+ ]
526
+ )
527
+
528
+
529
+ # authentication setting
530
+ _auth_settings: List[str] = [
229
531
  ]
230
- all_params.extend(
231
- [
232
- 'async_req',
233
- '_return_http_data_only',
234
- '_preload_content',
235
- '_request_timeout',
236
- '_request_auth'
237
- ]
238
- )
239
532
 
240
- for key, val in six.iteritems(local_var_params['kwargs']):
241
- if key not in all_params:
242
- raise ApiTypeError(
243
- "Got an unexpected keyword argument '%s'"
244
- " to method ping" % key
245
- )
246
- local_var_params[key] = val
247
- del local_var_params['kwargs']
533
+ return self.api_client.param_serialize(
534
+ method='GET',
535
+ resource_path='/api/ping',
536
+ path_params=_path_params,
537
+ query_params=_query_params,
538
+ header_params=_header_params,
539
+ body=_body_params,
540
+ post_params=_form_params,
541
+ files=_files,
542
+ auth_settings=_auth_settings,
543
+ collection_formats=_collection_formats,
544
+ _host=_host,
545
+ _request_auth=_request_auth
546
+ )
248
547
 
249
- collection_formats = {}
250
548
 
251
- path_params = {}
252
549
 
253
- query_params = []
254
550
 
255
- header_params = {}
256
- if 'x_request_id' in local_var_params:
257
- header_params['X-RequestID'] = local_var_params['x_request_id'] # noqa: E501
551
+ @validate_call
552
+ def readyz(
553
+ self,
554
+ x_request_id: Optional[StrictStr] = None,
555
+ _request_timeout: Union[
556
+ None,
557
+ Annotated[StrictFloat, Field(gt=0)],
558
+ Tuple[
559
+ Annotated[StrictFloat, Field(gt=0)],
560
+ Annotated[StrictFloat, Field(gt=0)]
561
+ ]
562
+ ] = None,
563
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
564
+ _content_type: Optional[StrictStr] = None,
565
+ _headers: Optional[Dict[StrictStr, Any]] = None,
566
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
567
+ ) -> None:
568
+ """License health check
258
569
 
259
- form_params = []
260
- local_var_files = {}
261
570
 
262
- body_params = None
263
- # HTTP header `Accept`
264
- header_params['Accept'] = self.api_client.select_header_accept(
265
- ['application/json']) # noqa: E501
571
+ :param x_request_id:
572
+ :type x_request_id: str
573
+ :param _request_timeout: timeout setting for this request. If one
574
+ number provided, it will be total request
575
+ timeout. It can also be a pair (tuple) of
576
+ (connection, read) timeouts.
577
+ :type _request_timeout: int, tuple(int, int), optional
578
+ :param _request_auth: set to override the auth_settings for an a single
579
+ request; this effectively ignores the
580
+ authentication in the spec for a single request.
581
+ :type _request_auth: dict, optional
582
+ :param _content_type: force content-type for the request.
583
+ :type _content_type: str, Optional
584
+ :param _headers: set to override the headers for a single
585
+ request; this effectively ignores the headers
586
+ in the spec for a single request.
587
+ :type _headers: dict, optional
588
+ :param _host_index: set to override the host_index for a single
589
+ request; this effectively ignores the host_index
590
+ in the spec for a single request.
591
+ :type _host_index: int, optional
592
+ :return: Returns the result object.
593
+ """ # noqa: E501
594
+
595
+ _param = self._readyz_serialize(
596
+ x_request_id=x_request_id,
597
+ _request_auth=_request_auth,
598
+ _content_type=_content_type,
599
+ _headers=_headers,
600
+ _host_index=_host_index
601
+ )
266
602
 
267
- # Authentication setting
268
- auth_settings = [] # noqa: E501
269
-
270
- response_types_map = {
271
- 200: "DeviceInfo",
603
+ _response_types_map: Dict[str, Optional[str]] = {
604
+ '200': None,
605
+ '400': None,
272
606
  }
607
+ response_data = self.api_client.call_api(
608
+ *_param,
609
+ _request_timeout=_request_timeout
610
+ )
611
+ response_data.read()
612
+ return self.api_client.response_deserialize(
613
+ response_data=response_data,
614
+ response_types_map=_response_types_map,
615
+ ).data
616
+
617
+
618
+ @validate_call
619
+ def readyz_with_http_info(
620
+ self,
621
+ x_request_id: Optional[StrictStr] = 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
+ ) -> ApiResponse[None]:
635
+ """License health check
273
636
 
274
- return self.api_client.call_api(
275
- '/api/ping', 'GET',
276
- path_params,
277
- query_params,
278
- header_params,
279
- body=body_params,
280
- post_params=form_params,
281
- files=local_var_files,
282
- response_types_map=response_types_map,
283
- auth_settings=auth_settings,
284
- async_req=local_var_params.get('async_req'),
285
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
286
- _preload_content=local_var_params.get('_preload_content', True),
287
- _request_timeout=local_var_params.get('_request_timeout'),
288
- collection_formats=collection_formats,
289
- _request_auth=local_var_params.get('_request_auth'))
290
-
291
- def readyz(self, **kwargs): # noqa: E501
292
- """License health check # noqa: E501
293
-
294
- This method makes a synchronous HTTP request by default. To make an
295
- asynchronous HTTP request, please pass async_req=True
296
-
297
- >>> thread = api.readyz(async_req=True)
298
- >>> result = thread.get()
299
637
 
300
638
  :param x_request_id:
301
639
  :type x_request_id: str
302
- :param async_req: Whether to execute the request asynchronously.
303
- :type async_req: bool, optional
304
- :param _preload_content: if False, the urllib3.HTTPResponse object will
305
- be returned without reading/decoding response
306
- data. Default is True.
307
- :type _preload_content: bool, optional
308
640
  :param _request_timeout: timeout setting for this request. If one
309
641
  number provided, it will be total request
310
642
  timeout. It can also be a pair (tuple) of
311
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
312
659
  :return: Returns the result object.
313
- If the method is called asynchronously,
314
- returns the request thread.
315
- :rtype: None
316
- """
317
- kwargs['_return_http_data_only'] = True
318
- return self.readyz_with_http_info(**kwargs) # noqa: E501
660
+ """ # noqa: E501
661
+
662
+ _param = self._readyz_serialize(
663
+ x_request_id=x_request_id,
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': None,
672
+ '400': None,
673
+ }
674
+ response_data = self.api_client.call_api(
675
+ *_param,
676
+ _request_timeout=_request_timeout
677
+ )
678
+ response_data.read()
679
+ return self.api_client.response_deserialize(
680
+ response_data=response_data,
681
+ response_types_map=_response_types_map,
682
+ )
319
683
 
320
- def readyz_with_http_info(self, **kwargs): # noqa: E501
321
- """License health check # noqa: E501
322
684
 
323
- This method makes a synchronous HTTP request by default. To make an
324
- asynchronous HTTP request, please pass async_req=True
685
+ @validate_call
686
+ def readyz_without_preload_content(
687
+ self,
688
+ x_request_id: Optional[StrictStr] = None,
689
+ _request_timeout: Union[
690
+ None,
691
+ Annotated[StrictFloat, Field(gt=0)],
692
+ Tuple[
693
+ Annotated[StrictFloat, Field(gt=0)],
694
+ Annotated[StrictFloat, Field(gt=0)]
695
+ ]
696
+ ] = None,
697
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
698
+ _content_type: Optional[StrictStr] = None,
699
+ _headers: Optional[Dict[StrictStr, Any]] = None,
700
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
701
+ ) -> RESTResponseType:
702
+ """License health check
325
703
 
326
- >>> thread = api.readyz_with_http_info(async_req=True)
327
- >>> result = thread.get()
328
704
 
329
705
  :param x_request_id:
330
706
  :type x_request_id: str
331
- :param async_req: Whether to execute the request asynchronously.
332
- :type async_req: bool, optional
333
- :param _return_http_data_only: response data without head status code
334
- and headers
335
- :type _return_http_data_only: bool, optional
336
- :param _preload_content: if False, the urllib3.HTTPResponse object will
337
- be returned without reading/decoding response
338
- data. Default is True.
339
- :type _preload_content: bool, optional
340
707
  :param _request_timeout: timeout setting for this request. If one
341
708
  number provided, it will be total request
342
709
  timeout. It can also be a pair (tuple) of
343
710
  (connection, read) timeouts.
711
+ :type _request_timeout: int, tuple(int, int), optional
344
712
  :param _request_auth: set to override the auth_settings for an a single
345
- request; this effectively ignores the authentication
346
- in the spec for a single request.
713
+ request; this effectively ignores the
714
+ authentication in the spec for a single request.
347
715
  :type _request_auth: dict, optional
716
+ :param _content_type: force content-type for the request.
717
+ :type _content_type: str, Optional
718
+ :param _headers: set to override the headers for a single
719
+ request; this effectively ignores the headers
720
+ in the spec for a single request.
721
+ :type _headers: dict, optional
722
+ :param _host_index: set to override the host_index for a single
723
+ request; this effectively ignores the host_index
724
+ in the spec for a single request.
725
+ :type _host_index: int, optional
348
726
  :return: Returns the result object.
349
- If the method is called asynchronously,
350
- returns the request thread.
351
- :rtype: None
352
- """
727
+ """ # noqa: E501
728
+
729
+ _param = self._readyz_serialize(
730
+ x_request_id=x_request_id,
731
+ _request_auth=_request_auth,
732
+ _content_type=_content_type,
733
+ _headers=_headers,
734
+ _host_index=_host_index
735
+ )
736
+
737
+ _response_types_map: Dict[str, Optional[str]] = {
738
+ '200': None,
739
+ '400': None,
740
+ }
741
+ response_data = self.api_client.call_api(
742
+ *_param,
743
+ _request_timeout=_request_timeout
744
+ )
745
+ return response_data.response
746
+
747
+
748
+ def _readyz_serialize(
749
+ self,
750
+ x_request_id,
751
+ _request_auth,
752
+ _content_type,
753
+ _headers,
754
+ _host_index,
755
+ ) -> RequestSerialized:
756
+
757
+ _host = None
758
+
759
+ _collection_formats: Dict[str, str] = {
760
+ }
761
+
762
+ _path_params: Dict[str, str] = {}
763
+ _query_params: List[Tuple[str, str]] = []
764
+ _header_params: Dict[str, Optional[str]] = _headers or {}
765
+ _form_params: List[Tuple[str, str]] = []
766
+ _files: Dict[
767
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
768
+ ] = {}
769
+ _body_params: Optional[bytes] = None
353
770
 
354
- local_var_params = locals()
771
+ # process the path parameters
772
+ # process the query parameters
773
+ # process the header parameters
774
+ if x_request_id is not None:
775
+ _header_params['X-RequestID'] = x_request_id
776
+ # process the form parameters
777
+ # process the body parameter
355
778
 
356
- all_params = [
357
- 'x_request_id'
779
+
780
+
781
+
782
+ # authentication setting
783
+ _auth_settings: List[str] = [
358
784
  ]
359
- all_params.extend(
360
- [
361
- 'async_req',
362
- '_return_http_data_only',
363
- '_preload_content',
364
- '_request_timeout',
365
- '_request_auth'
366
- ]
785
+
786
+ return self.api_client.param_serialize(
787
+ method='GET',
788
+ resource_path='/api/readyz',
789
+ path_params=_path_params,
790
+ query_params=_query_params,
791
+ header_params=_header_params,
792
+ body=_body_params,
793
+ post_params=_form_params,
794
+ files=_files,
795
+ auth_settings=_auth_settings,
796
+ collection_formats=_collection_formats,
797
+ _host=_host,
798
+ _request_auth=_request_auth
367
799
  )
368
800
 
369
- for key, val in six.iteritems(local_var_params['kwargs']):
370
- if key not in all_params:
371
- raise ApiTypeError(
372
- "Got an unexpected keyword argument '%s'"
373
- " to method readyz" % key
374
- )
375
- local_var_params[key] = val
376
- del local_var_params['kwargs']
377
-
378
- collection_formats = {}
379
-
380
- path_params = {}
381
-
382
- query_params = []
383
-
384
- header_params = {}
385
- if 'x_request_id' in local_var_params:
386
- header_params['X-RequestID'] = local_var_params['x_request_id'] # noqa: E501
387
-
388
- form_params = []
389
- local_var_files = {}
390
-
391
- body_params = None
392
- # Authentication setting
393
- auth_settings = [] # noqa: E501
394
-
395
- response_types_map = {}
396
-
397
- return self.api_client.call_api(
398
- '/api/readyz', 'GET',
399
- path_params,
400
- query_params,
401
- header_params,
402
- body=body_params,
403
- post_params=form_params,
404
- files=local_var_files,
405
- response_types_map=response_types_map,
406
- auth_settings=auth_settings,
407
- async_req=local_var_params.get('async_req'),
408
- _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501
409
- _preload_content=local_var_params.get('_preload_content', True),
410
- _request_timeout=local_var_params.get('_request_timeout'),
411
- collection_formats=collection_formats,
412
- _request_auth=local_var_params.get('_request_auth'))
801
+