rapidata 2.35.1__py3-none-any.whl → 3.0.0a8__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.

Files changed (790) hide show
  1. rapidata/__init__.py +25 -16
  2. rapidata/api_client/__init__.py +84 -408
  3. rapidata/api_client/api/__init__.py +6 -2
  4. rapidata/api_client/api/asset_api.py +853 -0
  5. rapidata/api_client/api/audience_api.py +2505 -0
  6. rapidata/api_client/api/benchmark_api.py +904 -245
  7. rapidata/api_client/api/campaign_api.py +582 -24
  8. rapidata/api_client/api/client_api.py +38 -33
  9. rapidata/api_client/api/compare_workflow_api.py +11 -10
  10. rapidata/api_client/api/customer_rapid_api.py +364 -123
  11. rapidata/api_client/api/datapoint_api.py +8 -6
  12. rapidata/api_client/api/dataset_api.py +240 -1516
  13. rapidata/api_client/api/evaluation_workflow_api.py +29 -82
  14. rapidata/api_client/api/feedback_api.py +11 -11
  15. rapidata/api_client/api/grouped_ranking_workflow_api.py +319 -0
  16. rapidata/api_client/api/identity_api.py +26 -300
  17. rapidata/api_client/api/job_api.py +3902 -0
  18. rapidata/api_client/api/job_definition_api.py +319 -0
  19. rapidata/api_client/api/job_revision_api.py +335 -0
  20. rapidata/api_client/api/leaderboard_api.py +140 -2067
  21. rapidata/api_client/api/newsletter_api.py +20 -19
  22. rapidata/api_client/api/order_api.py +375 -91
  23. rapidata/api_client/api/participant_api.py +80 -118
  24. rapidata/api_client/api/pipeline_api.py +24 -1480
  25. rapidata/api_client/api/prompt_api.py +11 -11
  26. rapidata/api_client/api/rapidata_identity_api_api.py +5 -4
  27. rapidata/api_client/api/sample_api.py +300 -0
  28. rapidata/api_client/api/simple_workflow_api.py +11 -10
  29. rapidata/api_client/api/survey_api.py +304 -0
  30. rapidata/api_client/api/user_rapid_api.py +35 -31
  31. rapidata/api_client/api/validation_set_api.py +377 -1835
  32. rapidata/api_client/api/workflow_api.py +32 -26
  33. rapidata/api_client/api_client.py +2 -2
  34. rapidata/api_client/configuration.py +16 -29
  35. rapidata/api_client/exceptions.py +2 -2
  36. rapidata/api_client/models/__init__.py +65 -382
  37. rapidata/api_client/models/ab_test_selection_a_inner.py +1 -1
  38. rapidata/api_client/models/add_rapid_to_audience_model.py +144 -0
  39. rapidata/api_client/models/add_user_response_result.py +10 -5
  40. rapidata/api_client/models/add_validation_rapid_model.py +49 -26
  41. rapidata/api_client/models/add_validation_rapid_model_asset.py +154 -0
  42. rapidata/api_client/models/add_validation_rapid_model_context_asset.py +160 -0
  43. rapidata/api_client/models/add_validation_rapid_model_metadata_inner.py +140 -0
  44. rapidata/api_client/models/add_validation_rapid_model_truth.py +7 -1
  45. rapidata/api_client/models/add_validation_rapid_new_model.py +137 -0
  46. rapidata/api_client/models/add_validation_rapid_new_model_asset.py +182 -0
  47. rapidata/api_client/models/add_validation_rapid_new_model_truth.py +286 -0
  48. rapidata/api_client/models/age_user_filter_model.py +2 -2
  49. rapidata/api_client/models/age_user_filter_model_age_group.py +41 -0
  50. rapidata/api_client/models/aggregated_orders_model.py +98 -0
  51. rapidata/api_client/models/aggregator_type.py +4 -2
  52. rapidata/api_client/models/and_filter.py +121 -0
  53. rapidata/api_client/models/and_filter_filters_inner.py +282 -0
  54. rapidata/api_client/models/are_rapids_active_result.py +2 -2
  55. rapidata/api_client/models/asset_metadata.py +11 -9
  56. rapidata/api_client/models/asset_type.py +40 -0
  57. rapidata/api_client/models/attach_category_rapid_blueprint.py +13 -3
  58. rapidata/api_client/models/attach_category_rapid_blueprint_category.py +89 -0
  59. rapidata/api_client/models/audience_job_state.py +38 -0
  60. rapidata/api_client/models/audience_status.py +39 -0
  61. rapidata/api_client/models/benchmark_query_result.py +5 -3
  62. rapidata/api_client/models/boost_leaderboard_model.py +5 -5
  63. rapidata/api_client/models/boost_mode.py +37 -0
  64. rapidata/api_client/models/boost_query_result.py +7 -10
  65. rapidata/api_client/models/boost_query_result_boost_mode.py +37 -0
  66. rapidata/api_client/models/boost_query_result_boost_status.py +39 -0
  67. rapidata/api_client/models/boosting_profile.py +91 -0
  68. rapidata/api_client/models/box_shape.py +4 -33
  69. rapidata/api_client/models/campaign_filter.py +98 -0
  70. rapidata/api_client/models/campaign_query_result.py +15 -13
  71. rapidata/api_client/models/campaign_status.py +2 -2
  72. rapidata/api_client/models/change_boost_model.py +89 -0
  73. rapidata/api_client/models/classification_metadata.py +12 -1
  74. rapidata/api_client/models/classify_payload.py +14 -15
  75. rapidata/api_client/models/classify_payload_category.py +89 -0
  76. rapidata/api_client/models/client_model.py +25 -35
  77. rapidata/api_client/models/clients_query_result.py +5 -5
  78. rapidata/api_client/models/clone_order_model.py +4 -4
  79. rapidata/api_client/models/clone_order_result.py +9 -4
  80. rapidata/api_client/models/compare_rapid_blueprint.py +5 -3
  81. rapidata/api_client/models/compare_rapid_blueprint1.py +96 -0
  82. rapidata/api_client/models/compare_workflow_config.py +34 -23
  83. rapidata/api_client/models/compare_workflow_config_context_asset.py +174 -0
  84. rapidata/api_client/models/compare_workflow_config_model.py +15 -5
  85. rapidata/api_client/models/compare_workflow_model.py +34 -6
  86. rapidata/api_client/models/compare_workflow_model1.py +20 -9
  87. rapidata/api_client/models/compare_workflow_model_context_asset.py +160 -0
  88. rapidata/api_client/models/compare_workflow_model_metadata_inner.py +154 -0
  89. rapidata/api_client/models/compare_workflow_model_pair_maker_config.py +1 -1
  90. rapidata/api_client/models/comparison_operator.py +2 -2
  91. rapidata/api_client/models/conditional_validation_selection.py +6 -11
  92. rapidata/api_client/models/conditional_validation_selection_validation_chance.py +103 -0
  93. rapidata/api_client/models/confidence_interval.py +89 -0
  94. rapidata/api_client/models/count_metadata.py +12 -1
  95. rapidata/api_client/models/country_filter.py +98 -0
  96. rapidata/api_client/models/create_audience_request.py +122 -0
  97. rapidata/api_client/models/create_audience_result.py +87 -0
  98. rapidata/api_client/models/create_benchmark_model.py +5 -5
  99. rapidata/api_client/models/create_benchmark_participant_model.py +5 -5
  100. rapidata/api_client/models/create_benchmark_participant_result.py +4 -4
  101. rapidata/api_client/models/create_benchmark_prompt_result.py +87 -0
  102. rapidata/api_client/models/create_benchmark_result.py +2 -2
  103. rapidata/api_client/models/create_bridge_token_result.py +2 -2
  104. rapidata/api_client/models/create_client_model.py +6 -13
  105. rapidata/api_client/models/create_complex_order_model.py +9 -9
  106. rapidata/api_client/models/create_complex_order_result.py +2 -2
  107. rapidata/api_client/models/create_customer_client_result.py +2 -2
  108. rapidata/api_client/models/create_datapoint_from_files_model.py +3 -3
  109. rapidata/api_client/models/create_datapoint_from_text_sources_model.py +3 -3
  110. rapidata/api_client/models/create_datapoint_from_urls_model.py +3 -3
  111. rapidata/api_client/models/create_datapoint_model.py +124 -0
  112. rapidata/api_client/models/create_datapoint_model_asset.py +154 -0
  113. rapidata/api_client/models/create_datapoint_model_context_asset.py +160 -0
  114. rapidata/api_client/models/create_datapoint_model_metadata_inner.py +154 -0
  115. rapidata/api_client/models/create_datapoint_result.py +2 -2
  116. rapidata/api_client/models/create_dataset_endpoint_input.py +87 -0
  117. rapidata/api_client/models/create_dataset_endpoint_output.py +87 -0
  118. rapidata/api_client/models/create_demographic_rapid_model.py +45 -7
  119. rapidata/api_client/models/create_demographic_rapid_model_asset.py +160 -0
  120. rapidata/api_client/models/create_demographic_rapid_model_context_asset.py +160 -0
  121. rapidata/api_client/models/create_demographic_rapid_model_new.py +119 -0
  122. rapidata/api_client/models/create_empty_validation_set_result.py +2 -2
  123. rapidata/api_client/models/create_job_definition_endpoint_input.py +119 -0
  124. rapidata/api_client/models/create_job_definition_endpoint_output.py +89 -0
  125. rapidata/api_client/models/create_job_endpoint_input.py +100 -0
  126. rapidata/api_client/models/create_job_endpoint_output.py +89 -0
  127. rapidata/api_client/models/create_job_revision_endpoint_input.py +127 -0
  128. rapidata/api_client/models/create_job_revision_endpoint_output.py +89 -0
  129. rapidata/api_client/models/create_leaderboard_model.py +42 -15
  130. rapidata/api_client/models/create_leaderboard_result.py +2 -2
  131. rapidata/api_client/models/create_order_definition_model.py +119 -0
  132. rapidata/api_client/models/create_order_definition_result.py +87 -0
  133. rapidata/api_client/models/create_order_definition_revision_model.py +117 -0
  134. rapidata/api_client/models/create_order_definition_revision_result.py +87 -0
  135. rapidata/api_client/models/create_order_model.py +30 -101
  136. rapidata/api_client/models/create_order_model_referee.py +12 -12
  137. rapidata/api_client/models/create_order_model_workflow.py +35 -21
  138. rapidata/api_client/models/create_order_result.py +2 -2
  139. rapidata/api_client/models/create_rapid_result.py +2 -2
  140. rapidata/api_client/models/create_sample_model.py +13 -7
  141. rapidata/api_client/models/create_sample_model_asset.py +154 -0
  142. rapidata/api_client/models/create_sample_model_obsolete.py +87 -0
  143. rapidata/api_client/models/create_simple_pipeline_model_pipeline_steps_inner.py +8 -22
  144. rapidata/api_client/models/create_unsupported_order_model.py +6 -6
  145. rapidata/api_client/models/create_validation_set_model.py +5 -5
  146. rapidata/api_client/models/datapoint_model.py +3 -3
  147. rapidata/api_client/models/datapoint_state.py +2 -2
  148. rapidata/api_client/models/definition_type.py +49 -0
  149. rapidata/api_client/models/demographic_filter.py +100 -0
  150. rapidata/api_client/models/dynamic_client_registration_request.py +21 -36
  151. rapidata/api_client/models/early_stopping_referee_model.py +3 -3
  152. rapidata/api_client/models/effort_capped_selection.py +2 -11
  153. rapidata/api_client/models/elo_config.py +2 -2
  154. rapidata/api_client/models/elo_config_model.py +6 -6
  155. rapidata/api_client/models/entity_tag_header_value.py +93 -0
  156. rapidata/api_client/models/evaluation_workflow_config.py +13 -3
  157. rapidata/api_client/models/evaluation_workflow_model.py +16 -6
  158. rapidata/api_client/models/existing_asset_input.py +109 -0
  159. rapidata/api_client/models/existing_asset_input_metadata_value.py +126 -0
  160. rapidata/api_client/models/feature_flag.py +2 -2
  161. rapidata/api_client/models/feature_flag_model.py +6 -6
  162. rapidata/api_client/models/feedback_model.py +7 -7
  163. rapidata/api_client/models/file_asset.py +3 -5
  164. rapidata/api_client/models/file_asset_input_file.py +8 -22
  165. rapidata/api_client/models/file_asset_metadata_value.py +252 -0
  166. rapidata/api_client/models/file_asset_model_metadata_value.py +18 -88
  167. rapidata/api_client/models/file_stream_result.py +122 -0
  168. rapidata/api_client/models/file_type.py +2 -2
  169. rapidata/api_client/models/file_type_metadata.py +11 -6
  170. rapidata/api_client/models/file_type_metadata_model.py +2 -8
  171. rapidata/api_client/models/filter.py +7 -25
  172. rapidata/api_client/models/filter_operator.py +2 -2
  173. rapidata/api_client/models/fork_benchmark_result.py +87 -0
  174. rapidata/api_client/models/form_file_wrapper.py +17 -2
  175. rapidata/api_client/models/free_text_payload.py +10 -3
  176. rapidata/api_client/models/free_text_rapid_blueprint.py +10 -3
  177. rapidata/api_client/models/gender_user_filter_model.py +2 -2
  178. rapidata/api_client/models/gender_user_filter_model_gender.py +38 -0
  179. rapidata/api_client/models/get_asset_metadata_result.py +100 -0
  180. rapidata/api_client/models/get_audience_by_id_result.py +118 -0
  181. rapidata/api_client/models/get_available_validation_sets_result.py +2 -2
  182. rapidata/api_client/models/get_benchmark_by_id_result.py +8 -4
  183. rapidata/api_client/models/get_boost_result.py +97 -0
  184. rapidata/api_client/models/get_boost_result_boost_mode.py +37 -0
  185. rapidata/api_client/models/get_boost_result_boost_status.py +39 -0
  186. rapidata/api_client/models/get_compare_ab_summary_result.py +5 -5
  187. rapidata/api_client/models/get_compare_workflow_results_model.py +7 -7
  188. rapidata/api_client/models/get_compare_workflow_results_result.py +5 -5
  189. rapidata/api_client/models/get_datapoint_by_id_result.py +10 -21
  190. rapidata/api_client/models/get_datapoint_by_id_result_asset.py +170 -0
  191. rapidata/api_client/models/get_dataset_by_id_result.py +2 -2
  192. rapidata/api_client/models/get_dataset_progress_result.py +2 -2
  193. rapidata/api_client/models/get_evaluation_workflow_results_model.py +119 -0
  194. rapidata/api_client/models/get_failed_datapoints_result.py +5 -5
  195. rapidata/api_client/models/get_failed_datapoints_result_datapoint.py +100 -0
  196. rapidata/api_client/models/get_file_metadata_result.py +100 -0
  197. rapidata/api_client/models/get_grouped_ranking_workflow_results_model.py +106 -0
  198. rapidata/api_client/models/get_grouped_ranking_workflow_results_result.py +97 -0
  199. rapidata/api_client/models/get_grouped_ranking_workflow_results_result_paged_result.py +105 -0
  200. rapidata/api_client/models/get_job_by_id_endpoint_output.py +130 -0
  201. rapidata/api_client/models/get_job_definition_by_id_endpoint_output.py +95 -0
  202. rapidata/api_client/models/get_job_revision_endpoint_output.py +133 -0
  203. rapidata/api_client/models/get_leaderboard_by_id_result.py +31 -4
  204. rapidata/api_client/models/get_order_by_id_result.py +12 -5
  205. rapidata/api_client/models/get_participant_by_id_result.py +4 -6
  206. rapidata/api_client/models/get_pipeline_by_id_result.py +5 -5
  207. rapidata/api_client/models/get_public_orders_result.py +2 -2
  208. rapidata/api_client/models/get_public_responses_result.py +95 -0
  209. rapidata/api_client/models/get_public_responses_result_response.py +112 -0
  210. rapidata/api_client/models/get_rapid_responses_result.py +6 -12
  211. rapidata/api_client/models/get_recommended_validation_set_result.py +95 -0
  212. rapidata/api_client/models/get_responses_for_rapid_result.py +106 -0
  213. rapidata/api_client/models/get_responses_for_rapid_result_response.py +103 -0
  214. rapidata/api_client/models/get_responses_for_rapid_result_response_result.py +266 -0
  215. rapidata/api_client/models/get_responses_result.py +5 -5
  216. rapidata/api_client/models/get_responses_result_response.py +103 -0
  217. rapidata/api_client/models/get_sample_by_id_result.py +125 -0
  218. rapidata/api_client/models/get_simple_workflow_results_model.py +20 -15
  219. rapidata/api_client/models/get_standing_by_id_result.py +6 -14
  220. rapidata/api_client/models/get_validation_rapids_result.py +32 -41
  221. rapidata/api_client/models/get_validation_set_by_id_result.py +10 -4
  222. rapidata/api_client/models/get_workflow_by_id_result.py +5 -5
  223. rapidata/api_client/models/get_workflow_by_id_result_workflow.py +23 -9
  224. rapidata/api_client/models/get_workflow_progress_result.py +5 -11
  225. rapidata/api_client/models/get_workflow_results_result.py +34 -23
  226. rapidata/api_client/models/get_workflow_results_result_response.py +103 -0
  227. rapidata/api_client/models/google_one_tap_login_model.py +4 -4
  228. rapidata/api_client/models/grouped_ranking_workflow_config.py +155 -0
  229. rapidata/api_client/models/grouped_ranking_workflow_config_context_assets_value.py +170 -0
  230. rapidata/api_client/models/grouped_ranking_workflow_model.py +147 -0
  231. rapidata/api_client/models/grouped_ranking_workflow_model1.py +121 -0
  232. rapidata/api_client/models/i_artifact_model.py +182 -0
  233. rapidata/api_client/models/i_artifact_model_campaign_artifact_model.py +98 -0
  234. rapidata/api_client/models/i_artifact_model_dataset_artifact_model.py +98 -0
  235. rapidata/api_client/models/i_artifact_model_file_artifact_model.py +98 -0
  236. rapidata/api_client/models/i_artifact_model_workflow_artifact_model.py +98 -0
  237. rapidata/api_client/models/i_artifact_model_workflow_config_artifact_model.py +102 -0
  238. rapidata/api_client/models/i_asset.py +170 -0
  239. rapidata/api_client/models/i_asset_file_asset.py +111 -0
  240. rapidata/api_client/models/i_asset_input.py +156 -0
  241. rapidata/api_client/models/i_asset_input_existing_asset_input.py +118 -0
  242. rapidata/api_client/models/i_asset_input_multi_asset_input.py +128 -0
  243. rapidata/api_client/models/i_asset_input_text_asset_input.py +118 -0
  244. rapidata/api_client/models/i_asset_model.py +170 -0
  245. rapidata/api_client/models/i_asset_model_file_asset_model.py +113 -0
  246. rapidata/api_client/models/i_asset_model_multi_asset_model.py +123 -0
  247. rapidata/api_client/models/i_asset_model_null_asset_model.py +111 -0
  248. rapidata/api_client/models/i_asset_model_text_asset_model.py +113 -0
  249. rapidata/api_client/models/i_asset_multi_asset.py +121 -0
  250. rapidata/api_client/models/i_asset_null_asset.py +109 -0
  251. rapidata/api_client/models/i_asset_text_asset.py +111 -0
  252. rapidata/api_client/models/i_audience_filter.py +184 -0
  253. rapidata/api_client/models/i_audience_filter_and_audience_filter.py +106 -0
  254. rapidata/api_client/models/i_audience_filter_country_audience_filter.py +96 -0
  255. rapidata/api_client/models/i_audience_filter_country_filter.py +96 -0
  256. rapidata/api_client/models/i_audience_filter_language_audience_filter.py +96 -0
  257. rapidata/api_client/models/i_audience_filter_language_filter.py +96 -0
  258. rapidata/api_client/models/i_audience_filter_not_audience_filter.py +102 -0
  259. rapidata/api_client/models/i_audience_filter_or_audience_filter.py +106 -0
  260. rapidata/api_client/models/i_campaign_filter.py +296 -0
  261. rapidata/api_client/models/i_campaign_filter_and_filter.py +117 -0
  262. rapidata/api_client/models/i_campaign_filter_campaign_filter.py +98 -0
  263. rapidata/api_client/models/i_campaign_filter_campaign_session_count_filter.py +101 -0
  264. rapidata/api_client/models/i_campaign_filter_country_filter.py +98 -0
  265. rapidata/api_client/models/i_campaign_filter_demographic_filter.py +100 -0
  266. rapidata/api_client/models/i_campaign_filter_device_filter.py +106 -0
  267. rapidata/api_client/models/i_campaign_filter_language_filter.py +98 -0
  268. rapidata/api_client/models/i_campaign_filter_new_user_filter.py +96 -0
  269. rapidata/api_client/models/i_campaign_filter_not_filter.py +113 -0
  270. rapidata/api_client/models/i_campaign_filter_or_filter.py +117 -0
  271. rapidata/api_client/models/i_campaign_filter_response_count_filter.py +103 -0
  272. rapidata/api_client/models/i_campaign_filter_user_action_restriction_filter.py +106 -0
  273. rapidata/api_client/models/i_campaign_filter_user_score_filter.py +102 -0
  274. rapidata/api_client/models/i_campaign_filter_user_state_filter.py +106 -0
  275. rapidata/api_client/models/i_dataset_metadata_input.py +154 -0
  276. rapidata/api_client/models/i_dataset_metadata_input_prompt_asset_metadata_input.py +100 -0
  277. rapidata/api_client/models/i_dataset_metadata_input_prompt_metadata_input.py +96 -0
  278. rapidata/api_client/models/i_dataset_metadata_input_transcription_metadata_input.py +96 -0
  279. rapidata/api_client/models/i_dataset_model.py +126 -0
  280. rapidata/api_client/models/i_dataset_model_clone_dataset_model.py +98 -0
  281. rapidata/api_client/models/i_metadata.py +252 -0
  282. rapidata/api_client/models/i_metadata_classification_metadata.py +109 -0
  283. rapidata/api_client/models/i_metadata_count_metadata.py +109 -0
  284. rapidata/api_client/models/i_metadata_duration_metadata.py +110 -0
  285. rapidata/api_client/models/i_metadata_file_type_metadata.py +110 -0
  286. rapidata/api_client/models/i_metadata_image_dimension_metadata.py +111 -0
  287. rapidata/api_client/models/i_metadata_input.py +126 -0
  288. rapidata/api_client/models/i_metadata_input_text_metadata_input.py +111 -0
  289. rapidata/api_client/models/i_metadata_location_metadata.py +111 -0
  290. rapidata/api_client/models/i_metadata_model.py +252 -0
  291. rapidata/api_client/models/i_metadata_model_classification_metadata_model.py +96 -0
  292. rapidata/api_client/models/i_metadata_model_count_metadata_model.py +96 -0
  293. rapidata/api_client/models/i_metadata_model_file_type_metadata_model.py +97 -0
  294. rapidata/api_client/models/i_metadata_model_image_dimension_metadata_model.py +98 -0
  295. rapidata/api_client/models/i_metadata_model_location_metadata_model.py +98 -0
  296. rapidata/api_client/models/i_metadata_model_original_filename_metadata_model.py +96 -0
  297. rapidata/api_client/models/i_metadata_model_source_url_metadata_model.py +96 -0
  298. rapidata/api_client/models/i_metadata_model_streams_metadata_model.py +100 -0
  299. rapidata/api_client/models/i_metadata_model_text_metadata_model.py +101 -0
  300. rapidata/api_client/models/i_metadata_model_video_duration_metadata_model.py +97 -0
  301. rapidata/api_client/models/i_metadata_original_filename_metadata.py +109 -0
  302. rapidata/api_client/models/i_metadata_source_url_metadata.py +109 -0
  303. rapidata/api_client/models/i_metadata_streams_metadata.py +113 -0
  304. rapidata/api_client/models/i_metadata_text_metadata.py +114 -0
  305. rapidata/api_client/models/i_metadata_video_duration_metadata.py +110 -0
  306. rapidata/api_client/models/i_order_workflow_model.py +168 -0
  307. rapidata/api_client/models/i_order_workflow_model_compare_workflow_model.py +146 -0
  308. rapidata/api_client/models/i_order_workflow_model_evaluation_workflow_model.py +108 -0
  309. rapidata/api_client/models/i_order_workflow_model_grouped_ranking_workflow_model.py +147 -0
  310. rapidata/api_client/models/i_order_workflow_model_simple_workflow_model.py +110 -0
  311. rapidata/api_client/models/i_pair_maker_config.py +126 -0
  312. rapidata/api_client/models/i_pair_maker_config_model.py +126 -0
  313. rapidata/api_client/models/i_pair_maker_config_model_online_pair_maker_config_model.py +98 -0
  314. rapidata/api_client/models/i_pair_maker_config_online_pair_maker_config.py +98 -0
  315. rapidata/api_client/models/i_pair_maker_information.py +126 -0
  316. rapidata/api_client/models/i_pair_maker_information_online_pair_maker_information.py +100 -0
  317. rapidata/api_client/models/i_pipeline_artifact_model.py +126 -0
  318. rapidata/api_client/models/i_pipeline_artifact_model_create_dataset_artifact_model.py +102 -0
  319. rapidata/api_client/models/i_pipeline_model.py +126 -0
  320. rapidata/api_client/models/i_pipeline_model_create_simple_pipeline_model.py +116 -0
  321. rapidata/api_client/models/i_pipeline_step_model.py +168 -0
  322. rapidata/api_client/models/i_pipeline_step_model_dataset_evaluation_step_model.py +102 -0
  323. rapidata/api_client/models/i_pipeline_step_model_send_completion_mail_step_model.py +98 -0
  324. rapidata/api_client/models/i_pipeline_step_model_workflow_aggregation_step_model.py +103 -0
  325. rapidata/api_client/models/i_pipeline_step_model_workflow_labeling_step_model.py +96 -0
  326. rapidata/api_client/models/i_rapid_blueprint.py +252 -0
  327. rapidata/api_client/models/i_rapid_blueprint_attach_category_rapid_blueprint.py +108 -0
  328. rapidata/api_client/models/i_rapid_blueprint_bounding_box_rapid_blueprint.py +96 -0
  329. rapidata/api_client/models/i_rapid_blueprint_compare_rapid_blueprint.py +98 -0
  330. rapidata/api_client/models/i_rapid_blueprint_free_text_rapid_blueprint.py +105 -0
  331. rapidata/api_client/models/i_rapid_blueprint_line_rapid_blueprint.py +96 -0
  332. rapidata/api_client/models/i_rapid_blueprint_locate_rapid_blueprint.py +96 -0
  333. rapidata/api_client/models/i_rapid_blueprint_named_entity_rapid_blueprint.py +98 -0
  334. rapidata/api_client/models/i_rapid_blueprint_polygon_rapid_blueprint.py +96 -0
  335. rapidata/api_client/models/i_rapid_blueprint_scrub_rapid_blueprint.py +96 -0
  336. rapidata/api_client/models/i_rapid_blueprint_transcription_rapid_blueprint.py +96 -0
  337. rapidata/api_client/models/i_rapid_payload.py +252 -0
  338. rapidata/api_client/models/i_rapid_payload_bounding_box_payload.py +96 -0
  339. rapidata/api_client/models/i_rapid_payload_classify_payload.py +106 -0
  340. rapidata/api_client/models/i_rapid_payload_compare_payload.py +96 -0
  341. rapidata/api_client/models/i_rapid_payload_free_text_payload.py +105 -0
  342. rapidata/api_client/models/i_rapid_payload_line_payload.py +96 -0
  343. rapidata/api_client/models/i_rapid_payload_locate_payload.py +96 -0
  344. rapidata/api_client/models/i_rapid_payload_named_entity_payload.py +98 -0
  345. rapidata/api_client/models/i_rapid_payload_polygon_payload.py +96 -0
  346. rapidata/api_client/models/i_rapid_payload_scrub_payload.py +96 -0
  347. rapidata/api_client/models/i_rapid_payload_transcription_payload.py +106 -0
  348. rapidata/api_client/models/i_rapid_result.py +266 -0
  349. rapidata/api_client/models/i_rapid_result_attach_category_result.py +98 -0
  350. rapidata/api_client/models/i_rapid_result_bounding_box_result.py +106 -0
  351. rapidata/api_client/models/i_rapid_result_compare_result.py +98 -0
  352. rapidata/api_client/models/i_rapid_result_free_text_result.py +98 -0
  353. rapidata/api_client/models/i_rapid_result_line_result.py +106 -0
  354. rapidata/api_client/models/i_rapid_result_locate_result.py +106 -0
  355. rapidata/api_client/models/i_rapid_result_named_entity_result.py +106 -0
  356. rapidata/api_client/models/i_rapid_result_polygon_result.py +106 -0
  357. rapidata/api_client/models/i_rapid_result_scrub_result.py +98 -0
  358. rapidata/api_client/models/i_rapid_result_skip_result.py +96 -0
  359. rapidata/api_client/models/i_rapid_result_transcription_result.py +106 -0
  360. rapidata/api_client/models/i_referee_config.py +154 -0
  361. rapidata/api_client/models/i_referee_config_naive_referee_config.py +96 -0
  362. rapidata/api_client/models/i_referee_config_never_ending_referee_config.py +94 -0
  363. rapidata/api_client/models/i_referee_config_probabilistic_attach_category_referee_config.py +98 -0
  364. rapidata/api_client/models/i_referee_info.py +154 -0
  365. rapidata/api_client/models/i_referee_info_naive_referee_info.py +96 -0
  366. rapidata/api_client/models/i_referee_info_never_ending_referee_info.py +94 -0
  367. rapidata/api_client/models/i_referee_info_probabilistic_attach_category_referee_info.py +98 -0
  368. rapidata/api_client/models/i_referee_model.py +140 -0
  369. rapidata/api_client/models/i_referee_model_early_stopping_referee_model.py +98 -0
  370. rapidata/api_client/models/i_referee_model_naive_referee_model.py +96 -0
  371. rapidata/api_client/models/i_selection.py +240 -0
  372. rapidata/api_client/models/i_selection_ab_test_selection.py +122 -0
  373. rapidata/api_client/models/i_selection_capped_selection.py +108 -0
  374. rapidata/api_client/models/i_selection_conditional_validation_selection.py +110 -0
  375. rapidata/api_client/models/i_selection_demographic_selection.py +98 -0
  376. rapidata/api_client/models/i_selection_effort_capped_selection.py +101 -0
  377. rapidata/api_client/models/i_selection_labeling_selection.py +103 -0
  378. rapidata/api_client/models/i_selection_shuffling_selection.py +106 -0
  379. rapidata/api_client/models/i_selection_static_selection.py +96 -0
  380. rapidata/api_client/models/i_selection_validation_selection.py +98 -0
  381. rapidata/api_client/models/i_user_filter_model.py +296 -0
  382. rapidata/api_client/models/i_user_filter_model_age_user_filter_model.py +104 -0
  383. rapidata/api_client/models/i_user_filter_model_and_user_filter_model.py +106 -0
  384. rapidata/api_client/models/i_user_filter_model_campaign_user_filter_model.py +96 -0
  385. rapidata/api_client/models/i_user_filter_model_country_user_filter_model.py +96 -0
  386. rapidata/api_client/models/i_user_filter_model_custom_user_filter_model.py +98 -0
  387. rapidata/api_client/models/i_user_filter_model_device_user_filter_model.py +104 -0
  388. rapidata/api_client/models/i_user_filter_model_gender_user_filter_model.py +104 -0
  389. rapidata/api_client/models/i_user_filter_model_language_user_filter_model.py +96 -0
  390. rapidata/api_client/models/i_user_filter_model_new_user_filter_model.py +94 -0
  391. rapidata/api_client/models/i_user_filter_model_not_user_filter_model.py +102 -0
  392. rapidata/api_client/models/i_user_filter_model_or_user_filter_model.py +106 -0
  393. rapidata/api_client/models/i_user_filter_model_response_count_user_filter_model.py +101 -0
  394. rapidata/api_client/models/i_user_filter_model_user_score_user_filter_model.py +105 -0
  395. rapidata/api_client/models/i_validation_metadata_input.py +140 -0
  396. rapidata/api_client/models/i_validation_metadata_input_prompt_asset_metadata_input.py +100 -0
  397. rapidata/api_client/models/i_validation_metadata_input_prompt_metadata_input.py +96 -0
  398. rapidata/api_client/models/i_validation_truth.py +280 -0
  399. rapidata/api_client/models/i_validation_truth_attach_category_truth.py +96 -0
  400. rapidata/api_client/models/i_validation_truth_bounding_box_truth.py +102 -0
  401. rapidata/api_client/models/i_validation_truth_compare_truth.py +96 -0
  402. rapidata/api_client/models/i_validation_truth_empty_validation_truth.py +94 -0
  403. rapidata/api_client/models/i_validation_truth_line_truth.py +94 -0
  404. rapidata/api_client/models/i_validation_truth_locate_box_truth.py +108 -0
  405. rapidata/api_client/models/i_validation_truth_model.py +294 -0
  406. rapidata/api_client/models/i_validation_truth_model_attach_category_truth_model.py +96 -0
  407. rapidata/api_client/models/i_validation_truth_model_bounding_box_truth_model.py +102 -0
  408. rapidata/api_client/models/i_validation_truth_model_classify_truth_model.py +96 -0
  409. rapidata/api_client/models/i_validation_truth_model_compare_truth_model.py +96 -0
  410. rapidata/api_client/models/i_validation_truth_model_empty_validation_truth_model.py +94 -0
  411. rapidata/api_client/models/i_validation_truth_model_line_truth_model.py +94 -0
  412. rapidata/api_client/models/i_validation_truth_model_locate_box_truth_model.py +108 -0
  413. rapidata/api_client/models/i_validation_truth_model_multi_compare_truth_model.py +96 -0
  414. rapidata/api_client/models/i_validation_truth_model_named_entity_truth_model.py +104 -0
  415. rapidata/api_client/models/i_validation_truth_model_polygon_truth_model.py +94 -0
  416. rapidata/api_client/models/i_validation_truth_model_scrub_truth_model.py +104 -0
  417. rapidata/api_client/models/i_validation_truth_model_skip_truth_model.py +94 -0
  418. rapidata/api_client/models/i_validation_truth_model_transcription_truth_model.py +115 -0
  419. rapidata/api_client/models/i_validation_truth_multi_compare_truth.py +96 -0
  420. rapidata/api_client/models/i_validation_truth_named_entity_truth.py +104 -0
  421. rapidata/api_client/models/i_validation_truth_polygon_truth.py +94 -0
  422. rapidata/api_client/models/i_validation_truth_scrub_truth.py +104 -0
  423. rapidata/api_client/models/i_validation_truth_skip_truth.py +94 -0
  424. rapidata/api_client/models/i_validation_truth_transcription_truth.py +115 -0
  425. rapidata/api_client/models/i_workflow_config.py +168 -0
  426. rapidata/api_client/models/i_workflow_config_compare_workflow_config.py +142 -0
  427. rapidata/api_client/models/i_workflow_config_evaluation_workflow_config.py +114 -0
  428. rapidata/api_client/models/i_workflow_config_grouped_ranking_workflow_config.py +155 -0
  429. rapidata/api_client/models/i_workflow_config_simple_workflow_config.py +116 -0
  430. rapidata/api_client/models/i_workflow_model.py +168 -0
  431. rapidata/api_client/models/i_workflow_model_compare_workflow_model.py +145 -0
  432. rapidata/api_client/models/i_workflow_model_evaluation_workflow_model.py +115 -0
  433. rapidata/api_client/models/i_workflow_model_grouped_ranking_workflow_model.py +121 -0
  434. rapidata/api_client/models/i_workflow_model_simple_workflow_model.py +119 -0
  435. rapidata/api_client/models/image_dimension_metadata.py +12 -1
  436. rapidata/api_client/models/inquire_file_metadata_result.py +100 -0
  437. rapidata/api_client/models/inspect_report_result.py +2 -2
  438. rapidata/api_client/models/job_definition_revision_state.py +38 -0
  439. rapidata/api_client/models/json_web_key.py +2 -36
  440. rapidata/api_client/models/json_web_key_set.py +2 -22
  441. rapidata/api_client/models/labeling_selection.py +11 -13
  442. rapidata/api_client/models/language_filter.py +98 -0
  443. rapidata/api_client/models/leaderboard_query_result.py +29 -2
  444. rapidata/api_client/models/leaderboards_query_result.py +135 -0
  445. rapidata/api_client/models/line_result.py +3 -3
  446. rapidata/api_client/models/line_result_line.py +97 -0
  447. rapidata/api_client/models/line_result_line_point.py +89 -0
  448. rapidata/api_client/models/locate_coordinate.py +4 -13
  449. rapidata/api_client/models/location_metadata.py +12 -1
  450. rapidata/api_client/models/logic_operator.py +2 -2
  451. rapidata/api_client/models/metadata_i_order_metadata_input.py +154 -0
  452. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_prompt_asset_metadata_input.py +100 -0
  453. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_prompt_metadata_input.py +96 -0
  454. rapidata/api_client/models/metadata_i_order_metadata_input_metadata_transcription_metadata_input.py +96 -0
  455. rapidata/api_client/models/metadata_prompt_asset_metadata_input.py +100 -0
  456. rapidata/api_client/models/metadata_prompt_metadata_input.py +96 -0
  457. rapidata/api_client/models/metadata_transcription_metadata_input.py +96 -0
  458. rapidata/api_client/models/multi_asset.py +6 -6
  459. rapidata/api_client/models/multi_asset_assets_inner.py +170 -0
  460. rapidata/api_client/models/multi_asset_input.py +21 -1
  461. rapidata/api_client/models/multi_asset_input1_assets_inner.py +40 -12
  462. rapidata/api_client/models/multi_asset_input3_assets_inner.py +40 -12
  463. rapidata/api_client/models/multi_asset_input_assets_inner.py +16 -30
  464. rapidata/api_client/models/multi_asset_model.py +3 -3
  465. rapidata/api_client/models/naive_referee_model.py +2 -2
  466. rapidata/api_client/models/named_classification.py +4 -13
  467. rapidata/api_client/models/new_user_filter.py +96 -0
  468. rapidata/api_client/models/newsletter_model.py +6 -6
  469. rapidata/api_client/models/not_available_yet_result.py +4 -13
  470. rapidata/api_client/models/not_filter.py +117 -0
  471. rapidata/api_client/models/null_asset.py +3 -5
  472. rapidata/api_client/models/online_pair_maker_config_model.py +3 -3
  473. rapidata/api_client/models/option_of_aggregator_type.py +49 -0
  474. rapidata/api_client/models/or_filter.py +121 -0
  475. rapidata/api_client/models/order_model.py +15 -14
  476. rapidata/api_client/models/order_state.py +2 -2
  477. rapidata/api_client/models/original_filename_metadata.py +12 -1
  478. rapidata/api_client/models/page_info.py +2 -7
  479. rapidata/api_client/models/paged_result_aggregated_orders_model.py +105 -0
  480. rapidata/api_client/models/paged_result_benchmark_query_result.py +105 -0
  481. rapidata/api_client/models/paged_result_campaign_query_result.py +105 -0
  482. rapidata/api_client/models/paged_result_clients_query_result.py +105 -0
  483. rapidata/api_client/models/paged_result_datapoint_model.py +105 -0
  484. rapidata/api_client/models/paged_result_get_compare_workflow_results_result.py +105 -0
  485. rapidata/api_client/models/paged_result_get_grouped_ranking_workflow_results_result.py +105 -0
  486. rapidata/api_client/models/paged_result_get_validation_rapids_result.py +105 -0
  487. rapidata/api_client/models/paged_result_get_workflow_results_result.py +105 -0
  488. rapidata/api_client/models/paged_result_i_workflow_model.py +105 -0
  489. rapidata/api_client/models/paged_result_leaderboard_query_result.py +105 -0
  490. rapidata/api_client/models/paged_result_leaderboards_query_result.py +105 -0
  491. rapidata/api_client/models/paged_result_of_aggregated_orders_model.py +103 -0
  492. rapidata/api_client/models/paged_result_of_benchmark_query_result.py +103 -0
  493. rapidata/api_client/models/paged_result_of_campaign_query_result.py +103 -0
  494. rapidata/api_client/models/paged_result_of_clients_query_result.py +103 -0
  495. rapidata/api_client/models/paged_result_of_get_compare_workflow_results_result.py +103 -0
  496. rapidata/api_client/models/paged_result_of_get_grouped_ranking_workflow_results_result.py +103 -0
  497. rapidata/api_client/models/paged_result_of_get_validation_rapids_result.py +103 -0
  498. rapidata/api_client/models/paged_result_of_get_workflow_results_result.py +103 -0
  499. rapidata/api_client/models/paged_result_of_i_workflow_model.py +103 -0
  500. rapidata/api_client/models/paged_result_of_leaderboards_query_result.py +103 -0
  501. rapidata/api_client/models/paged_result_of_order_model.py +103 -0
  502. rapidata/api_client/models/paged_result_of_participant_by_benchmark.py +103 -0
  503. rapidata/api_client/models/paged_result_of_prompt_by_benchmark_result.py +103 -0
  504. rapidata/api_client/models/paged_result_of_query_audiences_result.py +103 -0
  505. rapidata/api_client/models/paged_result_of_query_datapoints_by_dataset_id_result.py +103 -0
  506. rapidata/api_client/models/paged_result_of_query_job_definitions_result.py +103 -0
  507. rapidata/api_client/models/paged_result_of_query_job_revisions_result.py +103 -0
  508. rapidata/api_client/models/paged_result_of_query_jobs_result.py +103 -0
  509. rapidata/api_client/models/paged_result_of_query_rapids_for_audience_result.py +103 -0
  510. rapidata/api_client/models/paged_result_of_query_validation_rapid_eligibility_result.py +103 -0
  511. rapidata/api_client/models/paged_result_of_rapid_model.py +103 -0
  512. rapidata/api_client/models/paged_result_of_runs_by_leaderboard_result.py +103 -0
  513. rapidata/api_client/models/paged_result_of_sample_by_identifier.py +103 -0
  514. rapidata/api_client/models/paged_result_of_sample_by_participant.py +103 -0
  515. rapidata/api_client/models/paged_result_of_standing_by_leaderboard.py +103 -0
  516. rapidata/api_client/models/paged_result_of_validation_set_model.py +103 -0
  517. rapidata/api_client/models/paged_result_order_model.py +105 -0
  518. rapidata/api_client/models/paged_result_participant_by_benchmark.py +105 -0
  519. rapidata/api_client/models/paged_result_potential_validation_rapid.py +105 -0
  520. rapidata/api_client/models/paged_result_prompt_by_benchmark_result.py +105 -0
  521. rapidata/api_client/models/paged_result_query_audiences_result.py +105 -0
  522. rapidata/api_client/models/paged_result_query_datapoints_by_dataset_id_result.py +105 -0
  523. rapidata/api_client/models/paged_result_query_validation_rapid_eligibility_result.py +105 -0
  524. rapidata/api_client/models/paged_result_rapid_model.py +105 -0
  525. rapidata/api_client/models/paged_result_runs_by_leaderboard_result.py +105 -0
  526. rapidata/api_client/models/paged_result_sample_by_identifier.py +105 -0
  527. rapidata/api_client/models/paged_result_sample_by_participant.py +105 -0
  528. rapidata/api_client/models/paged_result_standing_by_leaderboard.py +105 -0
  529. rapidata/api_client/models/paged_result_validation_set_model.py +105 -0
  530. rapidata/api_client/models/participant_by_benchmark.py +6 -14
  531. rapidata/api_client/models/participant_status.py +2 -2
  532. rapidata/api_client/models/polygon_result.py +3 -3
  533. rapidata/api_client/models/polygon_result_coordinate.py +89 -0
  534. rapidata/api_client/models/polygon_result_shape.py +95 -0
  535. rapidata/api_client/models/preliminary_download_model.py +5 -5
  536. rapidata/api_client/models/preview_order_model.py +5 -5
  537. rapidata/api_client/models/problem_details.py +2 -20
  538. rapidata/api_client/models/prompt_asset_metadata_input.py +4 -6
  539. rapidata/api_client/models/prompt_asset_metadata_input_asset.py +25 -41
  540. rapidata/api_client/models/prompt_by_benchmark_result.py +5 -5
  541. rapidata/api_client/models/prompt_metadata.py +12 -1
  542. rapidata/api_client/models/prompt_metadata_input.py +5 -7
  543. rapidata/api_client/models/prompt_type.py +38 -0
  544. rapidata/api_client/models/proxy_file_wrapper.py +17 -2
  545. rapidata/api_client/models/public_order_model.py +2 -2
  546. rapidata/api_client/models/public_rapid_response.py +112 -0
  547. rapidata/api_client/models/query_audiences_result.py +118 -0
  548. rapidata/api_client/models/query_datapoints_by_dataset_id_result.py +95 -0
  549. rapidata/api_client/models/query_job_definitions_result.py +97 -0
  550. rapidata/api_client/models/query_job_revisions_result.py +95 -0
  551. rapidata/api_client/models/query_jobs_result.py +103 -0
  552. rapidata/api_client/models/query_model.py +10 -5
  553. rapidata/api_client/models/query_rapids_for_audience_result.py +150 -0
  554. rapidata/api_client/models/query_validation_rapid_eligibility_model_query_validation_model.py +107 -0
  555. rapidata/api_client/models/query_validation_rapid_eligibility_result.py +103 -0
  556. rapidata/api_client/models/query_validation_rapid_eligibility_result_truth.py +280 -0
  557. rapidata/api_client/models/rapid_issue.py +2 -2
  558. rapidata/api_client/models/rapid_modality.py +46 -0
  559. rapidata/api_client/models/rapid_model.py +33 -49
  560. rapidata/api_client/models/rapid_result_model.py +7 -7
  561. rapidata/api_client/models/rapid_skipped_model.py +5 -5
  562. rapidata/api_client/models/rapid_state.py +2 -2
  563. rapidata/api_client/models/read_bridge_token_keys_result.py +10 -24
  564. rapidata/api_client/models/reference_asset_input.py +100 -0
  565. rapidata/api_client/models/report_model.py +9 -15
  566. rapidata/api_client/models/response_count_filter.py +103 -0
  567. rapidata/api_client/models/response_count_user_filter_model.py +2 -8
  568. rapidata/api_client/models/retrieval_mode.py +2 -2
  569. rapidata/api_client/models/root_filter.py +5 -14
  570. rapidata/api_client/models/run_status.py +2 -2
  571. rapidata/api_client/models/runs_by_leaderboard_result.py +6 -12
  572. rapidata/api_client/models/sample_by_identifier.py +125 -0
  573. rapidata/api_client/models/sample_by_identifier_paged_result.py +105 -0
  574. rapidata/api_client/models/sample_by_participant.py +7 -8
  575. rapidata/api_client/models/scrub_range.py +2 -2
  576. rapidata/api_client/models/send_survey_model.py +87 -0
  577. rapidata/api_client/models/simple_workflow_config.py +15 -5
  578. rapidata/api_client/models/simple_workflow_config_blueprint.py +37 -23
  579. rapidata/api_client/models/simple_workflow_config_model.py +11 -3
  580. rapidata/api_client/models/simple_workflow_model.py +14 -4
  581. rapidata/api_client/models/simple_workflow_model1.py +4 -11
  582. rapidata/api_client/models/simple_workflow_model_blueprint.py +1 -1
  583. rapidata/api_client/models/sort_criterion.py +5 -11
  584. rapidata/api_client/models/sort_direction.py +2 -2
  585. rapidata/api_client/models/source_url_metadata.py +12 -1
  586. rapidata/api_client/models/standing_by_benchmark.py +113 -0
  587. rapidata/api_client/models/standing_by_leaderboard.py +19 -21
  588. rapidata/api_client/models/standing_status.py +2 -2
  589. rapidata/api_client/models/standings_by_benchmark_result.py +95 -0
  590. rapidata/api_client/models/standings_by_leaderboard_result.py +2 -2
  591. rapidata/api_client/models/start_preliminary_download_result.py +87 -0
  592. rapidata/api_client/models/sticky_state.py +3 -2
  593. rapidata/api_client/models/stream_file_wrapper.py +25 -3
  594. rapidata/api_client/models/streams_metadata.py +12 -1
  595. rapidata/api_client/models/string_segment.py +105 -0
  596. rapidata/api_client/models/submit_order_model.py +5 -5
  597. rapidata/api_client/models/submit_participant_result.py +2 -2
  598. rapidata/api_client/models/submit_prompt_model.py +9 -14
  599. rapidata/api_client/models/submit_prompt_model_prompt_asset.py +40 -12
  600. rapidata/api_client/models/tags_by_benchmark_result.py +2 -2
  601. rapidata/api_client/models/text_asset.py +3 -5
  602. rapidata/api_client/models/text_asset_input.py +21 -1
  603. rapidata/api_client/models/text_metadata.py +18 -2
  604. rapidata/api_client/models/text_metadata_input.py +111 -0
  605. rapidata/api_client/models/text_metadata_model.py +7 -2
  606. rapidata/api_client/models/transcription_metadata.py +9 -1
  607. rapidata/api_client/models/transcription_metadata_input.py +5 -7
  608. rapidata/api_client/models/transcription_word.py +2 -2
  609. rapidata/api_client/models/translated_string.py +2 -2
  610. rapidata/api_client/models/unlock_order_result.py +2 -2
  611. rapidata/api_client/models/update_audience_request.py +113 -0
  612. rapidata/api_client/models/update_benchmark_model.py +99 -0
  613. rapidata/api_client/models/update_benchmark_name_model.py +5 -5
  614. rapidata/api_client/models/update_campaign_model.py +11 -11
  615. rapidata/api_client/models/update_dataset_name_model.py +5 -5
  616. rapidata/api_client/models/update_dimensions_model.py +3 -3
  617. rapidata/api_client/models/update_job_definition_endpoint_input.py +92 -0
  618. rapidata/api_client/models/update_leaderboard_model.py +106 -0
  619. rapidata/api_client/models/update_leaderboard_name_model.py +5 -5
  620. rapidata/api_client/models/update_leaderboard_response_config_model.py +5 -5
  621. rapidata/api_client/models/update_order_name_model.py +5 -5
  622. rapidata/api_client/models/update_participant_model.py +92 -0
  623. rapidata/api_client/models/update_participant_name_model.py +5 -5
  624. rapidata/api_client/models/update_priority_model.py +87 -0
  625. rapidata/api_client/models/update_prompt_tags_model.py +5 -5
  626. rapidata/api_client/models/update_should_alert_model.py +4 -4
  627. rapidata/api_client/models/update_validation_rapid_model.py +35 -14
  628. rapidata/api_client/models/update_validation_rapid_model_context_asset.py +160 -0
  629. rapidata/api_client/models/update_validation_set_model.py +120 -0
  630. rapidata/api_client/models/upload_asset_result.py +102 -0
  631. rapidata/api_client/models/upload_file_from_url_result.py +87 -0
  632. rapidata/api_client/models/upload_file_result.py +87 -0
  633. rapidata/api_client/models/user_action_restriction.py +37 -0
  634. rapidata/api_client/models/user_action_restriction_filter.py +101 -0
  635. rapidata/api_client/models/user_score_filter.py +102 -0
  636. rapidata/api_client/models/user_state.py +38 -0
  637. rapidata/api_client/models/user_state_filter.py +101 -0
  638. rapidata/api_client/models/validation_chance.py +20 -3
  639. rapidata/api_client/models/validation_problem_details.py +117 -0
  640. rapidata/api_client/models/validation_set_model.py +39 -5
  641. rapidata/api_client/models/validation_set_overview_model.py +2 -2
  642. rapidata/api_client/models/video_duration_metadata.py +12 -1
  643. rapidata/api_client/models/workflow_aggregation_step_model.py +3 -12
  644. rapidata/api_client/models/workflow_config_artifact_model_workflow_config.py +23 -9
  645. rapidata/api_client/models/workflow_state.py +2 -2
  646. rapidata/api_client/models/zip_entry_file_wrapper.py +33 -2
  647. rapidata/api_client/rest.py +2 -2
  648. rapidata/api_client_README.md +384 -318
  649. rapidata/rapidata_client/__init__.py +17 -22
  650. rapidata/rapidata_client/api/rapidata_api_client.py +253 -0
  651. rapidata/rapidata_client/audience/__init__.py +2 -0
  652. rapidata/rapidata_client/audience/audience_example_handler.py +168 -0
  653. rapidata/rapidata_client/audience/rapidata_audience.py +287 -0
  654. rapidata/rapidata_client/audience/rapidata_audience_manager.py +162 -0
  655. rapidata/rapidata_client/benchmark/_detail_mapper.py +11 -9
  656. rapidata/rapidata_client/benchmark/leaderboard/rapidata_leaderboard.py +98 -54
  657. rapidata/rapidata_client/benchmark/participant/_participant.py +90 -46
  658. rapidata/rapidata_client/benchmark/rapidata_benchmark.py +388 -225
  659. rapidata/rapidata_client/benchmark/rapidata_benchmark_manager.py +172 -65
  660. rapidata/rapidata_client/config/__init__.py +4 -0
  661. rapidata/rapidata_client/config/logger.py +135 -0
  662. rapidata/rapidata_client/config/logging_config.py +55 -0
  663. rapidata/rapidata_client/config/managed_print.py +6 -0
  664. rapidata/rapidata_client/config/order_config.py +14 -0
  665. rapidata/rapidata_client/config/rapidata_config.py +36 -0
  666. rapidata/rapidata_client/config/tracer.py +184 -0
  667. rapidata/rapidata_client/config/upload_config.py +64 -0
  668. rapidata/rapidata_client/datapoints/__init__.py +8 -3
  669. rapidata/rapidata_client/datapoints/_asset_uploader.py +184 -0
  670. rapidata/rapidata_client/datapoints/_datapoint.py +92 -0
  671. rapidata/rapidata_client/datapoints/_datapoint_uploader.py +47 -0
  672. rapidata/rapidata_client/datapoints/_datapoints_validator.py +70 -0
  673. rapidata/rapidata_client/datapoints/assets/__init__.py +0 -10
  674. rapidata/rapidata_client/datapoints/assets/constants.py +7 -0
  675. rapidata/rapidata_client/datapoints/metadata/__init__.py +0 -2
  676. rapidata/rapidata_client/datapoints/metadata/_private_text_metadata.py +5 -6
  677. rapidata/rapidata_client/datapoints/metadata/_prompt_identifier_metadata.py +4 -5
  678. rapidata/rapidata_client/datapoints/metadata/_public_text_metadata.py +5 -6
  679. rapidata/rapidata_client/datapoints/metadata/_select_words_metadata.py +3 -4
  680. rapidata/rapidata_client/dataset/__init__.py +1 -0
  681. rapidata/rapidata_client/dataset/_rapidata_dataset.py +55 -0
  682. rapidata/rapidata_client/demographic/demographic_manager.py +44 -19
  683. rapidata/rapidata_client/exceptions/failed_upload_exception.py +15 -41
  684. rapidata/rapidata_client/filter/_backend_filter_mapper.py +134 -0
  685. rapidata/rapidata_client/filter/_base_filter.py +13 -8
  686. rapidata/rapidata_client/filter/age_filter.py +26 -10
  687. rapidata/rapidata_client/filter/and_filter.py +36 -11
  688. rapidata/rapidata_client/filter/campaign_filter.py +21 -10
  689. rapidata/rapidata_client/filter/country_filter.py +46 -12
  690. rapidata/rapidata_client/filter/custom_filter.py +25 -12
  691. rapidata/rapidata_client/filter/gender_filter.py +25 -10
  692. rapidata/rapidata_client/filter/language_filter.py +51 -21
  693. rapidata/rapidata_client/filter/models/age_group.py +14 -12
  694. rapidata/rapidata_client/filter/models/gender.py +12 -8
  695. rapidata/rapidata_client/filter/new_user_filter.py +14 -4
  696. rapidata/rapidata_client/filter/not_filter.py +35 -11
  697. rapidata/rapidata_client/filter/or_filter.py +36 -11
  698. rapidata/rapidata_client/filter/rapidata_filters.py +17 -23
  699. rapidata/rapidata_client/filter/response_count_filter.py +51 -20
  700. rapidata/rapidata_client/filter/user_score_filter.py +62 -24
  701. rapidata/rapidata_client/job/__init__.py +3 -0
  702. rapidata/rapidata_client/job/job_definition.py +110 -0
  703. rapidata/rapidata_client/job/job_manager.py +758 -0
  704. rapidata/rapidata_client/job/rapidata_job.py +326 -0
  705. rapidata/rapidata_client/order/__init__.py +2 -0
  706. rapidata/rapidata_client/order/_rapidata_order_builder.py +273 -122
  707. rapidata/rapidata_client/order/rapidata_order.py +316 -160
  708. rapidata/rapidata_client/order/rapidata_order_manager.py +680 -421
  709. rapidata/rapidata_client/rapidata_client.py +115 -37
  710. rapidata/rapidata_client/referee/__init__.py +1 -1
  711. rapidata/rapidata_client/referee/_base_referee.py +14 -3
  712. rapidata/rapidata_client/referee/_early_stopping_referee.py +32 -17
  713. rapidata/rapidata_client/referee/_naive_referee.py +24 -3
  714. rapidata/rapidata_client/results/__init__.py +3 -0
  715. rapidata/rapidata_client/{order → results}/rapidata_results.py +86 -63
  716. rapidata/rapidata_client/selection/__init__.py +1 -1
  717. rapidata/rapidata_client/selection/_base_selection.py +9 -2
  718. rapidata/rapidata_client/selection/ab_test_selection.py +28 -20
  719. rapidata/rapidata_client/selection/capped_selection.py +23 -16
  720. rapidata/rapidata_client/selection/conditional_validation_selection.py +43 -24
  721. rapidata/rapidata_client/selection/demographic_selection.py +21 -6
  722. rapidata/rapidata_client/selection/effort_selection.py +31 -8
  723. rapidata/rapidata_client/selection/labeling_selection.py +34 -11
  724. rapidata/rapidata_client/selection/{retrieval_modes.py → rapidata_retrieval_modes.py} +7 -4
  725. rapidata/rapidata_client/selection/rapidata_selections.py +23 -14
  726. rapidata/rapidata_client/selection/shuffling_selection.py +21 -13
  727. rapidata/rapidata_client/selection/static_selection.py +19 -8
  728. rapidata/rapidata_client/selection/validation_selection.py +20 -4
  729. rapidata/rapidata_client/settings/__init__.py +2 -0
  730. rapidata/rapidata_client/settings/_rapidata_setting.py +22 -3
  731. rapidata/rapidata_client/settings/alert_on_fast_response.py +8 -5
  732. rapidata/rapidata_client/settings/allow_neither_both.py +3 -0
  733. rapidata/rapidata_client/settings/custom_setting.py +3 -2
  734. rapidata/rapidata_client/settings/free_text_minimum_characters.py +9 -4
  735. rapidata/rapidata_client/settings/models/translation_behaviour_options.py +3 -2
  736. rapidata/rapidata_client/settings/mute_video.py +15 -0
  737. rapidata/rapidata_client/settings/no_shuffle.py +4 -2
  738. rapidata/rapidata_client/settings/play_video_until_the_end.py +7 -4
  739. rapidata/rapidata_client/settings/rapidata_settings.py +22 -9
  740. rapidata/rapidata_client/settings/swap_context_instruction.py +20 -0
  741. rapidata/rapidata_client/settings/translation_behaviour.py +7 -5
  742. rapidata/rapidata_client/utils/__init__.py +3 -0
  743. rapidata/rapidata_client/utils/threaded_uploader.py +153 -0
  744. rapidata/rapidata_client/validation/__init__.py +2 -0
  745. rapidata/rapidata_client/validation/rapidata_validation_set.py +96 -18
  746. rapidata/rapidata_client/validation/rapids/__init__.py +2 -0
  747. rapidata/rapidata_client/validation/rapids/_validation_rapid_uploader.py +48 -0
  748. rapidata/rapidata_client/validation/rapids/box.py +37 -12
  749. rapidata/rapidata_client/validation/rapids/rapids.py +29 -83
  750. rapidata/rapidata_client/validation/rapids/rapids_manager.py +369 -211
  751. rapidata/rapidata_client/validation/validation_set_manager.py +505 -276
  752. rapidata/rapidata_client/workflow/__init__.py +2 -2
  753. rapidata/rapidata_client/workflow/_base_workflow.py +25 -7
  754. rapidata/rapidata_client/workflow/_classify_workflow.py +58 -15
  755. rapidata/rapidata_client/workflow/_compare_workflow.py +44 -9
  756. rapidata/rapidata_client/workflow/_draw_workflow.py +40 -10
  757. rapidata/rapidata_client/workflow/_evaluation_workflow.py +28 -7
  758. rapidata/rapidata_client/workflow/_free_text_workflow.py +46 -9
  759. rapidata/rapidata_client/workflow/_locate_workflow.py +40 -10
  760. rapidata/rapidata_client/workflow/_multi_ranking_workflow.py +90 -0
  761. rapidata/rapidata_client/workflow/_select_words_workflow.py +51 -11
  762. rapidata/rapidata_client/workflow/_timestamp_workflow.py +42 -11
  763. rapidata/service/__init__.py +0 -1
  764. rapidata/service/credential_manager.py +14 -14
  765. rapidata/service/openapi_service.py +119 -34
  766. rapidata/types/__init__.py +149 -0
  767. rapidata-3.0.0a8.dist-info/METADATA +32 -0
  768. rapidata-3.0.0a8.dist-info/RECORD +1083 -0
  769. {rapidata-2.35.1.dist-info → rapidata-3.0.0a8.dist-info}/WHEEL +1 -1
  770. rapidata/rapidata_client/api/rapidata_exception.py +0 -107
  771. rapidata/rapidata_client/country_codes/__init__.py +0 -1
  772. rapidata/rapidata_client/country_codes/country_codes.py +0 -19
  773. rapidata/rapidata_client/datapoints/assets/_base_asset.py +0 -11
  774. rapidata/rapidata_client/datapoints/assets/_media_asset.py +0 -306
  775. rapidata/rapidata_client/datapoints/assets/_multi_asset.py +0 -61
  776. rapidata/rapidata_client/datapoints/assets/_sessions.py +0 -35
  777. rapidata/rapidata_client/datapoints/assets/_text_asset.py +0 -34
  778. rapidata/rapidata_client/datapoints/assets/data_type_enum.py +0 -8
  779. rapidata/rapidata_client/datapoints/datapoint.py +0 -108
  780. rapidata/rapidata_client/datapoints/metadata/_media_asset_metadata.py +0 -22
  781. rapidata/rapidata_client/datapoints/metadata/_prompt_metadata.py +0 -18
  782. rapidata/rapidata_client/logging/__init__.py +0 -2
  783. rapidata/rapidata_client/logging/logger.py +0 -122
  784. rapidata/rapidata_client/logging/output_manager.py +0 -20
  785. rapidata/rapidata_client/order/_rapidata_dataset.py +0 -396
  786. rapidata/rapidata_client/workflow/_ranking_workflow.py +0 -47
  787. rapidata/service/local_file_service.py +0 -25
  788. rapidata-2.35.1.dist-info/METADATA +0 -35
  789. rapidata-2.35.1.dist-info/RECORD +0 -657
  790. {rapidata-2.35.1.dist-info → rapidata-3.0.0a8.dist-info/licenses}/LICENSE +0 -0
