eval-studio-client 0.7.0__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 (470) hide show
  1. eval_studio_client/__about__.py +1 -0
  2. eval_studio_client/__init__.py +4 -0
  3. eval_studio_client/api/__init__.py +180 -0
  4. eval_studio_client/api/api/__init__.py +20 -0
  5. eval_studio_client/api/api/dashboard_service_api.py +2142 -0
  6. eval_studio_client/api/api/document_service_api.py +1868 -0
  7. eval_studio_client/api/api/evaluation_service_api.py +1603 -0
  8. eval_studio_client/api/api/evaluator_service_api.py +1343 -0
  9. eval_studio_client/api/api/info_service_api.py +275 -0
  10. eval_studio_client/api/api/leaderboard_service_api.py +3336 -0
  11. eval_studio_client/api/api/model_service_api.py +2913 -0
  12. eval_studio_client/api/api/operation_progress_service_api.py +292 -0
  13. eval_studio_client/api/api/operation_service_api.py +1359 -0
  14. eval_studio_client/api/api/perturbation_service_api.py +321 -0
  15. eval_studio_client/api/api/perturbator_service_api.py +532 -0
  16. eval_studio_client/api/api/test_case_service_api.py +1913 -0
  17. eval_studio_client/api/api/test_class_service_api.py +532 -0
  18. eval_studio_client/api/api/test_lab_service_api.py +634 -0
  19. eval_studio_client/api/api/test_service_api.py +2712 -0
  20. eval_studio_client/api/api/who_am_i_service_api.py +275 -0
  21. eval_studio_client/api/api_client.py +770 -0
  22. eval_studio_client/api/api_response.py +21 -0
  23. eval_studio_client/api/configuration.py +436 -0
  24. eval_studio_client/api/docs/DashboardServiceApi.md +549 -0
  25. eval_studio_client/api/docs/DocumentServiceApi.md +478 -0
  26. eval_studio_client/api/docs/EvaluationServiceApi.md +332 -0
  27. eval_studio_client/api/docs/EvaluatorServiceApi.md +345 -0
  28. eval_studio_client/api/docs/InfoServiceApi.md +71 -0
  29. eval_studio_client/api/docs/LeaderboardServiceApi.md +835 -0
  30. eval_studio_client/api/docs/ModelServiceApi.md +750 -0
  31. eval_studio_client/api/docs/OperationProgressServiceApi.md +75 -0
  32. eval_studio_client/api/docs/OperationServiceApi.md +345 -0
  33. eval_studio_client/api/docs/PerturbationServiceApi.md +78 -0
  34. eval_studio_client/api/docs/PerturbationServiceCreatePerturbationRequest.md +31 -0
  35. eval_studio_client/api/docs/PerturbatorServiceApi.md +138 -0
  36. eval_studio_client/api/docs/ProtobufAny.md +30 -0
  37. eval_studio_client/api/docs/RequiredTheDashboardToUpdate.md +41 -0
  38. eval_studio_client/api/docs/RequiredTheDocumentToUpdate.md +38 -0
  39. eval_studio_client/api/docs/RequiredTheLeaderboardToUpdate.md +54 -0
  40. eval_studio_client/api/docs/RequiredTheModelToUpdate.md +41 -0
  41. eval_studio_client/api/docs/RequiredTheOperationToFinalize.md +39 -0
  42. eval_studio_client/api/docs/RequiredTheOperationToUpdate.md +39 -0
  43. eval_studio_client/api/docs/RequiredTheTestCaseToUpdate.md +39 -0
  44. eval_studio_client/api/docs/RequiredTheTestToUpdate.md +39 -0
  45. eval_studio_client/api/docs/RpcStatus.md +32 -0
  46. eval_studio_client/api/docs/TestCaseServiceApi.md +486 -0
  47. eval_studio_client/api/docs/TestCaseServiceBatchDeleteTestCasesRequest.md +29 -0
  48. eval_studio_client/api/docs/TestClassServiceApi.md +138 -0
  49. eval_studio_client/api/docs/TestLabServiceApi.md +151 -0
  50. eval_studio_client/api/docs/TestServiceApi.md +689 -0
  51. eval_studio_client/api/docs/TestServicePerturbTestRequest.md +31 -0
  52. eval_studio_client/api/docs/V1alphaBatchCreateLeaderboardsRequest.md +31 -0
  53. eval_studio_client/api/docs/V1alphaBatchCreateLeaderboardsResponse.md +29 -0
  54. eval_studio_client/api/docs/V1alphaBatchDeleteDashboardsRequest.md +29 -0
  55. eval_studio_client/api/docs/V1alphaBatchDeleteDashboardsResponse.md +29 -0
  56. eval_studio_client/api/docs/V1alphaBatchDeleteDocumentsRequest.md +29 -0
  57. eval_studio_client/api/docs/V1alphaBatchDeleteDocumentsResponse.md +29 -0
  58. eval_studio_client/api/docs/V1alphaBatchDeleteEvaluatorsRequest.md +29 -0
  59. eval_studio_client/api/docs/V1alphaBatchDeleteEvaluatorsResponse.md +29 -0
  60. eval_studio_client/api/docs/V1alphaBatchDeleteLeaderboardsRequest.md +30 -0
  61. eval_studio_client/api/docs/V1alphaBatchDeleteLeaderboardsResponse.md +29 -0
  62. eval_studio_client/api/docs/V1alphaBatchDeleteModelsRequest.md +29 -0
  63. eval_studio_client/api/docs/V1alphaBatchDeleteModelsResponse.md +29 -0
  64. eval_studio_client/api/docs/V1alphaBatchDeleteTestCasesResponse.md +29 -0
  65. eval_studio_client/api/docs/V1alphaBatchDeleteTestsRequest.md +30 -0
  66. eval_studio_client/api/docs/V1alphaBatchDeleteTestsResponse.md +29 -0
  67. eval_studio_client/api/docs/V1alphaBatchGetDashboardsResponse.md +29 -0
  68. eval_studio_client/api/docs/V1alphaBatchGetDocumentsResponse.md +29 -0
  69. eval_studio_client/api/docs/V1alphaBatchGetLeaderboardsResponse.md +29 -0
  70. eval_studio_client/api/docs/V1alphaBatchGetModelsResponse.md +29 -0
  71. eval_studio_client/api/docs/V1alphaBatchGetOperationsResponse.md +29 -0
  72. eval_studio_client/api/docs/V1alphaBatchGetTestsResponse.md +29 -0
  73. eval_studio_client/api/docs/V1alphaBatchImportLeaderboardRequest.md +37 -0
  74. eval_studio_client/api/docs/V1alphaBatchImportLeaderboardResponse.md +29 -0
  75. eval_studio_client/api/docs/V1alphaBatchImportTestsRequest.md +32 -0
  76. eval_studio_client/api/docs/V1alphaBatchImportTestsResponse.md +29 -0
  77. eval_studio_client/api/docs/V1alphaCheckBaseModelsResponse.md +30 -0
  78. eval_studio_client/api/docs/V1alphaCollectionInfo.md +33 -0
  79. eval_studio_client/api/docs/V1alphaCreateDashboardResponse.md +29 -0
  80. eval_studio_client/api/docs/V1alphaCreateDocumentResponse.md +29 -0
  81. eval_studio_client/api/docs/V1alphaCreateEvaluationRequest.md +37 -0
  82. eval_studio_client/api/docs/V1alphaCreateEvaluatorResponse.md +29 -0
  83. eval_studio_client/api/docs/V1alphaCreateLeaderboardRequest.md +29 -0
  84. eval_studio_client/api/docs/V1alphaCreateLeaderboardResponse.md +29 -0
  85. eval_studio_client/api/docs/V1alphaCreateLeaderboardWithoutCacheResponse.md +29 -0
  86. eval_studio_client/api/docs/V1alphaCreateModelResponse.md +29 -0
  87. eval_studio_client/api/docs/V1alphaCreatePerturbationResponse.md +29 -0
  88. eval_studio_client/api/docs/V1alphaCreateTestCaseResponse.md +29 -0
  89. eval_studio_client/api/docs/V1alphaCreateTestLabResponse.md +29 -0
  90. eval_studio_client/api/docs/V1alphaCreateTestResponse.md +29 -0
  91. eval_studio_client/api/docs/V1alphaDashboard.md +41 -0
  92. eval_studio_client/api/docs/V1alphaDashboardStatus.md +12 -0
  93. eval_studio_client/api/docs/V1alphaDeleteDashboardResponse.md +29 -0
  94. eval_studio_client/api/docs/V1alphaDeleteDocumentResponse.md +29 -0
  95. eval_studio_client/api/docs/V1alphaDeleteEvaluatorResponse.md +29 -0
  96. eval_studio_client/api/docs/V1alphaDeleteLeaderboardResponse.md +29 -0
  97. eval_studio_client/api/docs/V1alphaDeleteModelResponse.md +29 -0
  98. eval_studio_client/api/docs/V1alphaDeleteTestCaseResponse.md +29 -0
  99. eval_studio_client/api/docs/V1alphaDeleteTestResponse.md +29 -0
  100. eval_studio_client/api/docs/V1alphaDocument.md +38 -0
  101. eval_studio_client/api/docs/V1alphaEvaluationTest.md +32 -0
  102. eval_studio_client/api/docs/V1alphaEvaluator.md +45 -0
  103. eval_studio_client/api/docs/V1alphaEvaluatorParamType.md +12 -0
  104. eval_studio_client/api/docs/V1alphaEvaluatorParameter.md +40 -0
  105. eval_studio_client/api/docs/V1alphaEvaluatorView.md +12 -0
  106. eval_studio_client/api/docs/V1alphaFinalizeOperationResponse.md +29 -0
  107. eval_studio_client/api/docs/V1alphaFindAllTestCasesByIDResponse.md +29 -0
  108. eval_studio_client/api/docs/V1alphaFindTestLabResponse.md +29 -0
  109. eval_studio_client/api/docs/V1alphaGetDashboardResponse.md +29 -0
  110. eval_studio_client/api/docs/V1alphaGetDocumentResponse.md +29 -0
  111. eval_studio_client/api/docs/V1alphaGetEvaluatorResponse.md +29 -0
  112. eval_studio_client/api/docs/V1alphaGetInfoResponse.md +29 -0
  113. eval_studio_client/api/docs/V1alphaGetLeaderboardResponse.md +29 -0
  114. eval_studio_client/api/docs/V1alphaGetModelResponse.md +29 -0
  115. eval_studio_client/api/docs/V1alphaGetOperationProgressByParentResponse.md +29 -0
  116. eval_studio_client/api/docs/V1alphaGetOperationResponse.md +29 -0
  117. eval_studio_client/api/docs/V1alphaGetPerturbatorResponse.md +29 -0
  118. eval_studio_client/api/docs/V1alphaGetTestCaseResponse.md +29 -0
  119. eval_studio_client/api/docs/V1alphaGetTestClassResponse.md +29 -0
  120. eval_studio_client/api/docs/V1alphaGetTestResponse.md +29 -0
  121. eval_studio_client/api/docs/V1alphaImportEvaluationRequest.md +33 -0
  122. eval_studio_client/api/docs/V1alphaImportLeaderboardRequest.md +37 -0
  123. eval_studio_client/api/docs/V1alphaImportLeaderboardResponse.md +29 -0
  124. eval_studio_client/api/docs/V1alphaInfo.md +35 -0
  125. eval_studio_client/api/docs/V1alphaInsight.md +40 -0
  126. eval_studio_client/api/docs/V1alphaLeaderboard.md +54 -0
  127. eval_studio_client/api/docs/V1alphaLeaderboardStatus.md +12 -0
  128. eval_studio_client/api/docs/V1alphaLeaderboardType.md +12 -0
  129. eval_studio_client/api/docs/V1alphaLeaderboardView.md +12 -0
  130. eval_studio_client/api/docs/V1alphaListBaseModelsResponse.md +29 -0
  131. eval_studio_client/api/docs/V1alphaListDashboardsResponse.md +29 -0
  132. eval_studio_client/api/docs/V1alphaListDocumentsResponse.md +29 -0
  133. eval_studio_client/api/docs/V1alphaListEvaluatorsResponse.md +29 -0
  134. eval_studio_client/api/docs/V1alphaListLLMModelsResponse.md +29 -0
  135. eval_studio_client/api/docs/V1alphaListLeaderboardsResponse.md +30 -0
  136. eval_studio_client/api/docs/V1alphaListModelCollectionsResponse.md +29 -0
  137. eval_studio_client/api/docs/V1alphaListModelsResponse.md +29 -0
  138. eval_studio_client/api/docs/V1alphaListMostRecentDashboardsResponse.md +29 -0
  139. eval_studio_client/api/docs/V1alphaListMostRecentLeaderboardsResponse.md +29 -0
  140. eval_studio_client/api/docs/V1alphaListMostRecentModelsResponse.md +29 -0
  141. eval_studio_client/api/docs/V1alphaListMostRecentTestsResponse.md +29 -0
  142. eval_studio_client/api/docs/V1alphaListOperationsResponse.md +29 -0
  143. eval_studio_client/api/docs/V1alphaListPerturbatorsResponse.md +29 -0
  144. eval_studio_client/api/docs/V1alphaListRAGCollectionsResponse.md +29 -0
  145. eval_studio_client/api/docs/V1alphaListTestCasesResponse.md +29 -0
  146. eval_studio_client/api/docs/V1alphaListTestClassesResponse.md +29 -0
  147. eval_studio_client/api/docs/V1alphaListTestsResponse.md +29 -0
  148. eval_studio_client/api/docs/V1alphaModel.md +42 -0
  149. eval_studio_client/api/docs/V1alphaModelType.md +12 -0
  150. eval_studio_client/api/docs/V1alphaOperation.md +40 -0
  151. eval_studio_client/api/docs/V1alphaOperationProgress.md +32 -0
  152. eval_studio_client/api/docs/V1alphaPerturbTestResponse.md +29 -0
  153. eval_studio_client/api/docs/V1alphaPerturbator.md +39 -0
  154. eval_studio_client/api/docs/V1alphaPerturbatorConfiguration.md +32 -0
  155. eval_studio_client/api/docs/V1alphaPerturbatorIntensity.md +11 -0
  156. eval_studio_client/api/docs/V1alphaProblemAndAction.md +39 -0
  157. eval_studio_client/api/docs/V1alphaTest.md +40 -0
  158. eval_studio_client/api/docs/V1alphaTestCase.md +40 -0
  159. eval_studio_client/api/docs/V1alphaTestCaseRelationship.md +31 -0
  160. eval_studio_client/api/docs/V1alphaTestClass.md +41 -0
  161. eval_studio_client/api/docs/V1alphaTestClassType.md +12 -0
  162. eval_studio_client/api/docs/V1alphaTestLab.md +41 -0
  163. eval_studio_client/api/docs/V1alphaUpdateDashboardResponse.md +29 -0
  164. eval_studio_client/api/docs/V1alphaUpdateDocumentResponse.md +29 -0
  165. eval_studio_client/api/docs/V1alphaUpdateLeaderboardResponse.md +29 -0
  166. eval_studio_client/api/docs/V1alphaUpdateModelResponse.md +29 -0
  167. eval_studio_client/api/docs/V1alphaUpdateOperationResponse.md +29 -0
  168. eval_studio_client/api/docs/V1alphaUpdateTestCaseResponse.md +29 -0
  169. eval_studio_client/api/docs/V1alphaUpdateTestResponse.md +29 -0
  170. eval_studio_client/api/docs/V1alphaWhoAmIResponse.md +31 -0
  171. eval_studio_client/api/docs/WhoAmIServiceApi.md +72 -0
  172. eval_studio_client/api/exceptions.py +199 -0
  173. eval_studio_client/api/models/__init__.py +148 -0
  174. eval_studio_client/api/models/perturbation_service_create_perturbation_request.py +115 -0
  175. eval_studio_client/api/models/protobuf_any.py +100 -0
  176. eval_studio_client/api/models/required_the_dashboard_to_update.py +127 -0
  177. eval_studio_client/api/models/required_the_document_to_update.py +116 -0
  178. eval_studio_client/api/models/required_the_leaderboard_to_update.py +178 -0
  179. eval_studio_client/api/models/required_the_model_to_update.py +127 -0
  180. eval_studio_client/api/models/required_the_operation_to_finalize.py +129 -0
  181. eval_studio_client/api/models/required_the_operation_to_update.py +129 -0
  182. eval_studio_client/api/models/required_the_test_case_to_update.py +120 -0
  183. eval_studio_client/api/models/required_the_test_to_update.py +122 -0
  184. eval_studio_client/api/models/rpc_status.py +99 -0
  185. eval_studio_client/api/models/test_case_service_batch_delete_test_cases_request.py +87 -0
  186. eval_studio_client/api/models/test_service_perturb_test_request.py +99 -0
  187. eval_studio_client/api/models/v1alpha_batch_create_leaderboards_request.py +99 -0
  188. eval_studio_client/api/models/v1alpha_batch_create_leaderboards_response.py +91 -0
  189. eval_studio_client/api/models/v1alpha_batch_delete_dashboards_request.py +87 -0
  190. eval_studio_client/api/models/v1alpha_batch_delete_dashboards_response.py +95 -0
  191. eval_studio_client/api/models/v1alpha_batch_delete_documents_request.py +87 -0
  192. eval_studio_client/api/models/v1alpha_batch_delete_documents_response.py +95 -0
  193. eval_studio_client/api/models/v1alpha_batch_delete_evaluators_request.py +87 -0
  194. eval_studio_client/api/models/v1alpha_batch_delete_evaluators_response.py +95 -0
  195. eval_studio_client/api/models/v1alpha_batch_delete_leaderboards_request.py +90 -0
  196. eval_studio_client/api/models/v1alpha_batch_delete_leaderboards_response.py +95 -0
  197. eval_studio_client/api/models/v1alpha_batch_delete_models_request.py +87 -0
  198. eval_studio_client/api/models/v1alpha_batch_delete_models_response.py +95 -0
  199. eval_studio_client/api/models/v1alpha_batch_delete_test_cases_response.py +95 -0
  200. eval_studio_client/api/models/v1alpha_batch_delete_tests_request.py +89 -0
  201. eval_studio_client/api/models/v1alpha_batch_delete_tests_response.py +95 -0
  202. eval_studio_client/api/models/v1alpha_batch_get_dashboards_response.py +95 -0
  203. eval_studio_client/api/models/v1alpha_batch_get_documents_response.py +95 -0
  204. eval_studio_client/api/models/v1alpha_batch_get_leaderboards_response.py +95 -0
  205. eval_studio_client/api/models/v1alpha_batch_get_models_response.py +95 -0
  206. eval_studio_client/api/models/v1alpha_batch_get_operations_response.py +95 -0
  207. eval_studio_client/api/models/v1alpha_batch_get_tests_response.py +95 -0
  208. eval_studio_client/api/models/v1alpha_batch_import_leaderboard_request.py +104 -0
  209. eval_studio_client/api/models/v1alpha_batch_import_leaderboard_response.py +91 -0
  210. eval_studio_client/api/models/v1alpha_batch_import_tests_request.py +93 -0
  211. eval_studio_client/api/models/v1alpha_batch_import_tests_response.py +95 -0
  212. eval_studio_client/api/models/v1alpha_check_base_models_response.py +89 -0
  213. eval_studio_client/api/models/v1alpha_collection_info.py +93 -0
  214. eval_studio_client/api/models/v1alpha_create_dashboard_response.py +91 -0
  215. eval_studio_client/api/models/v1alpha_create_document_response.py +91 -0
  216. eval_studio_client/api/models/v1alpha_create_evaluation_request.py +115 -0
  217. eval_studio_client/api/models/v1alpha_create_evaluator_response.py +91 -0
  218. eval_studio_client/api/models/v1alpha_create_leaderboard_request.py +91 -0
  219. eval_studio_client/api/models/v1alpha_create_leaderboard_response.py +91 -0
  220. eval_studio_client/api/models/v1alpha_create_leaderboard_without_cache_response.py +91 -0
  221. eval_studio_client/api/models/v1alpha_create_model_response.py +91 -0
  222. eval_studio_client/api/models/v1alpha_create_perturbation_response.py +87 -0
  223. eval_studio_client/api/models/v1alpha_create_test_case_response.py +91 -0
  224. eval_studio_client/api/models/v1alpha_create_test_lab_response.py +91 -0
  225. eval_studio_client/api/models/v1alpha_create_test_response.py +91 -0
  226. eval_studio_client/api/models/v1alpha_dashboard.py +131 -0
  227. eval_studio_client/api/models/v1alpha_dashboard_status.py +39 -0
  228. eval_studio_client/api/models/v1alpha_delete_dashboard_response.py +91 -0
  229. eval_studio_client/api/models/v1alpha_delete_document_response.py +91 -0
  230. eval_studio_client/api/models/v1alpha_delete_evaluator_response.py +91 -0
  231. eval_studio_client/api/models/v1alpha_delete_leaderboard_response.py +91 -0
  232. eval_studio_client/api/models/v1alpha_delete_model_response.py +91 -0
  233. eval_studio_client/api/models/v1alpha_delete_test_case_response.py +91 -0
  234. eval_studio_client/api/models/v1alpha_delete_test_response.py +91 -0
  235. eval_studio_client/api/models/v1alpha_document.py +120 -0
  236. eval_studio_client/api/models/v1alpha_evaluation_test.py +107 -0
  237. eval_studio_client/api/models/v1alpha_evaluator.py +155 -0
  238. eval_studio_client/api/models/v1alpha_evaluator_param_type.py +42 -0
  239. eval_studio_client/api/models/v1alpha_evaluator_parameter.py +126 -0
  240. eval_studio_client/api/models/v1alpha_evaluator_view.py +38 -0
  241. eval_studio_client/api/models/v1alpha_finalize_operation_response.py +91 -0
  242. eval_studio_client/api/models/v1alpha_find_all_test_cases_by_id_response.py +95 -0
  243. eval_studio_client/api/models/v1alpha_find_test_lab_response.py +91 -0
  244. eval_studio_client/api/models/v1alpha_get_dashboard_response.py +91 -0
  245. eval_studio_client/api/models/v1alpha_get_document_response.py +91 -0
  246. eval_studio_client/api/models/v1alpha_get_evaluator_response.py +91 -0
  247. eval_studio_client/api/models/v1alpha_get_info_response.py +91 -0
  248. eval_studio_client/api/models/v1alpha_get_leaderboard_response.py +91 -0
  249. eval_studio_client/api/models/v1alpha_get_model_response.py +91 -0
  250. eval_studio_client/api/models/v1alpha_get_operation_progress_by_parent_response.py +91 -0
  251. eval_studio_client/api/models/v1alpha_get_operation_response.py +91 -0
  252. eval_studio_client/api/models/v1alpha_get_perturbator_response.py +91 -0
  253. eval_studio_client/api/models/v1alpha_get_test_case_response.py +91 -0
  254. eval_studio_client/api/models/v1alpha_get_test_class_response.py +91 -0
  255. eval_studio_client/api/models/v1alpha_get_test_response.py +91 -0
  256. eval_studio_client/api/models/v1alpha_import_evaluation_request.py +99 -0
  257. eval_studio_client/api/models/v1alpha_import_leaderboard_request.py +104 -0
  258. eval_studio_client/api/models/v1alpha_import_leaderboard_response.py +91 -0
  259. eval_studio_client/api/models/v1alpha_info.py +99 -0
  260. eval_studio_client/api/models/v1alpha_insight.py +107 -0
  261. eval_studio_client/api/models/v1alpha_leaderboard.py +182 -0
  262. eval_studio_client/api/models/v1alpha_leaderboard_status.py +39 -0
  263. eval_studio_client/api/models/v1alpha_leaderboard_type.py +39 -0
  264. eval_studio_client/api/models/v1alpha_leaderboard_view.py +39 -0
  265. eval_studio_client/api/models/v1alpha_list_base_models_response.py +87 -0
  266. eval_studio_client/api/models/v1alpha_list_dashboards_response.py +95 -0
  267. eval_studio_client/api/models/v1alpha_list_documents_response.py +95 -0
  268. eval_studio_client/api/models/v1alpha_list_evaluators_response.py +95 -0
  269. eval_studio_client/api/models/v1alpha_list_leaderboards_response.py +97 -0
  270. eval_studio_client/api/models/v1alpha_list_llm_models_response.py +87 -0
  271. eval_studio_client/api/models/v1alpha_list_model_collections_response.py +95 -0
  272. eval_studio_client/api/models/v1alpha_list_models_response.py +95 -0
  273. eval_studio_client/api/models/v1alpha_list_most_recent_dashboards_response.py +95 -0
  274. eval_studio_client/api/models/v1alpha_list_most_recent_leaderboards_response.py +95 -0
  275. eval_studio_client/api/models/v1alpha_list_most_recent_models_response.py +95 -0
  276. eval_studio_client/api/models/v1alpha_list_most_recent_tests_response.py +95 -0
  277. eval_studio_client/api/models/v1alpha_list_operations_response.py +95 -0
  278. eval_studio_client/api/models/v1alpha_list_perturbators_response.py +95 -0
  279. eval_studio_client/api/models/v1alpha_list_rag_collections_response.py +95 -0
  280. eval_studio_client/api/models/v1alpha_list_test_cases_response.py +95 -0
  281. eval_studio_client/api/models/v1alpha_list_test_classes_response.py +95 -0
  282. eval_studio_client/api/models/v1alpha_list_tests_response.py +95 -0
  283. eval_studio_client/api/models/v1alpha_model.py +131 -0
  284. eval_studio_client/api/models/v1alpha_model_type.py +46 -0
  285. eval_studio_client/api/models/v1alpha_operation.py +133 -0
  286. eval_studio_client/api/models/v1alpha_operation_progress.py +99 -0
  287. eval_studio_client/api/models/v1alpha_perturb_test_response.py +91 -0
  288. eval_studio_client/api/models/v1alpha_perturbator.py +122 -0
  289. eval_studio_client/api/models/v1alpha_perturbator_configuration.py +92 -0
  290. eval_studio_client/api/models/v1alpha_perturbator_intensity.py +39 -0
  291. eval_studio_client/api/models/v1alpha_problem_and_action.py +129 -0
  292. eval_studio_client/api/models/v1alpha_test.py +126 -0
  293. eval_studio_client/api/models/v1alpha_test_case.py +124 -0
  294. eval_studio_client/api/models/v1alpha_test_case_relationship.py +91 -0
  295. eval_studio_client/api/models/v1alpha_test_class.py +127 -0
  296. eval_studio_client/api/models/v1alpha_test_class_type.py +42 -0
  297. eval_studio_client/api/models/v1alpha_test_lab.py +137 -0
  298. eval_studio_client/api/models/v1alpha_update_dashboard_response.py +91 -0
  299. eval_studio_client/api/models/v1alpha_update_document_response.py +91 -0
  300. eval_studio_client/api/models/v1alpha_update_leaderboard_response.py +91 -0
  301. eval_studio_client/api/models/v1alpha_update_model_response.py +91 -0
  302. eval_studio_client/api/models/v1alpha_update_operation_response.py +91 -0
  303. eval_studio_client/api/models/v1alpha_update_test_case_response.py +91 -0
  304. eval_studio_client/api/models/v1alpha_update_test_response.py +91 -0
  305. eval_studio_client/api/models/v1alpha_who_am_i_response.py +91 -0
  306. eval_studio_client/api/rest.py +257 -0
  307. eval_studio_client/api/test/__init__.py +0 -0
  308. eval_studio_client/api/test/test_dashboard_service_api.py +79 -0
  309. eval_studio_client/api/test/test_document_service_api.py +73 -0
  310. eval_studio_client/api/test/test_evaluation_service_api.py +55 -0
  311. eval_studio_client/api/test/test_evaluator_service_api.py +61 -0
  312. eval_studio_client/api/test/test_info_service_api.py +37 -0
  313. eval_studio_client/api/test/test_leaderboard_service_api.py +103 -0
  314. eval_studio_client/api/test/test_model_service_api.py +97 -0
  315. eval_studio_client/api/test/test_operation_progress_service_api.py +37 -0
  316. eval_studio_client/api/test/test_operation_service_api.py +61 -0
  317. eval_studio_client/api/test/test_perturbation_service_api.py +37 -0
  318. eval_studio_client/api/test/test_perturbation_service_create_perturbation_request.py +79 -0
  319. eval_studio_client/api/test/test_perturbator_service_api.py +43 -0
  320. eval_studio_client/api/test/test_protobuf_any.py +51 -0
  321. eval_studio_client/api/test/test_required_the_dashboard_to_update.py +64 -0
  322. eval_studio_client/api/test/test_required_the_document_to_update.py +59 -0
  323. eval_studio_client/api/test/test_required_the_leaderboard_to_update.py +115 -0
  324. eval_studio_client/api/test/test_required_the_model_to_update.py +63 -0
  325. eval_studio_client/api/test/test_required_the_operation_to_finalize.py +71 -0
  326. eval_studio_client/api/test/test_required_the_operation_to_update.py +71 -0
  327. eval_studio_client/api/test/test_required_the_test_case_to_update.py +63 -0
  328. eval_studio_client/api/test/test_required_the_test_to_update.py +65 -0
  329. eval_studio_client/api/test/test_rpc_status.py +57 -0
  330. eval_studio_client/api/test/test_test_case_service_api.py +73 -0
  331. eval_studio_client/api/test/test_test_case_service_batch_delete_test_cases_request.py +53 -0
  332. eval_studio_client/api/test/test_test_class_service_api.py +43 -0
  333. eval_studio_client/api/test/test_test_lab_service_api.py +43 -0
  334. eval_studio_client/api/test/test_test_service_api.py +91 -0
  335. eval_studio_client/api/test/test_test_service_perturb_test_request.py +58 -0
  336. eval_studio_client/api/test/test_v1alpha_batch_create_leaderboards_request.py +119 -0
  337. eval_studio_client/api/test/test_v1alpha_batch_create_leaderboards_response.py +71 -0
  338. eval_studio_client/api/test/test_v1alpha_batch_delete_dashboards_request.py +53 -0
  339. eval_studio_client/api/test/test_v1alpha_batch_delete_dashboards_response.py +68 -0
  340. eval_studio_client/api/test/test_v1alpha_batch_delete_documents_request.py +53 -0
  341. eval_studio_client/api/test/test_v1alpha_batch_delete_documents_response.py +63 -0
  342. eval_studio_client/api/test/test_v1alpha_batch_delete_evaluators_request.py +53 -0
  343. eval_studio_client/api/test/test_v1alpha_batch_delete_evaluators_response.py +91 -0
  344. eval_studio_client/api/test/test_v1alpha_batch_delete_leaderboards_request.py +54 -0
  345. eval_studio_client/api/test/test_v1alpha_batch_delete_leaderboards_response.py +116 -0
  346. eval_studio_client/api/test/test_v1alpha_batch_delete_models_request.py +53 -0
  347. eval_studio_client/api/test/test_v1alpha_batch_delete_models_response.py +67 -0
  348. eval_studio_client/api/test/test_v1alpha_batch_delete_test_cases_response.py +67 -0
  349. eval_studio_client/api/test/test_v1alpha_batch_delete_tests_request.py +54 -0
  350. eval_studio_client/api/test/test_v1alpha_batch_delete_tests_response.py +69 -0
  351. eval_studio_client/api/test/test_v1alpha_batch_get_dashboards_response.py +68 -0
  352. eval_studio_client/api/test/test_v1alpha_batch_get_documents_response.py +63 -0
  353. eval_studio_client/api/test/test_v1alpha_batch_get_leaderboards_response.py +116 -0
  354. eval_studio_client/api/test/test_v1alpha_batch_get_models_response.py +67 -0
  355. eval_studio_client/api/test/test_v1alpha_batch_get_operations_response.py +73 -0
  356. eval_studio_client/api/test/test_v1alpha_batch_get_tests_response.py +69 -0
  357. eval_studio_client/api/test/test_v1alpha_batch_import_leaderboard_request.py +61 -0
  358. eval_studio_client/api/test/test_v1alpha_batch_import_leaderboard_response.py +71 -0
  359. eval_studio_client/api/test/test_v1alpha_batch_import_tests_request.py +54 -0
  360. eval_studio_client/api/test/test_v1alpha_batch_import_tests_response.py +69 -0
  361. eval_studio_client/api/test/test_v1alpha_check_base_models_response.py +52 -0
  362. eval_studio_client/api/test/test_v1alpha_collection_info.py +54 -0
  363. eval_studio_client/api/test/test_v1alpha_create_dashboard_response.py +66 -0
  364. eval_studio_client/api/test/test_v1alpha_create_document_response.py +61 -0
  365. eval_studio_client/api/test/test_v1alpha_create_evaluation_request.py +107 -0
  366. eval_studio_client/api/test/test_v1alpha_create_evaluator_response.py +89 -0
  367. eval_studio_client/api/test/test_v1alpha_create_leaderboard_request.py +114 -0
  368. eval_studio_client/api/test/test_v1alpha_create_leaderboard_response.py +71 -0
  369. eval_studio_client/api/test/test_v1alpha_create_leaderboard_without_cache_response.py +71 -0
  370. eval_studio_client/api/test/test_v1alpha_create_model_response.py +65 -0
  371. eval_studio_client/api/test/test_v1alpha_create_perturbation_response.py +51 -0
  372. eval_studio_client/api/test/test_v1alpha_create_test_case_response.py +65 -0
  373. eval_studio_client/api/test/test_v1alpha_create_test_lab_response.py +68 -0
  374. eval_studio_client/api/test/test_v1alpha_create_test_response.py +67 -0
  375. eval_studio_client/api/test/test_v1alpha_dashboard.py +65 -0
  376. eval_studio_client/api/test/test_v1alpha_dashboard_status.py +33 -0
  377. eval_studio_client/api/test/test_v1alpha_delete_dashboard_response.py +66 -0
  378. eval_studio_client/api/test/test_v1alpha_delete_document_response.py +61 -0
  379. eval_studio_client/api/test/test_v1alpha_delete_evaluator_response.py +89 -0
  380. eval_studio_client/api/test/test_v1alpha_delete_leaderboard_response.py +114 -0
  381. eval_studio_client/api/test/test_v1alpha_delete_model_response.py +65 -0
  382. eval_studio_client/api/test/test_v1alpha_delete_test_case_response.py +65 -0
  383. eval_studio_client/api/test/test_v1alpha_delete_test_response.py +67 -0
  384. eval_studio_client/api/test/test_v1alpha_document.py +60 -0
  385. eval_studio_client/api/test/test_v1alpha_evaluation_test.py +76 -0
  386. eval_studio_client/api/test/test_v1alpha_evaluator.py +91 -0
  387. eval_studio_client/api/test/test_v1alpha_evaluator_param_type.py +33 -0
  388. eval_studio_client/api/test/test_v1alpha_evaluator_parameter.py +68 -0
  389. eval_studio_client/api/test/test_v1alpha_evaluator_view.py +33 -0
  390. eval_studio_client/api/test/test_v1alpha_finalize_operation_response.py +71 -0
  391. eval_studio_client/api/test/test_v1alpha_find_all_test_cases_by_id_response.py +67 -0
  392. eval_studio_client/api/test/test_v1alpha_find_test_lab_response.py +68 -0
  393. eval_studio_client/api/test/test_v1alpha_get_dashboard_response.py +66 -0
  394. eval_studio_client/api/test/test_v1alpha_get_document_response.py +61 -0
  395. eval_studio_client/api/test/test_v1alpha_get_evaluator_response.py +89 -0
  396. eval_studio_client/api/test/test_v1alpha_get_info_response.py +60 -0
  397. eval_studio_client/api/test/test_v1alpha_get_leaderboard_response.py +114 -0
  398. eval_studio_client/api/test/test_v1alpha_get_model_response.py +65 -0
  399. eval_studio_client/api/test/test_v1alpha_get_operation_progress_by_parent_response.py +55 -0
  400. eval_studio_client/api/test/test_v1alpha_get_operation_response.py +71 -0
  401. eval_studio_client/api/test/test_v1alpha_get_perturbator_response.py +64 -0
  402. eval_studio_client/api/test/test_v1alpha_get_test_case_response.py +65 -0
  403. eval_studio_client/api/test/test_v1alpha_get_test_class_response.py +70 -0
  404. eval_studio_client/api/test/test_v1alpha_get_test_response.py +67 -0
  405. eval_studio_client/api/test/test_v1alpha_import_evaluation_request.py +73 -0
  406. eval_studio_client/api/test/test_v1alpha_import_leaderboard_request.py +59 -0
  407. eval_studio_client/api/test/test_v1alpha_import_leaderboard_response.py +71 -0
  408. eval_studio_client/api/test/test_v1alpha_info.py +59 -0
  409. eval_studio_client/api/test/test_v1alpha_insight.py +67 -0
  410. eval_studio_client/api/test/test_v1alpha_leaderboard.py +116 -0
  411. eval_studio_client/api/test/test_v1alpha_leaderboard_status.py +33 -0
  412. eval_studio_client/api/test/test_v1alpha_leaderboard_type.py +33 -0
  413. eval_studio_client/api/test/test_v1alpha_leaderboard_view.py +33 -0
  414. eval_studio_client/api/test/test_v1alpha_list_base_models_response.py +53 -0
  415. eval_studio_client/api/test/test_v1alpha_list_dashboards_response.py +68 -0
  416. eval_studio_client/api/test/test_v1alpha_list_documents_response.py +63 -0
  417. eval_studio_client/api/test/test_v1alpha_list_evaluators_response.py +91 -0
  418. eval_studio_client/api/test/test_v1alpha_list_leaderboards_response.py +117 -0
  419. eval_studio_client/api/test/test_v1alpha_list_llm_models_response.py +53 -0
  420. eval_studio_client/api/test/test_v1alpha_list_model_collections_response.py +57 -0
  421. eval_studio_client/api/test/test_v1alpha_list_models_response.py +67 -0
  422. eval_studio_client/api/test/test_v1alpha_list_most_recent_dashboards_response.py +68 -0
  423. eval_studio_client/api/test/test_v1alpha_list_most_recent_leaderboards_response.py +116 -0
  424. eval_studio_client/api/test/test_v1alpha_list_most_recent_models_response.py +67 -0
  425. eval_studio_client/api/test/test_v1alpha_list_most_recent_tests_response.py +69 -0
  426. eval_studio_client/api/test/test_v1alpha_list_operations_response.py +73 -0
  427. eval_studio_client/api/test/test_v1alpha_list_perturbators_response.py +66 -0
  428. eval_studio_client/api/test/test_v1alpha_list_rag_collections_response.py +57 -0
  429. eval_studio_client/api/test/test_v1alpha_list_test_cases_response.py +67 -0
  430. eval_studio_client/api/test/test_v1alpha_list_test_classes_response.py +72 -0
  431. eval_studio_client/api/test/test_v1alpha_list_tests_response.py +69 -0
  432. eval_studio_client/api/test/test_v1alpha_model.py +64 -0
  433. eval_studio_client/api/test/test_v1alpha_model_type.py +33 -0
  434. eval_studio_client/api/test/test_v1alpha_operation.py +72 -0
  435. eval_studio_client/api/test/test_v1alpha_operation_progress.py +54 -0
  436. eval_studio_client/api/test/test_v1alpha_perturb_test_response.py +67 -0
  437. eval_studio_client/api/test/test_v1alpha_perturbator.py +63 -0
  438. eval_studio_client/api/test/test_v1alpha_perturbator_configuration.py +53 -0
  439. eval_studio_client/api/test/test_v1alpha_perturbator_intensity.py +33 -0
  440. eval_studio_client/api/test/test_v1alpha_problem_and_action.py +65 -0
  441. eval_studio_client/api/test/test_v1alpha_test.py +66 -0
  442. eval_studio_client/api/test/test_v1alpha_test_case.py +64 -0
  443. eval_studio_client/api/test/test_v1alpha_test_case_relationship.py +53 -0
  444. eval_studio_client/api/test/test_v1alpha_test_class.py +69 -0
  445. eval_studio_client/api/test/test_v1alpha_test_class_type.py +33 -0
  446. eval_studio_client/api/test/test_v1alpha_test_lab.py +67 -0
  447. eval_studio_client/api/test/test_v1alpha_update_dashboard_response.py +66 -0
  448. eval_studio_client/api/test/test_v1alpha_update_document_response.py +61 -0
  449. eval_studio_client/api/test/test_v1alpha_update_leaderboard_response.py +114 -0
  450. eval_studio_client/api/test/test_v1alpha_update_model_response.py +65 -0
  451. eval_studio_client/api/test/test_v1alpha_update_operation_response.py +71 -0
  452. eval_studio_client/api/test/test_v1alpha_update_test_case_response.py +65 -0
  453. eval_studio_client/api/test/test_v1alpha_update_test_response.py +67 -0
  454. eval_studio_client/api/test/test_v1alpha_who_am_i_response.py +53 -0
  455. eval_studio_client/api/test/test_who_am_i_service_api.py +38 -0
  456. eval_studio_client/client.py +98 -0
  457. eval_studio_client/dashboards.py +187 -0
  458. eval_studio_client/documents.py +95 -0
  459. eval_studio_client/evaluators.py +65 -0
  460. eval_studio_client/gen/openapiv2/eval_studio.swagger.json +6043 -0
  461. eval_studio_client/insights.py +35 -0
  462. eval_studio_client/leaderboards.py +207 -0
  463. eval_studio_client/models.py +522 -0
  464. eval_studio_client/perturbators.py +101 -0
  465. eval_studio_client/problems.py +50 -0
  466. eval_studio_client/test_labs.py +319 -0
  467. eval_studio_client/tests.py +369 -0
  468. eval_studio_client-0.7.0.dist-info/METADATA +18 -0
  469. eval_studio_client-0.7.0.dist-info/RECORD +470 -0
  470. eval_studio_client-0.7.0.dist-info/WHEEL +4 -0
