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