@@ -0,0 +1,2505 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ Rapidata Asset API
5
+
6
+ The API for the Rapidata Asset service
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, StrictStr
20
+ from typing import Optional
21
+ from typing_extensions import Annotated
22
+ from rapidata.api_client.models.add_rapid_to_audience_model import AddRapidToAudienceModel
23
+ from rapidata.api_client.models.create_audience_request import CreateAudienceRequest
24
+ from rapidata.api_client.models.create_audience_result import CreateAudienceResult
25
+ from rapidata.api_client.models.get_audience_by_id_result import GetAudienceByIdResult
26
+ from rapidata.api_client.models.paged_result_of_query_audiences_result import PagedResultOfQueryAudiencesResult
27
+ from rapidata.api_client.models.paged_result_of_query_jobs_result import PagedResultOfQueryJobsResult
28
+ from rapidata.api_client.models.paged_result_of_query_rapids_for_audience_result import PagedResultOfQueryRapidsForAudienceResult
29
+ from rapidata.api_client.models.query_model import QueryModel
30
+ from rapidata.api_client.models.update_audience_request import UpdateAudienceRequest
31
+
32
+ from rapidata.api_client.api_client import ApiClient, RequestSerialized
33
+ from rapidata.api_client.api_response import ApiResponse
34
+ from rapidata.api_client.rest import RESTResponseType
35
+
36
+
37
+ class AudienceApi:
38
+ """NOTE: This class is auto generated by OpenAPI Generator
39
+ Ref: https://openapi-generator.tech
40
+
41
+ Do not edit the class manually.
42
+ """
43
+
44
+ def __init__(self, api_client=None) -> None:
45
+ if api_client is None:
46
+ api_client = ApiClient.get_default()
47
+ self.api_client = api_client
48
+
49
+
50
+ @validate_call
51
+ def audience_audience_id_delete(
52
+ self,
53
+ audience_id: StrictStr,
54
+ _request_timeout: Union[
55
+ None,
56
+ Annotated[StrictFloat, Field(gt=0)],
57
+ Tuple[
58
+ Annotated[StrictFloat, Field(gt=0)],
59
+ Annotated[StrictFloat, Field(gt=0)]
60
+ ]
61
+ ] = None,
62
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
63
+ _content_type: Optional[StrictStr] = None,
64
+ _headers: Optional[Dict[StrictStr, Any]] = None,
65
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
66
+ ) -> None:
67
+ """Deletes the specified audience.
68
+
69
+
70
+ :param audience_id: (required)
71
+ :type audience_id: str
72
+ :param _request_timeout: timeout setting for this request. If one
73
+ number provided, it will be total request
74
+ timeout. It can also be a pair (tuple) of
75
+ (connection, read) timeouts.
76
+ :type _request_timeout: int, tuple(int, int), optional
77
+ :param _request_auth: set to override the auth_settings for an a single
78
+ request; this effectively ignores the
79
+ authentication in the spec for a single request.
80
+ :type _request_auth: dict, optional
81
+ :param _content_type: force content-type for the request.
82
+ :type _content_type: str, Optional
83
+ :param _headers: set to override the headers for a single
84
+ request; this effectively ignores the headers
85
+ in the spec for a single request.
86
+ :type _headers: dict, optional
87
+ :param _host_index: set to override the host_index for a single
88
+ request; this effectively ignores the host_index
89
+ in the spec for a single request.
90
+ :type _host_index: int, optional
91
+ :return: Returns the result object.
92
+ """ # noqa: E501
93
+
94
+ _param = self._audience_audience_id_delete_serialize(
95
+ audience_id=audience_id,
96
+ _request_auth=_request_auth,
97
+ _content_type=_content_type,
98
+ _headers=_headers,
99
+ _host_index=_host_index
100
+ )
101
+
102
+ _response_types_map: Dict[str, Optional[str]] = {
103
+ '204': None,
104
+ '400': "ValidationProblemDetails",
105
+ '401': None,
106
+ '403': None,
107
+ }
108
+ response_data = self.api_client.call_api(
109
+ *_param,
110
+ _request_timeout=_request_timeout
111
+ )
112
+ response_data.read()
113
+ return self.api_client.response_deserialize(
114
+ response_data=response_data,
115
+ response_types_map=_response_types_map,
116
+ ).data
117
+
118
+
119
+ @validate_call
120
+ def audience_audience_id_delete_with_http_info(
121
+ self,
122
+ audience_id: StrictStr,
123
+ _request_timeout: Union[
124
+ None,
125
+ Annotated[StrictFloat, Field(gt=0)],
126
+ Tuple[
127
+ Annotated[StrictFloat, Field(gt=0)],
128
+ Annotated[StrictFloat, Field(gt=0)]
129
+ ]
130
+ ] = None,
131
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
132
+ _content_type: Optional[StrictStr] = None,
133
+ _headers: Optional[Dict[StrictStr, Any]] = None,
134
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
135
+ ) -> ApiResponse[None]:
136
+ """Deletes the specified audience.
137
+
138
+
139
+ :param audience_id: (required)
140
+ :type audience_id: str
141
+ :param _request_timeout: timeout setting for this request. If one
142
+ number provided, it will be total request
143
+ timeout. It can also be a pair (tuple) of
144
+ (connection, read) timeouts.
145
+ :type _request_timeout: int, tuple(int, int), optional
146
+ :param _request_auth: set to override the auth_settings for an a single
147
+ request; this effectively ignores the
148
+ authentication in the spec for a single request.
149
+ :type _request_auth: dict, optional
150
+ :param _content_type: force content-type for the request.
151
+ :type _content_type: str, Optional
152
+ :param _headers: set to override the headers for a single
153
+ request; this effectively ignores the headers
154
+ in the spec for a single request.
155
+ :type _headers: dict, optional
156
+ :param _host_index: set to override the host_index for a single
157
+ request; this effectively ignores the host_index
158
+ in the spec for a single request.
159
+ :type _host_index: int, optional
160
+ :return: Returns the result object.
161
+ """ # noqa: E501
162
+
163
+ _param = self._audience_audience_id_delete_serialize(
164
+ audience_id=audience_id,
165
+ _request_auth=_request_auth,
166
+ _content_type=_content_type,
167
+ _headers=_headers,
168
+ _host_index=_host_index
169
+ )
170
+
171
+ _response_types_map: Dict[str, Optional[str]] = {
172
+ '204': None,
173
+ '400': "ValidationProblemDetails",
174
+ '401': None,
175
+ '403': None,
176
+ }
177
+ response_data = self.api_client.call_api(
178
+ *_param,
179
+ _request_timeout=_request_timeout
180
+ )
181
+ response_data.read()
182
+ return self.api_client.response_deserialize(
183
+ response_data=response_data,
184
+ response_types_map=_response_types_map,
185
+ )
186
+
187
+
188
+ @validate_call
189
+ def audience_audience_id_delete_without_preload_content(
190
+ self,
191
+ audience_id: StrictStr,
192
+ _request_timeout: Union[
193
+ None,
194
+ Annotated[StrictFloat, Field(gt=0)],
195
+ Tuple[
196
+ Annotated[StrictFloat, Field(gt=0)],
197
+ Annotated[StrictFloat, Field(gt=0)]
198
+ ]
199
+ ] = None,
200
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
201
+ _content_type: Optional[StrictStr] = None,
202
+ _headers: Optional[Dict[StrictStr, Any]] = None,
203
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
204
+ ) -> RESTResponseType:
205
+ """Deletes the specified audience.
206
+
207
+
208
+ :param audience_id: (required)
209
+ :type audience_id: str
210
+ :param _request_timeout: timeout setting for this request. If one
211
+ number provided, it will be total request
212
+ timeout. It can also be a pair (tuple) of
213
+ (connection, read) timeouts.
214
+ :type _request_timeout: int, tuple(int, int), optional
215
+ :param _request_auth: set to override the auth_settings for an a single
216
+ request; this effectively ignores the
217
+ authentication in the spec for a single request.
218
+ :type _request_auth: dict, optional
219
+ :param _content_type: force content-type for the request.
220
+ :type _content_type: str, Optional
221
+ :param _headers: set to override the headers for a single
222
+ request; this effectively ignores the headers
223
+ in the spec for a single request.
224
+ :type _headers: dict, optional
225
+ :param _host_index: set to override the host_index for a single
226
+ request; this effectively ignores the host_index
227
+ in the spec for a single request.
228
+ :type _host_index: int, optional
229
+ :return: Returns the result object.
230
+ """ # noqa: E501
231
+
232
+ _param = self._audience_audience_id_delete_serialize(
233
+ audience_id=audience_id,
234
+ _request_auth=_request_auth,
235
+ _content_type=_content_type,
236
+ _headers=_headers,
237
+ _host_index=_host_index
238
+ )
239
+
240
+ _response_types_map: Dict[str, Optional[str]] = {
241
+ '204': None,
242
+ '400': "ValidationProblemDetails",
243
+ '401': None,
244
+ '403': None,
245
+ }
246
+ response_data = self.api_client.call_api(
247
+ *_param,
248
+ _request_timeout=_request_timeout
249
+ )
250
+ return response_data.response
251
+
252
+
253
+ def _audience_audience_id_delete_serialize(
254
+ self,
255
+ audience_id,
256
+ _request_auth,
257
+ _content_type,
258
+ _headers,
259
+ _host_index,
260
+ ) -> RequestSerialized:
261
+
262
+ _host = None
263
+
264
+ _collection_formats: Dict[str, str] = {
265
+ }
266
+
267
+ _path_params: Dict[str, str] = {}
268
+ _query_params: List[Tuple[str, str]] = []
269
+ _header_params: Dict[str, Optional[str]] = _headers or {}
270
+ _form_params: List[Tuple[str, str]] = []
271
+ _files: Dict[
272
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
273
+ ] = {}
274
+ _body_params: Optional[bytes] = None
275
+
276
+ # process the path parameters
277
+ if audience_id is not None:
278
+ _path_params['audienceId'] = audience_id
279
+ # process the query parameters
280
+ # process the header parameters
281
+ # process the form parameters
282
+ # process the body parameter
283
+
284
+
285
+ # set the HTTP header `Accept`
286
+ if 'Accept' not in _header_params:
287
+ _header_params['Accept'] = self.api_client.select_header_accept(
288
+ [
289
+ 'application/json'
290
+ ]
291
+ )
292
+
293
+
294
+ # authentication setting
295
+ _auth_settings: List[str] = [
296
+ 'OAuth2',
297
+ 'OpenIdConnect',
298
+ 'Bearer'
299
+ ]
300
+
301
+ return self.api_client.param_serialize(
302
+ method='DELETE',
303
+ resource_path='/audience/{audienceId}',
304
+ path_params=_path_params,
305
+ query_params=_query_params,
306
+ header_params=_header_params,
307
+ body=_body_params,
308
+ post_params=_form_params,
309
+ files=_files,
310
+ auth_settings=_auth_settings,
311
+ collection_formats=_collection_formats,
312
+ _host=_host,
313
+ _request_auth=_request_auth
314
+ )
315
+
316
+
317
+
318
+
319
+ @validate_call
320
+ def audience_audience_id_get(
321
+ self,
322
+ audience_id: Annotated[StrictStr, Field(description="The id of the audience to get.")],
323
+ _request_timeout: Union[
324
+ None,
325
+ Annotated[StrictFloat, Field(gt=0)],
326
+ Tuple[
327
+ Annotated[StrictFloat, Field(gt=0)],
328
+ Annotated[StrictFloat, Field(gt=0)]
329
+ ]
330
+ ] = None,
331
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
332
+ _content_type: Optional[StrictStr] = None,
333
+ _headers: Optional[Dict[StrictStr, Any]] = None,
334
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
335
+ ) -> GetAudienceByIdResult:
336
+ """Gets an audience by its Id.
337
+
338
+
339
+ :param audience_id: The id of the audience to get. (required)
340
+ :type audience_id: str
341
+ :param _request_timeout: timeout setting for this request. If one
342
+ number provided, it will be total request
343
+ timeout. It can also be a pair (tuple) of
344
+ (connection, read) timeouts.
345
+ :type _request_timeout: int, tuple(int, int), optional
346
+ :param _request_auth: set to override the auth_settings for an a single
347
+ request; this effectively ignores the
348
+ authentication in the spec for a single request.
349
+ :type _request_auth: dict, optional
350
+ :param _content_type: force content-type for the request.
351
+ :type _content_type: str, Optional
352
+ :param _headers: set to override the headers for a single
353
+ request; this effectively ignores the headers
354
+ in the spec for a single request.
355
+ :type _headers: dict, optional
356
+ :param _host_index: set to override the host_index for a single
357
+ request; this effectively ignores the host_index
358
+ in the spec for a single request.
359
+ :type _host_index: int, optional
360
+ :return: Returns the result object.
361
+ """ # noqa: E501
362
+
363
+ _param = self._audience_audience_id_get_serialize(
364
+ audience_id=audience_id,
365
+ _request_auth=_request_auth,
366
+ _content_type=_content_type,
367
+ _headers=_headers,
368
+ _host_index=_host_index
369
+ )
370
+
371
+ _response_types_map: Dict[str, Optional[str]] = {
372
+ '200': "GetAudienceByIdResult",
373
+ }
374
+ response_data = self.api_client.call_api(
375
+ *_param,
376
+ _request_timeout=_request_timeout
377
+ )
378
+ response_data.read()
379
+ return self.api_client.response_deserialize(
380
+ response_data=response_data,
381
+ response_types_map=_response_types_map,
382
+ ).data
383
+
384
+
385
+ @validate_call
386
+ def audience_audience_id_get_with_http_info(
387
+ self,
388
+ audience_id: Annotated[StrictStr, Field(description="The id of the audience to get.")],
389
+ _request_timeout: Union[
390
+ None,
391
+ Annotated[StrictFloat, Field(gt=0)],
392
+ Tuple[
393
+ Annotated[StrictFloat, Field(gt=0)],
394
+ Annotated[StrictFloat, Field(gt=0)]
395
+ ]
396
+ ] = None,
397
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
398
+ _content_type: Optional[StrictStr] = None,
399
+ _headers: Optional[Dict[StrictStr, Any]] = None,
400
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
401
+ ) -> ApiResponse[GetAudienceByIdResult]:
402
+ """Gets an audience by its Id.
403
+
404
+
405
+ :param audience_id: The id of the audience to get. (required)
406
+ :type audience_id: str
407
+ :param _request_timeout: timeout setting for this request. If one
408
+ number provided, it will be total request
409
+ timeout. It can also be a pair (tuple) of
410
+ (connection, read) timeouts.
411
+ :type _request_timeout: int, tuple(int, int), optional
412
+ :param _request_auth: set to override the auth_settings for an a single
413
+ request; this effectively ignores the
414
+ authentication in the spec for a single request.
415
+ :type _request_auth: dict, optional
416
+ :param _content_type: force content-type for the request.
417
+ :type _content_type: str, Optional
418
+ :param _headers: set to override the headers for a single
419
+ request; this effectively ignores the headers
420
+ in the spec for a single request.
421
+ :type _headers: dict, optional
422
+ :param _host_index: set to override the host_index for a single
423
+ request; this effectively ignores the host_index
424
+ in the spec for a single request.
425
+ :type _host_index: int, optional
426
+ :return: Returns the result object.
427
+ """ # noqa: E501
428
+
429
+ _param = self._audience_audience_id_get_serialize(
430
+ audience_id=audience_id,
431
+ _request_auth=_request_auth,
432
+ _content_type=_content_type,
433
+ _headers=_headers,
434
+ _host_index=_host_index
435
+ )
436
+
437
+ _response_types_map: Dict[str, Optional[str]] = {
438
+ '200': "GetAudienceByIdResult",
439
+ }
440
+ response_data = self.api_client.call_api(
441
+ *_param,
442
+ _request_timeout=_request_timeout
443
+ )
444
+ response_data.read()
445
+ return self.api_client.response_deserialize(
446
+ response_data=response_data,
447
+ response_types_map=_response_types_map,
448
+ )
449
+
450
+
451
+ @validate_call
452
+ def audience_audience_id_get_without_preload_content(
453
+ self,
454
+ audience_id: Annotated[StrictStr, Field(description="The id of the audience to get.")],
455
+ _request_timeout: Union[
456
+ None,
457
+ Annotated[StrictFloat, Field(gt=0)],
458
+ Tuple[
459
+ Annotated[StrictFloat, Field(gt=0)],
460
+ Annotated[StrictFloat, Field(gt=0)]
461
+ ]
462
+ ] = None,
463
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
464
+ _content_type: Optional[StrictStr] = None,
465
+ _headers: Optional[Dict[StrictStr, Any]] = None,
466
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
467
+ ) -> RESTResponseType:
468
+ """Gets an audience by its Id.
469
+
470
+
471
+ :param audience_id: The id of the audience to get. (required)
472
+ :type audience_id: str
473
+ :param _request_timeout: timeout setting for this request. If one
474
+ number provided, it will be total request
475
+ timeout. It can also be a pair (tuple) of
476
+ (connection, read) timeouts.
477
+ :type _request_timeout: int, tuple(int, int), optional
478
+ :param _request_auth: set to override the auth_settings for an a single
479
+ request; this effectively ignores the
480
+ authentication in the spec for a single request.
481
+ :type _request_auth: dict, optional
482
+ :param _content_type: force content-type for the request.
483
+ :type _content_type: str, Optional
484
+ :param _headers: set to override the headers for a single
485
+ request; this effectively ignores the headers
486
+ in the spec for a single request.
487
+ :type _headers: dict, optional
488
+ :param _host_index: set to override the host_index for a single
489
+ request; this effectively ignores the host_index
490
+ in the spec for a single request.
491
+ :type _host_index: int, optional
492
+ :return: Returns the result object.
493
+ """ # noqa: E501
494
+
495
+ _param = self._audience_audience_id_get_serialize(
496
+ audience_id=audience_id,
497
+ _request_auth=_request_auth,
498
+ _content_type=_content_type,
499
+ _headers=_headers,
500
+ _host_index=_host_index
501
+ )
502
+
503
+ _response_types_map: Dict[str, Optional[str]] = {
504
+ '200': "GetAudienceByIdResult",
505
+ }
506
+ response_data = self.api_client.call_api(
507
+ *_param,
508
+ _request_timeout=_request_timeout
509
+ )
510
+ return response_data.response
511
+
512
+
513
+ def _audience_audience_id_get_serialize(
514
+ self,
515
+ audience_id,
516
+ _request_auth,
517
+ _content_type,
518
+ _headers,
519
+ _host_index,
520
+ ) -> RequestSerialized:
521
+
522
+ _host = None
523
+
524
+ _collection_formats: Dict[str, str] = {
525
+ }
526
+
527
+ _path_params: Dict[str, str] = {}
528
+ _query_params: List[Tuple[str, str]] = []
529
+ _header_params: Dict[str, Optional[str]] = _headers or {}
530
+ _form_params: List[Tuple[str, str]] = []
531
+ _files: Dict[
532
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
533
+ ] = {}
534
+ _body_params: Optional[bytes] = None
535
+
536
+ # process the path parameters
537
+ if audience_id is not None:
538
+ _path_params['audienceId'] = audience_id
539
+ # process the query parameters
540
+ # process the header parameters
541
+ # process the form parameters
542
+ # process the body parameter
543
+
544
+
545
+ # set the HTTP header `Accept`
546
+ if 'Accept' not in _header_params:
547
+ _header_params['Accept'] = self.api_client.select_header_accept(
548
+ [
549
+ 'text/plain',
550
+ 'application/json',
551
+ 'text/json'
552
+ ]
553
+ )
554
+
555
+
556
+ # authentication setting
557
+ _auth_settings: List[str] = [
558
+ 'OAuth2',
559
+ 'OpenIdConnect',
560
+ 'Bearer'
561
+ ]
562
+
563
+ return self.api_client.param_serialize(
564
+ method='GET',
565
+ resource_path='/audience/{audienceId}',
566
+ path_params=_path_params,
567
+ query_params=_query_params,
568
+ header_params=_header_params,
569
+ body=_body_params,
570
+ post_params=_form_params,
571
+ files=_files,
572
+ auth_settings=_auth_settings,
573
+ collection_formats=_collection_formats,
574
+ _host=_host,
575
+ _request_auth=_request_auth
576
+ )
577
+
578
+
579
+
580
+
581
+ @validate_call
582
+ def audience_audience_id_jobs_get(
583
+ self,
584
+ audience_id: StrictStr,
585
+ _request_timeout: Union[
586
+ None,
587
+ Annotated[StrictFloat, Field(gt=0)],
588
+ Tuple[
589
+ Annotated[StrictFloat, Field(gt=0)],
590
+ Annotated[StrictFloat, Field(gt=0)]
591
+ ]
592
+ ] = None,
593
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
594
+ _content_type: Optional[StrictStr] = None,
595
+ _headers: Optional[Dict[StrictStr, Any]] = None,
596
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
597
+ ) -> PagedResultOfQueryJobsResult:
598
+ """audience_audience_id_jobs_get
599
+
600
+
601
+ :param audience_id: (required)
602
+ :type audience_id: str
603
+ :param _request_timeout: timeout setting for this request. If one
604
+ number provided, it will be total request
605
+ timeout. It can also be a pair (tuple) of
606
+ (connection, read) timeouts.
607
+ :type _request_timeout: int, tuple(int, int), optional
608
+ :param _request_auth: set to override the auth_settings for an a single
609
+ request; this effectively ignores the
610
+ authentication in the spec for a single request.
611
+ :type _request_auth: dict, optional
612
+ :param _content_type: force content-type for the request.
613
+ :type _content_type: str, Optional
614
+ :param _headers: set to override the headers for a single
615
+ request; this effectively ignores the headers
616
+ in the spec for a single request.
617
+ :type _headers: dict, optional
618
+ :param _host_index: set to override the host_index for a single
619
+ request; this effectively ignores the host_index
620
+ in the spec for a single request.
621
+ :type _host_index: int, optional
622
+ :return: Returns the result object.
623
+ """ # noqa: E501
624
+
625
+ _param = self._audience_audience_id_jobs_get_serialize(
626
+ audience_id=audience_id,
627
+ _request_auth=_request_auth,
628
+ _content_type=_content_type,
629
+ _headers=_headers,
630
+ _host_index=_host_index
631
+ )
632
+
633
+ _response_types_map: Dict[str, Optional[str]] = {
634
+ '200': "PagedResultOfQueryJobsResult",
635
+ '400': "ValidationProblemDetails",
636
+ '401': None,
637
+ '403': None,
638
+ }
639
+ response_data = self.api_client.call_api(
640
+ *_param,
641
+ _request_timeout=_request_timeout
642
+ )
643
+ response_data.read()
644
+ return self.api_client.response_deserialize(
645
+ response_data=response_data,
646
+ response_types_map=_response_types_map,
647
+ ).data
648
+
649
+
650
+ @validate_call
651
+ def audience_audience_id_jobs_get_with_http_info(
652
+ self,
653
+ audience_id: StrictStr,
654
+ _request_timeout: Union[
655
+ None,
656
+ Annotated[StrictFloat, Field(gt=0)],
657
+ Tuple[
658
+ Annotated[StrictFloat, Field(gt=0)],
659
+ Annotated[StrictFloat, Field(gt=0)]
660
+ ]
661
+ ] = None,
662
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
663
+ _content_type: Optional[StrictStr] = None,
664
+ _headers: Optional[Dict[StrictStr, Any]] = None,
665
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
666
+ ) -> ApiResponse[PagedResultOfQueryJobsResult]:
667
+ """audience_audience_id_jobs_get
668
+
669
+
670
+ :param audience_id: (required)
671
+ :type audience_id: str
672
+ :param _request_timeout: timeout setting for this request. If one
673
+ number provided, it will be total request
674
+ timeout. It can also be a pair (tuple) of
675
+ (connection, read) timeouts.
676
+ :type _request_timeout: int, tuple(int, int), optional
677
+ :param _request_auth: set to override the auth_settings for an a single
678
+ request; this effectively ignores the
679
+ authentication in the spec for a single request.
680
+ :type _request_auth: dict, optional
681
+ :param _content_type: force content-type for the request.
682
+ :type _content_type: str, Optional
683
+ :param _headers: set to override the headers for a single
684
+ request; this effectively ignores the headers
685
+ in the spec for a single request.
686
+ :type _headers: dict, optional
687
+ :param _host_index: set to override the host_index for a single
688
+ request; this effectively ignores the host_index
689
+ in the spec for a single request.
690
+ :type _host_index: int, optional
691
+ :return: Returns the result object.
692
+ """ # noqa: E501
693
+
694
+ _param = self._audience_audience_id_jobs_get_serialize(
695
+ audience_id=audience_id,
696
+ _request_auth=_request_auth,
697
+ _content_type=_content_type,
698
+ _headers=_headers,
699
+ _host_index=_host_index
700
+ )
701
+
702
+ _response_types_map: Dict[str, Optional[str]] = {
703
+ '200': "PagedResultOfQueryJobsResult",
704
+ '400': "ValidationProblemDetails",
705
+ '401': None,
706
+ '403': None,
707
+ }
708
+ response_data = self.api_client.call_api(
709
+ *_param,
710
+ _request_timeout=_request_timeout
711
+ )
712
+ response_data.read()
713
+ return self.api_client.response_deserialize(
714
+ response_data=response_data,
715
+ response_types_map=_response_types_map,
716
+ )
717
+
718
+
719
+ @validate_call
720
+ def audience_audience_id_jobs_get_without_preload_content(
721
+ self,
722
+ audience_id: StrictStr,
723
+ _request_timeout: Union[
724
+ None,
725
+ Annotated[StrictFloat, Field(gt=0)],
726
+ Tuple[
727
+ Annotated[StrictFloat, Field(gt=0)],
728
+ Annotated[StrictFloat, Field(gt=0)]
729
+ ]
730
+ ] = None,
731
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
732
+ _content_type: Optional[StrictStr] = None,
733
+ _headers: Optional[Dict[StrictStr, Any]] = None,
734
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
735
+ ) -> RESTResponseType:
736
+ """audience_audience_id_jobs_get
737
+
738
+
739
+ :param audience_id: (required)
740
+ :type audience_id: str
741
+ :param _request_timeout: timeout setting for this request. If one
742
+ number provided, it will be total request
743
+ timeout. It can also be a pair (tuple) of
744
+ (connection, read) timeouts.
745
+ :type _request_timeout: int, tuple(int, int), optional
746
+ :param _request_auth: set to override the auth_settings for an a single
747
+ request; this effectively ignores the
748
+ authentication in the spec for a single request.
749
+ :type _request_auth: dict, optional
750
+ :param _content_type: force content-type for the request.
751
+ :type _content_type: str, Optional
752
+ :param _headers: set to override the headers for a single
753
+ request; this effectively ignores the headers
754
+ in the spec for a single request.
755
+ :type _headers: dict, optional
756
+ :param _host_index: set to override the host_index for a single
757
+ request; this effectively ignores the host_index
758
+ in the spec for a single request.
759
+ :type _host_index: int, optional
760
+ :return: Returns the result object.
761
+ """ # noqa: E501
762
+
763
+ _param = self._audience_audience_id_jobs_get_serialize(
764
+ audience_id=audience_id,
765
+ _request_auth=_request_auth,
766
+ _content_type=_content_type,
767
+ _headers=_headers,
768
+ _host_index=_host_index
769
+ )
770
+
771
+ _response_types_map: Dict[str, Optional[str]] = {
772
+ '200': "PagedResultOfQueryJobsResult",
773
+ '400': "ValidationProblemDetails",
774
+ '401': None,
775
+ '403': None,
776
+ }
777
+ response_data = self.api_client.call_api(
778
+ *_param,
779
+ _request_timeout=_request_timeout
780
+ )
781
+ return response_data.response
782
+
783
+
784
+ def _audience_audience_id_jobs_get_serialize(
785
+ self,
786
+ audience_id,
787
+ _request_auth,
788
+ _content_type,
789
+ _headers,
790
+ _host_index,
791
+ ) -> RequestSerialized:
792
+
793
+ _host = None
794
+
795
+ _collection_formats: Dict[str, str] = {
796
+ }
797
+
798
+ _path_params: Dict[str, str] = {}
799
+ _query_params: List[Tuple[str, str]] = []
800
+ _header_params: Dict[str, Optional[str]] = _headers or {}
801
+ _form_params: List[Tuple[str, str]] = []
802
+ _files: Dict[
803
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
804
+ ] = {}
805
+ _body_params: Optional[bytes] = None
806
+
807
+ # process the path parameters
808
+ if audience_id is not None:
809
+ _path_params['audienceId'] = audience_id
810
+ # process the query parameters
811
+ # process the header parameters
812
+ # process the form parameters
813
+ # process the body parameter
814
+
815
+
816
+ # set the HTTP header `Accept`
817
+ if 'Accept' not in _header_params:
818
+ _header_params['Accept'] = self.api_client.select_header_accept(
819
+ [
820
+ 'application/json'
821
+ ]
822
+ )
823
+
824
+
825
+ # authentication setting
826
+ _auth_settings: List[str] = [
827
+ 'OAuth2',
828
+ 'OpenIdConnect',
829
+ 'Bearer'
830
+ ]
831
+
832
+ return self.api_client.param_serialize(
833
+ method='GET',
834
+ resource_path='/audience/{audienceId}/jobs',
835
+ path_params=_path_params,
836
+ query_params=_query_params,
837
+ header_params=_header_params,
838
+ body=_body_params,
839
+ post_params=_form_params,
840
+ files=_files,
841
+ auth_settings=_auth_settings,
842
+ collection_formats=_collection_formats,
843
+ _host=_host,
844
+ _request_auth=_request_auth
845
+ )
846
+
847
+
848
+
849
+
850
+ @validate_call
851
+ def audience_audience_id_patch(
852
+ self,
853
+ audience_id: StrictStr,
854
+ update_audience_request: UpdateAudienceRequest,
855
+ _request_timeout: Union[
856
+ None,
857
+ Annotated[StrictFloat, Field(gt=0)],
858
+ Tuple[
859
+ Annotated[StrictFloat, Field(gt=0)],
860
+ Annotated[StrictFloat, Field(gt=0)]
861
+ ]
862
+ ] = None,
863
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
864
+ _content_type: Optional[StrictStr] = None,
865
+ _headers: Optional[Dict[StrictStr, Any]] = None,
866
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
867
+ ) -> None:
868
+ """Patches an existing audience.
869
+
870
+
871
+ :param audience_id: (required)
872
+ :type audience_id: str
873
+ :param update_audience_request: (required)
874
+ :type update_audience_request: UpdateAudienceRequest
875
+ :param _request_timeout: timeout setting for this request. If one
876
+ number provided, it will be total request
877
+ timeout. It can also be a pair (tuple) of
878
+ (connection, read) timeouts.
879
+ :type _request_timeout: int, tuple(int, int), optional
880
+ :param _request_auth: set to override the auth_settings for an a single
881
+ request; this effectively ignores the
882
+ authentication in the spec for a single request.
883
+ :type _request_auth: dict, optional
884
+ :param _content_type: force content-type for the request.
885
+ :type _content_type: str, Optional
886
+ :param _headers: set to override the headers for a single
887
+ request; this effectively ignores the headers
888
+ in the spec for a single request.
889
+ :type _headers: dict, optional
890
+ :param _host_index: set to override the host_index for a single
891
+ request; this effectively ignores the host_index
892
+ in the spec for a single request.
893
+ :type _host_index: int, optional
894
+ :return: Returns the result object.
895
+ """ # noqa: E501
896
+
897
+ _param = self._audience_audience_id_patch_serialize(
898
+ audience_id=audience_id,
899
+ update_audience_request=update_audience_request,
900
+ _request_auth=_request_auth,
901
+ _content_type=_content_type,
902
+ _headers=_headers,
903
+ _host_index=_host_index
904
+ )
905
+
906
+ _response_types_map: Dict[str, Optional[str]] = {
907
+ '204': None,
908
+ }
909
+ response_data = self.api_client.call_api(
910
+ *_param,
911
+ _request_timeout=_request_timeout
912
+ )
913
+ response_data.read()
914
+ return self.api_client.response_deserialize(
915
+ response_data=response_data,
916
+ response_types_map=_response_types_map,
917
+ ).data
918
+
919
+
920
+ @validate_call
921
+ def audience_audience_id_patch_with_http_info(
922
+ self,
923
+ audience_id: StrictStr,
924
+ update_audience_request: UpdateAudienceRequest,
925
+ _request_timeout: Union[
926
+ None,
927
+ Annotated[StrictFloat, Field(gt=0)],
928
+ Tuple[
929
+ Annotated[StrictFloat, Field(gt=0)],
930
+ Annotated[StrictFloat, Field(gt=0)]
931
+ ]
932
+ ] = None,
933
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
934
+ _content_type: Optional[StrictStr] = None,
935
+ _headers: Optional[Dict[StrictStr, Any]] = None,
936
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
937
+ ) -> ApiResponse[None]:
938
+ """Patches an existing audience.
939
+
940
+
941
+ :param audience_id: (required)
942
+ :type audience_id: str
943
+ :param update_audience_request: (required)
944
+ :type update_audience_request: UpdateAudienceRequest
945
+ :param _request_timeout: timeout setting for this request. If one
946
+ number provided, it will be total request
947
+ timeout. It can also be a pair (tuple) of
948
+ (connection, read) timeouts.
949
+ :type _request_timeout: int, tuple(int, int), optional
950
+ :param _request_auth: set to override the auth_settings for an a single
951
+ request; this effectively ignores the
952
+ authentication in the spec for a single request.
953
+ :type _request_auth: dict, optional
954
+ :param _content_type: force content-type for the request.
955
+ :type _content_type: str, Optional
956
+ :param _headers: set to override the headers for a single
957
+ request; this effectively ignores the headers
958
+ in the spec for a single request.
959
+ :type _headers: dict, optional
960
+ :param _host_index: set to override the host_index for a single
961
+ request; this effectively ignores the host_index
962
+ in the spec for a single request.
963
+ :type _host_index: int, optional
964
+ :return: Returns the result object.
965
+ """ # noqa: E501
966
+
967
+ _param = self._audience_audience_id_patch_serialize(
968
+ audience_id=audience_id,
969
+ update_audience_request=update_audience_request,
970
+ _request_auth=_request_auth,
971
+ _content_type=_content_type,
972
+ _headers=_headers,
973
+ _host_index=_host_index
974
+ )
975
+
976
+ _response_types_map: Dict[str, Optional[str]] = {
977
+ '204': None,
978
+ }
979
+ response_data = self.api_client.call_api(
980
+ *_param,
981
+ _request_timeout=_request_timeout
982
+ )
983
+ response_data.read()
984
+ return self.api_client.response_deserialize(
985
+ response_data=response_data,
986
+ response_types_map=_response_types_map,
987
+ )
988
+
989
+
990
+ @validate_call
991
+ def audience_audience_id_patch_without_preload_content(
992
+ self,
993
+ audience_id: StrictStr,
994
+ update_audience_request: UpdateAudienceRequest,
995
+ _request_timeout: Union[
996
+ None,
997
+ Annotated[StrictFloat, Field(gt=0)],
998
+ Tuple[
999
+ Annotated[StrictFloat, Field(gt=0)],
1000
+ Annotated[StrictFloat, Field(gt=0)]
1001
+ ]
1002
+ ] = None,
1003
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1004
+ _content_type: Optional[StrictStr] = None,
1005
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1006
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1007
+ ) -> RESTResponseType:
1008
+ """Patches an existing audience.
1009
+
1010
+
1011
+ :param audience_id: (required)
1012
+ :type audience_id: str
1013
+ :param update_audience_request: (required)
1014
+ :type update_audience_request: UpdateAudienceRequest
1015
+ :param _request_timeout: timeout setting for this request. If one
1016
+ number provided, it will be total request
1017
+ timeout. It can also be a pair (tuple) of
1018
+ (connection, read) timeouts.
1019
+ :type _request_timeout: int, tuple(int, int), optional
1020
+ :param _request_auth: set to override the auth_settings for an a single
1021
+ request; this effectively ignores the
1022
+ authentication in the spec for a single request.
1023
+ :type _request_auth: dict, optional
1024
+ :param _content_type: force content-type for the request.
1025
+ :type _content_type: str, Optional
1026
+ :param _headers: set to override the headers for a single
1027
+ request; this effectively ignores the headers
1028
+ in the spec for a single request.
1029
+ :type _headers: dict, optional
1030
+ :param _host_index: set to override the host_index for a single
1031
+ request; this effectively ignores the host_index
1032
+ in the spec for a single request.
1033
+ :type _host_index: int, optional
1034
+ :return: Returns the result object.
1035
+ """ # noqa: E501
1036
+
1037
+ _param = self._audience_audience_id_patch_serialize(
1038
+ audience_id=audience_id,
1039
+ update_audience_request=update_audience_request,
1040
+ _request_auth=_request_auth,
1041
+ _content_type=_content_type,
1042
+ _headers=_headers,
1043
+ _host_index=_host_index
1044
+ )
1045
+
1046
+ _response_types_map: Dict[str, Optional[str]] = {
1047
+ '204': None,
1048
+ }
1049
+ response_data = self.api_client.call_api(
1050
+ *_param,
1051
+ _request_timeout=_request_timeout
1052
+ )
1053
+ return response_data.response
1054
+
1055
+
1056
+ def _audience_audience_id_patch_serialize(
1057
+ self,
1058
+ audience_id,
1059
+ update_audience_request,
1060
+ _request_auth,
1061
+ _content_type,
1062
+ _headers,
1063
+ _host_index,
1064
+ ) -> RequestSerialized:
1065
+
1066
+ _host = None
1067
+
1068
+ _collection_formats: Dict[str, str] = {
1069
+ }
1070
+
1071
+ _path_params: Dict[str, str] = {}
1072
+ _query_params: List[Tuple[str, str]] = []
1073
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1074
+ _form_params: List[Tuple[str, str]] = []
1075
+ _files: Dict[
1076
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1077
+ ] = {}
1078
+ _body_params: Optional[bytes] = None
1079
+
1080
+ # process the path parameters
1081
+ if audience_id is not None:
1082
+ _path_params['audienceId'] = audience_id
1083
+ # process the query parameters
1084
+ # process the header parameters
1085
+ # process the form parameters
1086
+ # process the body parameter
1087
+ if update_audience_request is not None:
1088
+ _body_params = update_audience_request
1089
+
1090
+
1091
+
1092
+ # set the HTTP header `Content-Type`
1093
+ if _content_type:
1094
+ _header_params['Content-Type'] = _content_type
1095
+ else:
1096
+ _default_content_type = (
1097
+ self.api_client.select_header_content_type(
1098
+ [
1099
+ 'application/json',
1100
+ 'text/json',
1101
+ 'application/*+json'
1102
+ ]
1103
+ )
1104
+ )
1105
+ if _default_content_type is not None:
1106
+ _header_params['Content-Type'] = _default_content_type
1107
+
1108
+ # authentication setting
1109
+ _auth_settings: List[str] = [
1110
+ 'OAuth2',
1111
+ 'OpenIdConnect',
1112
+ 'Bearer'
1113
+ ]
1114
+
1115
+ return self.api_client.param_serialize(
1116
+ method='PATCH',
1117
+ resource_path='/audience/{audienceId}',
1118
+ path_params=_path_params,
1119
+ query_params=_query_params,
1120
+ header_params=_header_params,
1121
+ body=_body_params,
1122
+ post_params=_form_params,
1123
+ files=_files,
1124
+ auth_settings=_auth_settings,
1125
+ collection_formats=_collection_formats,
1126
+ _host=_host,
1127
+ _request_auth=_request_auth
1128
+ )
1129
+
1130
+
1131
+
1132
+
1133
+ @validate_call
1134
+ def audience_audience_id_rapid_post(
1135
+ self,
1136
+ audience_id: StrictStr,
1137
+ add_rapid_to_audience_model: AddRapidToAudienceModel,
1138
+ _request_timeout: Union[
1139
+ None,
1140
+ Annotated[StrictFloat, Field(gt=0)],
1141
+ Tuple[
1142
+ Annotated[StrictFloat, Field(gt=0)],
1143
+ Annotated[StrictFloat, Field(gt=0)]
1144
+ ]
1145
+ ] = None,
1146
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1147
+ _content_type: Optional[StrictStr] = None,
1148
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1149
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1150
+ ) -> None:
1151
+ """Adds a new rapid to be used to train users for the specified audience.
1152
+
1153
+
1154
+ :param audience_id: (required)
1155
+ :type audience_id: str
1156
+ :param add_rapid_to_audience_model: (required)
1157
+ :type add_rapid_to_audience_model: AddRapidToAudienceModel
1158
+ :param _request_timeout: timeout setting for this request. If one
1159
+ number provided, it will be total request
1160
+ timeout. It can also be a pair (tuple) of
1161
+ (connection, read) timeouts.
1162
+ :type _request_timeout: int, tuple(int, int), optional
1163
+ :param _request_auth: set to override the auth_settings for an a single
1164
+ request; this effectively ignores the
1165
+ authentication in the spec for a single request.
1166
+ :type _request_auth: dict, optional
1167
+ :param _content_type: force content-type for the request.
1168
+ :type _content_type: str, Optional
1169
+ :param _headers: set to override the headers for a single
1170
+ request; this effectively ignores the headers
1171
+ in the spec for a single request.
1172
+ :type _headers: dict, optional
1173
+ :param _host_index: set to override the host_index for a single
1174
+ request; this effectively ignores the host_index
1175
+ in the spec for a single request.
1176
+ :type _host_index: int, optional
1177
+ :return: Returns the result object.
1178
+ """ # noqa: E501
1179
+
1180
+ _param = self._audience_audience_id_rapid_post_serialize(
1181
+ audience_id=audience_id,
1182
+ add_rapid_to_audience_model=add_rapid_to_audience_model,
1183
+ _request_auth=_request_auth,
1184
+ _content_type=_content_type,
1185
+ _headers=_headers,
1186
+ _host_index=_host_index
1187
+ )
1188
+
1189
+ _response_types_map: Dict[str, Optional[str]] = {
1190
+ '204': None,
1191
+ }
1192
+ response_data = self.api_client.call_api(
1193
+ *_param,
1194
+ _request_timeout=_request_timeout
1195
+ )
1196
+ response_data.read()
1197
+ return self.api_client.response_deserialize(
1198
+ response_data=response_data,
1199
+ response_types_map=_response_types_map,
1200
+ ).data
1201
+
1202
+
1203
+ @validate_call
1204
+ def audience_audience_id_rapid_post_with_http_info(
1205
+ self,
1206
+ audience_id: StrictStr,
1207
+ add_rapid_to_audience_model: AddRapidToAudienceModel,
1208
+ _request_timeout: Union[
1209
+ None,
1210
+ Annotated[StrictFloat, Field(gt=0)],
1211
+ Tuple[
1212
+ Annotated[StrictFloat, Field(gt=0)],
1213
+ Annotated[StrictFloat, Field(gt=0)]
1214
+ ]
1215
+ ] = None,
1216
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1217
+ _content_type: Optional[StrictStr] = None,
1218
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1219
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1220
+ ) -> ApiResponse[None]:
1221
+ """Adds a new rapid to be used to train users for the specified audience.
1222
+
1223
+
1224
+ :param audience_id: (required)
1225
+ :type audience_id: str
1226
+ :param add_rapid_to_audience_model: (required)
1227
+ :type add_rapid_to_audience_model: AddRapidToAudienceModel
1228
+ :param _request_timeout: timeout setting for this request. If one
1229
+ number provided, it will be total request
1230
+ timeout. It can also be a pair (tuple) of
1231
+ (connection, read) timeouts.
1232
+ :type _request_timeout: int, tuple(int, int), optional
1233
+ :param _request_auth: set to override the auth_settings for an a single
1234
+ request; this effectively ignores the
1235
+ authentication in the spec for a single request.
1236
+ :type _request_auth: dict, optional
1237
+ :param _content_type: force content-type for the request.
1238
+ :type _content_type: str, Optional
1239
+ :param _headers: set to override the headers for a single
1240
+ request; this effectively ignores the headers
1241
+ in the spec for a single request.
1242
+ :type _headers: dict, optional
1243
+ :param _host_index: set to override the host_index for a single
1244
+ request; this effectively ignores the host_index
1245
+ in the spec for a single request.
1246
+ :type _host_index: int, optional
1247
+ :return: Returns the result object.
1248
+ """ # noqa: E501
1249
+
1250
+ _param = self._audience_audience_id_rapid_post_serialize(
1251
+ audience_id=audience_id,
1252
+ add_rapid_to_audience_model=add_rapid_to_audience_model,
1253
+ _request_auth=_request_auth,
1254
+ _content_type=_content_type,
1255
+ _headers=_headers,
1256
+ _host_index=_host_index
1257
+ )
1258
+
1259
+ _response_types_map: Dict[str, Optional[str]] = {
1260
+ '204': None,
1261
+ }
1262
+ response_data = self.api_client.call_api(
1263
+ *_param,
1264
+ _request_timeout=_request_timeout
1265
+ )
1266
+ response_data.read()
1267
+ return self.api_client.response_deserialize(
1268
+ response_data=response_data,
1269
+ response_types_map=_response_types_map,
1270
+ )
1271
+
1272
+
1273
+ @validate_call
1274
+ def audience_audience_id_rapid_post_without_preload_content(
1275
+ self,
1276
+ audience_id: StrictStr,
1277
+ add_rapid_to_audience_model: AddRapidToAudienceModel,
1278
+ _request_timeout: Union[
1279
+ None,
1280
+ Annotated[StrictFloat, Field(gt=0)],
1281
+ Tuple[
1282
+ Annotated[StrictFloat, Field(gt=0)],
1283
+ Annotated[StrictFloat, Field(gt=0)]
1284
+ ]
1285
+ ] = None,
1286
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1287
+ _content_type: Optional[StrictStr] = None,
1288
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1289
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1290
+ ) -> RESTResponseType:
1291
+ """Adds a new rapid to be used to train users for the specified audience.
1292
+
1293
+
1294
+ :param audience_id: (required)
1295
+ :type audience_id: str
1296
+ :param add_rapid_to_audience_model: (required)
1297
+ :type add_rapid_to_audience_model: AddRapidToAudienceModel
1298
+ :param _request_timeout: timeout setting for this request. If one
1299
+ number provided, it will be total request
1300
+ timeout. It can also be a pair (tuple) of
1301
+ (connection, read) timeouts.
1302
+ :type _request_timeout: int, tuple(int, int), optional
1303
+ :param _request_auth: set to override the auth_settings for an a single
1304
+ request; this effectively ignores the
1305
+ authentication in the spec for a single request.
1306
+ :type _request_auth: dict, optional
1307
+ :param _content_type: force content-type for the request.
1308
+ :type _content_type: str, Optional
1309
+ :param _headers: set to override the headers for a single
1310
+ request; this effectively ignores the headers
1311
+ in the spec for a single request.
1312
+ :type _headers: dict, optional
1313
+ :param _host_index: set to override the host_index for a single
1314
+ request; this effectively ignores the host_index
1315
+ in the spec for a single request.
1316
+ :type _host_index: int, optional
1317
+ :return: Returns the result object.
1318
+ """ # noqa: E501
1319
+
1320
+ _param = self._audience_audience_id_rapid_post_serialize(
1321
+ audience_id=audience_id,
1322
+ add_rapid_to_audience_model=add_rapid_to_audience_model,
1323
+ _request_auth=_request_auth,
1324
+ _content_type=_content_type,
1325
+ _headers=_headers,
1326
+ _host_index=_host_index
1327
+ )
1328
+
1329
+ _response_types_map: Dict[str, Optional[str]] = {
1330
+ '204': None,
1331
+ }
1332
+ response_data = self.api_client.call_api(
1333
+ *_param,
1334
+ _request_timeout=_request_timeout
1335
+ )
1336
+ return response_data.response
1337
+
1338
+
1339
+ def _audience_audience_id_rapid_post_serialize(
1340
+ self,
1341
+ audience_id,
1342
+ add_rapid_to_audience_model,
1343
+ _request_auth,
1344
+ _content_type,
1345
+ _headers,
1346
+ _host_index,
1347
+ ) -> RequestSerialized:
1348
+
1349
+ _host = None
1350
+
1351
+ _collection_formats: Dict[str, str] = {
1352
+ }
1353
+
1354
+ _path_params: Dict[str, str] = {}
1355
+ _query_params: List[Tuple[str, str]] = []
1356
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1357
+ _form_params: List[Tuple[str, str]] = []
1358
+ _files: Dict[
1359
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1360
+ ] = {}
1361
+ _body_params: Optional[bytes] = None
1362
+
1363
+ # process the path parameters
1364
+ if audience_id is not None:
1365
+ _path_params['audienceId'] = audience_id
1366
+ # process the query parameters
1367
+ # process the header parameters
1368
+ # process the form parameters
1369
+ # process the body parameter
1370
+ if add_rapid_to_audience_model is not None:
1371
+ _body_params = add_rapid_to_audience_model
1372
+
1373
+
1374
+
1375
+ # set the HTTP header `Content-Type`
1376
+ if _content_type:
1377
+ _header_params['Content-Type'] = _content_type
1378
+ else:
1379
+ _default_content_type = (
1380
+ self.api_client.select_header_content_type(
1381
+ [
1382
+ 'application/json',
1383
+ 'text/json',
1384
+ 'application/*+json'
1385
+ ]
1386
+ )
1387
+ )
1388
+ if _default_content_type is not None:
1389
+ _header_params['Content-Type'] = _default_content_type
1390
+
1391
+ # authentication setting
1392
+ _auth_settings: List[str] = [
1393
+ 'OAuth2',
1394
+ 'OpenIdConnect',
1395
+ 'Bearer'
1396
+ ]
1397
+
1398
+ return self.api_client.param_serialize(
1399
+ method='POST',
1400
+ resource_path='/audience/{audienceId}/rapid',
1401
+ path_params=_path_params,
1402
+ query_params=_query_params,
1403
+ header_params=_header_params,
1404
+ body=_body_params,
1405
+ post_params=_form_params,
1406
+ files=_files,
1407
+ auth_settings=_auth_settings,
1408
+ collection_formats=_collection_formats,
1409
+ _host=_host,
1410
+ _request_auth=_request_auth
1411
+ )
1412
+
1413
+
1414
+
1415
+
1416
+ @validate_call
1417
+ def audience_audience_id_rapids_get(
1418
+ self,
1419
+ audience_id: StrictStr,
1420
+ request: Optional[QueryModel] = None,
1421
+ _request_timeout: Union[
1422
+ None,
1423
+ Annotated[StrictFloat, Field(gt=0)],
1424
+ Tuple[
1425
+ Annotated[StrictFloat, Field(gt=0)],
1426
+ Annotated[StrictFloat, Field(gt=0)]
1427
+ ]
1428
+ ] = None,
1429
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1430
+ _content_type: Optional[StrictStr] = None,
1431
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1432
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1433
+ ) -> PagedResultOfQueryRapidsForAudienceResult:
1434
+ """Queries all rapids for the specified audience.
1435
+
1436
+
1437
+ :param audience_id: (required)
1438
+ :type audience_id: str
1439
+ :param request:
1440
+ :type request: QueryModel
1441
+ :param _request_timeout: timeout setting for this request. If one
1442
+ number provided, it will be total request
1443
+ timeout. It can also be a pair (tuple) of
1444
+ (connection, read) timeouts.
1445
+ :type _request_timeout: int, tuple(int, int), optional
1446
+ :param _request_auth: set to override the auth_settings for an a single
1447
+ request; this effectively ignores the
1448
+ authentication in the spec for a single request.
1449
+ :type _request_auth: dict, optional
1450
+ :param _content_type: force content-type for the request.
1451
+ :type _content_type: str, Optional
1452
+ :param _headers: set to override the headers for a single
1453
+ request; this effectively ignores the headers
1454
+ in the spec for a single request.
1455
+ :type _headers: dict, optional
1456
+ :param _host_index: set to override the host_index for a single
1457
+ request; this effectively ignores the host_index
1458
+ in the spec for a single request.
1459
+ :type _host_index: int, optional
1460
+ :return: Returns the result object.
1461
+ """ # noqa: E501
1462
+
1463
+ _param = self._audience_audience_id_rapids_get_serialize(
1464
+ audience_id=audience_id,
1465
+ request=request,
1466
+ _request_auth=_request_auth,
1467
+ _content_type=_content_type,
1468
+ _headers=_headers,
1469
+ _host_index=_host_index
1470
+ )
1471
+
1472
+ _response_types_map: Dict[str, Optional[str]] = {
1473
+ '200': "PagedResultOfQueryRapidsForAudienceResult",
1474
+ }
1475
+ response_data = self.api_client.call_api(
1476
+ *_param,
1477
+ _request_timeout=_request_timeout
1478
+ )
1479
+ response_data.read()
1480
+ return self.api_client.response_deserialize(
1481
+ response_data=response_data,
1482
+ response_types_map=_response_types_map,
1483
+ ).data
1484
+
1485
+
1486
+ @validate_call
1487
+ def audience_audience_id_rapids_get_with_http_info(
1488
+ self,
1489
+ audience_id: StrictStr,
1490
+ request: Optional[QueryModel] = None,
1491
+ _request_timeout: Union[
1492
+ None,
1493
+ Annotated[StrictFloat, Field(gt=0)],
1494
+ Tuple[
1495
+ Annotated[StrictFloat, Field(gt=0)],
1496
+ Annotated[StrictFloat, Field(gt=0)]
1497
+ ]
1498
+ ] = None,
1499
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1500
+ _content_type: Optional[StrictStr] = None,
1501
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1502
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1503
+ ) -> ApiResponse[PagedResultOfQueryRapidsForAudienceResult]:
1504
+ """Queries all rapids for the specified audience.
1505
+
1506
+
1507
+ :param audience_id: (required)
1508
+ :type audience_id: str
1509
+ :param request:
1510
+ :type request: QueryModel
1511
+ :param _request_timeout: timeout setting for this request. If one
1512
+ number provided, it will be total request
1513
+ timeout. It can also be a pair (tuple) of
1514
+ (connection, read) timeouts.
1515
+ :type _request_timeout: int, tuple(int, int), optional
1516
+ :param _request_auth: set to override the auth_settings for an a single
1517
+ request; this effectively ignores the
1518
+ authentication in the spec for a single request.
1519
+ :type _request_auth: dict, optional
1520
+ :param _content_type: force content-type for the request.
1521
+ :type _content_type: str, Optional
1522
+ :param _headers: set to override the headers for a single
1523
+ request; this effectively ignores the headers
1524
+ in the spec for a single request.
1525
+ :type _headers: dict, optional
1526
+ :param _host_index: set to override the host_index for a single
1527
+ request; this effectively ignores the host_index
1528
+ in the spec for a single request.
1529
+ :type _host_index: int, optional
1530
+ :return: Returns the result object.
1531
+ """ # noqa: E501
1532
+
1533
+ _param = self._audience_audience_id_rapids_get_serialize(
1534
+ audience_id=audience_id,
1535
+ request=request,
1536
+ _request_auth=_request_auth,
1537
+ _content_type=_content_type,
1538
+ _headers=_headers,
1539
+ _host_index=_host_index
1540
+ )
1541
+
1542
+ _response_types_map: Dict[str, Optional[str]] = {
1543
+ '200': "PagedResultOfQueryRapidsForAudienceResult",
1544
+ }
1545
+ response_data = self.api_client.call_api(
1546
+ *_param,
1547
+ _request_timeout=_request_timeout
1548
+ )
1549
+ response_data.read()
1550
+ return self.api_client.response_deserialize(
1551
+ response_data=response_data,
1552
+ response_types_map=_response_types_map,
1553
+ )
1554
+
1555
+
1556
+ @validate_call
1557
+ def audience_audience_id_rapids_get_without_preload_content(
1558
+ self,
1559
+ audience_id: StrictStr,
1560
+ request: Optional[QueryModel] = None,
1561
+ _request_timeout: Union[
1562
+ None,
1563
+ Annotated[StrictFloat, Field(gt=0)],
1564
+ Tuple[
1565
+ Annotated[StrictFloat, Field(gt=0)],
1566
+ Annotated[StrictFloat, Field(gt=0)]
1567
+ ]
1568
+ ] = None,
1569
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1570
+ _content_type: Optional[StrictStr] = None,
1571
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1572
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1573
+ ) -> RESTResponseType:
1574
+ """Queries all rapids for the specified audience.
1575
+
1576
+
1577
+ :param audience_id: (required)
1578
+ :type audience_id: str
1579
+ :param request:
1580
+ :type request: QueryModel
1581
+ :param _request_timeout: timeout setting for this request. If one
1582
+ number provided, it will be total request
1583
+ timeout. It can also be a pair (tuple) of
1584
+ (connection, read) timeouts.
1585
+ :type _request_timeout: int, tuple(int, int), optional
1586
+ :param _request_auth: set to override the auth_settings for an a single
1587
+ request; this effectively ignores the
1588
+ authentication in the spec for a single request.
1589
+ :type _request_auth: dict, optional
1590
+ :param _content_type: force content-type for the request.
1591
+ :type _content_type: str, Optional
1592
+ :param _headers: set to override the headers for a single
1593
+ request; this effectively ignores the headers
1594
+ in the spec for a single request.
1595
+ :type _headers: dict, optional
1596
+ :param _host_index: set to override the host_index for a single
1597
+ request; this effectively ignores the host_index
1598
+ in the spec for a single request.
1599
+ :type _host_index: int, optional
1600
+ :return: Returns the result object.
1601
+ """ # noqa: E501
1602
+
1603
+ _param = self._audience_audience_id_rapids_get_serialize(
1604
+ audience_id=audience_id,
1605
+ request=request,
1606
+ _request_auth=_request_auth,
1607
+ _content_type=_content_type,
1608
+ _headers=_headers,
1609
+ _host_index=_host_index
1610
+ )
1611
+
1612
+ _response_types_map: Dict[str, Optional[str]] = {
1613
+ '200': "PagedResultOfQueryRapidsForAudienceResult",
1614
+ }
1615
+ response_data = self.api_client.call_api(
1616
+ *_param,
1617
+ _request_timeout=_request_timeout
1618
+ )
1619
+ return response_data.response
1620
+
1621
+
1622
+ def _audience_audience_id_rapids_get_serialize(
1623
+ self,
1624
+ audience_id,
1625
+ request,
1626
+ _request_auth,
1627
+ _content_type,
1628
+ _headers,
1629
+ _host_index,
1630
+ ) -> RequestSerialized:
1631
+
1632
+ _host = None
1633
+
1634
+ _collection_formats: Dict[str, str] = {
1635
+ }
1636
+
1637
+ _path_params: Dict[str, str] = {}
1638
+ _query_params: List[Tuple[str, str]] = []
1639
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1640
+ _form_params: List[Tuple[str, str]] = []
1641
+ _files: Dict[
1642
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1643
+ ] = {}
1644
+ _body_params: Optional[bytes] = None
1645
+
1646
+ # process the path parameters
1647
+ if audience_id is not None:
1648
+ _path_params['audienceId'] = audience_id
1649
+ # process the query parameters
1650
+ if request is not None:
1651
+
1652
+ _query_params.append(('request', request))
1653
+
1654
+ # process the header parameters
1655
+ # process the form parameters
1656
+ # process the body parameter
1657
+
1658
+
1659
+ # set the HTTP header `Accept`
1660
+ if 'Accept' not in _header_params:
1661
+ _header_params['Accept'] = self.api_client.select_header_accept(
1662
+ [
1663
+ 'text/plain',
1664
+ 'application/json',
1665
+ 'text/json'
1666
+ ]
1667
+ )
1668
+
1669
+
1670
+ # authentication setting
1671
+ _auth_settings: List[str] = [
1672
+ 'OAuth2',
1673
+ 'OpenIdConnect',
1674
+ 'Bearer'
1675
+ ]
1676
+
1677
+ return self.api_client.param_serialize(
1678
+ method='GET',
1679
+ resource_path='/audience/{audienceId}/rapids',
1680
+ path_params=_path_params,
1681
+ query_params=_query_params,
1682
+ header_params=_header_params,
1683
+ body=_body_params,
1684
+ post_params=_form_params,
1685
+ files=_files,
1686
+ auth_settings=_auth_settings,
1687
+ collection_formats=_collection_formats,
1688
+ _host=_host,
1689
+ _request_auth=_request_auth
1690
+ )
1691
+
1692
+
1693
+
1694
+
1695
+ @validate_call
1696
+ def audience_audience_id_recruit_post(
1697
+ self,
1698
+ audience_id: StrictStr,
1699
+ _request_timeout: Union[
1700
+ None,
1701
+ Annotated[StrictFloat, Field(gt=0)],
1702
+ Tuple[
1703
+ Annotated[StrictFloat, Field(gt=0)],
1704
+ Annotated[StrictFloat, Field(gt=0)]
1705
+ ]
1706
+ ] = None,
1707
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1708
+ _content_type: Optional[StrictStr] = None,
1709
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1710
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1711
+ ) -> None:
1712
+ """Starts recruiting users for the specified audience.
1713
+
1714
+
1715
+ :param audience_id: (required)
1716
+ :type audience_id: str
1717
+ :param _request_timeout: timeout setting for this request. If one
1718
+ number provided, it will be total request
1719
+ timeout. It can also be a pair (tuple) of
1720
+ (connection, read) timeouts.
1721
+ :type _request_timeout: int, tuple(int, int), optional
1722
+ :param _request_auth: set to override the auth_settings for an a single
1723
+ request; this effectively ignores the
1724
+ authentication in the spec for a single request.
1725
+ :type _request_auth: dict, optional
1726
+ :param _content_type: force content-type for the request.
1727
+ :type _content_type: str, Optional
1728
+ :param _headers: set to override the headers for a single
1729
+ request; this effectively ignores the headers
1730
+ in the spec for a single request.
1731
+ :type _headers: dict, optional
1732
+ :param _host_index: set to override the host_index for a single
1733
+ request; this effectively ignores the host_index
1734
+ in the spec for a single request.
1735
+ :type _host_index: int, optional
1736
+ :return: Returns the result object.
1737
+ """ # noqa: E501
1738
+
1739
+ _param = self._audience_audience_id_recruit_post_serialize(
1740
+ audience_id=audience_id,
1741
+ _request_auth=_request_auth,
1742
+ _content_type=_content_type,
1743
+ _headers=_headers,
1744
+ _host_index=_host_index
1745
+ )
1746
+
1747
+ _response_types_map: Dict[str, Optional[str]] = {
1748
+ '204': None,
1749
+ '400': "ValidationProblemDetails",
1750
+ '401': None,
1751
+ '403': None,
1752
+ }
1753
+ response_data = self.api_client.call_api(
1754
+ *_param,
1755
+ _request_timeout=_request_timeout
1756
+ )
1757
+ response_data.read()
1758
+ return self.api_client.response_deserialize(
1759
+ response_data=response_data,
1760
+ response_types_map=_response_types_map,
1761
+ ).data
1762
+
1763
+
1764
+ @validate_call
1765
+ def audience_audience_id_recruit_post_with_http_info(
1766
+ self,
1767
+ audience_id: StrictStr,
1768
+ _request_timeout: Union[
1769
+ None,
1770
+ Annotated[StrictFloat, Field(gt=0)],
1771
+ Tuple[
1772
+ Annotated[StrictFloat, Field(gt=0)],
1773
+ Annotated[StrictFloat, Field(gt=0)]
1774
+ ]
1775
+ ] = None,
1776
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1777
+ _content_type: Optional[StrictStr] = None,
1778
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1779
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1780
+ ) -> ApiResponse[None]:
1781
+ """Starts recruiting users for the specified audience.
1782
+
1783
+
1784
+ :param audience_id: (required)
1785
+ :type audience_id: str
1786
+ :param _request_timeout: timeout setting for this request. If one
1787
+ number provided, it will be total request
1788
+ timeout. It can also be a pair (tuple) of
1789
+ (connection, read) timeouts.
1790
+ :type _request_timeout: int, tuple(int, int), optional
1791
+ :param _request_auth: set to override the auth_settings for an a single
1792
+ request; this effectively ignores the
1793
+ authentication in the spec for a single request.
1794
+ :type _request_auth: dict, optional
1795
+ :param _content_type: force content-type for the request.
1796
+ :type _content_type: str, Optional
1797
+ :param _headers: set to override the headers for a single
1798
+ request; this effectively ignores the headers
1799
+ in the spec for a single request.
1800
+ :type _headers: dict, optional
1801
+ :param _host_index: set to override the host_index for a single
1802
+ request; this effectively ignores the host_index
1803
+ in the spec for a single request.
1804
+ :type _host_index: int, optional
1805
+ :return: Returns the result object.
1806
+ """ # noqa: E501
1807
+
1808
+ _param = self._audience_audience_id_recruit_post_serialize(
1809
+ audience_id=audience_id,
1810
+ _request_auth=_request_auth,
1811
+ _content_type=_content_type,
1812
+ _headers=_headers,
1813
+ _host_index=_host_index
1814
+ )
1815
+
1816
+ _response_types_map: Dict[str, Optional[str]] = {
1817
+ '204': None,
1818
+ '400': "ValidationProblemDetails",
1819
+ '401': None,
1820
+ '403': None,
1821
+ }
1822
+ response_data = self.api_client.call_api(
1823
+ *_param,
1824
+ _request_timeout=_request_timeout
1825
+ )
1826
+ response_data.read()
1827
+ return self.api_client.response_deserialize(
1828
+ response_data=response_data,
1829
+ response_types_map=_response_types_map,
1830
+ )
1831
+
1832
+
1833
+ @validate_call
1834
+ def audience_audience_id_recruit_post_without_preload_content(
1835
+ self,
1836
+ audience_id: StrictStr,
1837
+ _request_timeout: Union[
1838
+ None,
1839
+ Annotated[StrictFloat, Field(gt=0)],
1840
+ Tuple[
1841
+ Annotated[StrictFloat, Field(gt=0)],
1842
+ Annotated[StrictFloat, Field(gt=0)]
1843
+ ]
1844
+ ] = None,
1845
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1846
+ _content_type: Optional[StrictStr] = None,
1847
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1848
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1849
+ ) -> RESTResponseType:
1850
+ """Starts recruiting users for the specified audience.
1851
+
1852
+
1853
+ :param audience_id: (required)
1854
+ :type audience_id: str
1855
+ :param _request_timeout: timeout setting for this request. If one
1856
+ number provided, it will be total request
1857
+ timeout. It can also be a pair (tuple) of
1858
+ (connection, read) timeouts.
1859
+ :type _request_timeout: int, tuple(int, int), optional
1860
+ :param _request_auth: set to override the auth_settings for an a single
1861
+ request; this effectively ignores the
1862
+ authentication in the spec for a single request.
1863
+ :type _request_auth: dict, optional
1864
+ :param _content_type: force content-type for the request.
1865
+ :type _content_type: str, Optional
1866
+ :param _headers: set to override the headers for a single
1867
+ request; this effectively ignores the headers
1868
+ in the spec for a single request.
1869
+ :type _headers: dict, optional
1870
+ :param _host_index: set to override the host_index for a single
1871
+ request; this effectively ignores the host_index
1872
+ in the spec for a single request.
1873
+ :type _host_index: int, optional
1874
+ :return: Returns the result object.
1875
+ """ # noqa: E501
1876
+
1877
+ _param = self._audience_audience_id_recruit_post_serialize(
1878
+ audience_id=audience_id,
1879
+ _request_auth=_request_auth,
1880
+ _content_type=_content_type,
1881
+ _headers=_headers,
1882
+ _host_index=_host_index
1883
+ )
1884
+
1885
+ _response_types_map: Dict[str, Optional[str]] = {
1886
+ '204': None,
1887
+ '400': "ValidationProblemDetails",
1888
+ '401': None,
1889
+ '403': None,
1890
+ }
1891
+ response_data = self.api_client.call_api(
1892
+ *_param,
1893
+ _request_timeout=_request_timeout
1894
+ )
1895
+ return response_data.response
1896
+
1897
+
1898
+ def _audience_audience_id_recruit_post_serialize(
1899
+ self,
1900
+ audience_id,
1901
+ _request_auth,
1902
+ _content_type,
1903
+ _headers,
1904
+ _host_index,
1905
+ ) -> RequestSerialized:
1906
+
1907
+ _host = None
1908
+
1909
+ _collection_formats: Dict[str, str] = {
1910
+ }
1911
+
1912
+ _path_params: Dict[str, str] = {}
1913
+ _query_params: List[Tuple[str, str]] = []
1914
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1915
+ _form_params: List[Tuple[str, str]] = []
1916
+ _files: Dict[
1917
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1918
+ ] = {}
1919
+ _body_params: Optional[bytes] = None
1920
+
1921
+ # process the path parameters
1922
+ if audience_id is not None:
1923
+ _path_params['audienceId'] = audience_id
1924
+ # process the query parameters
1925
+ # process the header parameters
1926
+ # process the form parameters
1927
+ # process the body parameter
1928
+
1929
+
1930
+ # set the HTTP header `Accept`
1931
+ if 'Accept' not in _header_params:
1932
+ _header_params['Accept'] = self.api_client.select_header_accept(
1933
+ [
1934
+ 'application/json'
1935
+ ]
1936
+ )
1937
+
1938
+
1939
+ # authentication setting
1940
+ _auth_settings: List[str] = [
1941
+ 'OAuth2',
1942
+ 'OpenIdConnect',
1943
+ 'Bearer'
1944
+ ]
1945
+
1946
+ return self.api_client.param_serialize(
1947
+ method='POST',
1948
+ resource_path='/audience/{audienceId}/recruit',
1949
+ path_params=_path_params,
1950
+ query_params=_query_params,
1951
+ header_params=_header_params,
1952
+ body=_body_params,
1953
+ post_params=_form_params,
1954
+ files=_files,
1955
+ auth_settings=_auth_settings,
1956
+ collection_formats=_collection_formats,
1957
+ _host=_host,
1958
+ _request_auth=_request_auth
1959
+ )
1960
+
1961
+
1962
+
1963
+
1964
+ @validate_call
1965
+ def audience_post(
1966
+ self,
1967
+ create_audience_request: CreateAudienceRequest,
1968
+ _request_timeout: Union[
1969
+ None,
1970
+ Annotated[StrictFloat, Field(gt=0)],
1971
+ Tuple[
1972
+ Annotated[StrictFloat, Field(gt=0)],
1973
+ Annotated[StrictFloat, Field(gt=0)]
1974
+ ]
1975
+ ] = None,
1976
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1977
+ _content_type: Optional[StrictStr] = None,
1978
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1979
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1980
+ ) -> CreateAudienceResult:
1981
+ """Creates a new empty audience.
1982
+
1983
+ An audience is a group of users that are trained to solve particular tasks.
1984
+
1985
+ :param create_audience_request: (required)
1986
+ :type create_audience_request: CreateAudienceRequest
1987
+ :param _request_timeout: timeout setting for this request. If one
1988
+ number provided, it will be total request
1989
+ timeout. It can also be a pair (tuple) of
1990
+ (connection, read) timeouts.
1991
+ :type _request_timeout: int, tuple(int, int), optional
1992
+ :param _request_auth: set to override the auth_settings for an a single
1993
+ request; this effectively ignores the
1994
+ authentication in the spec for a single request.
1995
+ :type _request_auth: dict, optional
1996
+ :param _content_type: force content-type for the request.
1997
+ :type _content_type: str, Optional
1998
+ :param _headers: set to override the headers for a single
1999
+ request; this effectively ignores the headers
2000
+ in the spec for a single request.
2001
+ :type _headers: dict, optional
2002
+ :param _host_index: set to override the host_index for a single
2003
+ request; this effectively ignores the host_index
2004
+ in the spec for a single request.
2005
+ :type _host_index: int, optional
2006
+ :return: Returns the result object.
2007
+ """ # noqa: E501
2008
+
2009
+ _param = self._audience_post_serialize(
2010
+ create_audience_request=create_audience_request,
2011
+ _request_auth=_request_auth,
2012
+ _content_type=_content_type,
2013
+ _headers=_headers,
2014
+ _host_index=_host_index
2015
+ )
2016
+
2017
+ _response_types_map: Dict[str, Optional[str]] = {
2018
+ '200': "CreateAudienceResult",
2019
+ }
2020
+ response_data = self.api_client.call_api(
2021
+ *_param,
2022
+ _request_timeout=_request_timeout
2023
+ )
2024
+ response_data.read()
2025
+ return self.api_client.response_deserialize(
2026
+ response_data=response_data,
2027
+ response_types_map=_response_types_map,
2028
+ ).data
2029
+
2030
+
2031
+ @validate_call
2032
+ def audience_post_with_http_info(
2033
+ self,
2034
+ create_audience_request: CreateAudienceRequest,
2035
+ _request_timeout: Union[
2036
+ None,
2037
+ Annotated[StrictFloat, Field(gt=0)],
2038
+ Tuple[
2039
+ Annotated[StrictFloat, Field(gt=0)],
2040
+ Annotated[StrictFloat, Field(gt=0)]
2041
+ ]
2042
+ ] = None,
2043
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2044
+ _content_type: Optional[StrictStr] = None,
2045
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2046
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2047
+ ) -> ApiResponse[CreateAudienceResult]:
2048
+ """Creates a new empty audience.
2049
+
2050
+ An audience is a group of users that are trained to solve particular tasks.
2051
+
2052
+ :param create_audience_request: (required)
2053
+ :type create_audience_request: CreateAudienceRequest
2054
+ :param _request_timeout: timeout setting for this request. If one
2055
+ number provided, it will be total request
2056
+ timeout. It can also be a pair (tuple) of
2057
+ (connection, read) timeouts.
2058
+ :type _request_timeout: int, tuple(int, int), optional
2059
+ :param _request_auth: set to override the auth_settings for an a single
2060
+ request; this effectively ignores the
2061
+ authentication in the spec for a single request.
2062
+ :type _request_auth: dict, optional
2063
+ :param _content_type: force content-type for the request.
2064
+ :type _content_type: str, Optional
2065
+ :param _headers: set to override the headers for a single
2066
+ request; this effectively ignores the headers
2067
+ in the spec for a single request.
2068
+ :type _headers: dict, optional
2069
+ :param _host_index: set to override the host_index for a single
2070
+ request; this effectively ignores the host_index
2071
+ in the spec for a single request.
2072
+ :type _host_index: int, optional
2073
+ :return: Returns the result object.
2074
+ """ # noqa: E501
2075
+
2076
+ _param = self._audience_post_serialize(
2077
+ create_audience_request=create_audience_request,
2078
+ _request_auth=_request_auth,
2079
+ _content_type=_content_type,
2080
+ _headers=_headers,
2081
+ _host_index=_host_index
2082
+ )
2083
+
2084
+ _response_types_map: Dict[str, Optional[str]] = {
2085
+ '200': "CreateAudienceResult",
2086
+ }
2087
+ response_data = self.api_client.call_api(
2088
+ *_param,
2089
+ _request_timeout=_request_timeout
2090
+ )
2091
+ response_data.read()
2092
+ return self.api_client.response_deserialize(
2093
+ response_data=response_data,
2094
+ response_types_map=_response_types_map,
2095
+ )
2096
+
2097
+
2098
+ @validate_call
2099
+ def audience_post_without_preload_content(
2100
+ self,
2101
+ create_audience_request: CreateAudienceRequest,
2102
+ _request_timeout: Union[
2103
+ None,
2104
+ Annotated[StrictFloat, Field(gt=0)],
2105
+ Tuple[
2106
+ Annotated[StrictFloat, Field(gt=0)],
2107
+ Annotated[StrictFloat, Field(gt=0)]
2108
+ ]
2109
+ ] = None,
2110
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2111
+ _content_type: Optional[StrictStr] = None,
2112
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2113
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2114
+ ) -> RESTResponseType:
2115
+ """Creates a new empty audience.
2116
+
2117
+ An audience is a group of users that are trained to solve particular tasks.
2118
+
2119
+ :param create_audience_request: (required)
2120
+ :type create_audience_request: CreateAudienceRequest
2121
+ :param _request_timeout: timeout setting for this request. If one
2122
+ number provided, it will be total request
2123
+ timeout. It can also be a pair (tuple) of
2124
+ (connection, read) timeouts.
2125
+ :type _request_timeout: int, tuple(int, int), optional
2126
+ :param _request_auth: set to override the auth_settings for an a single
2127
+ request; this effectively ignores the
2128
+ authentication in the spec for a single request.
2129
+ :type _request_auth: dict, optional
2130
+ :param _content_type: force content-type for the request.
2131
+ :type _content_type: str, Optional
2132
+ :param _headers: set to override the headers for a single
2133
+ request; this effectively ignores the headers
2134
+ in the spec for a single request.
2135
+ :type _headers: dict, optional
2136
+ :param _host_index: set to override the host_index for a single
2137
+ request; this effectively ignores the host_index
2138
+ in the spec for a single request.
2139
+ :type _host_index: int, optional
2140
+ :return: Returns the result object.
2141
+ """ # noqa: E501
2142
+
2143
+ _param = self._audience_post_serialize(
2144
+ create_audience_request=create_audience_request,
2145
+ _request_auth=_request_auth,
2146
+ _content_type=_content_type,
2147
+ _headers=_headers,
2148
+ _host_index=_host_index
2149
+ )
2150
+
2151
+ _response_types_map: Dict[str, Optional[str]] = {
2152
+ '200': "CreateAudienceResult",
2153
+ }
2154
+ response_data = self.api_client.call_api(
2155
+ *_param,
2156
+ _request_timeout=_request_timeout
2157
+ )
2158
+ return response_data.response
2159
+
2160
+
2161
+ def _audience_post_serialize(
2162
+ self,
2163
+ create_audience_request,
2164
+ _request_auth,
2165
+ _content_type,
2166
+ _headers,
2167
+ _host_index,
2168
+ ) -> RequestSerialized:
2169
+
2170
+ _host = None
2171
+
2172
+ _collection_formats: Dict[str, str] = {
2173
+ }
2174
+
2175
+ _path_params: Dict[str, str] = {}
2176
+ _query_params: List[Tuple[str, str]] = []
2177
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2178
+ _form_params: List[Tuple[str, str]] = []
2179
+ _files: Dict[
2180
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2181
+ ] = {}
2182
+ _body_params: Optional[bytes] = None
2183
+
2184
+ # process the path parameters
2185
+ # process the query parameters
2186
+ # process the header parameters
2187
+ # process the form parameters
2188
+ # process the body parameter
2189
+ if create_audience_request is not None:
2190
+ _body_params = create_audience_request
2191
+
2192
+
2193
+ # set the HTTP header `Accept`
2194
+ if 'Accept' not in _header_params:
2195
+ _header_params['Accept'] = self.api_client.select_header_accept(
2196
+ [
2197
+ 'text/plain',
2198
+ 'application/json',
2199
+ 'text/json'
2200
+ ]
2201
+ )
2202
+
2203
+ # set the HTTP header `Content-Type`
2204
+ if _content_type:
2205
+ _header_params['Content-Type'] = _content_type
2206
+ else:
2207
+ _default_content_type = (
2208
+ self.api_client.select_header_content_type(
2209
+ [
2210
+ 'application/json',
2211
+ 'text/json',
2212
+ 'application/*+json'
2213
+ ]
2214
+ )
2215
+ )
2216
+ if _default_content_type is not None:
2217
+ _header_params['Content-Type'] = _default_content_type
2218
+
2219
+ # authentication setting
2220
+ _auth_settings: List[str] = [
2221
+ 'OAuth2',
2222
+ 'OpenIdConnect',
2223
+ 'Bearer'
2224
+ ]
2225
+
2226
+ return self.api_client.param_serialize(
2227
+ method='POST',
2228
+ resource_path='/audience',
2229
+ path_params=_path_params,
2230
+ query_params=_query_params,
2231
+ header_params=_header_params,
2232
+ body=_body_params,
2233
+ post_params=_form_params,
2234
+ files=_files,
2235
+ auth_settings=_auth_settings,
2236
+ collection_formats=_collection_formats,
2237
+ _host=_host,
2238
+ _request_auth=_request_auth
2239
+ )
2240
+
2241
+
2242
+
2243
+
2244
+ @validate_call
2245
+ def audiences_get(
2246
+ self,
2247
+ request: Optional[QueryModel] = None,
2248
+ _request_timeout: Union[
2249
+ None,
2250
+ Annotated[StrictFloat, Field(gt=0)],
2251
+ Tuple[
2252
+ Annotated[StrictFloat, Field(gt=0)],
2253
+ Annotated[StrictFloat, Field(gt=0)]
2254
+ ]
2255
+ ] = None,
2256
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2257
+ _content_type: Optional[StrictStr] = None,
2258
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2259
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2260
+ ) -> PagedResultOfQueryAudiencesResult:
2261
+ """Queries all available audiences.
2262
+
2263
+
2264
+ :param request:
2265
+ :type request: QueryModel
2266
+ :param _request_timeout: timeout setting for this request. If one
2267
+ number provided, it will be total request
2268
+ timeout. It can also be a pair (tuple) of
2269
+ (connection, read) timeouts.
2270
+ :type _request_timeout: int, tuple(int, int), optional
2271
+ :param _request_auth: set to override the auth_settings for an a single
2272
+ request; this effectively ignores the
2273
+ authentication in the spec for a single request.
2274
+ :type _request_auth: dict, optional
2275
+ :param _content_type: force content-type for the request.
2276
+ :type _content_type: str, Optional
2277
+ :param _headers: set to override the headers for a single
2278
+ request; this effectively ignores the headers
2279
+ in the spec for a single request.
2280
+ :type _headers: dict, optional
2281
+ :param _host_index: set to override the host_index for a single
2282
+ request; this effectively ignores the host_index
2283
+ in the spec for a single request.
2284
+ :type _host_index: int, optional
2285
+ :return: Returns the result object.
2286
+ """ # noqa: E501
2287
+
2288
+ _param = self._audiences_get_serialize(
2289
+ request=request,
2290
+ _request_auth=_request_auth,
2291
+ _content_type=_content_type,
2292
+ _headers=_headers,
2293
+ _host_index=_host_index
2294
+ )
2295
+
2296
+ _response_types_map: Dict[str, Optional[str]] = {
2297
+ '200': "PagedResultOfQueryAudiencesResult",
2298
+ }
2299
+ response_data = self.api_client.call_api(
2300
+ *_param,
2301
+ _request_timeout=_request_timeout
2302
+ )
2303
+ response_data.read()
2304
+ return self.api_client.response_deserialize(
2305
+ response_data=response_data,
2306
+ response_types_map=_response_types_map,
2307
+ ).data
2308
+
2309
+
2310
+ @validate_call
2311
+ def audiences_get_with_http_info(
2312
+ self,
2313
+ request: Optional[QueryModel] = None,
2314
+ _request_timeout: Union[
2315
+ None,
2316
+ Annotated[StrictFloat, Field(gt=0)],
2317
+ Tuple[
2318
+ Annotated[StrictFloat, Field(gt=0)],
2319
+ Annotated[StrictFloat, Field(gt=0)]
2320
+ ]
2321
+ ] = None,
2322
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2323
+ _content_type: Optional[StrictStr] = None,
2324
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2325
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2326
+ ) -> ApiResponse[PagedResultOfQueryAudiencesResult]:
2327
+ """Queries all available audiences.
2328
+
2329
+
2330
+ :param request:
2331
+ :type request: QueryModel
2332
+ :param _request_timeout: timeout setting for this request. If one
2333
+ number provided, it will be total request
2334
+ timeout. It can also be a pair (tuple) of
2335
+ (connection, read) timeouts.
2336
+ :type _request_timeout: int, tuple(int, int), optional
2337
+ :param _request_auth: set to override the auth_settings for an a single
2338
+ request; this effectively ignores the
2339
+ authentication in the spec for a single request.
2340
+ :type _request_auth: dict, optional
2341
+ :param _content_type: force content-type for the request.
2342
+ :type _content_type: str, Optional
2343
+ :param _headers: set to override the headers for a single
2344
+ request; this effectively ignores the headers
2345
+ in the spec for a single request.
2346
+ :type _headers: dict, optional
2347
+ :param _host_index: set to override the host_index for a single
2348
+ request; this effectively ignores the host_index
2349
+ in the spec for a single request.
2350
+ :type _host_index: int, optional
2351
+ :return: Returns the result object.
2352
+ """ # noqa: E501
2353
+
2354
+ _param = self._audiences_get_serialize(
2355
+ request=request,
2356
+ _request_auth=_request_auth,
2357
+ _content_type=_content_type,
2358
+ _headers=_headers,
2359
+ _host_index=_host_index
2360
+ )
2361
+
2362
+ _response_types_map: Dict[str, Optional[str]] = {
2363
+ '200': "PagedResultOfQueryAudiencesResult",
2364
+ }
2365
+ response_data = self.api_client.call_api(
2366
+ *_param,
2367
+ _request_timeout=_request_timeout
2368
+ )
2369
+ response_data.read()
2370
+ return self.api_client.response_deserialize(
2371
+ response_data=response_data,
2372
+ response_types_map=_response_types_map,
2373
+ )
2374
+
2375
+
2376
+ @validate_call
2377
+ def audiences_get_without_preload_content(
2378
+ self,
2379
+ request: Optional[QueryModel] = None,
2380
+ _request_timeout: Union[
2381
+ None,
2382
+ Annotated[StrictFloat, Field(gt=0)],
2383
+ Tuple[
2384
+ Annotated[StrictFloat, Field(gt=0)],
2385
+ Annotated[StrictFloat, Field(gt=0)]
2386
+ ]
2387
+ ] = None,
2388
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2389
+ _content_type: Optional[StrictStr] = None,
2390
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2391
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2392
+ ) -> RESTResponseType:
2393
+ """Queries all available audiences.
2394
+
2395
+
2396
+ :param request:
2397
+ :type request: QueryModel
2398
+ :param _request_timeout: timeout setting for this request. If one
2399
+ number provided, it will be total request
2400
+ timeout. It can also be a pair (tuple) of
2401
+ (connection, read) timeouts.
2402
+ :type _request_timeout: int, tuple(int, int), optional
2403
+ :param _request_auth: set to override the auth_settings for an a single
2404
+ request; this effectively ignores the
2405
+ authentication in the spec for a single request.
2406
+ :type _request_auth: dict, optional
2407
+ :param _content_type: force content-type for the request.
2408
+ :type _content_type: str, Optional
2409
+ :param _headers: set to override the headers for a single
2410
+ request; this effectively ignores the headers
2411
+ in the spec for a single request.
2412
+ :type _headers: dict, optional
2413
+ :param _host_index: set to override the host_index for a single
2414
+ request; this effectively ignores the host_index
2415
+ in the spec for a single request.
2416
+ :type _host_index: int, optional
2417
+ :return: Returns the result object.
2418
+ """ # noqa: E501
2419
+
2420
+ _param = self._audiences_get_serialize(
2421
+ request=request,
2422
+ _request_auth=_request_auth,
2423
+ _content_type=_content_type,
2424
+ _headers=_headers,
2425
+ _host_index=_host_index
2426
+ )
2427
+
2428
+ _response_types_map: Dict[str, Optional[str]] = {
2429
+ '200': "PagedResultOfQueryAudiencesResult",
2430
+ }
2431
+ response_data = self.api_client.call_api(
2432
+ *_param,
2433
+ _request_timeout=_request_timeout
2434
+ )
2435
+ return response_data.response
2436
+
2437
+
2438
+ def _audiences_get_serialize(
2439
+ self,
2440
+ request,
2441
+ _request_auth,
2442
+ _content_type,
2443
+ _headers,
2444
+ _host_index,
2445
+ ) -> RequestSerialized:
2446
+
2447
+ _host = None
2448
+
2449
+ _collection_formats: Dict[str, str] = {
2450
+ }
2451
+
2452
+ _path_params: Dict[str, str] = {}
2453
+ _query_params: List[Tuple[str, str]] = []
2454
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2455
+ _form_params: List[Tuple[str, str]] = []
2456
+ _files: Dict[
2457
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2458
+ ] = {}
2459
+ _body_params: Optional[bytes] = None
2460
+
2461
+ # process the path parameters
2462
+ # process the query parameters
2463
+ if request is not None:
2464
+
2465
+ _query_params.append(('request', request))
2466
+
2467
+ # process the header parameters
2468
+ # process the form parameters
2469
+ # process the body parameter
2470
+
2471
+
2472
+ # set the HTTP header `Accept`
2473
+ if 'Accept' not in _header_params:
2474
+ _header_params['Accept'] = self.api_client.select_header_accept(
2475
+ [
2476
+ 'text/plain',
2477
+ 'application/json',
2478
+ 'text/json'
2479
+ ]
2480
+ )
2481
+
2482
+
2483
+ # authentication setting
2484
+ _auth_settings: List[str] = [
2485
+ 'OAuth2',
2486
+ 'OpenIdConnect',
2487
+ 'Bearer'
2488
+ ]
2489
+
2490
+ return self.api_client.param_serialize(
2491
+ method='GET',
2492
+ resource_path='/audiences',
2493
+ path_params=_path_params,
2494
+ query_params=_query_params,
2495
+ header_params=_header_params,
2496
+ body=_body_params,
2497
+ post_params=_form_params,
2498
+ files=_files,
2499
+ auth_settings=_auth_settings,
2500
+ collection_formats=_collection_formats,
2501
+ _host=_host,
2502
+ _request_auth=_request_auth
2503
+ )
2504
+
2505
+