rapidata 2.23.2__py3-none-any.whl → 3.0.1__py3-none-any.whl

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

Potentially problematic release.


This version of rapidata might be problematic. Click here for more details.

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