@@ -0,0 +1,3336 @@
1
+ # coding: utf-8
2
+
3
+ """
4
+ ai/h2o/eval_studio/v1alpha/collection.proto
5
+
6
+ No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+
8
+ The version of the OpenAPI document: version not set
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, StrictInt, StrictStr, field_validator
20
+ from typing import List, Optional
21
+ from typing_extensions import Annotated
22
+ from eval_studio_client.api.models.required_the_leaderboard_to_update import RequiredTheLeaderboardToUpdate
23
+ from eval_studio_client.api.models.v1alpha_batch_create_leaderboards_request import V1alphaBatchCreateLeaderboardsRequest
24
+ from eval_studio_client.api.models.v1alpha_batch_create_leaderboards_response import V1alphaBatchCreateLeaderboardsResponse
25
+ from eval_studio_client.api.models.v1alpha_batch_delete_leaderboards_request import V1alphaBatchDeleteLeaderboardsRequest
26
+ from eval_studio_client.api.models.v1alpha_batch_delete_leaderboards_response import V1alphaBatchDeleteLeaderboardsResponse
27
+ from eval_studio_client.api.models.v1alpha_batch_get_leaderboards_response import V1alphaBatchGetLeaderboardsResponse
28
+ from eval_studio_client.api.models.v1alpha_batch_import_leaderboard_request import V1alphaBatchImportLeaderboardRequest
29
+ from eval_studio_client.api.models.v1alpha_batch_import_leaderboard_response import V1alphaBatchImportLeaderboardResponse
30
+ from eval_studio_client.api.models.v1alpha_create_leaderboard_response import V1alphaCreateLeaderboardResponse
31
+ from eval_studio_client.api.models.v1alpha_create_leaderboard_without_cache_response import V1alphaCreateLeaderboardWithoutCacheResponse
32
+ from eval_studio_client.api.models.v1alpha_delete_leaderboard_response import V1alphaDeleteLeaderboardResponse
33
+ from eval_studio_client.api.models.v1alpha_get_leaderboard_response import V1alphaGetLeaderboardResponse
34
+ from eval_studio_client.api.models.v1alpha_import_leaderboard_request import V1alphaImportLeaderboardRequest
35
+ from eval_studio_client.api.models.v1alpha_import_leaderboard_response import V1alphaImportLeaderboardResponse
36
+ from eval_studio_client.api.models.v1alpha_leaderboard import V1alphaLeaderboard
37
+ from eval_studio_client.api.models.v1alpha_list_leaderboards_response import V1alphaListLeaderboardsResponse
38
+ from eval_studio_client.api.models.v1alpha_list_most_recent_leaderboards_response import V1alphaListMostRecentLeaderboardsResponse
39
+ from eval_studio_client.api.models.v1alpha_update_leaderboard_response import V1alphaUpdateLeaderboardResponse
40
+
41
+ from eval_studio_client.api.api_client import ApiClient, RequestSerialized
42
+ from eval_studio_client.api.api_response import ApiResponse
43
+ from eval_studio_client.api.rest import RESTResponseType
44
+
45
+
46
+ class LeaderboardServiceApi:
47
+ """NOTE: This class is auto generated by OpenAPI Generator
48
+ Ref: https://openapi-generator.tech
49
+
50
+ Do not edit the class manually.
51
+ """
52
+
53
+ def __init__(self, api_client=None) -> None:
54
+ if api_client is None:
55
+ api_client = ApiClient.get_default()
56
+ self.api_client = api_client
57
+
58
+
59
+ @validate_call
60
+ def leaderboard_service_batch_create_leaderboards(
61
+ self,
62
+ body: V1alphaBatchCreateLeaderboardsRequest,
63
+ _request_timeout: Union[
64
+ None,
65
+ Annotated[StrictFloat, Field(gt=0)],
66
+ Tuple[
67
+ Annotated[StrictFloat, Field(gt=0)],
68
+ Annotated[StrictFloat, Field(gt=0)]
69
+ ]
70
+ ] = None,
71
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
72
+ _content_type: Optional[StrictStr] = None,
73
+ _headers: Optional[Dict[StrictStr, Any]] = None,
74
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
75
+ ) -> V1alphaBatchCreateLeaderboardsResponse:
76
+ """leaderboard_service_batch_create_leaderboards
77
+
78
+
79
+ :param body: (required)
80
+ :type body: V1alphaBatchCreateLeaderboardsRequest
81
+ :param _request_timeout: timeout setting for this request. If one
82
+ number provided, it will be total request
83
+ timeout. It can also be a pair (tuple) of
84
+ (connection, read) timeouts.
85
+ :type _request_timeout: int, tuple(int, int), optional
86
+ :param _request_auth: set to override the auth_settings for an a single
87
+ request; this effectively ignores the
88
+ authentication in the spec for a single request.
89
+ :type _request_auth: dict, optional
90
+ :param _content_type: force content-type for the request.
91
+ :type _content_type: str, Optional
92
+ :param _headers: set to override the headers for a single
93
+ request; this effectively ignores the headers
94
+ in the spec for a single request.
95
+ :type _headers: dict, optional
96
+ :param _host_index: set to override the host_index for a single
97
+ request; this effectively ignores the host_index
98
+ in the spec for a single request.
99
+ :type _host_index: int, optional
100
+ :return: Returns the result object.
101
+ """ # noqa: E501
102
+
103
+ _param = self._leaderboard_service_batch_create_leaderboards_serialize(
104
+ body=body,
105
+ _request_auth=_request_auth,
106
+ _content_type=_content_type,
107
+ _headers=_headers,
108
+ _host_index=_host_index
109
+ )
110
+
111
+ _response_types_map: Dict[str, Optional[str]] = {
112
+ '200': "V1alphaBatchCreateLeaderboardsResponse",
113
+ }
114
+ response_data = self.api_client.call_api(
115
+ *_param,
116
+ _request_timeout=_request_timeout
117
+ )
118
+ response_data.read()
119
+ return self.api_client.response_deserialize(
120
+ response_data=response_data,
121
+ response_types_map=_response_types_map,
122
+ ).data
123
+
124
+
125
+ @validate_call
126
+ def leaderboard_service_batch_create_leaderboards_with_http_info(
127
+ self,
128
+ body: V1alphaBatchCreateLeaderboardsRequest,
129
+ _request_timeout: Union[
130
+ None,
131
+ Annotated[StrictFloat, Field(gt=0)],
132
+ Tuple[
133
+ Annotated[StrictFloat, Field(gt=0)],
134
+ Annotated[StrictFloat, Field(gt=0)]
135
+ ]
136
+ ] = None,
137
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
138
+ _content_type: Optional[StrictStr] = None,
139
+ _headers: Optional[Dict[StrictStr, Any]] = None,
140
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
141
+ ) -> ApiResponse[V1alphaBatchCreateLeaderboardsResponse]:
142
+ """leaderboard_service_batch_create_leaderboards
143
+
144
+
145
+ :param body: (required)
146
+ :type body: V1alphaBatchCreateLeaderboardsRequest
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._leaderboard_service_batch_create_leaderboards_serialize(
170
+ body=body,
171
+ _request_auth=_request_auth,
172
+ _content_type=_content_type,
173
+ _headers=_headers,
174
+ _host_index=_host_index
175
+ )
176
+
177
+ _response_types_map: Dict[str, Optional[str]] = {
178
+ '200': "V1alphaBatchCreateLeaderboardsResponse",
179
+ }
180
+ response_data = self.api_client.call_api(
181
+ *_param,
182
+ _request_timeout=_request_timeout
183
+ )
184
+ response_data.read()
185
+ return self.api_client.response_deserialize(
186
+ response_data=response_data,
187
+ response_types_map=_response_types_map,
188
+ )
189
+
190
+
191
+ @validate_call
192
+ def leaderboard_service_batch_create_leaderboards_without_preload_content(
193
+ self,
194
+ body: V1alphaBatchCreateLeaderboardsRequest,
195
+ _request_timeout: Union[
196
+ None,
197
+ Annotated[StrictFloat, Field(gt=0)],
198
+ Tuple[
199
+ Annotated[StrictFloat, Field(gt=0)],
200
+ Annotated[StrictFloat, Field(gt=0)]
201
+ ]
202
+ ] = None,
203
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
204
+ _content_type: Optional[StrictStr] = None,
205
+ _headers: Optional[Dict[StrictStr, Any]] = None,
206
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
207
+ ) -> RESTResponseType:
208
+ """leaderboard_service_batch_create_leaderboards
209
+
210
+
211
+ :param body: (required)
212
+ :type body: V1alphaBatchCreateLeaderboardsRequest
213
+ :param _request_timeout: timeout setting for this request. If one
214
+ number provided, it will be total request
215
+ timeout. It can also be a pair (tuple) of
216
+ (connection, read) timeouts.
217
+ :type _request_timeout: int, tuple(int, int), optional
218
+ :param _request_auth: set to override the auth_settings for an a single
219
+ request; this effectively ignores the
220
+ authentication in the spec for a single request.
221
+ :type _request_auth: dict, optional
222
+ :param _content_type: force content-type for the request.
223
+ :type _content_type: str, Optional
224
+ :param _headers: set to override the headers for a single
225
+ request; this effectively ignores the headers
226
+ in the spec for a single request.
227
+ :type _headers: dict, optional
228
+ :param _host_index: set to override the host_index for a single
229
+ request; this effectively ignores the host_index
230
+ in the spec for a single request.
231
+ :type _host_index: int, optional
232
+ :return: Returns the result object.
233
+ """ # noqa: E501
234
+
235
+ _param = self._leaderboard_service_batch_create_leaderboards_serialize(
236
+ body=body,
237
+ _request_auth=_request_auth,
238
+ _content_type=_content_type,
239
+ _headers=_headers,
240
+ _host_index=_host_index
241
+ )
242
+
243
+ _response_types_map: Dict[str, Optional[str]] = {
244
+ '200': "V1alphaBatchCreateLeaderboardsResponse",
245
+ }
246
+ response_data = self.api_client.call_api(
247
+ *_param,
248
+ _request_timeout=_request_timeout
249
+ )
250
+ return response_data.response
251
+
252
+
253
+ def _leaderboard_service_batch_create_leaderboards_serialize(
254
+ self,
255
+ body,
256
+ _request_auth,
257
+ _content_type,
258
+ _headers,
259
+ _host_index,
260
+ ) -> RequestSerialized:
261
+
262
+ _host = None
263
+
264
+ _collection_formats: Dict[str, str] = {
265
+ }
266
+
267
+ _path_params: Dict[str, str] = {}
268
+ _query_params: List[Tuple[str, str]] = []
269
+ _header_params: Dict[str, Optional[str]] = _headers or {}
270
+ _form_params: List[Tuple[str, str]] = []
271
+ _files: Dict[str, Union[str, bytes]] = {}
272
+ _body_params: Optional[bytes] = None
273
+
274
+ # process the path parameters
275
+ # process the query parameters
276
+ # process the header parameters
277
+ # process the form parameters
278
+ # process the body parameter
279
+ if body is not None:
280
+ _body_params = body
281
+
282
+
283
+ # set the HTTP header `Accept`
284
+ _header_params['Accept'] = self.api_client.select_header_accept(
285
+ [
286
+ 'application/json'
287
+ ]
288
+ )
289
+
290
+ # set the HTTP header `Content-Type`
291
+ if _content_type:
292
+ _header_params['Content-Type'] = _content_type
293
+ else:
294
+ _default_content_type = (
295
+ self.api_client.select_header_content_type(
296
+ [
297
+ 'application/json'
298
+ ]
299
+ )
300
+ )
301
+ if _default_content_type is not None:
302
+ _header_params['Content-Type'] = _default_content_type
303
+
304
+ # authentication setting
305
+ _auth_settings: List[str] = [
306
+ ]
307
+
308
+ return self.api_client.param_serialize(
309
+ method='POST',
310
+ resource_path='/v1alpha/leaderboards:batchCreate',
311
+ path_params=_path_params,
312
+ query_params=_query_params,
313
+ header_params=_header_params,
314
+ body=_body_params,
315
+ post_params=_form_params,
316
+ files=_files,
317
+ auth_settings=_auth_settings,
318
+ collection_formats=_collection_formats,
319
+ _host=_host,
320
+ _request_auth=_request_auth
321
+ )
322
+
323
+
324
+
325
+
326
+ @validate_call
327
+ def leaderboard_service_batch_delete_leaderboards(
328
+ self,
329
+ body: V1alphaBatchDeleteLeaderboardsRequest,
330
+ _request_timeout: Union[
331
+ None,
332
+ Annotated[StrictFloat, Field(gt=0)],
333
+ Tuple[
334
+ Annotated[StrictFloat, Field(gt=0)],
335
+ Annotated[StrictFloat, Field(gt=0)]
336
+ ]
337
+ ] = None,
338
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
339
+ _content_type: Optional[StrictStr] = None,
340
+ _headers: Optional[Dict[StrictStr, Any]] = None,
341
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
342
+ ) -> V1alphaBatchDeleteLeaderboardsResponse:
343
+ """leaderboard_service_batch_delete_leaderboards
344
+
345
+
346
+ :param body: (required)
347
+ :type body: V1alphaBatchDeleteLeaderboardsRequest
348
+ :param _request_timeout: timeout setting for this request. If one
349
+ number provided, it will be total request
350
+ timeout. It can also be a pair (tuple) of
351
+ (connection, read) timeouts.
352
+ :type _request_timeout: int, tuple(int, int), optional
353
+ :param _request_auth: set to override the auth_settings for an a single
354
+ request; this effectively ignores the
355
+ authentication in the spec for a single request.
356
+ :type _request_auth: dict, optional
357
+ :param _content_type: force content-type for the request.
358
+ :type _content_type: str, Optional
359
+ :param _headers: set to override the headers for a single
360
+ request; this effectively ignores the headers
361
+ in the spec for a single request.
362
+ :type _headers: dict, optional
363
+ :param _host_index: set to override the host_index for a single
364
+ request; this effectively ignores the host_index
365
+ in the spec for a single request.
366
+ :type _host_index: int, optional
367
+ :return: Returns the result object.
368
+ """ # noqa: E501
369
+
370
+ _param = self._leaderboard_service_batch_delete_leaderboards_serialize(
371
+ body=body,
372
+ _request_auth=_request_auth,
373
+ _content_type=_content_type,
374
+ _headers=_headers,
375
+ _host_index=_host_index
376
+ )
377
+
378
+ _response_types_map: Dict[str, Optional[str]] = {
379
+ '200': "V1alphaBatchDeleteLeaderboardsResponse",
380
+ }
381
+ response_data = self.api_client.call_api(
382
+ *_param,
383
+ _request_timeout=_request_timeout
384
+ )
385
+ response_data.read()
386
+ return self.api_client.response_deserialize(
387
+ response_data=response_data,
388
+ response_types_map=_response_types_map,
389
+ ).data
390
+
391
+
392
+ @validate_call
393
+ def leaderboard_service_batch_delete_leaderboards_with_http_info(
394
+ self,
395
+ body: V1alphaBatchDeleteLeaderboardsRequest,
396
+ _request_timeout: Union[
397
+ None,
398
+ Annotated[StrictFloat, Field(gt=0)],
399
+ Tuple[
400
+ Annotated[StrictFloat, Field(gt=0)],
401
+ Annotated[StrictFloat, Field(gt=0)]
402
+ ]
403
+ ] = None,
404
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
405
+ _content_type: Optional[StrictStr] = None,
406
+ _headers: Optional[Dict[StrictStr, Any]] = None,
407
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
408
+ ) -> ApiResponse[V1alphaBatchDeleteLeaderboardsResponse]:
409
+ """leaderboard_service_batch_delete_leaderboards
410
+
411
+
412
+ :param body: (required)
413
+ :type body: V1alphaBatchDeleteLeaderboardsRequest
414
+ :param _request_timeout: timeout setting for this request. If one
415
+ number provided, it will be total request
416
+ timeout. It can also be a pair (tuple) of
417
+ (connection, read) timeouts.
418
+ :type _request_timeout: int, tuple(int, int), optional
419
+ :param _request_auth: set to override the auth_settings for an a single
420
+ request; this effectively ignores the
421
+ authentication in the spec for a single request.
422
+ :type _request_auth: dict, optional
423
+ :param _content_type: force content-type for the request.
424
+ :type _content_type: str, Optional
425
+ :param _headers: set to override the headers for a single
426
+ request; this effectively ignores the headers
427
+ in the spec for a single request.
428
+ :type _headers: dict, optional
429
+ :param _host_index: set to override the host_index for a single
430
+ request; this effectively ignores the host_index
431
+ in the spec for a single request.
432
+ :type _host_index: int, optional
433
+ :return: Returns the result object.
434
+ """ # noqa: E501
435
+
436
+ _param = self._leaderboard_service_batch_delete_leaderboards_serialize(
437
+ body=body,
438
+ _request_auth=_request_auth,
439
+ _content_type=_content_type,
440
+ _headers=_headers,
441
+ _host_index=_host_index
442
+ )
443
+
444
+ _response_types_map: Dict[str, Optional[str]] = {
445
+ '200': "V1alphaBatchDeleteLeaderboardsResponse",
446
+ }
447
+ response_data = self.api_client.call_api(
448
+ *_param,
449
+ _request_timeout=_request_timeout
450
+ )
451
+ response_data.read()
452
+ return self.api_client.response_deserialize(
453
+ response_data=response_data,
454
+ response_types_map=_response_types_map,
455
+ )
456
+
457
+
458
+ @validate_call
459
+ def leaderboard_service_batch_delete_leaderboards_without_preload_content(
460
+ self,
461
+ body: V1alphaBatchDeleteLeaderboardsRequest,
462
+ _request_timeout: Union[
463
+ None,
464
+ Annotated[StrictFloat, Field(gt=0)],
465
+ Tuple[
466
+ Annotated[StrictFloat, Field(gt=0)],
467
+ Annotated[StrictFloat, Field(gt=0)]
468
+ ]
469
+ ] = None,
470
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
471
+ _content_type: Optional[StrictStr] = None,
472
+ _headers: Optional[Dict[StrictStr, Any]] = None,
473
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
474
+ ) -> RESTResponseType:
475
+ """leaderboard_service_batch_delete_leaderboards
476
+
477
+
478
+ :param body: (required)
479
+ :type body: V1alphaBatchDeleteLeaderboardsRequest
480
+ :param _request_timeout: timeout setting for this request. If one
481
+ number provided, it will be total request
482
+ timeout. It can also be a pair (tuple) of
483
+ (connection, read) timeouts.
484
+ :type _request_timeout: int, tuple(int, int), optional
485
+ :param _request_auth: set to override the auth_settings for an a single
486
+ request; this effectively ignores the
487
+ authentication in the spec for a single request.
488
+ :type _request_auth: dict, optional
489
+ :param _content_type: force content-type for the request.
490
+ :type _content_type: str, Optional
491
+ :param _headers: set to override the headers for a single
492
+ request; this effectively ignores the headers
493
+ in the spec for a single request.
494
+ :type _headers: dict, optional
495
+ :param _host_index: set to override the host_index for a single
496
+ request; this effectively ignores the host_index
497
+ in the spec for a single request.
498
+ :type _host_index: int, optional
499
+ :return: Returns the result object.
500
+ """ # noqa: E501
501
+
502
+ _param = self._leaderboard_service_batch_delete_leaderboards_serialize(
503
+ body=body,
504
+ _request_auth=_request_auth,
505
+ _content_type=_content_type,
506
+ _headers=_headers,
507
+ _host_index=_host_index
508
+ )
509
+
510
+ _response_types_map: Dict[str, Optional[str]] = {
511
+ '200': "V1alphaBatchDeleteLeaderboardsResponse",
512
+ }
513
+ response_data = self.api_client.call_api(
514
+ *_param,
515
+ _request_timeout=_request_timeout
516
+ )
517
+ return response_data.response
518
+
519
+
520
+ def _leaderboard_service_batch_delete_leaderboards_serialize(
521
+ self,
522
+ body,
523
+ _request_auth,
524
+ _content_type,
525
+ _headers,
526
+ _host_index,
527
+ ) -> RequestSerialized:
528
+
529
+ _host = None
530
+
531
+ _collection_formats: Dict[str, str] = {
532
+ }
533
+
534
+ _path_params: Dict[str, str] = {}
535
+ _query_params: List[Tuple[str, str]] = []
536
+ _header_params: Dict[str, Optional[str]] = _headers or {}
537
+ _form_params: List[Tuple[str, str]] = []
538
+ _files: Dict[str, Union[str, bytes]] = {}
539
+ _body_params: Optional[bytes] = None
540
+
541
+ # process the path parameters
542
+ # process the query parameters
543
+ # process the header parameters
544
+ # process the form parameters
545
+ # process the body parameter
546
+ if body is not None:
547
+ _body_params = body
548
+
549
+
550
+ # set the HTTP header `Accept`
551
+ _header_params['Accept'] = self.api_client.select_header_accept(
552
+ [
553
+ 'application/json'
554
+ ]
555
+ )
556
+
557
+ # set the HTTP header `Content-Type`
558
+ if _content_type:
559
+ _header_params['Content-Type'] = _content_type
560
+ else:
561
+ _default_content_type = (
562
+ self.api_client.select_header_content_type(
563
+ [
564
+ 'application/json'
565
+ ]
566
+ )
567
+ )
568
+ if _default_content_type is not None:
569
+ _header_params['Content-Type'] = _default_content_type
570
+
571
+ # authentication setting
572
+ _auth_settings: List[str] = [
573
+ ]
574
+
575
+ return self.api_client.param_serialize(
576
+ method='POST',
577
+ resource_path='/v1alpha/leaderboards:batchDelete',
578
+ path_params=_path_params,
579
+ query_params=_query_params,
580
+ header_params=_header_params,
581
+ body=_body_params,
582
+ post_params=_form_params,
583
+ files=_files,
584
+ auth_settings=_auth_settings,
585
+ collection_formats=_collection_formats,
586
+ _host=_host,
587
+ _request_auth=_request_auth
588
+ )
589
+
590
+
591
+
592
+
593
+ @validate_call
594
+ def leaderboard_service_batch_get_leaderboards(
595
+ self,
596
+ names: Annotated[Optional[List[StrictStr]], Field(description="Required. The names of the Leaderboards to retrieve. A maximum of 1000 can be specified.")] = None,
597
+ view: Annotated[Optional[StrictStr], Field(description="Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.")] = None,
598
+ _request_timeout: Union[
599
+ None,
600
+ Annotated[StrictFloat, Field(gt=0)],
601
+ Tuple[
602
+ Annotated[StrictFloat, Field(gt=0)],
603
+ Annotated[StrictFloat, Field(gt=0)]
604
+ ]
605
+ ] = None,
606
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
607
+ _content_type: Optional[StrictStr] = None,
608
+ _headers: Optional[Dict[StrictStr, Any]] = None,
609
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
610
+ ) -> V1alphaBatchGetLeaderboardsResponse:
611
+ """leaderboard_service_batch_get_leaderboards
612
+
613
+
614
+ :param names: Required. The names of the Leaderboards to retrieve. A maximum of 1000 can be specified.
615
+ :type names: List[str]
616
+ :param view: Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.
617
+ :type view: str
618
+ :param _request_timeout: timeout setting for this request. If one
619
+ number provided, it will be total request
620
+ timeout. It can also be a pair (tuple) of
621
+ (connection, read) timeouts.
622
+ :type _request_timeout: int, tuple(int, int), optional
623
+ :param _request_auth: set to override the auth_settings for an a single
624
+ request; this effectively ignores the
625
+ authentication in the spec for a single request.
626
+ :type _request_auth: dict, optional
627
+ :param _content_type: force content-type for the request.
628
+ :type _content_type: str, Optional
629
+ :param _headers: set to override the headers for a single
630
+ request; this effectively ignores the headers
631
+ in the spec for a single request.
632
+ :type _headers: dict, optional
633
+ :param _host_index: set to override the host_index for a single
634
+ request; this effectively ignores the host_index
635
+ in the spec for a single request.
636
+ :type _host_index: int, optional
637
+ :return: Returns the result object.
638
+ """ # noqa: E501
639
+
640
+ _param = self._leaderboard_service_batch_get_leaderboards_serialize(
641
+ names=names,
642
+ view=view,
643
+ _request_auth=_request_auth,
644
+ _content_type=_content_type,
645
+ _headers=_headers,
646
+ _host_index=_host_index
647
+ )
648
+
649
+ _response_types_map: Dict[str, Optional[str]] = {
650
+ '200': "V1alphaBatchGetLeaderboardsResponse",
651
+ }
652
+ response_data = self.api_client.call_api(
653
+ *_param,
654
+ _request_timeout=_request_timeout
655
+ )
656
+ response_data.read()
657
+ return self.api_client.response_deserialize(
658
+ response_data=response_data,
659
+ response_types_map=_response_types_map,
660
+ ).data
661
+
662
+
663
+ @validate_call
664
+ def leaderboard_service_batch_get_leaderboards_with_http_info(
665
+ self,
666
+ names: Annotated[Optional[List[StrictStr]], Field(description="Required. The names of the Leaderboards to retrieve. A maximum of 1000 can be specified.")] = None,
667
+ view: Annotated[Optional[StrictStr], Field(description="Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.")] = None,
668
+ _request_timeout: Union[
669
+ None,
670
+ Annotated[StrictFloat, Field(gt=0)],
671
+ Tuple[
672
+ Annotated[StrictFloat, Field(gt=0)],
673
+ Annotated[StrictFloat, Field(gt=0)]
674
+ ]
675
+ ] = None,
676
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
677
+ _content_type: Optional[StrictStr] = None,
678
+ _headers: Optional[Dict[StrictStr, Any]] = None,
679
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
680
+ ) -> ApiResponse[V1alphaBatchGetLeaderboardsResponse]:
681
+ """leaderboard_service_batch_get_leaderboards
682
+
683
+
684
+ :param names: Required. The names of the Leaderboards to retrieve. A maximum of 1000 can be specified.
685
+ :type names: List[str]
686
+ :param view: Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.
687
+ :type view: str
688
+ :param _request_timeout: timeout setting for this request. If one
689
+ number provided, it will be total request
690
+ timeout. It can also be a pair (tuple) of
691
+ (connection, read) timeouts.
692
+ :type _request_timeout: int, tuple(int, int), optional
693
+ :param _request_auth: set to override the auth_settings for an a single
694
+ request; this effectively ignores the
695
+ authentication in the spec for a single request.
696
+ :type _request_auth: dict, optional
697
+ :param _content_type: force content-type for the request.
698
+ :type _content_type: str, Optional
699
+ :param _headers: set to override the headers for a single
700
+ request; this effectively ignores the headers
701
+ in the spec for a single request.
702
+ :type _headers: dict, optional
703
+ :param _host_index: set to override the host_index for a single
704
+ request; this effectively ignores the host_index
705
+ in the spec for a single request.
706
+ :type _host_index: int, optional
707
+ :return: Returns the result object.
708
+ """ # noqa: E501
709
+
710
+ _param = self._leaderboard_service_batch_get_leaderboards_serialize(
711
+ names=names,
712
+ view=view,
713
+ _request_auth=_request_auth,
714
+ _content_type=_content_type,
715
+ _headers=_headers,
716
+ _host_index=_host_index
717
+ )
718
+
719
+ _response_types_map: Dict[str, Optional[str]] = {
720
+ '200': "V1alphaBatchGetLeaderboardsResponse",
721
+ }
722
+ response_data = self.api_client.call_api(
723
+ *_param,
724
+ _request_timeout=_request_timeout
725
+ )
726
+ response_data.read()
727
+ return self.api_client.response_deserialize(
728
+ response_data=response_data,
729
+ response_types_map=_response_types_map,
730
+ )
731
+
732
+
733
+ @validate_call
734
+ def leaderboard_service_batch_get_leaderboards_without_preload_content(
735
+ self,
736
+ names: Annotated[Optional[List[StrictStr]], Field(description="Required. The names of the Leaderboards to retrieve. A maximum of 1000 can be specified.")] = None,
737
+ view: Annotated[Optional[StrictStr], Field(description="Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.")] = None,
738
+ _request_timeout: Union[
739
+ None,
740
+ Annotated[StrictFloat, Field(gt=0)],
741
+ Tuple[
742
+ Annotated[StrictFloat, Field(gt=0)],
743
+ Annotated[StrictFloat, Field(gt=0)]
744
+ ]
745
+ ] = None,
746
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
747
+ _content_type: Optional[StrictStr] = None,
748
+ _headers: Optional[Dict[StrictStr, Any]] = None,
749
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
750
+ ) -> RESTResponseType:
751
+ """leaderboard_service_batch_get_leaderboards
752
+
753
+
754
+ :param names: Required. The names of the Leaderboards to retrieve. A maximum of 1000 can be specified.
755
+ :type names: List[str]
756
+ :param view: Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.
757
+ :type view: str
758
+ :param _request_timeout: timeout setting for this request. If one
759
+ number provided, it will be total request
760
+ timeout. It can also be a pair (tuple) of
761
+ (connection, read) timeouts.
762
+ :type _request_timeout: int, tuple(int, int), optional
763
+ :param _request_auth: set to override the auth_settings for an a single
764
+ request; this effectively ignores the
765
+ authentication in the spec for a single request.
766
+ :type _request_auth: dict, optional
767
+ :param _content_type: force content-type for the request.
768
+ :type _content_type: str, Optional
769
+ :param _headers: set to override the headers for a single
770
+ request; this effectively ignores the headers
771
+ in the spec for a single request.
772
+ :type _headers: dict, optional
773
+ :param _host_index: set to override the host_index for a single
774
+ request; this effectively ignores the host_index
775
+ in the spec for a single request.
776
+ :type _host_index: int, optional
777
+ :return: Returns the result object.
778
+ """ # noqa: E501
779
+
780
+ _param = self._leaderboard_service_batch_get_leaderboards_serialize(
781
+ names=names,
782
+ view=view,
783
+ _request_auth=_request_auth,
784
+ _content_type=_content_type,
785
+ _headers=_headers,
786
+ _host_index=_host_index
787
+ )
788
+
789
+ _response_types_map: Dict[str, Optional[str]] = {
790
+ '200': "V1alphaBatchGetLeaderboardsResponse",
791
+ }
792
+ response_data = self.api_client.call_api(
793
+ *_param,
794
+ _request_timeout=_request_timeout
795
+ )
796
+ return response_data.response
797
+
798
+
799
+ def _leaderboard_service_batch_get_leaderboards_serialize(
800
+ self,
801
+ names,
802
+ view,
803
+ _request_auth,
804
+ _content_type,
805
+ _headers,
806
+ _host_index,
807
+ ) -> RequestSerialized:
808
+
809
+ _host = None
810
+
811
+ _collection_formats: Dict[str, str] = {
812
+ 'names': 'multi',
813
+ }
814
+
815
+ _path_params: Dict[str, str] = {}
816
+ _query_params: List[Tuple[str, str]] = []
817
+ _header_params: Dict[str, Optional[str]] = _headers or {}
818
+ _form_params: List[Tuple[str, str]] = []
819
+ _files: Dict[str, Union[str, bytes]] = {}
820
+ _body_params: Optional[bytes] = None
821
+
822
+ # process the path parameters
823
+ # process the query parameters
824
+ if names is not None:
825
+
826
+ _query_params.append(('names', names))
827
+
828
+ if view is not None:
829
+
830
+ _query_params.append(('view', view))
831
+
832
+ # process the header parameters
833
+ # process the form parameters
834
+ # process the body parameter
835
+
836
+
837
+ # set the HTTP header `Accept`
838
+ _header_params['Accept'] = self.api_client.select_header_accept(
839
+ [
840
+ 'application/json'
841
+ ]
842
+ )
843
+
844
+
845
+ # authentication setting
846
+ _auth_settings: List[str] = [
847
+ ]
848
+
849
+ return self.api_client.param_serialize(
850
+ method='GET',
851
+ resource_path='/v1alpha/leaderboards:batchGet',
852
+ path_params=_path_params,
853
+ query_params=_query_params,
854
+ header_params=_header_params,
855
+ body=_body_params,
856
+ post_params=_form_params,
857
+ files=_files,
858
+ auth_settings=_auth_settings,
859
+ collection_formats=_collection_formats,
860
+ _host=_host,
861
+ _request_auth=_request_auth
862
+ )
863
+
864
+
865
+
866
+
867
+ @validate_call
868
+ def leaderboard_service_batch_import_leaderboard(
869
+ self,
870
+ body: V1alphaBatchImportLeaderboardRequest,
871
+ _request_timeout: Union[
872
+ None,
873
+ Annotated[StrictFloat, Field(gt=0)],
874
+ Tuple[
875
+ Annotated[StrictFloat, Field(gt=0)],
876
+ Annotated[StrictFloat, Field(gt=0)]
877
+ ]
878
+ ] = None,
879
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
880
+ _content_type: Optional[StrictStr] = None,
881
+ _headers: Optional[Dict[StrictStr, Any]] = None,
882
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
883
+ ) -> V1alphaBatchImportLeaderboardResponse:
884
+ """leaderboard_service_batch_import_leaderboard
885
+
886
+
887
+ :param body: (required)
888
+ :type body: V1alphaBatchImportLeaderboardRequest
889
+ :param _request_timeout: timeout setting for this request. If one
890
+ number provided, it will be total request
891
+ timeout. It can also be a pair (tuple) of
892
+ (connection, read) timeouts.
893
+ :type _request_timeout: int, tuple(int, int), optional
894
+ :param _request_auth: set to override the auth_settings for an a single
895
+ request; this effectively ignores the
896
+ authentication in the spec for a single request.
897
+ :type _request_auth: dict, optional
898
+ :param _content_type: force content-type for the request.
899
+ :type _content_type: str, Optional
900
+ :param _headers: set to override the headers for a single
901
+ request; this effectively ignores the headers
902
+ in the spec for a single request.
903
+ :type _headers: dict, optional
904
+ :param _host_index: set to override the host_index for a single
905
+ request; this effectively ignores the host_index
906
+ in the spec for a single request.
907
+ :type _host_index: int, optional
908
+ :return: Returns the result object.
909
+ """ # noqa: E501
910
+
911
+ _param = self._leaderboard_service_batch_import_leaderboard_serialize(
912
+ body=body,
913
+ _request_auth=_request_auth,
914
+ _content_type=_content_type,
915
+ _headers=_headers,
916
+ _host_index=_host_index
917
+ )
918
+
919
+ _response_types_map: Dict[str, Optional[str]] = {
920
+ '200': "V1alphaBatchImportLeaderboardResponse",
921
+ }
922
+ response_data = self.api_client.call_api(
923
+ *_param,
924
+ _request_timeout=_request_timeout
925
+ )
926
+ response_data.read()
927
+ return self.api_client.response_deserialize(
928
+ response_data=response_data,
929
+ response_types_map=_response_types_map,
930
+ ).data
931
+
932
+
933
+ @validate_call
934
+ def leaderboard_service_batch_import_leaderboard_with_http_info(
935
+ self,
936
+ body: V1alphaBatchImportLeaderboardRequest,
937
+ _request_timeout: Union[
938
+ None,
939
+ Annotated[StrictFloat, Field(gt=0)],
940
+ Tuple[
941
+ Annotated[StrictFloat, Field(gt=0)],
942
+ Annotated[StrictFloat, Field(gt=0)]
943
+ ]
944
+ ] = None,
945
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
946
+ _content_type: Optional[StrictStr] = None,
947
+ _headers: Optional[Dict[StrictStr, Any]] = None,
948
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
949
+ ) -> ApiResponse[V1alphaBatchImportLeaderboardResponse]:
950
+ """leaderboard_service_batch_import_leaderboard
951
+
952
+
953
+ :param body: (required)
954
+ :type body: V1alphaBatchImportLeaderboardRequest
955
+ :param _request_timeout: timeout setting for this request. If one
956
+ number provided, it will be total request
957
+ timeout. It can also be a pair (tuple) of
958
+ (connection, read) timeouts.
959
+ :type _request_timeout: int, tuple(int, int), optional
960
+ :param _request_auth: set to override the auth_settings for an a single
961
+ request; this effectively ignores the
962
+ authentication in the spec for a single request.
963
+ :type _request_auth: dict, optional
964
+ :param _content_type: force content-type for the request.
965
+ :type _content_type: str, Optional
966
+ :param _headers: set to override the headers for a single
967
+ request; this effectively ignores the headers
968
+ in the spec for a single request.
969
+ :type _headers: dict, optional
970
+ :param _host_index: set to override the host_index for a single
971
+ request; this effectively ignores the host_index
972
+ in the spec for a single request.
973
+ :type _host_index: int, optional
974
+ :return: Returns the result object.
975
+ """ # noqa: E501
976
+
977
+ _param = self._leaderboard_service_batch_import_leaderboard_serialize(
978
+ body=body,
979
+ _request_auth=_request_auth,
980
+ _content_type=_content_type,
981
+ _headers=_headers,
982
+ _host_index=_host_index
983
+ )
984
+
985
+ _response_types_map: Dict[str, Optional[str]] = {
986
+ '200': "V1alphaBatchImportLeaderboardResponse",
987
+ }
988
+ response_data = self.api_client.call_api(
989
+ *_param,
990
+ _request_timeout=_request_timeout
991
+ )
992
+ response_data.read()
993
+ return self.api_client.response_deserialize(
994
+ response_data=response_data,
995
+ response_types_map=_response_types_map,
996
+ )
997
+
998
+
999
+ @validate_call
1000
+ def leaderboard_service_batch_import_leaderboard_without_preload_content(
1001
+ self,
1002
+ body: V1alphaBatchImportLeaderboardRequest,
1003
+ _request_timeout: Union[
1004
+ None,
1005
+ Annotated[StrictFloat, Field(gt=0)],
1006
+ Tuple[
1007
+ Annotated[StrictFloat, Field(gt=0)],
1008
+ Annotated[StrictFloat, Field(gt=0)]
1009
+ ]
1010
+ ] = None,
1011
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1012
+ _content_type: Optional[StrictStr] = None,
1013
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1014
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1015
+ ) -> RESTResponseType:
1016
+ """leaderboard_service_batch_import_leaderboard
1017
+
1018
+
1019
+ :param body: (required)
1020
+ :type body: V1alphaBatchImportLeaderboardRequest
1021
+ :param _request_timeout: timeout setting for this request. If one
1022
+ number provided, it will be total request
1023
+ timeout. It can also be a pair (tuple) of
1024
+ (connection, read) timeouts.
1025
+ :type _request_timeout: int, tuple(int, int), optional
1026
+ :param _request_auth: set to override the auth_settings for an a single
1027
+ request; this effectively ignores the
1028
+ authentication in the spec for a single request.
1029
+ :type _request_auth: dict, optional
1030
+ :param _content_type: force content-type for the request.
1031
+ :type _content_type: str, Optional
1032
+ :param _headers: set to override the headers for a single
1033
+ request; this effectively ignores the headers
1034
+ in the spec for a single request.
1035
+ :type _headers: dict, optional
1036
+ :param _host_index: set to override the host_index for a single
1037
+ request; this effectively ignores the host_index
1038
+ in the spec for a single request.
1039
+ :type _host_index: int, optional
1040
+ :return: Returns the result object.
1041
+ """ # noqa: E501
1042
+
1043
+ _param = self._leaderboard_service_batch_import_leaderboard_serialize(
1044
+ body=body,
1045
+ _request_auth=_request_auth,
1046
+ _content_type=_content_type,
1047
+ _headers=_headers,
1048
+ _host_index=_host_index
1049
+ )
1050
+
1051
+ _response_types_map: Dict[str, Optional[str]] = {
1052
+ '200': "V1alphaBatchImportLeaderboardResponse",
1053
+ }
1054
+ response_data = self.api_client.call_api(
1055
+ *_param,
1056
+ _request_timeout=_request_timeout
1057
+ )
1058
+ return response_data.response
1059
+
1060
+
1061
+ def _leaderboard_service_batch_import_leaderboard_serialize(
1062
+ self,
1063
+ body,
1064
+ _request_auth,
1065
+ _content_type,
1066
+ _headers,
1067
+ _host_index,
1068
+ ) -> RequestSerialized:
1069
+
1070
+ _host = None
1071
+
1072
+ _collection_formats: Dict[str, str] = {
1073
+ }
1074
+
1075
+ _path_params: Dict[str, str] = {}
1076
+ _query_params: List[Tuple[str, str]] = []
1077
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1078
+ _form_params: List[Tuple[str, str]] = []
1079
+ _files: Dict[str, Union[str, bytes]] = {}
1080
+ _body_params: Optional[bytes] = None
1081
+
1082
+ # process the path parameters
1083
+ # process the query parameters
1084
+ # process the header parameters
1085
+ # process the form parameters
1086
+ # process the body parameter
1087
+ if body is not None:
1088
+ _body_params = body
1089
+
1090
+
1091
+ # set the HTTP header `Accept`
1092
+ _header_params['Accept'] = self.api_client.select_header_accept(
1093
+ [
1094
+ 'application/json'
1095
+ ]
1096
+ )
1097
+
1098
+ # set the HTTP header `Content-Type`
1099
+ if _content_type:
1100
+ _header_params['Content-Type'] = _content_type
1101
+ else:
1102
+ _default_content_type = (
1103
+ self.api_client.select_header_content_type(
1104
+ [
1105
+ 'application/json'
1106
+ ]
1107
+ )
1108
+ )
1109
+ if _default_content_type is not None:
1110
+ _header_params['Content-Type'] = _default_content_type
1111
+
1112
+ # authentication setting
1113
+ _auth_settings: List[str] = [
1114
+ ]
1115
+
1116
+ return self.api_client.param_serialize(
1117
+ method='POST',
1118
+ resource_path='/v1alpha/leaderboards:batchImport',
1119
+ path_params=_path_params,
1120
+ query_params=_query_params,
1121
+ header_params=_header_params,
1122
+ body=_body_params,
1123
+ post_params=_form_params,
1124
+ files=_files,
1125
+ auth_settings=_auth_settings,
1126
+ collection_formats=_collection_formats,
1127
+ _host=_host,
1128
+ _request_auth=_request_auth
1129
+ )
1130
+
1131
+
1132
+
1133
+
1134
+ @validate_call
1135
+ def leaderboard_service_create_leaderboard(
1136
+ self,
1137
+ leaderboard: Annotated[V1alphaLeaderboard, Field(description="Required. The Leaderboard to create.")],
1138
+ _request_timeout: Union[
1139
+ None,
1140
+ Annotated[StrictFloat, Field(gt=0)],
1141
+ Tuple[
1142
+ Annotated[StrictFloat, Field(gt=0)],
1143
+ Annotated[StrictFloat, Field(gt=0)]
1144
+ ]
1145
+ ] = None,
1146
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1147
+ _content_type: Optional[StrictStr] = None,
1148
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1149
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1150
+ ) -> V1alphaCreateLeaderboardResponse:
1151
+ """leaderboard_service_create_leaderboard
1152
+
1153
+
1154
+ :param leaderboard: Required. The Leaderboard to create. (required)
1155
+ :type leaderboard: V1alphaLeaderboard
1156
+ :param _request_timeout: timeout setting for this request. If one
1157
+ number provided, it will be total request
1158
+ timeout. It can also be a pair (tuple) of
1159
+ (connection, read) timeouts.
1160
+ :type _request_timeout: int, tuple(int, int), optional
1161
+ :param _request_auth: set to override the auth_settings for an a single
1162
+ request; this effectively ignores the
1163
+ authentication in the spec for a single request.
1164
+ :type _request_auth: dict, optional
1165
+ :param _content_type: force content-type for the request.
1166
+ :type _content_type: str, Optional
1167
+ :param _headers: set to override the headers for a single
1168
+ request; this effectively ignores the headers
1169
+ in the spec for a single request.
1170
+ :type _headers: dict, optional
1171
+ :param _host_index: set to override the host_index for a single
1172
+ request; this effectively ignores the host_index
1173
+ in the spec for a single request.
1174
+ :type _host_index: int, optional
1175
+ :return: Returns the result object.
1176
+ """ # noqa: E501
1177
+
1178
+ _param = self._leaderboard_service_create_leaderboard_serialize(
1179
+ leaderboard=leaderboard,
1180
+ _request_auth=_request_auth,
1181
+ _content_type=_content_type,
1182
+ _headers=_headers,
1183
+ _host_index=_host_index
1184
+ )
1185
+
1186
+ _response_types_map: Dict[str, Optional[str]] = {
1187
+ '200': "V1alphaCreateLeaderboardResponse",
1188
+ }
1189
+ response_data = self.api_client.call_api(
1190
+ *_param,
1191
+ _request_timeout=_request_timeout
1192
+ )
1193
+ response_data.read()
1194
+ return self.api_client.response_deserialize(
1195
+ response_data=response_data,
1196
+ response_types_map=_response_types_map,
1197
+ ).data
1198
+
1199
+
1200
+ @validate_call
1201
+ def leaderboard_service_create_leaderboard_with_http_info(
1202
+ self,
1203
+ leaderboard: Annotated[V1alphaLeaderboard, Field(description="Required. The Leaderboard to create.")],
1204
+ _request_timeout: Union[
1205
+ None,
1206
+ Annotated[StrictFloat, Field(gt=0)],
1207
+ Tuple[
1208
+ Annotated[StrictFloat, Field(gt=0)],
1209
+ Annotated[StrictFloat, Field(gt=0)]
1210
+ ]
1211
+ ] = None,
1212
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1213
+ _content_type: Optional[StrictStr] = None,
1214
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1215
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1216
+ ) -> ApiResponse[V1alphaCreateLeaderboardResponse]:
1217
+ """leaderboard_service_create_leaderboard
1218
+
1219
+
1220
+ :param leaderboard: Required. The Leaderboard to create. (required)
1221
+ :type leaderboard: V1alphaLeaderboard
1222
+ :param _request_timeout: timeout setting for this request. If one
1223
+ number provided, it will be total request
1224
+ timeout. It can also be a pair (tuple) of
1225
+ (connection, read) timeouts.
1226
+ :type _request_timeout: int, tuple(int, int), optional
1227
+ :param _request_auth: set to override the auth_settings for an a single
1228
+ request; this effectively ignores the
1229
+ authentication in the spec for a single request.
1230
+ :type _request_auth: dict, optional
1231
+ :param _content_type: force content-type for the request.
1232
+ :type _content_type: str, Optional
1233
+ :param _headers: set to override the headers for a single
1234
+ request; this effectively ignores the headers
1235
+ in the spec for a single request.
1236
+ :type _headers: dict, optional
1237
+ :param _host_index: set to override the host_index for a single
1238
+ request; this effectively ignores the host_index
1239
+ in the spec for a single request.
1240
+ :type _host_index: int, optional
1241
+ :return: Returns the result object.
1242
+ """ # noqa: E501
1243
+
1244
+ _param = self._leaderboard_service_create_leaderboard_serialize(
1245
+ leaderboard=leaderboard,
1246
+ _request_auth=_request_auth,
1247
+ _content_type=_content_type,
1248
+ _headers=_headers,
1249
+ _host_index=_host_index
1250
+ )
1251
+
1252
+ _response_types_map: Dict[str, Optional[str]] = {
1253
+ '200': "V1alphaCreateLeaderboardResponse",
1254
+ }
1255
+ response_data = self.api_client.call_api(
1256
+ *_param,
1257
+ _request_timeout=_request_timeout
1258
+ )
1259
+ response_data.read()
1260
+ return self.api_client.response_deserialize(
1261
+ response_data=response_data,
1262
+ response_types_map=_response_types_map,
1263
+ )
1264
+
1265
+
1266
+ @validate_call
1267
+ def leaderboard_service_create_leaderboard_without_preload_content(
1268
+ self,
1269
+ leaderboard: Annotated[V1alphaLeaderboard, Field(description="Required. The Leaderboard to create.")],
1270
+ _request_timeout: Union[
1271
+ None,
1272
+ Annotated[StrictFloat, Field(gt=0)],
1273
+ Tuple[
1274
+ Annotated[StrictFloat, Field(gt=0)],
1275
+ Annotated[StrictFloat, Field(gt=0)]
1276
+ ]
1277
+ ] = None,
1278
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1279
+ _content_type: Optional[StrictStr] = None,
1280
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1281
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1282
+ ) -> RESTResponseType:
1283
+ """leaderboard_service_create_leaderboard
1284
+
1285
+
1286
+ :param leaderboard: Required. The Leaderboard to create. (required)
1287
+ :type leaderboard: V1alphaLeaderboard
1288
+ :param _request_timeout: timeout setting for this request. If one
1289
+ number provided, it will be total request
1290
+ timeout. It can also be a pair (tuple) of
1291
+ (connection, read) timeouts.
1292
+ :type _request_timeout: int, tuple(int, int), optional
1293
+ :param _request_auth: set to override the auth_settings for an a single
1294
+ request; this effectively ignores the
1295
+ authentication in the spec for a single request.
1296
+ :type _request_auth: dict, optional
1297
+ :param _content_type: force content-type for the request.
1298
+ :type _content_type: str, Optional
1299
+ :param _headers: set to override the headers for a single
1300
+ request; this effectively ignores the headers
1301
+ in the spec for a single request.
1302
+ :type _headers: dict, optional
1303
+ :param _host_index: set to override the host_index for a single
1304
+ request; this effectively ignores the host_index
1305
+ in the spec for a single request.
1306
+ :type _host_index: int, optional
1307
+ :return: Returns the result object.
1308
+ """ # noqa: E501
1309
+
1310
+ _param = self._leaderboard_service_create_leaderboard_serialize(
1311
+ leaderboard=leaderboard,
1312
+ _request_auth=_request_auth,
1313
+ _content_type=_content_type,
1314
+ _headers=_headers,
1315
+ _host_index=_host_index
1316
+ )
1317
+
1318
+ _response_types_map: Dict[str, Optional[str]] = {
1319
+ '200': "V1alphaCreateLeaderboardResponse",
1320
+ }
1321
+ response_data = self.api_client.call_api(
1322
+ *_param,
1323
+ _request_timeout=_request_timeout
1324
+ )
1325
+ return response_data.response
1326
+
1327
+
1328
+ def _leaderboard_service_create_leaderboard_serialize(
1329
+ self,
1330
+ leaderboard,
1331
+ _request_auth,
1332
+ _content_type,
1333
+ _headers,
1334
+ _host_index,
1335
+ ) -> RequestSerialized:
1336
+
1337
+ _host = None
1338
+
1339
+ _collection_formats: Dict[str, str] = {
1340
+ }
1341
+
1342
+ _path_params: Dict[str, str] = {}
1343
+ _query_params: List[Tuple[str, str]] = []
1344
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1345
+ _form_params: List[Tuple[str, str]] = []
1346
+ _files: Dict[str, Union[str, bytes]] = {}
1347
+ _body_params: Optional[bytes] = None
1348
+
1349
+ # process the path parameters
1350
+ # process the query parameters
1351
+ # process the header parameters
1352
+ # process the form parameters
1353
+ # process the body parameter
1354
+ if leaderboard is not None:
1355
+ _body_params = leaderboard
1356
+
1357
+
1358
+ # set the HTTP header `Accept`
1359
+ _header_params['Accept'] = self.api_client.select_header_accept(
1360
+ [
1361
+ 'application/json'
1362
+ ]
1363
+ )
1364
+
1365
+ # set the HTTP header `Content-Type`
1366
+ if _content_type:
1367
+ _header_params['Content-Type'] = _content_type
1368
+ else:
1369
+ _default_content_type = (
1370
+ self.api_client.select_header_content_type(
1371
+ [
1372
+ 'application/json'
1373
+ ]
1374
+ )
1375
+ )
1376
+ if _default_content_type is not None:
1377
+ _header_params['Content-Type'] = _default_content_type
1378
+
1379
+ # authentication setting
1380
+ _auth_settings: List[str] = [
1381
+ ]
1382
+
1383
+ return self.api_client.param_serialize(
1384
+ method='POST',
1385
+ resource_path='/v1alpha/leaderboards',
1386
+ path_params=_path_params,
1387
+ query_params=_query_params,
1388
+ header_params=_header_params,
1389
+ body=_body_params,
1390
+ post_params=_form_params,
1391
+ files=_files,
1392
+ auth_settings=_auth_settings,
1393
+ collection_formats=_collection_formats,
1394
+ _host=_host,
1395
+ _request_auth=_request_auth
1396
+ )
1397
+
1398
+
1399
+
1400
+
1401
+ @validate_call
1402
+ def leaderboard_service_create_leaderboard_without_cache(
1403
+ self,
1404
+ leaderboard: Annotated[V1alphaLeaderboard, Field(description="Required. The Leaderboard to create.")],
1405
+ _request_timeout: Union[
1406
+ None,
1407
+ Annotated[StrictFloat, Field(gt=0)],
1408
+ Tuple[
1409
+ Annotated[StrictFloat, Field(gt=0)],
1410
+ Annotated[StrictFloat, Field(gt=0)]
1411
+ ]
1412
+ ] = None,
1413
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1414
+ _content_type: Optional[StrictStr] = None,
1415
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1416
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1417
+ ) -> V1alphaCreateLeaderboardWithoutCacheResponse:
1418
+ """leaderboard_service_create_leaderboard_without_cache
1419
+
1420
+
1421
+ :param leaderboard: Required. The Leaderboard to create. (required)
1422
+ :type leaderboard: V1alphaLeaderboard
1423
+ :param _request_timeout: timeout setting for this request. If one
1424
+ number provided, it will be total request
1425
+ timeout. It can also be a pair (tuple) of
1426
+ (connection, read) timeouts.
1427
+ :type _request_timeout: int, tuple(int, int), optional
1428
+ :param _request_auth: set to override the auth_settings for an a single
1429
+ request; this effectively ignores the
1430
+ authentication in the spec for a single request.
1431
+ :type _request_auth: dict, optional
1432
+ :param _content_type: force content-type for the request.
1433
+ :type _content_type: str, Optional
1434
+ :param _headers: set to override the headers for a single
1435
+ request; this effectively ignores the headers
1436
+ in the spec for a single request.
1437
+ :type _headers: dict, optional
1438
+ :param _host_index: set to override the host_index for a single
1439
+ request; this effectively ignores the host_index
1440
+ in the spec for a single request.
1441
+ :type _host_index: int, optional
1442
+ :return: Returns the result object.
1443
+ """ # noqa: E501
1444
+
1445
+ _param = self._leaderboard_service_create_leaderboard_without_cache_serialize(
1446
+ leaderboard=leaderboard,
1447
+ _request_auth=_request_auth,
1448
+ _content_type=_content_type,
1449
+ _headers=_headers,
1450
+ _host_index=_host_index
1451
+ )
1452
+
1453
+ _response_types_map: Dict[str, Optional[str]] = {
1454
+ '200': "V1alphaCreateLeaderboardWithoutCacheResponse",
1455
+ }
1456
+ response_data = self.api_client.call_api(
1457
+ *_param,
1458
+ _request_timeout=_request_timeout
1459
+ )
1460
+ response_data.read()
1461
+ return self.api_client.response_deserialize(
1462
+ response_data=response_data,
1463
+ response_types_map=_response_types_map,
1464
+ ).data
1465
+
1466
+
1467
+ @validate_call
1468
+ def leaderboard_service_create_leaderboard_without_cache_with_http_info(
1469
+ self,
1470
+ leaderboard: Annotated[V1alphaLeaderboard, Field(description="Required. The Leaderboard to create.")],
1471
+ _request_timeout: Union[
1472
+ None,
1473
+ Annotated[StrictFloat, Field(gt=0)],
1474
+ Tuple[
1475
+ Annotated[StrictFloat, Field(gt=0)],
1476
+ Annotated[StrictFloat, Field(gt=0)]
1477
+ ]
1478
+ ] = None,
1479
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1480
+ _content_type: Optional[StrictStr] = None,
1481
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1482
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1483
+ ) -> ApiResponse[V1alphaCreateLeaderboardWithoutCacheResponse]:
1484
+ """leaderboard_service_create_leaderboard_without_cache
1485
+
1486
+
1487
+ :param leaderboard: Required. The Leaderboard to create. (required)
1488
+ :type leaderboard: V1alphaLeaderboard
1489
+ :param _request_timeout: timeout setting for this request. If one
1490
+ number provided, it will be total request
1491
+ timeout. It can also be a pair (tuple) of
1492
+ (connection, read) timeouts.
1493
+ :type _request_timeout: int, tuple(int, int), optional
1494
+ :param _request_auth: set to override the auth_settings for an a single
1495
+ request; this effectively ignores the
1496
+ authentication in the spec for a single request.
1497
+ :type _request_auth: dict, optional
1498
+ :param _content_type: force content-type for the request.
1499
+ :type _content_type: str, Optional
1500
+ :param _headers: set to override the headers for a single
1501
+ request; this effectively ignores the headers
1502
+ in the spec for a single request.
1503
+ :type _headers: dict, optional
1504
+ :param _host_index: set to override the host_index for a single
1505
+ request; this effectively ignores the host_index
1506
+ in the spec for a single request.
1507
+ :type _host_index: int, optional
1508
+ :return: Returns the result object.
1509
+ """ # noqa: E501
1510
+
1511
+ _param = self._leaderboard_service_create_leaderboard_without_cache_serialize(
1512
+ leaderboard=leaderboard,
1513
+ _request_auth=_request_auth,
1514
+ _content_type=_content_type,
1515
+ _headers=_headers,
1516
+ _host_index=_host_index
1517
+ )
1518
+
1519
+ _response_types_map: Dict[str, Optional[str]] = {
1520
+ '200': "V1alphaCreateLeaderboardWithoutCacheResponse",
1521
+ }
1522
+ response_data = self.api_client.call_api(
1523
+ *_param,
1524
+ _request_timeout=_request_timeout
1525
+ )
1526
+ response_data.read()
1527
+ return self.api_client.response_deserialize(
1528
+ response_data=response_data,
1529
+ response_types_map=_response_types_map,
1530
+ )
1531
+
1532
+
1533
+ @validate_call
1534
+ def leaderboard_service_create_leaderboard_without_cache_without_preload_content(
1535
+ self,
1536
+ leaderboard: Annotated[V1alphaLeaderboard, Field(description="Required. The Leaderboard to create.")],
1537
+ _request_timeout: Union[
1538
+ None,
1539
+ Annotated[StrictFloat, Field(gt=0)],
1540
+ Tuple[
1541
+ Annotated[StrictFloat, Field(gt=0)],
1542
+ Annotated[StrictFloat, Field(gt=0)]
1543
+ ]
1544
+ ] = None,
1545
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1546
+ _content_type: Optional[StrictStr] = None,
1547
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1548
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1549
+ ) -> RESTResponseType:
1550
+ """leaderboard_service_create_leaderboard_without_cache
1551
+
1552
+
1553
+ :param leaderboard: Required. The Leaderboard to create. (required)
1554
+ :type leaderboard: V1alphaLeaderboard
1555
+ :param _request_timeout: timeout setting for this request. If one
1556
+ number provided, it will be total request
1557
+ timeout. It can also be a pair (tuple) of
1558
+ (connection, read) timeouts.
1559
+ :type _request_timeout: int, tuple(int, int), optional
1560
+ :param _request_auth: set to override the auth_settings for an a single
1561
+ request; this effectively ignores the
1562
+ authentication in the spec for a single request.
1563
+ :type _request_auth: dict, optional
1564
+ :param _content_type: force content-type for the request.
1565
+ :type _content_type: str, Optional
1566
+ :param _headers: set to override the headers for a single
1567
+ request; this effectively ignores the headers
1568
+ in the spec for a single request.
1569
+ :type _headers: dict, optional
1570
+ :param _host_index: set to override the host_index for a single
1571
+ request; this effectively ignores the host_index
1572
+ in the spec for a single request.
1573
+ :type _host_index: int, optional
1574
+ :return: Returns the result object.
1575
+ """ # noqa: E501
1576
+
1577
+ _param = self._leaderboard_service_create_leaderboard_without_cache_serialize(
1578
+ leaderboard=leaderboard,
1579
+ _request_auth=_request_auth,
1580
+ _content_type=_content_type,
1581
+ _headers=_headers,
1582
+ _host_index=_host_index
1583
+ )
1584
+
1585
+ _response_types_map: Dict[str, Optional[str]] = {
1586
+ '200': "V1alphaCreateLeaderboardWithoutCacheResponse",
1587
+ }
1588
+ response_data = self.api_client.call_api(
1589
+ *_param,
1590
+ _request_timeout=_request_timeout
1591
+ )
1592
+ return response_data.response
1593
+
1594
+
1595
+ def _leaderboard_service_create_leaderboard_without_cache_serialize(
1596
+ self,
1597
+ leaderboard,
1598
+ _request_auth,
1599
+ _content_type,
1600
+ _headers,
1601
+ _host_index,
1602
+ ) -> RequestSerialized:
1603
+
1604
+ _host = None
1605
+
1606
+ _collection_formats: Dict[str, str] = {
1607
+ }
1608
+
1609
+ _path_params: Dict[str, str] = {}
1610
+ _query_params: List[Tuple[str, str]] = []
1611
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1612
+ _form_params: List[Tuple[str, str]] = []
1613
+ _files: Dict[str, Union[str, bytes]] = {}
1614
+ _body_params: Optional[bytes] = None
1615
+
1616
+ # process the path parameters
1617
+ # process the query parameters
1618
+ # process the header parameters
1619
+ # process the form parameters
1620
+ # process the body parameter
1621
+ if leaderboard is not None:
1622
+ _body_params = leaderboard
1623
+
1624
+
1625
+ # set the HTTP header `Accept`
1626
+ _header_params['Accept'] = self.api_client.select_header_accept(
1627
+ [
1628
+ 'application/json'
1629
+ ]
1630
+ )
1631
+
1632
+ # set the HTTP header `Content-Type`
1633
+ if _content_type:
1634
+ _header_params['Content-Type'] = _content_type
1635
+ else:
1636
+ _default_content_type = (
1637
+ self.api_client.select_header_content_type(
1638
+ [
1639
+ 'application/json'
1640
+ ]
1641
+ )
1642
+ )
1643
+ if _default_content_type is not None:
1644
+ _header_params['Content-Type'] = _default_content_type
1645
+
1646
+ # authentication setting
1647
+ _auth_settings: List[str] = [
1648
+ ]
1649
+
1650
+ return self.api_client.param_serialize(
1651
+ method='POST',
1652
+ resource_path='/v1alpha/leaderboards:withoutCache',
1653
+ path_params=_path_params,
1654
+ query_params=_query_params,
1655
+ header_params=_header_params,
1656
+ body=_body_params,
1657
+ post_params=_form_params,
1658
+ files=_files,
1659
+ auth_settings=_auth_settings,
1660
+ collection_formats=_collection_formats,
1661
+ _host=_host,
1662
+ _request_auth=_request_auth
1663
+ )
1664
+
1665
+
1666
+
1667
+
1668
+ @validate_call
1669
+ def leaderboard_service_delete_leaderboard(
1670
+ self,
1671
+ name_3: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to delete.")],
1672
+ _request_timeout: Union[
1673
+ None,
1674
+ Annotated[StrictFloat, Field(gt=0)],
1675
+ Tuple[
1676
+ Annotated[StrictFloat, Field(gt=0)],
1677
+ Annotated[StrictFloat, Field(gt=0)]
1678
+ ]
1679
+ ] = None,
1680
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1681
+ _content_type: Optional[StrictStr] = None,
1682
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1683
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1684
+ ) -> V1alphaDeleteLeaderboardResponse:
1685
+ """leaderboard_service_delete_leaderboard
1686
+
1687
+
1688
+ :param name_3: Required. The name of the Leaderboard to delete. (required)
1689
+ :type name_3: str
1690
+ :param _request_timeout: timeout setting for this request. If one
1691
+ number provided, it will be total request
1692
+ timeout. It can also be a pair (tuple) of
1693
+ (connection, read) timeouts.
1694
+ :type _request_timeout: int, tuple(int, int), optional
1695
+ :param _request_auth: set to override the auth_settings for an a single
1696
+ request; this effectively ignores the
1697
+ authentication in the spec for a single request.
1698
+ :type _request_auth: dict, optional
1699
+ :param _content_type: force content-type for the request.
1700
+ :type _content_type: str, Optional
1701
+ :param _headers: set to override the headers for a single
1702
+ request; this effectively ignores the headers
1703
+ in the spec for a single request.
1704
+ :type _headers: dict, optional
1705
+ :param _host_index: set to override the host_index for a single
1706
+ request; this effectively ignores the host_index
1707
+ in the spec for a single request.
1708
+ :type _host_index: int, optional
1709
+ :return: Returns the result object.
1710
+ """ # noqa: E501
1711
+
1712
+ _param = self._leaderboard_service_delete_leaderboard_serialize(
1713
+ name_3=name_3,
1714
+ _request_auth=_request_auth,
1715
+ _content_type=_content_type,
1716
+ _headers=_headers,
1717
+ _host_index=_host_index
1718
+ )
1719
+
1720
+ _response_types_map: Dict[str, Optional[str]] = {
1721
+ '200': "V1alphaDeleteLeaderboardResponse",
1722
+ }
1723
+ response_data = self.api_client.call_api(
1724
+ *_param,
1725
+ _request_timeout=_request_timeout
1726
+ )
1727
+ response_data.read()
1728
+ return self.api_client.response_deserialize(
1729
+ response_data=response_data,
1730
+ response_types_map=_response_types_map,
1731
+ ).data
1732
+
1733
+
1734
+ @validate_call
1735
+ def leaderboard_service_delete_leaderboard_with_http_info(
1736
+ self,
1737
+ name_3: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to delete.")],
1738
+ _request_timeout: Union[
1739
+ None,
1740
+ Annotated[StrictFloat, Field(gt=0)],
1741
+ Tuple[
1742
+ Annotated[StrictFloat, Field(gt=0)],
1743
+ Annotated[StrictFloat, Field(gt=0)]
1744
+ ]
1745
+ ] = None,
1746
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1747
+ _content_type: Optional[StrictStr] = None,
1748
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1749
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1750
+ ) -> ApiResponse[V1alphaDeleteLeaderboardResponse]:
1751
+ """leaderboard_service_delete_leaderboard
1752
+
1753
+
1754
+ :param name_3: Required. The name of the Leaderboard to delete. (required)
1755
+ :type name_3: str
1756
+ :param _request_timeout: timeout setting for this request. If one
1757
+ number provided, it will be total request
1758
+ timeout. It can also be a pair (tuple) of
1759
+ (connection, read) timeouts.
1760
+ :type _request_timeout: int, tuple(int, int), optional
1761
+ :param _request_auth: set to override the auth_settings for an a single
1762
+ request; this effectively ignores the
1763
+ authentication in the spec for a single request.
1764
+ :type _request_auth: dict, optional
1765
+ :param _content_type: force content-type for the request.
1766
+ :type _content_type: str, Optional
1767
+ :param _headers: set to override the headers for a single
1768
+ request; this effectively ignores the headers
1769
+ in the spec for a single request.
1770
+ :type _headers: dict, optional
1771
+ :param _host_index: set to override the host_index for a single
1772
+ request; this effectively ignores the host_index
1773
+ in the spec for a single request.
1774
+ :type _host_index: int, optional
1775
+ :return: Returns the result object.
1776
+ """ # noqa: E501
1777
+
1778
+ _param = self._leaderboard_service_delete_leaderboard_serialize(
1779
+ name_3=name_3,
1780
+ _request_auth=_request_auth,
1781
+ _content_type=_content_type,
1782
+ _headers=_headers,
1783
+ _host_index=_host_index
1784
+ )
1785
+
1786
+ _response_types_map: Dict[str, Optional[str]] = {
1787
+ '200': "V1alphaDeleteLeaderboardResponse",
1788
+ }
1789
+ response_data = self.api_client.call_api(
1790
+ *_param,
1791
+ _request_timeout=_request_timeout
1792
+ )
1793
+ response_data.read()
1794
+ return self.api_client.response_deserialize(
1795
+ response_data=response_data,
1796
+ response_types_map=_response_types_map,
1797
+ )
1798
+
1799
+
1800
+ @validate_call
1801
+ def leaderboard_service_delete_leaderboard_without_preload_content(
1802
+ self,
1803
+ name_3: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to delete.")],
1804
+ _request_timeout: Union[
1805
+ None,
1806
+ Annotated[StrictFloat, Field(gt=0)],
1807
+ Tuple[
1808
+ Annotated[StrictFloat, Field(gt=0)],
1809
+ Annotated[StrictFloat, Field(gt=0)]
1810
+ ]
1811
+ ] = None,
1812
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1813
+ _content_type: Optional[StrictStr] = None,
1814
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1815
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1816
+ ) -> RESTResponseType:
1817
+ """leaderboard_service_delete_leaderboard
1818
+
1819
+
1820
+ :param name_3: Required. The name of the Leaderboard to delete. (required)
1821
+ :type name_3: str
1822
+ :param _request_timeout: timeout setting for this request. If one
1823
+ number provided, it will be total request
1824
+ timeout. It can also be a pair (tuple) of
1825
+ (connection, read) timeouts.
1826
+ :type _request_timeout: int, tuple(int, int), optional
1827
+ :param _request_auth: set to override the auth_settings for an a single
1828
+ request; this effectively ignores the
1829
+ authentication in the spec for a single request.
1830
+ :type _request_auth: dict, optional
1831
+ :param _content_type: force content-type for the request.
1832
+ :type _content_type: str, Optional
1833
+ :param _headers: set to override the headers for a single
1834
+ request; this effectively ignores the headers
1835
+ in the spec for a single request.
1836
+ :type _headers: dict, optional
1837
+ :param _host_index: set to override the host_index for a single
1838
+ request; this effectively ignores the host_index
1839
+ in the spec for a single request.
1840
+ :type _host_index: int, optional
1841
+ :return: Returns the result object.
1842
+ """ # noqa: E501
1843
+
1844
+ _param = self._leaderboard_service_delete_leaderboard_serialize(
1845
+ name_3=name_3,
1846
+ _request_auth=_request_auth,
1847
+ _content_type=_content_type,
1848
+ _headers=_headers,
1849
+ _host_index=_host_index
1850
+ )
1851
+
1852
+ _response_types_map: Dict[str, Optional[str]] = {
1853
+ '200': "V1alphaDeleteLeaderboardResponse",
1854
+ }
1855
+ response_data = self.api_client.call_api(
1856
+ *_param,
1857
+ _request_timeout=_request_timeout
1858
+ )
1859
+ return response_data.response
1860
+
1861
+
1862
+ def _leaderboard_service_delete_leaderboard_serialize(
1863
+ self,
1864
+ name_3,
1865
+ _request_auth,
1866
+ _content_type,
1867
+ _headers,
1868
+ _host_index,
1869
+ ) -> RequestSerialized:
1870
+
1871
+ _host = None
1872
+
1873
+ _collection_formats: Dict[str, str] = {
1874
+ }
1875
+
1876
+ _path_params: Dict[str, str] = {}
1877
+ _query_params: List[Tuple[str, str]] = []
1878
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1879
+ _form_params: List[Tuple[str, str]] = []
1880
+ _files: Dict[str, Union[str, bytes]] = {}
1881
+ _body_params: Optional[bytes] = None
1882
+
1883
+ # process the path parameters
1884
+ if name_3 is not None:
1885
+ _path_params['name_3'] = name_3
1886
+ # process the query parameters
1887
+ # process the header parameters
1888
+ # process the form parameters
1889
+ # process the body parameter
1890
+
1891
+
1892
+ # set the HTTP header `Accept`
1893
+ _header_params['Accept'] = self.api_client.select_header_accept(
1894
+ [
1895
+ 'application/json'
1896
+ ]
1897
+ )
1898
+
1899
+
1900
+ # authentication setting
1901
+ _auth_settings: List[str] = [
1902
+ ]
1903
+
1904
+ return self.api_client.param_serialize(
1905
+ method='DELETE',
1906
+ resource_path='/v1alpha/{name_3}',
1907
+ path_params=_path_params,
1908
+ query_params=_query_params,
1909
+ header_params=_header_params,
1910
+ body=_body_params,
1911
+ post_params=_form_params,
1912
+ files=_files,
1913
+ auth_settings=_auth_settings,
1914
+ collection_formats=_collection_formats,
1915
+ _host=_host,
1916
+ _request_auth=_request_auth
1917
+ )
1918
+
1919
+
1920
+
1921
+
1922
+ @validate_call
1923
+ def leaderboard_service_get_leaderboard(
1924
+ self,
1925
+ name_3: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to retrieve.")],
1926
+ _request_timeout: Union[
1927
+ None,
1928
+ Annotated[StrictFloat, Field(gt=0)],
1929
+ Tuple[
1930
+ Annotated[StrictFloat, Field(gt=0)],
1931
+ Annotated[StrictFloat, Field(gt=0)]
1932
+ ]
1933
+ ] = None,
1934
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1935
+ _content_type: Optional[StrictStr] = None,
1936
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1937
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1938
+ ) -> V1alphaGetLeaderboardResponse:
1939
+ """leaderboard_service_get_leaderboard
1940
+
1941
+
1942
+ :param name_3: Required. The name of the Leaderboard to retrieve. (required)
1943
+ :type name_3: str
1944
+ :param _request_timeout: timeout setting for this request. If one
1945
+ number provided, it will be total request
1946
+ timeout. It can also be a pair (tuple) of
1947
+ (connection, read) timeouts.
1948
+ :type _request_timeout: int, tuple(int, int), optional
1949
+ :param _request_auth: set to override the auth_settings for an a single
1950
+ request; this effectively ignores the
1951
+ authentication in the spec for a single request.
1952
+ :type _request_auth: dict, optional
1953
+ :param _content_type: force content-type for the request.
1954
+ :type _content_type: str, Optional
1955
+ :param _headers: set to override the headers for a single
1956
+ request; this effectively ignores the headers
1957
+ in the spec for a single request.
1958
+ :type _headers: dict, optional
1959
+ :param _host_index: set to override the host_index for a single
1960
+ request; this effectively ignores the host_index
1961
+ in the spec for a single request.
1962
+ :type _host_index: int, optional
1963
+ :return: Returns the result object.
1964
+ """ # noqa: E501
1965
+
1966
+ _param = self._leaderboard_service_get_leaderboard_serialize(
1967
+ name_3=name_3,
1968
+ _request_auth=_request_auth,
1969
+ _content_type=_content_type,
1970
+ _headers=_headers,
1971
+ _host_index=_host_index
1972
+ )
1973
+
1974
+ _response_types_map: Dict[str, Optional[str]] = {
1975
+ '200': "V1alphaGetLeaderboardResponse",
1976
+ }
1977
+ response_data = self.api_client.call_api(
1978
+ *_param,
1979
+ _request_timeout=_request_timeout
1980
+ )
1981
+ response_data.read()
1982
+ return self.api_client.response_deserialize(
1983
+ response_data=response_data,
1984
+ response_types_map=_response_types_map,
1985
+ ).data
1986
+
1987
+
1988
+ @validate_call
1989
+ def leaderboard_service_get_leaderboard_with_http_info(
1990
+ self,
1991
+ name_3: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to retrieve.")],
1992
+ _request_timeout: Union[
1993
+ None,
1994
+ Annotated[StrictFloat, Field(gt=0)],
1995
+ Tuple[
1996
+ Annotated[StrictFloat, Field(gt=0)],
1997
+ Annotated[StrictFloat, Field(gt=0)]
1998
+ ]
1999
+ ] = None,
2000
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2001
+ _content_type: Optional[StrictStr] = None,
2002
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2003
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2004
+ ) -> ApiResponse[V1alphaGetLeaderboardResponse]:
2005
+ """leaderboard_service_get_leaderboard
2006
+
2007
+
2008
+ :param name_3: Required. The name of the Leaderboard to retrieve. (required)
2009
+ :type name_3: str
2010
+ :param _request_timeout: timeout setting for this request. If one
2011
+ number provided, it will be total request
2012
+ timeout. It can also be a pair (tuple) of
2013
+ (connection, read) timeouts.
2014
+ :type _request_timeout: int, tuple(int, int), optional
2015
+ :param _request_auth: set to override the auth_settings for an a single
2016
+ request; this effectively ignores the
2017
+ authentication in the spec for a single request.
2018
+ :type _request_auth: dict, optional
2019
+ :param _content_type: force content-type for the request.
2020
+ :type _content_type: str, Optional
2021
+ :param _headers: set to override the headers for a single
2022
+ request; this effectively ignores the headers
2023
+ in the spec for a single request.
2024
+ :type _headers: dict, optional
2025
+ :param _host_index: set to override the host_index for a single
2026
+ request; this effectively ignores the host_index
2027
+ in the spec for a single request.
2028
+ :type _host_index: int, optional
2029
+ :return: Returns the result object.
2030
+ """ # noqa: E501
2031
+
2032
+ _param = self._leaderboard_service_get_leaderboard_serialize(
2033
+ name_3=name_3,
2034
+ _request_auth=_request_auth,
2035
+ _content_type=_content_type,
2036
+ _headers=_headers,
2037
+ _host_index=_host_index
2038
+ )
2039
+
2040
+ _response_types_map: Dict[str, Optional[str]] = {
2041
+ '200': "V1alphaGetLeaderboardResponse",
2042
+ }
2043
+ response_data = self.api_client.call_api(
2044
+ *_param,
2045
+ _request_timeout=_request_timeout
2046
+ )
2047
+ response_data.read()
2048
+ return self.api_client.response_deserialize(
2049
+ response_data=response_data,
2050
+ response_types_map=_response_types_map,
2051
+ )
2052
+
2053
+
2054
+ @validate_call
2055
+ def leaderboard_service_get_leaderboard_without_preload_content(
2056
+ self,
2057
+ name_3: Annotated[str, Field(strict=True, description="Required. The name of the Leaderboard to retrieve.")],
2058
+ _request_timeout: Union[
2059
+ None,
2060
+ Annotated[StrictFloat, Field(gt=0)],
2061
+ Tuple[
2062
+ Annotated[StrictFloat, Field(gt=0)],
2063
+ Annotated[StrictFloat, Field(gt=0)]
2064
+ ]
2065
+ ] = None,
2066
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2067
+ _content_type: Optional[StrictStr] = None,
2068
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2069
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2070
+ ) -> RESTResponseType:
2071
+ """leaderboard_service_get_leaderboard
2072
+
2073
+
2074
+ :param name_3: Required. The name of the Leaderboard to retrieve. (required)
2075
+ :type name_3: str
2076
+ :param _request_timeout: timeout setting for this request. If one
2077
+ number provided, it will be total request
2078
+ timeout. It can also be a pair (tuple) of
2079
+ (connection, read) timeouts.
2080
+ :type _request_timeout: int, tuple(int, int), optional
2081
+ :param _request_auth: set to override the auth_settings for an a single
2082
+ request; this effectively ignores the
2083
+ authentication in the spec for a single request.
2084
+ :type _request_auth: dict, optional
2085
+ :param _content_type: force content-type for the request.
2086
+ :type _content_type: str, Optional
2087
+ :param _headers: set to override the headers for a single
2088
+ request; this effectively ignores the headers
2089
+ in the spec for a single request.
2090
+ :type _headers: dict, optional
2091
+ :param _host_index: set to override the host_index for a single
2092
+ request; this effectively ignores the host_index
2093
+ in the spec for a single request.
2094
+ :type _host_index: int, optional
2095
+ :return: Returns the result object.
2096
+ """ # noqa: E501
2097
+
2098
+ _param = self._leaderboard_service_get_leaderboard_serialize(
2099
+ name_3=name_3,
2100
+ _request_auth=_request_auth,
2101
+ _content_type=_content_type,
2102
+ _headers=_headers,
2103
+ _host_index=_host_index
2104
+ )
2105
+
2106
+ _response_types_map: Dict[str, Optional[str]] = {
2107
+ '200': "V1alphaGetLeaderboardResponse",
2108
+ }
2109
+ response_data = self.api_client.call_api(
2110
+ *_param,
2111
+ _request_timeout=_request_timeout
2112
+ )
2113
+ return response_data.response
2114
+
2115
+
2116
+ def _leaderboard_service_get_leaderboard_serialize(
2117
+ self,
2118
+ name_3,
2119
+ _request_auth,
2120
+ _content_type,
2121
+ _headers,
2122
+ _host_index,
2123
+ ) -> RequestSerialized:
2124
+
2125
+ _host = None
2126
+
2127
+ _collection_formats: Dict[str, str] = {
2128
+ }
2129
+
2130
+ _path_params: Dict[str, str] = {}
2131
+ _query_params: List[Tuple[str, str]] = []
2132
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2133
+ _form_params: List[Tuple[str, str]] = []
2134
+ _files: Dict[str, Union[str, bytes]] = {}
2135
+ _body_params: Optional[bytes] = None
2136
+
2137
+ # process the path parameters
2138
+ if name_3 is not None:
2139
+ _path_params['name_3'] = name_3
2140
+ # process the query parameters
2141
+ # process the header parameters
2142
+ # process the form parameters
2143
+ # process the body parameter
2144
+
2145
+
2146
+ # set the HTTP header `Accept`
2147
+ _header_params['Accept'] = self.api_client.select_header_accept(
2148
+ [
2149
+ 'application/json'
2150
+ ]
2151
+ )
2152
+
2153
+
2154
+ # authentication setting
2155
+ _auth_settings: List[str] = [
2156
+ ]
2157
+
2158
+ return self.api_client.param_serialize(
2159
+ method='GET',
2160
+ resource_path='/v1alpha/{name_3}',
2161
+ path_params=_path_params,
2162
+ query_params=_query_params,
2163
+ header_params=_header_params,
2164
+ body=_body_params,
2165
+ post_params=_form_params,
2166
+ files=_files,
2167
+ auth_settings=_auth_settings,
2168
+ collection_formats=_collection_formats,
2169
+ _host=_host,
2170
+ _request_auth=_request_auth
2171
+ )
2172
+
2173
+
2174
+
2175
+
2176
+ @validate_call
2177
+ def leaderboard_service_import_leaderboard(
2178
+ self,
2179
+ body: V1alphaImportLeaderboardRequest,
2180
+ _request_timeout: Union[
2181
+ None,
2182
+ Annotated[StrictFloat, Field(gt=0)],
2183
+ Tuple[
2184
+ Annotated[StrictFloat, Field(gt=0)],
2185
+ Annotated[StrictFloat, Field(gt=0)]
2186
+ ]
2187
+ ] = None,
2188
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2189
+ _content_type: Optional[StrictStr] = None,
2190
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2191
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2192
+ ) -> V1alphaImportLeaderboardResponse:
2193
+ """leaderboard_service_import_leaderboard
2194
+
2195
+
2196
+ :param body: (required)
2197
+ :type body: V1alphaImportLeaderboardRequest
2198
+ :param _request_timeout: timeout setting for this request. If one
2199
+ number provided, it will be total request
2200
+ timeout. It can also be a pair (tuple) of
2201
+ (connection, read) timeouts.
2202
+ :type _request_timeout: int, tuple(int, int), optional
2203
+ :param _request_auth: set to override the auth_settings for an a single
2204
+ request; this effectively ignores the
2205
+ authentication in the spec for a single request.
2206
+ :type _request_auth: dict, optional
2207
+ :param _content_type: force content-type for the request.
2208
+ :type _content_type: str, Optional
2209
+ :param _headers: set to override the headers for a single
2210
+ request; this effectively ignores the headers
2211
+ in the spec for a single request.
2212
+ :type _headers: dict, optional
2213
+ :param _host_index: set to override the host_index for a single
2214
+ request; this effectively ignores the host_index
2215
+ in the spec for a single request.
2216
+ :type _host_index: int, optional
2217
+ :return: Returns the result object.
2218
+ """ # noqa: E501
2219
+
2220
+ _param = self._leaderboard_service_import_leaderboard_serialize(
2221
+ body=body,
2222
+ _request_auth=_request_auth,
2223
+ _content_type=_content_type,
2224
+ _headers=_headers,
2225
+ _host_index=_host_index
2226
+ )
2227
+
2228
+ _response_types_map: Dict[str, Optional[str]] = {
2229
+ '200': "V1alphaImportLeaderboardResponse",
2230
+ }
2231
+ response_data = self.api_client.call_api(
2232
+ *_param,
2233
+ _request_timeout=_request_timeout
2234
+ )
2235
+ response_data.read()
2236
+ return self.api_client.response_deserialize(
2237
+ response_data=response_data,
2238
+ response_types_map=_response_types_map,
2239
+ ).data
2240
+
2241
+
2242
+ @validate_call
2243
+ def leaderboard_service_import_leaderboard_with_http_info(
2244
+ self,
2245
+ body: V1alphaImportLeaderboardRequest,
2246
+ _request_timeout: Union[
2247
+ None,
2248
+ Annotated[StrictFloat, Field(gt=0)],
2249
+ Tuple[
2250
+ Annotated[StrictFloat, Field(gt=0)],
2251
+ Annotated[StrictFloat, Field(gt=0)]
2252
+ ]
2253
+ ] = None,
2254
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2255
+ _content_type: Optional[StrictStr] = None,
2256
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2257
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2258
+ ) -> ApiResponse[V1alphaImportLeaderboardResponse]:
2259
+ """leaderboard_service_import_leaderboard
2260
+
2261
+
2262
+ :param body: (required)
2263
+ :type body: V1alphaImportLeaderboardRequest
2264
+ :param _request_timeout: timeout setting for this request. If one
2265
+ number provided, it will be total request
2266
+ timeout. It can also be a pair (tuple) of
2267
+ (connection, read) timeouts.
2268
+ :type _request_timeout: int, tuple(int, int), optional
2269
+ :param _request_auth: set to override the auth_settings for an a single
2270
+ request; this effectively ignores the
2271
+ authentication in the spec for a single request.
2272
+ :type _request_auth: dict, optional
2273
+ :param _content_type: force content-type for the request.
2274
+ :type _content_type: str, Optional
2275
+ :param _headers: set to override the headers for a single
2276
+ request; this effectively ignores the headers
2277
+ in the spec for a single request.
2278
+ :type _headers: dict, optional
2279
+ :param _host_index: set to override the host_index for a single
2280
+ request; this effectively ignores the host_index
2281
+ in the spec for a single request.
2282
+ :type _host_index: int, optional
2283
+ :return: Returns the result object.
2284
+ """ # noqa: E501
2285
+
2286
+ _param = self._leaderboard_service_import_leaderboard_serialize(
2287
+ body=body,
2288
+ _request_auth=_request_auth,
2289
+ _content_type=_content_type,
2290
+ _headers=_headers,
2291
+ _host_index=_host_index
2292
+ )
2293
+
2294
+ _response_types_map: Dict[str, Optional[str]] = {
2295
+ '200': "V1alphaImportLeaderboardResponse",
2296
+ }
2297
+ response_data = self.api_client.call_api(
2298
+ *_param,
2299
+ _request_timeout=_request_timeout
2300
+ )
2301
+ response_data.read()
2302
+ return self.api_client.response_deserialize(
2303
+ response_data=response_data,
2304
+ response_types_map=_response_types_map,
2305
+ )
2306
+
2307
+
2308
+ @validate_call
2309
+ def leaderboard_service_import_leaderboard_without_preload_content(
2310
+ self,
2311
+ body: V1alphaImportLeaderboardRequest,
2312
+ _request_timeout: Union[
2313
+ None,
2314
+ Annotated[StrictFloat, Field(gt=0)],
2315
+ Tuple[
2316
+ Annotated[StrictFloat, Field(gt=0)],
2317
+ Annotated[StrictFloat, Field(gt=0)]
2318
+ ]
2319
+ ] = None,
2320
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2321
+ _content_type: Optional[StrictStr] = None,
2322
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2323
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2324
+ ) -> RESTResponseType:
2325
+ """leaderboard_service_import_leaderboard
2326
+
2327
+
2328
+ :param body: (required)
2329
+ :type body: V1alphaImportLeaderboardRequest
2330
+ :param _request_timeout: timeout setting for this request. If one
2331
+ number provided, it will be total request
2332
+ timeout. It can also be a pair (tuple) of
2333
+ (connection, read) timeouts.
2334
+ :type _request_timeout: int, tuple(int, int), optional
2335
+ :param _request_auth: set to override the auth_settings for an a single
2336
+ request; this effectively ignores the
2337
+ authentication in the spec for a single request.
2338
+ :type _request_auth: dict, optional
2339
+ :param _content_type: force content-type for the request.
2340
+ :type _content_type: str, Optional
2341
+ :param _headers: set to override the headers for a single
2342
+ request; this effectively ignores the headers
2343
+ in the spec for a single request.
2344
+ :type _headers: dict, optional
2345
+ :param _host_index: set to override the host_index for a single
2346
+ request; this effectively ignores the host_index
2347
+ in the spec for a single request.
2348
+ :type _host_index: int, optional
2349
+ :return: Returns the result object.
2350
+ """ # noqa: E501
2351
+
2352
+ _param = self._leaderboard_service_import_leaderboard_serialize(
2353
+ body=body,
2354
+ _request_auth=_request_auth,
2355
+ _content_type=_content_type,
2356
+ _headers=_headers,
2357
+ _host_index=_host_index
2358
+ )
2359
+
2360
+ _response_types_map: Dict[str, Optional[str]] = {
2361
+ '200': "V1alphaImportLeaderboardResponse",
2362
+ }
2363
+ response_data = self.api_client.call_api(
2364
+ *_param,
2365
+ _request_timeout=_request_timeout
2366
+ )
2367
+ return response_data.response
2368
+
2369
+
2370
+ def _leaderboard_service_import_leaderboard_serialize(
2371
+ self,
2372
+ body,
2373
+ _request_auth,
2374
+ _content_type,
2375
+ _headers,
2376
+ _host_index,
2377
+ ) -> RequestSerialized:
2378
+
2379
+ _host = None
2380
+
2381
+ _collection_formats: Dict[str, str] = {
2382
+ }
2383
+
2384
+ _path_params: Dict[str, str] = {}
2385
+ _query_params: List[Tuple[str, str]] = []
2386
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2387
+ _form_params: List[Tuple[str, str]] = []
2388
+ _files: Dict[str, Union[str, bytes]] = {}
2389
+ _body_params: Optional[bytes] = None
2390
+
2391
+ # process the path parameters
2392
+ # process the query parameters
2393
+ # process the header parameters
2394
+ # process the form parameters
2395
+ # process the body parameter
2396
+ if body is not None:
2397
+ _body_params = body
2398
+
2399
+
2400
+ # set the HTTP header `Accept`
2401
+ _header_params['Accept'] = self.api_client.select_header_accept(
2402
+ [
2403
+ 'application/json'
2404
+ ]
2405
+ )
2406
+
2407
+ # set the HTTP header `Content-Type`
2408
+ if _content_type:
2409
+ _header_params['Content-Type'] = _content_type
2410
+ else:
2411
+ _default_content_type = (
2412
+ self.api_client.select_header_content_type(
2413
+ [
2414
+ 'application/json'
2415
+ ]
2416
+ )
2417
+ )
2418
+ if _default_content_type is not None:
2419
+ _header_params['Content-Type'] = _default_content_type
2420
+
2421
+ # authentication setting
2422
+ _auth_settings: List[str] = [
2423
+ ]
2424
+
2425
+ return self.api_client.param_serialize(
2426
+ method='POST',
2427
+ resource_path='/v1alpha/leaderboards:import',
2428
+ path_params=_path_params,
2429
+ query_params=_query_params,
2430
+ header_params=_header_params,
2431
+ body=_body_params,
2432
+ post_params=_form_params,
2433
+ files=_files,
2434
+ auth_settings=_auth_settings,
2435
+ collection_formats=_collection_formats,
2436
+ _host=_host,
2437
+ _request_auth=_request_auth
2438
+ )
2439
+
2440
+
2441
+
2442
+
2443
+ @validate_call
2444
+ def leaderboard_service_list_leaderboards(
2445
+ self,
2446
+ page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of Leaderboards to return. The service may return fewer than this value. If unspecified, at most 20 Leaderboards will be returned. The maximum value is 50; values above 50 will be coerced to 50.")] = None,
2447
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token, received from a previous `ListLeaderboards` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLeaderboards` must match the call that provided the page token.")] = None,
2448
+ filter: Annotated[Optional[StrictStr], Field(description="Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"")] = None,
2449
+ order_by: Annotated[Optional[StrictStr], Field(description="If specified, the returned leaderboards will be ordered by the specified field. Attempts to implement AIP-130 (https://google.aip.dev/132#ordering), although not all features are supported yet. Supported fields: - create_time - update_time")] = None,
2450
+ view: Annotated[Optional[StrictStr], Field(description="Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.")] = None,
2451
+ _request_timeout: Union[
2452
+ None,
2453
+ Annotated[StrictFloat, Field(gt=0)],
2454
+ Tuple[
2455
+ Annotated[StrictFloat, Field(gt=0)],
2456
+ Annotated[StrictFloat, Field(gt=0)]
2457
+ ]
2458
+ ] = None,
2459
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2460
+ _content_type: Optional[StrictStr] = None,
2461
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2462
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2463
+ ) -> V1alphaListLeaderboardsResponse:
2464
+ """leaderboard_service_list_leaderboards
2465
+
2466
+
2467
+ :param page_size: The maximum number of Leaderboards to return. The service may return fewer than this value. If unspecified, at most 20 Leaderboards will be returned. The maximum value is 50; values above 50 will be coerced to 50.
2468
+ :type page_size: int
2469
+ :param page_token: A page token, received from a previous `ListLeaderboards` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLeaderboards` must match the call that provided the page token.
2470
+ :type page_token: str
2471
+ :param filter: Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"
2472
+ :type filter: str
2473
+ :param order_by: If specified, the returned leaderboards will be ordered by the specified field. Attempts to implement AIP-130 (https://google.aip.dev/132#ordering), although not all features are supported yet. Supported fields: - create_time - update_time
2474
+ :type order_by: str
2475
+ :param view: Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.
2476
+ :type view: str
2477
+ :param _request_timeout: timeout setting for this request. If one
2478
+ number provided, it will be total request
2479
+ timeout. It can also be a pair (tuple) of
2480
+ (connection, read) timeouts.
2481
+ :type _request_timeout: int, tuple(int, int), optional
2482
+ :param _request_auth: set to override the auth_settings for an a single
2483
+ request; this effectively ignores the
2484
+ authentication in the spec for a single request.
2485
+ :type _request_auth: dict, optional
2486
+ :param _content_type: force content-type for the request.
2487
+ :type _content_type: str, Optional
2488
+ :param _headers: set to override the headers for a single
2489
+ request; this effectively ignores the headers
2490
+ in the spec for a single request.
2491
+ :type _headers: dict, optional
2492
+ :param _host_index: set to override the host_index for a single
2493
+ request; this effectively ignores the host_index
2494
+ in the spec for a single request.
2495
+ :type _host_index: int, optional
2496
+ :return: Returns the result object.
2497
+ """ # noqa: E501
2498
+
2499
+ _param = self._leaderboard_service_list_leaderboards_serialize(
2500
+ page_size=page_size,
2501
+ page_token=page_token,
2502
+ filter=filter,
2503
+ order_by=order_by,
2504
+ view=view,
2505
+ _request_auth=_request_auth,
2506
+ _content_type=_content_type,
2507
+ _headers=_headers,
2508
+ _host_index=_host_index
2509
+ )
2510
+
2511
+ _response_types_map: Dict[str, Optional[str]] = {
2512
+ '200': "V1alphaListLeaderboardsResponse",
2513
+ }
2514
+ response_data = self.api_client.call_api(
2515
+ *_param,
2516
+ _request_timeout=_request_timeout
2517
+ )
2518
+ response_data.read()
2519
+ return self.api_client.response_deserialize(
2520
+ response_data=response_data,
2521
+ response_types_map=_response_types_map,
2522
+ ).data
2523
+
2524
+
2525
+ @validate_call
2526
+ def leaderboard_service_list_leaderboards_with_http_info(
2527
+ self,
2528
+ page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of Leaderboards to return. The service may return fewer than this value. If unspecified, at most 20 Leaderboards will be returned. The maximum value is 50; values above 50 will be coerced to 50.")] = None,
2529
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token, received from a previous `ListLeaderboards` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLeaderboards` must match the call that provided the page token.")] = None,
2530
+ filter: Annotated[Optional[StrictStr], Field(description="Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"")] = None,
2531
+ order_by: Annotated[Optional[StrictStr], Field(description="If specified, the returned leaderboards will be ordered by the specified field. Attempts to implement AIP-130 (https://google.aip.dev/132#ordering), although not all features are supported yet. Supported fields: - create_time - update_time")] = None,
2532
+ view: Annotated[Optional[StrictStr], Field(description="Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.")] = None,
2533
+ _request_timeout: Union[
2534
+ None,
2535
+ Annotated[StrictFloat, Field(gt=0)],
2536
+ Tuple[
2537
+ Annotated[StrictFloat, Field(gt=0)],
2538
+ Annotated[StrictFloat, Field(gt=0)]
2539
+ ]
2540
+ ] = None,
2541
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2542
+ _content_type: Optional[StrictStr] = None,
2543
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2544
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2545
+ ) -> ApiResponse[V1alphaListLeaderboardsResponse]:
2546
+ """leaderboard_service_list_leaderboards
2547
+
2548
+
2549
+ :param page_size: The maximum number of Leaderboards to return. The service may return fewer than this value. If unspecified, at most 20 Leaderboards will be returned. The maximum value is 50; values above 50 will be coerced to 50.
2550
+ :type page_size: int
2551
+ :param page_token: A page token, received from a previous `ListLeaderboards` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLeaderboards` must match the call that provided the page token.
2552
+ :type page_token: str
2553
+ :param filter: Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"
2554
+ :type filter: str
2555
+ :param order_by: If specified, the returned leaderboards will be ordered by the specified field. Attempts to implement AIP-130 (https://google.aip.dev/132#ordering), although not all features are supported yet. Supported fields: - create_time - update_time
2556
+ :type order_by: str
2557
+ :param view: Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.
2558
+ :type view: str
2559
+ :param _request_timeout: timeout setting for this request. If one
2560
+ number provided, it will be total request
2561
+ timeout. It can also be a pair (tuple) of
2562
+ (connection, read) timeouts.
2563
+ :type _request_timeout: int, tuple(int, int), optional
2564
+ :param _request_auth: set to override the auth_settings for an a single
2565
+ request; this effectively ignores the
2566
+ authentication in the spec for a single request.
2567
+ :type _request_auth: dict, optional
2568
+ :param _content_type: force content-type for the request.
2569
+ :type _content_type: str, Optional
2570
+ :param _headers: set to override the headers for a single
2571
+ request; this effectively ignores the headers
2572
+ in the spec for a single request.
2573
+ :type _headers: dict, optional
2574
+ :param _host_index: set to override the host_index for a single
2575
+ request; this effectively ignores the host_index
2576
+ in the spec for a single request.
2577
+ :type _host_index: int, optional
2578
+ :return: Returns the result object.
2579
+ """ # noqa: E501
2580
+
2581
+ _param = self._leaderboard_service_list_leaderboards_serialize(
2582
+ page_size=page_size,
2583
+ page_token=page_token,
2584
+ filter=filter,
2585
+ order_by=order_by,
2586
+ view=view,
2587
+ _request_auth=_request_auth,
2588
+ _content_type=_content_type,
2589
+ _headers=_headers,
2590
+ _host_index=_host_index
2591
+ )
2592
+
2593
+ _response_types_map: Dict[str, Optional[str]] = {
2594
+ '200': "V1alphaListLeaderboardsResponse",
2595
+ }
2596
+ response_data = self.api_client.call_api(
2597
+ *_param,
2598
+ _request_timeout=_request_timeout
2599
+ )
2600
+ response_data.read()
2601
+ return self.api_client.response_deserialize(
2602
+ response_data=response_data,
2603
+ response_types_map=_response_types_map,
2604
+ )
2605
+
2606
+
2607
+ @validate_call
2608
+ def leaderboard_service_list_leaderboards_without_preload_content(
2609
+ self,
2610
+ page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of Leaderboards to return. The service may return fewer than this value. If unspecified, at most 20 Leaderboards will be returned. The maximum value is 50; values above 50 will be coerced to 50.")] = None,
2611
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token, received from a previous `ListLeaderboards` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLeaderboards` must match the call that provided the page token.")] = None,
2612
+ filter: Annotated[Optional[StrictStr], Field(description="Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"")] = None,
2613
+ order_by: Annotated[Optional[StrictStr], Field(description="If specified, the returned leaderboards will be ordered by the specified field. Attempts to implement AIP-130 (https://google.aip.dev/132#ordering), although not all features are supported yet. Supported fields: - create_time - update_time")] = None,
2614
+ view: Annotated[Optional[StrictStr], Field(description="Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.")] = None,
2615
+ _request_timeout: Union[
2616
+ None,
2617
+ Annotated[StrictFloat, Field(gt=0)],
2618
+ Tuple[
2619
+ Annotated[StrictFloat, Field(gt=0)],
2620
+ Annotated[StrictFloat, Field(gt=0)]
2621
+ ]
2622
+ ] = None,
2623
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2624
+ _content_type: Optional[StrictStr] = None,
2625
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2626
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2627
+ ) -> RESTResponseType:
2628
+ """leaderboard_service_list_leaderboards
2629
+
2630
+
2631
+ :param page_size: The maximum number of Leaderboards to return. The service may return fewer than this value. If unspecified, at most 20 Leaderboards will be returned. The maximum value is 50; values above 50 will be coerced to 50.
2632
+ :type page_size: int
2633
+ :param page_token: A page token, received from a previous `ListLeaderboards` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListLeaderboards` must match the call that provided the page token.
2634
+ :type page_token: str
2635
+ :param filter: Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"
2636
+ :type filter: str
2637
+ :param order_by: If specified, the returned leaderboards will be ordered by the specified field. Attempts to implement AIP-130 (https://google.aip.dev/132#ordering), although not all features are supported yet. Supported fields: - create_time - update_time
2638
+ :type order_by: str
2639
+ :param view: Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.
2640
+ :type view: str
2641
+ :param _request_timeout: timeout setting for this request. If one
2642
+ number provided, it will be total request
2643
+ timeout. It can also be a pair (tuple) of
2644
+ (connection, read) timeouts.
2645
+ :type _request_timeout: int, tuple(int, int), optional
2646
+ :param _request_auth: set to override the auth_settings for an a single
2647
+ request; this effectively ignores the
2648
+ authentication in the spec for a single request.
2649
+ :type _request_auth: dict, optional
2650
+ :param _content_type: force content-type for the request.
2651
+ :type _content_type: str, Optional
2652
+ :param _headers: set to override the headers for a single
2653
+ request; this effectively ignores the headers
2654
+ in the spec for a single request.
2655
+ :type _headers: dict, optional
2656
+ :param _host_index: set to override the host_index for a single
2657
+ request; this effectively ignores the host_index
2658
+ in the spec for a single request.
2659
+ :type _host_index: int, optional
2660
+ :return: Returns the result object.
2661
+ """ # noqa: E501
2662
+
2663
+ _param = self._leaderboard_service_list_leaderboards_serialize(
2664
+ page_size=page_size,
2665
+ page_token=page_token,
2666
+ filter=filter,
2667
+ order_by=order_by,
2668
+ view=view,
2669
+ _request_auth=_request_auth,
2670
+ _content_type=_content_type,
2671
+ _headers=_headers,
2672
+ _host_index=_host_index
2673
+ )
2674
+
2675
+ _response_types_map: Dict[str, Optional[str]] = {
2676
+ '200': "V1alphaListLeaderboardsResponse",
2677
+ }
2678
+ response_data = self.api_client.call_api(
2679
+ *_param,
2680
+ _request_timeout=_request_timeout
2681
+ )
2682
+ return response_data.response
2683
+
2684
+
2685
+ def _leaderboard_service_list_leaderboards_serialize(
2686
+ self,
2687
+ page_size,
2688
+ page_token,
2689
+ filter,
2690
+ order_by,
2691
+ view,
2692
+ _request_auth,
2693
+ _content_type,
2694
+ _headers,
2695
+ _host_index,
2696
+ ) -> RequestSerialized:
2697
+
2698
+ _host = None
2699
+
2700
+ _collection_formats: Dict[str, str] = {
2701
+ }
2702
+
2703
+ _path_params: Dict[str, str] = {}
2704
+ _query_params: List[Tuple[str, str]] = []
2705
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2706
+ _form_params: List[Tuple[str, str]] = []
2707
+ _files: Dict[str, Union[str, bytes]] = {}
2708
+ _body_params: Optional[bytes] = None
2709
+
2710
+ # process the path parameters
2711
+ # process the query parameters
2712
+ if page_size is not None:
2713
+
2714
+ _query_params.append(('pageSize', page_size))
2715
+
2716
+ if page_token is not None:
2717
+
2718
+ _query_params.append(('pageToken', page_token))
2719
+
2720
+ if filter is not None:
2721
+
2722
+ _query_params.append(('filter', filter))
2723
+
2724
+ if order_by is not None:
2725
+
2726
+ _query_params.append(('orderBy', order_by))
2727
+
2728
+ if view is not None:
2729
+
2730
+ _query_params.append(('view', view))
2731
+
2732
+ # process the header parameters
2733
+ # process the form parameters
2734
+ # process the body parameter
2735
+
2736
+
2737
+ # set the HTTP header `Accept`
2738
+ _header_params['Accept'] = self.api_client.select_header_accept(
2739
+ [
2740
+ 'application/json'
2741
+ ]
2742
+ )
2743
+
2744
+
2745
+ # authentication setting
2746
+ _auth_settings: List[str] = [
2747
+ ]
2748
+
2749
+ return self.api_client.param_serialize(
2750
+ method='GET',
2751
+ resource_path='/v1alpha/leaderboards',
2752
+ path_params=_path_params,
2753
+ query_params=_query_params,
2754
+ header_params=_header_params,
2755
+ body=_body_params,
2756
+ post_params=_form_params,
2757
+ files=_files,
2758
+ auth_settings=_auth_settings,
2759
+ collection_formats=_collection_formats,
2760
+ _host=_host,
2761
+ _request_auth=_request_auth
2762
+ )
2763
+
2764
+
2765
+
2766
+
2767
+ @validate_call
2768
+ def leaderboard_service_list_most_recent_leaderboards(
2769
+ self,
2770
+ limit: Annotated[Optional[StrictInt], Field(description="Optional. The max number of the most recent Leaderboards to retrieve. Use -1 to retrieve all. Defaults to 3.")] = None,
2771
+ filter: Annotated[Optional[StrictStr], Field(description="Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"")] = None,
2772
+ view: Annotated[Optional[StrictStr], Field(description="Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.")] = None,
2773
+ _request_timeout: Union[
2774
+ None,
2775
+ Annotated[StrictFloat, Field(gt=0)],
2776
+ Tuple[
2777
+ Annotated[StrictFloat, Field(gt=0)],
2778
+ Annotated[StrictFloat, Field(gt=0)]
2779
+ ]
2780
+ ] = None,
2781
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2782
+ _content_type: Optional[StrictStr] = None,
2783
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2784
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2785
+ ) -> V1alphaListMostRecentLeaderboardsResponse:
2786
+ """leaderboard_service_list_most_recent_leaderboards
2787
+
2788
+
2789
+ :param limit: Optional. The max number of the most recent Leaderboards to retrieve. Use -1 to retrieve all. Defaults to 3.
2790
+ :type limit: int
2791
+ :param filter: Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"
2792
+ :type filter: str
2793
+ :param view: Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.
2794
+ :type view: str
2795
+ :param _request_timeout: timeout setting for this request. If one
2796
+ number provided, it will be total request
2797
+ timeout. It can also be a pair (tuple) of
2798
+ (connection, read) timeouts.
2799
+ :type _request_timeout: int, tuple(int, int), optional
2800
+ :param _request_auth: set to override the auth_settings for an a single
2801
+ request; this effectively ignores the
2802
+ authentication in the spec for a single request.
2803
+ :type _request_auth: dict, optional
2804
+ :param _content_type: force content-type for the request.
2805
+ :type _content_type: str, Optional
2806
+ :param _headers: set to override the headers for a single
2807
+ request; this effectively ignores the headers
2808
+ in the spec for a single request.
2809
+ :type _headers: dict, optional
2810
+ :param _host_index: set to override the host_index for a single
2811
+ request; this effectively ignores the host_index
2812
+ in the spec for a single request.
2813
+ :type _host_index: int, optional
2814
+ :return: Returns the result object.
2815
+ """ # noqa: E501
2816
+
2817
+ _param = self._leaderboard_service_list_most_recent_leaderboards_serialize(
2818
+ limit=limit,
2819
+ filter=filter,
2820
+ view=view,
2821
+ _request_auth=_request_auth,
2822
+ _content_type=_content_type,
2823
+ _headers=_headers,
2824
+ _host_index=_host_index
2825
+ )
2826
+
2827
+ _response_types_map: Dict[str, Optional[str]] = {
2828
+ '200': "V1alphaListMostRecentLeaderboardsResponse",
2829
+ }
2830
+ response_data = self.api_client.call_api(
2831
+ *_param,
2832
+ _request_timeout=_request_timeout
2833
+ )
2834
+ response_data.read()
2835
+ return self.api_client.response_deserialize(
2836
+ response_data=response_data,
2837
+ response_types_map=_response_types_map,
2838
+ ).data
2839
+
2840
+
2841
+ @validate_call
2842
+ def leaderboard_service_list_most_recent_leaderboards_with_http_info(
2843
+ self,
2844
+ limit: Annotated[Optional[StrictInt], Field(description="Optional. The max number of the most recent Leaderboards to retrieve. Use -1 to retrieve all. Defaults to 3.")] = None,
2845
+ filter: Annotated[Optional[StrictStr], Field(description="Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"")] = None,
2846
+ view: Annotated[Optional[StrictStr], Field(description="Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.")] = None,
2847
+ _request_timeout: Union[
2848
+ None,
2849
+ Annotated[StrictFloat, Field(gt=0)],
2850
+ Tuple[
2851
+ Annotated[StrictFloat, Field(gt=0)],
2852
+ Annotated[StrictFloat, Field(gt=0)]
2853
+ ]
2854
+ ] = None,
2855
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2856
+ _content_type: Optional[StrictStr] = None,
2857
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2858
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2859
+ ) -> ApiResponse[V1alphaListMostRecentLeaderboardsResponse]:
2860
+ """leaderboard_service_list_most_recent_leaderboards
2861
+
2862
+
2863
+ :param limit: Optional. The max number of the most recent Leaderboards to retrieve. Use -1 to retrieve all. Defaults to 3.
2864
+ :type limit: int
2865
+ :param filter: Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"
2866
+ :type filter: str
2867
+ :param view: Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.
2868
+ :type view: str
2869
+ :param _request_timeout: timeout setting for this request. If one
2870
+ number provided, it will be total request
2871
+ timeout. It can also be a pair (tuple) of
2872
+ (connection, read) timeouts.
2873
+ :type _request_timeout: int, tuple(int, int), optional
2874
+ :param _request_auth: set to override the auth_settings for an a single
2875
+ request; this effectively ignores the
2876
+ authentication in the spec for a single request.
2877
+ :type _request_auth: dict, optional
2878
+ :param _content_type: force content-type for the request.
2879
+ :type _content_type: str, Optional
2880
+ :param _headers: set to override the headers for a single
2881
+ request; this effectively ignores the headers
2882
+ in the spec for a single request.
2883
+ :type _headers: dict, optional
2884
+ :param _host_index: set to override the host_index for a single
2885
+ request; this effectively ignores the host_index
2886
+ in the spec for a single request.
2887
+ :type _host_index: int, optional
2888
+ :return: Returns the result object.
2889
+ """ # noqa: E501
2890
+
2891
+ _param = self._leaderboard_service_list_most_recent_leaderboards_serialize(
2892
+ limit=limit,
2893
+ filter=filter,
2894
+ view=view,
2895
+ _request_auth=_request_auth,
2896
+ _content_type=_content_type,
2897
+ _headers=_headers,
2898
+ _host_index=_host_index
2899
+ )
2900
+
2901
+ _response_types_map: Dict[str, Optional[str]] = {
2902
+ '200': "V1alphaListMostRecentLeaderboardsResponse",
2903
+ }
2904
+ response_data = self.api_client.call_api(
2905
+ *_param,
2906
+ _request_timeout=_request_timeout
2907
+ )
2908
+ response_data.read()
2909
+ return self.api_client.response_deserialize(
2910
+ response_data=response_data,
2911
+ response_types_map=_response_types_map,
2912
+ )
2913
+
2914
+
2915
+ @validate_call
2916
+ def leaderboard_service_list_most_recent_leaderboards_without_preload_content(
2917
+ self,
2918
+ limit: Annotated[Optional[StrictInt], Field(description="Optional. The max number of the most recent Leaderboards to retrieve. Use -1 to retrieve all. Defaults to 3.")] = None,
2919
+ filter: Annotated[Optional[StrictStr], Field(description="Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"")] = None,
2920
+ view: Annotated[Optional[StrictStr], Field(description="Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.")] = None,
2921
+ _request_timeout: Union[
2922
+ None,
2923
+ Annotated[StrictFloat, Field(gt=0)],
2924
+ Tuple[
2925
+ Annotated[StrictFloat, Field(gt=0)],
2926
+ Annotated[StrictFloat, Field(gt=0)]
2927
+ ]
2928
+ ] = None,
2929
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2930
+ _content_type: Optional[StrictStr] = None,
2931
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2932
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2933
+ ) -> RESTResponseType:
2934
+ """leaderboard_service_list_most_recent_leaderboards
2935
+
2936
+
2937
+ :param limit: Optional. The max number of the most recent Leaderboards to retrieve. Use -1 to retrieve all. Defaults to 3.
2938
+ :type limit: int
2939
+ :param filter: Optional. If specified, only leaderboards matching the filter will be returned. Attempts to implement AIP-160 (https://aip.dev/160), although not all fields, operators and features are supported. Supported fields: - model - only '=' operator is supported, e.g. \"model = \\\"models/<UUID>\\\"\"
2940
+ :type filter: str
2941
+ :param view: Optional. View specifying which fields should be returned in the response. Defaults to LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_UNSPECIFIED: The default / unset value. The API will default to the LEADERBOARD_VIEW_BASIC. - LEADERBOARD_VIEW_BASIC: Basic view of the Leaderboard. The following fields are omitted in the response: - result - leaderboard_table - leaderboard_summary - LEADERBOARD_VIEW_FULL: Full view of the Leaderboard. No fields are omitted. - LEADERBOARD_VIEW_BASIC_WITH_TABLE: View of the Leaderboard that is the same as LEADERBOARD_VIEW_BASIC but it includes the leaderboard_table field.
2942
+ :type view: str
2943
+ :param _request_timeout: timeout setting for this request. If one
2944
+ number provided, it will be total request
2945
+ timeout. It can also be a pair (tuple) of
2946
+ (connection, read) timeouts.
2947
+ :type _request_timeout: int, tuple(int, int), optional
2948
+ :param _request_auth: set to override the auth_settings for an a single
2949
+ request; this effectively ignores the
2950
+ authentication in the spec for a single request.
2951
+ :type _request_auth: dict, optional
2952
+ :param _content_type: force content-type for the request.
2953
+ :type _content_type: str, Optional
2954
+ :param _headers: set to override the headers for a single
2955
+ request; this effectively ignores the headers
2956
+ in the spec for a single request.
2957
+ :type _headers: dict, optional
2958
+ :param _host_index: set to override the host_index for a single
2959
+ request; this effectively ignores the host_index
2960
+ in the spec for a single request.
2961
+ :type _host_index: int, optional
2962
+ :return: Returns the result object.
2963
+ """ # noqa: E501
2964
+
2965
+ _param = self._leaderboard_service_list_most_recent_leaderboards_serialize(
2966
+ limit=limit,
2967
+ filter=filter,
2968
+ view=view,
2969
+ _request_auth=_request_auth,
2970
+ _content_type=_content_type,
2971
+ _headers=_headers,
2972
+ _host_index=_host_index
2973
+ )
2974
+
2975
+ _response_types_map: Dict[str, Optional[str]] = {
2976
+ '200': "V1alphaListMostRecentLeaderboardsResponse",
2977
+ }
2978
+ response_data = self.api_client.call_api(
2979
+ *_param,
2980
+ _request_timeout=_request_timeout
2981
+ )
2982
+ return response_data.response
2983
+
2984
+
2985
+ def _leaderboard_service_list_most_recent_leaderboards_serialize(
2986
+ self,
2987
+ limit,
2988
+ filter,
2989
+ view,
2990
+ _request_auth,
2991
+ _content_type,
2992
+ _headers,
2993
+ _host_index,
2994
+ ) -> RequestSerialized:
2995
+
2996
+ _host = None
2997
+
2998
+ _collection_formats: Dict[str, str] = {
2999
+ }
3000
+
3001
+ _path_params: Dict[str, str] = {}
3002
+ _query_params: List[Tuple[str, str]] = []
3003
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3004
+ _form_params: List[Tuple[str, str]] = []
3005
+ _files: Dict[str, Union[str, bytes]] = {}
3006
+ _body_params: Optional[bytes] = None
3007
+
3008
+ # process the path parameters
3009
+ # process the query parameters
3010
+ if limit is not None:
3011
+
3012
+ _query_params.append(('limit', limit))
3013
+
3014
+ if filter is not None:
3015
+
3016
+ _query_params.append(('filter', filter))
3017
+
3018
+ if view is not None:
3019
+
3020
+ _query_params.append(('view', view))
3021
+
3022
+ # process the header parameters
3023
+ # process the form parameters
3024
+ # process the body parameter
3025
+
3026
+
3027
+ # set the HTTP header `Accept`
3028
+ _header_params['Accept'] = self.api_client.select_header_accept(
3029
+ [
3030
+ 'application/json'
3031
+ ]
3032
+ )
3033
+
3034
+
3035
+ # authentication setting
3036
+ _auth_settings: List[str] = [
3037
+ ]
3038
+
3039
+ return self.api_client.param_serialize(
3040
+ method='GET',
3041
+ resource_path='/v1alpha/leaderboards:mostRecent',
3042
+ path_params=_path_params,
3043
+ query_params=_query_params,
3044
+ header_params=_header_params,
3045
+ body=_body_params,
3046
+ post_params=_form_params,
3047
+ files=_files,
3048
+ auth_settings=_auth_settings,
3049
+ collection_formats=_collection_formats,
3050
+ _host=_host,
3051
+ _request_auth=_request_auth
3052
+ )
3053
+
3054
+
3055
+
3056
+
3057
+ @validate_call
3058
+ def leaderboard_service_update_leaderboard(
3059
+ self,
3060
+ leaderboard_name: Annotated[str, Field(strict=True, description="Output only. Name of the Leaderboard resource. e.g.: \"leaderboards/<UUID>\"")],
3061
+ leaderboard: Annotated[RequiredTheLeaderboardToUpdate, Field(description="Required. The Leaderboard to update. The Leaderboard's `name` field is used to identify the Leaderboard to update. Format: leaderboards/{leaderboard}")],
3062
+ _request_timeout: Union[
3063
+ None,
3064
+ Annotated[StrictFloat, Field(gt=0)],
3065
+ Tuple[
3066
+ Annotated[StrictFloat, Field(gt=0)],
3067
+ Annotated[StrictFloat, Field(gt=0)]
3068
+ ]
3069
+ ] = None,
3070
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3071
+ _content_type: Optional[StrictStr] = None,
3072
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3073
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3074
+ ) -> V1alphaUpdateLeaderboardResponse:
3075
+ """leaderboard_service_update_leaderboard
3076
+
3077
+
3078
+ :param leaderboard_name: Output only. Name of the Leaderboard resource. e.g.: \"leaderboards/<UUID>\" (required)
3079
+ :type leaderboard_name: str
3080
+ :param leaderboard: Required. The Leaderboard to update. The Leaderboard's `name` field is used to identify the Leaderboard to update. Format: leaderboards/{leaderboard} (required)
3081
+ :type leaderboard: RequiredTheLeaderboardToUpdate
3082
+ :param _request_timeout: timeout setting for this request. If one
3083
+ number provided, it will be total request
3084
+ timeout. It can also be a pair (tuple) of
3085
+ (connection, read) timeouts.
3086
+ :type _request_timeout: int, tuple(int, int), optional
3087
+ :param _request_auth: set to override the auth_settings for an a single
3088
+ request; this effectively ignores the
3089
+ authentication in the spec for a single request.
3090
+ :type _request_auth: dict, optional
3091
+ :param _content_type: force content-type for the request.
3092
+ :type _content_type: str, Optional
3093
+ :param _headers: set to override the headers for a single
3094
+ request; this effectively ignores the headers
3095
+ in the spec for a single request.
3096
+ :type _headers: dict, optional
3097
+ :param _host_index: set to override the host_index for a single
3098
+ request; this effectively ignores the host_index
3099
+ in the spec for a single request.
3100
+ :type _host_index: int, optional
3101
+ :return: Returns the result object.
3102
+ """ # noqa: E501
3103
+
3104
+ _param = self._leaderboard_service_update_leaderboard_serialize(
3105
+ leaderboard_name=leaderboard_name,
3106
+ leaderboard=leaderboard,
3107
+ _request_auth=_request_auth,
3108
+ _content_type=_content_type,
3109
+ _headers=_headers,
3110
+ _host_index=_host_index
3111
+ )
3112
+
3113
+ _response_types_map: Dict[str, Optional[str]] = {
3114
+ '200': "V1alphaUpdateLeaderboardResponse",
3115
+ }
3116
+ response_data = self.api_client.call_api(
3117
+ *_param,
3118
+ _request_timeout=_request_timeout
3119
+ )
3120
+ response_data.read()
3121
+ return self.api_client.response_deserialize(
3122
+ response_data=response_data,
3123
+ response_types_map=_response_types_map,
3124
+ ).data
3125
+
3126
+
3127
+ @validate_call
3128
+ def leaderboard_service_update_leaderboard_with_http_info(
3129
+ self,
3130
+ leaderboard_name: Annotated[str, Field(strict=True, description="Output only. Name of the Leaderboard resource. e.g.: \"leaderboards/<UUID>\"")],
3131
+ leaderboard: Annotated[RequiredTheLeaderboardToUpdate, Field(description="Required. The Leaderboard to update. The Leaderboard's `name` field is used to identify the Leaderboard to update. Format: leaderboards/{leaderboard}")],
3132
+ _request_timeout: Union[
3133
+ None,
3134
+ Annotated[StrictFloat, Field(gt=0)],
3135
+ Tuple[
3136
+ Annotated[StrictFloat, Field(gt=0)],
3137
+ Annotated[StrictFloat, Field(gt=0)]
3138
+ ]
3139
+ ] = None,
3140
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3141
+ _content_type: Optional[StrictStr] = None,
3142
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3143
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3144
+ ) -> ApiResponse[V1alphaUpdateLeaderboardResponse]:
3145
+ """leaderboard_service_update_leaderboard
3146
+
3147
+
3148
+ :param leaderboard_name: Output only. Name of the Leaderboard resource. e.g.: \"leaderboards/<UUID>\" (required)
3149
+ :type leaderboard_name: str
3150
+ :param leaderboard: Required. The Leaderboard to update. The Leaderboard's `name` field is used to identify the Leaderboard to update. Format: leaderboards/{leaderboard} (required)
3151
+ :type leaderboard: RequiredTheLeaderboardToUpdate
3152
+ :param _request_timeout: timeout setting for this request. If one
3153
+ number provided, it will be total request
3154
+ timeout. It can also be a pair (tuple) of
3155
+ (connection, read) timeouts.
3156
+ :type _request_timeout: int, tuple(int, int), optional
3157
+ :param _request_auth: set to override the auth_settings for an a single
3158
+ request; this effectively ignores the
3159
+ authentication in the spec for a single request.
3160
+ :type _request_auth: dict, optional
3161
+ :param _content_type: force content-type for the request.
3162
+ :type _content_type: str, Optional
3163
+ :param _headers: set to override the headers for a single
3164
+ request; this effectively ignores the headers
3165
+ in the spec for a single request.
3166
+ :type _headers: dict, optional
3167
+ :param _host_index: set to override the host_index for a single
3168
+ request; this effectively ignores the host_index
3169
+ in the spec for a single request.
3170
+ :type _host_index: int, optional
3171
+ :return: Returns the result object.
3172
+ """ # noqa: E501
3173
+
3174
+ _param = self._leaderboard_service_update_leaderboard_serialize(
3175
+ leaderboard_name=leaderboard_name,
3176
+ leaderboard=leaderboard,
3177
+ _request_auth=_request_auth,
3178
+ _content_type=_content_type,
3179
+ _headers=_headers,
3180
+ _host_index=_host_index
3181
+ )
3182
+
3183
+ _response_types_map: Dict[str, Optional[str]] = {
3184
+ '200': "V1alphaUpdateLeaderboardResponse",
3185
+ }
3186
+ response_data = self.api_client.call_api(
3187
+ *_param,
3188
+ _request_timeout=_request_timeout
3189
+ )
3190
+ response_data.read()
3191
+ return self.api_client.response_deserialize(
3192
+ response_data=response_data,
3193
+ response_types_map=_response_types_map,
3194
+ )
3195
+
3196
+
3197
+ @validate_call
3198
+ def leaderboard_service_update_leaderboard_without_preload_content(
3199
+ self,
3200
+ leaderboard_name: Annotated[str, Field(strict=True, description="Output only. Name of the Leaderboard resource. e.g.: \"leaderboards/<UUID>\"")],
3201
+ leaderboard: Annotated[RequiredTheLeaderboardToUpdate, Field(description="Required. The Leaderboard to update. The Leaderboard's `name` field is used to identify the Leaderboard to update. Format: leaderboards/{leaderboard}")],
3202
+ _request_timeout: Union[
3203
+ None,
3204
+ Annotated[StrictFloat, Field(gt=0)],
3205
+ Tuple[
3206
+ Annotated[StrictFloat, Field(gt=0)],
3207
+ Annotated[StrictFloat, Field(gt=0)]
3208
+ ]
3209
+ ] = None,
3210
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
3211
+ _content_type: Optional[StrictStr] = None,
3212
+ _headers: Optional[Dict[StrictStr, Any]] = None,
3213
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3214
+ ) -> RESTResponseType:
3215
+ """leaderboard_service_update_leaderboard
3216
+
3217
+
3218
+ :param leaderboard_name: Output only. Name of the Leaderboard resource. e.g.: \"leaderboards/<UUID>\" (required)
3219
+ :type leaderboard_name: str
3220
+ :param leaderboard: Required. The Leaderboard to update. The Leaderboard's `name` field is used to identify the Leaderboard to update. Format: leaderboards/{leaderboard} (required)
3221
+ :type leaderboard: RequiredTheLeaderboardToUpdate
3222
+ :param _request_timeout: timeout setting for this request. If one
3223
+ number provided, it will be total request
3224
+ timeout. It can also be a pair (tuple) of
3225
+ (connection, read) timeouts.
3226
+ :type _request_timeout: int, tuple(int, int), optional
3227
+ :param _request_auth: set to override the auth_settings for an a single
3228
+ request; this effectively ignores the
3229
+ authentication in the spec for a single request.
3230
+ :type _request_auth: dict, optional
3231
+ :param _content_type: force content-type for the request.
3232
+ :type _content_type: str, Optional
3233
+ :param _headers: set to override the headers for a single
3234
+ request; this effectively ignores the headers
3235
+ in the spec for a single request.
3236
+ :type _headers: dict, optional
3237
+ :param _host_index: set to override the host_index for a single
3238
+ request; this effectively ignores the host_index
3239
+ in the spec for a single request.
3240
+ :type _host_index: int, optional
3241
+ :return: Returns the result object.
3242
+ """ # noqa: E501
3243
+
3244
+ _param = self._leaderboard_service_update_leaderboard_serialize(
3245
+ leaderboard_name=leaderboard_name,
3246
+ leaderboard=leaderboard,
3247
+ _request_auth=_request_auth,
3248
+ _content_type=_content_type,
3249
+ _headers=_headers,
3250
+ _host_index=_host_index
3251
+ )
3252
+
3253
+ _response_types_map: Dict[str, Optional[str]] = {
3254
+ '200': "V1alphaUpdateLeaderboardResponse",
3255
+ }
3256
+ response_data = self.api_client.call_api(
3257
+ *_param,
3258
+ _request_timeout=_request_timeout
3259
+ )
3260
+ return response_data.response
3261
+
3262
+
3263
+ def _leaderboard_service_update_leaderboard_serialize(
3264
+ self,
3265
+ leaderboard_name,
3266
+ leaderboard,
3267
+ _request_auth,
3268
+ _content_type,
3269
+ _headers,
3270
+ _host_index,
3271
+ ) -> RequestSerialized:
3272
+
3273
+ _host = None
3274
+
3275
+ _collection_formats: Dict[str, str] = {
3276
+ }
3277
+
3278
+ _path_params: Dict[str, str] = {}
3279
+ _query_params: List[Tuple[str, str]] = []
3280
+ _header_params: Dict[str, Optional[str]] = _headers or {}
3281
+ _form_params: List[Tuple[str, str]] = []
3282
+ _files: Dict[str, Union[str, bytes]] = {}
3283
+ _body_params: Optional[bytes] = None
3284
+
3285
+ # process the path parameters
3286
+ if leaderboard_name is not None:
3287
+ _path_params['leaderboard.name'] = leaderboard_name
3288
+ # process the query parameters
3289
+ # process the header parameters
3290
+ # process the form parameters
3291
+ # process the body parameter
3292
+ if leaderboard is not None:
3293
+ _body_params = leaderboard
3294
+
3295
+
3296
+ # set the HTTP header `Accept`
3297
+ _header_params['Accept'] = self.api_client.select_header_accept(
3298
+ [
3299
+ 'application/json'
3300
+ ]
3301
+ )
3302
+
3303
+ # set the HTTP header `Content-Type`
3304
+ if _content_type:
3305
+ _header_params['Content-Type'] = _content_type
3306
+ else:
3307
+ _default_content_type = (
3308
+ self.api_client.select_header_content_type(
3309
+ [
3310
+ 'application/json'
3311
+ ]
3312
+ )
3313
+ )
3314
+ if _default_content_type is not None:
3315
+ _header_params['Content-Type'] = _default_content_type
3316
+
3317
+ # authentication setting
3318
+ _auth_settings: List[str] = [
3319
+ ]
3320
+
3321
+ return self.api_client.param_serialize(
3322
+ method='PATCH',
3323
+ resource_path='/v1alpha/{leaderboard.name}',
3324
+ path_params=_path_params,
3325
+ query_params=_query_params,
3326
+ header_params=_header_params,
3327
+ body=_body_params,
3328
+ post_params=_form_params,
3329
+ files=_files,
3330
+ auth_settings=_auth_settings,
3331
+ collection_formats=_collection_formats,
3332
+ _host=_host,
3333
+ _request_auth=_request_auth
3334
+ )
3335
+
3336
+