trophy_api_client 1.14.0 → 1.26.1

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 (635) hide show
  1. checksums.yaml +4 -4
  2. data/.fern/metadata.json +9 -0
  3. data/.rubocop.yml +103 -0
  4. data/CONTRIBUTING.md +120 -0
  5. data/LICENSE +21 -0
  6. data/README.md +50 -0
  7. data/Rakefile +13 -0
  8. data/custom.gemspec.rb +5 -0
  9. data/lib/gemconfig.rb +1 -1
  10. data/lib/trophy/achievements/client.rb +93 -0
  11. data/lib/trophy/achievements/types/achievements_all_request.rb +11 -0
  12. data/lib/trophy/achievements/types/achievements_complete_request.rb +13 -0
  13. data/lib/trophy/admin/achievements/client.rb +201 -0
  14. data/lib/trophy/admin/achievements/types/achievements_delete_request.rb +13 -0
  15. data/lib/trophy/admin/achievements/types/achievements_list_request.rb +15 -0
  16. data/lib/trophy/admin/application_api_keys/client.rb +93 -0
  17. data/lib/trophy/admin/application_api_keys/types/application_api_keys_delete_request.rb +13 -0
  18. data/lib/trophy/admin/attributes/client.rb +200 -0
  19. data/lib/trophy/admin/attributes/types/attributes_delete_request.rb +13 -0
  20. data/lib/trophy/admin/attributes/types/attributes_list_request.rb +15 -0
  21. data/lib/trophy/admin/client.rb +68 -0
  22. data/lib/trophy/admin/environments/client.rb +52 -0
  23. data/lib/trophy/admin/leaderboards/client.rb +201 -0
  24. data/lib/trophy/admin/leaderboards/types/leaderboards_delete_request.rb +13 -0
  25. data/lib/trophy/admin/leaderboards/types/leaderboards_list_request.rb +15 -0
  26. data/lib/trophy/admin/metrics/client.rb +234 -0
  27. data/lib/trophy/admin/metrics/types/metrics_delete_request.rb +13 -0
  28. data/lib/trophy/admin/metrics/types/metrics_list_request.rb +15 -0
  29. data/lib/trophy/admin/points/boosts/client.rb +207 -0
  30. data/lib/trophy/admin/points/boosts/types/boosts_delete_request.rb +17 -0
  31. data/lib/trophy/admin/points/boosts/types/boosts_list_request.rb +19 -0
  32. data/lib/trophy/admin/points/client.rb +40 -0
  33. data/lib/trophy/admin/points/levels/client.rb +207 -0
  34. data/lib/trophy/admin/points/levels/types/levels_delete_request.rb +17 -0
  35. data/lib/trophy/admin/points/levels/types/levels_list_request.rb +19 -0
  36. data/lib/trophy/admin/points/systems/client.rb +203 -0
  37. data/lib/trophy/admin/points/systems/types/systems_delete_request.rb +15 -0
  38. data/lib/trophy/admin/points/systems/types/systems_list_request.rb +17 -0
  39. data/lib/trophy/admin/points/triggers/client.rb +208 -0
  40. data/lib/trophy/admin/points/triggers/types/triggers_delete_request.rb +17 -0
  41. data/lib/trophy/admin/points/triggers/types/triggers_list_request.rb +19 -0
  42. data/lib/trophy/admin/settings/client.rb +86 -0
  43. data/lib/trophy/admin/settings/types/update_admin_settings_request.rb +17 -0
  44. data/lib/trophy/admin/streaks/client.rb +106 -0
  45. data/lib/trophy/admin/streaks/freezes/client.rb +56 -0
  46. data/lib/trophy/admin/streaks/freezes/types/create_streak_freezes_request.rb +15 -0
  47. data/lib/trophy/admin/streaks/freezes/types/create_streak_freezes_request_freezes_item.rb +15 -0
  48. data/lib/trophy/admin/streaks/pauses/client.rb +95 -0
  49. data/lib/trophy/admin/streaks/pauses/types/create_streak_pauses_request.rb +15 -0
  50. data/lib/trophy/admin/streaks/pauses/types/create_streak_pauses_request_pauses_item.rb +19 -0
  51. data/lib/trophy/admin/streaks/pauses/types/pauses_delete_request.rb +15 -0
  52. data/lib/trophy/admin/streaks/settings/client.rb +88 -0
  53. data/lib/trophy/admin/streaks/settings/types/update_streak_settings_request.rb +25 -0
  54. data/lib/trophy/admin/streaks/types/reset_streaks_request.rb +13 -0
  55. data/lib/trophy/admin/streaks/types/reset_streaks_request_users_item.rb +13 -0
  56. data/lib/trophy/admin/streaks/types/restore_streaks_request.rb +13 -0
  57. data/lib/trophy/admin/streaks/types/restore_streaks_request_users_item.rb +13 -0
  58. data/lib/trophy/admin/tenants/client.rb +200 -0
  59. data/lib/trophy/admin/tenants/types/tenants_delete_request.rb +13 -0
  60. data/lib/trophy/admin/tenants/types/tenants_list_request.rb +15 -0
  61. data/lib/trophy/client.rb +62 -0
  62. data/lib/{environment.rb → trophy/environment.rb} +1 -1
  63. data/lib/trophy/errors/api_error.rb +8 -0
  64. data/lib/trophy/errors/client_error.rb +17 -0
  65. data/lib/trophy/errors/redirect_error.rb +8 -0
  66. data/lib/trophy/errors/response_error.rb +42 -0
  67. data/lib/trophy/errors/server_error.rb +11 -0
  68. data/lib/trophy/errors/timeout_error.rb +8 -0
  69. data/lib/trophy/internal/errors/constraint_error.rb +10 -0
  70. data/lib/trophy/internal/errors/type_error.rb +10 -0
  71. data/lib/trophy/internal/http/base_request.rb +51 -0
  72. data/lib/trophy/internal/http/raw_client.rb +215 -0
  73. data/lib/trophy/internal/iterators/cursor_item_iterator.rb +28 -0
  74. data/lib/trophy/internal/iterators/cursor_page_iterator.rb +63 -0
  75. data/lib/trophy/internal/iterators/item_iterator.rb +65 -0
  76. data/lib/trophy/internal/iterators/offset_item_iterator.rb +30 -0
  77. data/lib/trophy/internal/iterators/offset_page_iterator.rb +103 -0
  78. data/lib/trophy/internal/json/request.rb +41 -0
  79. data/lib/trophy/internal/json/serializable.rb +25 -0
  80. data/lib/trophy/internal/multipart/multipart_encoder.rb +141 -0
  81. data/lib/trophy/internal/multipart/multipart_form_data.rb +78 -0
  82. data/lib/trophy/internal/multipart/multipart_form_data_part.rb +51 -0
  83. data/lib/trophy/internal/multipart/multipart_request.rb +40 -0
  84. data/lib/trophy/internal/types/array.rb +47 -0
  85. data/lib/trophy/internal/types/boolean.rb +34 -0
  86. data/lib/trophy/internal/types/enum.rb +56 -0
  87. data/lib/trophy/internal/types/hash.rb +36 -0
  88. data/lib/trophy/internal/types/model/field.rb +38 -0
  89. data/lib/trophy/internal/types/model.rb +208 -0
  90. data/lib/trophy/internal/types/type.rb +35 -0
  91. data/lib/trophy/internal/types/union.rb +161 -0
  92. data/lib/trophy/internal/types/unknown.rb +15 -0
  93. data/lib/trophy/internal/types/utils.rb +116 -0
  94. data/lib/trophy/leaderboards/client.rb +101 -0
  95. data/lib/trophy/leaderboards/types/leaderboards_all_request.rb +11 -0
  96. data/lib/trophy/leaderboards/types/leaderboards_all_response_item.rb +47 -0
  97. data/lib/trophy/leaderboards/types/leaderboards_all_response_item_status.rb +15 -0
  98. data/lib/trophy/leaderboards/types/leaderboards_get_request.rb +21 -0
  99. data/lib/trophy/metrics/client.rb +62 -0
  100. data/lib/trophy/metrics/types/metrics_event_request.rb +19 -0
  101. data/lib/trophy/points/client.rb +194 -0
  102. data/lib/trophy/points/types/points_boosts_request.rb +13 -0
  103. data/lib/trophy/points/types/points_summary_request.rb +13 -0
  104. data/lib/trophy/streaks/client.rb +56 -0
  105. data/lib/trophy/streaks/types/streaks_list_request.rb +11 -0
  106. data/lib/trophy/types/achievement_completion_response.rb +13 -0
  107. data/lib/trophy/types/achievement_response.rb +37 -0
  108. data/lib/trophy/types/achievement_response_event_attribute.rb +13 -0
  109. data/lib/trophy/types/achievement_response_event_attributes_item.rb +11 -0
  110. data/lib/trophy/types/achievement_response_trigger.rb +15 -0
  111. data/lib/trophy/types/achievement_response_user_attributes_item.rb +11 -0
  112. data/lib/trophy/types/achievement_with_stats_response.rb +41 -0
  113. data/lib/trophy/types/admin_achievement.rb +37 -0
  114. data/lib/trophy/types/admin_achievement_badge.rb +9 -0
  115. data/lib/trophy/types/admin_achievement_event_attributes_item.rb +11 -0
  116. data/lib/trophy/types/admin_achievement_status.rb +13 -0
  117. data/lib/trophy/types/admin_achievement_trigger.rb +15 -0
  118. data/lib/trophy/types/admin_achievement_user_attributes_item.rb +11 -0
  119. data/lib/trophy/types/admin_aggregation_period.rb +12 -0
  120. data/lib/trophy/types/admin_attribute.rb +16 -0
  121. data/lib/trophy/types/admin_attribute_type.rb +12 -0
  122. data/lib/trophy/types/admin_environment.rb +14 -0
  123. data/lib/trophy/types/admin_error_body.rb +9 -0
  124. data/lib/trophy/types/admin_font_family.rb +19 -0
  125. data/lib/trophy/types/admin_issue.rb +20 -0
  126. data/lib/trophy/types/admin_issue_severity.rb +12 -0
  127. data/lib/trophy/types/admin_leaderboard.rb +40 -0
  128. data/lib/trophy/types/admin_leaderboard_rank_by.rb +13 -0
  129. data/lib/trophy/types/admin_leaderboard_run_unit.rb +13 -0
  130. data/lib/trophy/types/admin_leaderboard_status.rb +14 -0
  131. data/lib/trophy/types/admin_points_boost.rb +26 -0
  132. data/lib/trophy/types/admin_points_boost_rounding.rb +13 -0
  133. data/lib/{trophy_api_client/leaderboards/types/leaderboards_all_response_item_status.rb → trophy/types/admin_points_boost_status.rb} +5 -4
  134. data/lib/trophy/types/admin_points_boost_user_attributes_item.rb +11 -0
  135. data/lib/trophy/types/admin_points_level.rb +20 -0
  136. data/lib/trophy/types/admin_points_level_badge.rb +9 -0
  137. data/lib/trophy/types/admin_points_system.rb +22 -0
  138. data/lib/trophy/types/admin_points_system_badge.rb +9 -0
  139. data/lib/trophy/types/admin_points_system_status.rb +12 -0
  140. data/lib/trophy/types/admin_points_trigger.rb +34 -0
  141. data/lib/trophy/types/admin_points_trigger_event_attributes_item.rb +11 -0
  142. data/lib/trophy/types/admin_points_trigger_status.rb +12 -0
  143. data/lib/trophy/types/admin_points_trigger_time_unit.rb +12 -0
  144. data/lib/trophy/types/admin_points_trigger_type.rb +15 -0
  145. data/lib/trophy/types/admin_points_trigger_user_attributes_item.rb +11 -0
  146. data/lib/trophy/types/admin_settings.rb +14 -0
  147. data/lib/trophy/types/admin_settings_branding.rb +20 -0
  148. data/lib/trophy/types/admin_settings_branding_app_icon.rb +9 -0
  149. data/lib/trophy/types/admin_settings_branding_logo.rb +9 -0
  150. data/lib/trophy/types/admin_settings_experimentation.rb +12 -0
  151. data/lib/trophy/types/admin_streak_evaluation_mode.rb +12 -0
  152. data/lib/{trophy_api_client/users/types/users_points_event_summary_request_aggregation.rb → trophy/types/admin_streak_frequency.rb} +5 -3
  153. data/lib/trophy/types/admin_streak_pause.rb +18 -0
  154. data/lib/trophy/types/admin_streak_pause_status.rb +12 -0
  155. data/lib/trophy/types/admin_tenant.rb +20 -0
  156. data/lib/trophy/types/admin_tenant_status.rb +12 -0
  157. data/lib/trophy/types/base_streak_response.rb +27 -0
  158. data/lib/trophy/types/batch_events_response.rb +10 -0
  159. data/lib/trophy/types/batch_metric_event.rb +19 -0
  160. data/lib/trophy/types/batch_metric_event_user.rb +22 -0
  161. data/lib/trophy/types/bulk_streak_response.rb +23 -0
  162. data/lib/trophy/types/bulk_streak_response_item.rb +13 -0
  163. data/lib/trophy/types/create_achievement_request_item.rb +35 -0
  164. data/lib/trophy/types/create_achievement_request_item_badge.rb +10 -0
  165. data/lib/trophy/types/create_achievement_request_item_event_attributes_item.rb +11 -0
  166. data/lib/trophy/types/create_achievement_request_item_status.rb +13 -0
  167. data/lib/trophy/types/create_achievement_request_item_trigger.rb +15 -0
  168. data/lib/trophy/types/create_achievement_request_item_user_attributes_item.rb +11 -0
  169. data/lib/trophy/types/create_achievements_request.rb +23 -0
  170. data/lib/trophy/types/create_achievements_response.rb +12 -0
  171. data/lib/trophy/types/create_application_key_request_item.rb +10 -0
  172. data/lib/trophy/types/create_application_keys_request.rb +23 -0
  173. data/lib/trophy/types/create_application_keys_response.rb +12 -0
  174. data/lib/trophy/types/create_attribute_request_item.rb +14 -0
  175. data/lib/trophy/types/create_attribute_request_item_type.rb +12 -0
  176. data/lib/trophy/types/create_attributes_request.rb +23 -0
  177. data/lib/trophy/types/create_attributes_response.rb +12 -0
  178. data/lib/trophy/types/create_leaderboard_request_item.rb +38 -0
  179. data/lib/trophy/types/create_leaderboard_request_item_rank_by.rb +13 -0
  180. data/lib/trophy/types/create_leaderboard_request_item_run_unit.rb +13 -0
  181. data/lib/trophy/types/create_leaderboard_request_item_status.rb +14 -0
  182. data/lib/trophy/types/create_leaderboards_request.rb +23 -0
  183. data/lib/trophy/types/create_leaderboards_response.rb +12 -0
  184. data/lib/trophy/types/create_metric_request_item.rb +16 -0
  185. data/lib/trophy/types/create_metric_request_item_unit_type.rb +12 -0
  186. data/lib/trophy/types/create_metrics_request.rb +23 -0
  187. data/lib/trophy/types/create_metrics_response.rb +12 -0
  188. data/lib/trophy/types/create_points_boost_request_item.rb +23 -0
  189. data/lib/trophy/types/create_points_boost_request_item_rounding.rb +13 -0
  190. data/lib/trophy/types/create_points_boost_request_item_user_attributes_item.rb +11 -0
  191. data/lib/trophy/types/create_points_boosts_request.rb +23 -0
  192. data/lib/trophy/types/create_points_boosts_response.rb +12 -0
  193. data/lib/trophy/types/create_points_level_request_item.rb +18 -0
  194. data/lib/trophy/types/create_points_level_request_item_badge.rb +10 -0
  195. data/lib/trophy/types/create_points_levels_request.rb +23 -0
  196. data/lib/trophy/types/create_points_levels_response.rb +12 -0
  197. data/lib/trophy/types/create_points_system_request_item.rb +24 -0
  198. data/lib/trophy/types/create_points_system_request_item_badge.rb +9 -0
  199. data/lib/trophy/types/create_points_systems_request.rb +23 -0
  200. data/lib/trophy/types/create_points_systems_response.rb +12 -0
  201. data/lib/trophy/types/create_points_trigger_request_item.rb +32 -0
  202. data/lib/trophy/types/create_points_trigger_request_item_event_attributes_item.rb +11 -0
  203. data/lib/trophy/types/create_points_trigger_request_item_status.rb +12 -0
  204. data/lib/trophy/types/create_points_trigger_request_item_time_unit.rb +12 -0
  205. data/lib/trophy/types/create_points_trigger_request_item_type.rb +15 -0
  206. data/lib/trophy/types/create_points_trigger_request_item_user_attributes_item.rb +11 -0
  207. data/lib/trophy/types/create_points_triggers_request.rb +23 -0
  208. data/lib/trophy/types/create_points_triggers_response.rb +12 -0
  209. data/lib/trophy/types/create_streak_freezes_response.rb +10 -0
  210. data/lib/trophy/types/create_streak_pauses_response.rb +12 -0
  211. data/lib/trophy/types/create_tenant_request_item.rb +12 -0
  212. data/lib/trophy/types/create_tenants_request.rb +23 -0
  213. data/lib/trophy/types/create_tenants_response.rb +12 -0
  214. data/lib/trophy/types/created_admin_points_system.rb +29 -0
  215. data/lib/trophy/types/created_application_key.rb +16 -0
  216. data/lib/trophy/types/created_metric.rb +18 -0
  217. data/lib/trophy/types/created_metric_unit_type.rb +12 -0
  218. data/lib/trophy/types/delete_achievements_response.rb +13 -0
  219. data/lib/trophy/types/delete_application_keys_response.rb +12 -0
  220. data/lib/trophy/types/delete_attributes_response.rb +13 -0
  221. data/lib/trophy/types/delete_leaderboards_response.rb +12 -0
  222. data/lib/trophy/types/delete_metrics_response.rb +13 -0
  223. data/lib/trophy/types/delete_points_boosts_response.rb +12 -0
  224. data/lib/trophy/types/delete_points_levels_response.rb +12 -0
  225. data/lib/trophy/types/delete_points_systems_response.rb +12 -0
  226. data/lib/trophy/types/delete_points_triggers_response.rb +12 -0
  227. data/lib/trophy/types/delete_streak_pauses_response.rb +12 -0
  228. data/lib/trophy/types/delete_tenants_response.rb +12 -0
  229. data/lib/trophy/types/deleted_resource.rb +10 -0
  230. data/lib/trophy/types/error_body.rb +9 -0
  231. data/lib/trophy/types/event_response.rb +25 -0
  232. data/lib/trophy/types/get_user_points_response.rb +25 -0
  233. data/lib/trophy/types/leaderboard_event.rb +20 -0
  234. data/lib/trophy/types/leaderboard_ranking.rb +16 -0
  235. data/lib/trophy/types/leaderboard_response.rb +44 -0
  236. data/lib/trophy/types/leaderboard_response_rank_by.rb +13 -0
  237. data/lib/trophy/types/leaderboard_response_run_unit.rb +13 -0
  238. data/lib/trophy/types/leaderboard_response_with_rankings.rb +47 -0
  239. data/lib/trophy/types/leaderboard_response_with_rankings_status.rb +13 -0
  240. data/lib/trophy/types/list_achievements_response.rb +23 -0
  241. data/lib/trophy/types/list_attributes_response.rb +23 -0
  242. data/lib/trophy/types/list_environments_response.rb +23 -0
  243. data/lib/trophy/types/list_leaderboards_response.rb +23 -0
  244. data/lib/trophy/types/list_metrics_response.rb +23 -0
  245. data/lib/trophy/types/list_points_boosts_response.rb +23 -0
  246. data/lib/trophy/types/list_points_levels_response.rb +23 -0
  247. data/lib/trophy/types/list_points_systems_response.rb +23 -0
  248. data/lib/trophy/types/list_points_triggers_response.rb +23 -0
  249. data/lib/trophy/types/list_tenants_response.rb +23 -0
  250. data/lib/trophy/types/metric_event_leaderboard_response.rb +53 -0
  251. data/lib/trophy/types/metric_event_leaderboard_response_breakdown_attribute_values_item.rb +11 -0
  252. data/lib/trophy/types/metric_event_points_response.rb +28 -0
  253. data/lib/trophy/types/metric_event_streak_response.rb +30 -0
  254. data/lib/trophy/types/metric_response.rb +17 -0
  255. data/lib/trophy/types/notification_channel.rb +12 -0
  256. data/lib/trophy/types/notification_preferences.rb +16 -0
  257. data/lib/trophy/types/patch_points_boosts_request.rb +23 -0
  258. data/lib/trophy/types/patch_points_boosts_request_item.rb +21 -0
  259. data/lib/trophy/types/patch_points_boosts_request_item_rounding.rb +13 -0
  260. data/lib/trophy/types/patch_points_boosts_request_item_user_attributes_item.rb +11 -0
  261. data/lib/trophy/types/patch_points_boosts_response.rb +12 -0
  262. data/lib/trophy/types/patch_points_levels_request.rb +23 -0
  263. data/lib/trophy/types/patch_points_levels_request_item.rb +17 -0
  264. data/lib/trophy/types/patch_points_levels_request_item_badge.rb +9 -0
  265. data/lib/trophy/types/patch_points_levels_response.rb +12 -0
  266. data/lib/trophy/types/patch_points_triggers_request.rb +23 -0
  267. data/lib/trophy/types/patch_points_triggers_request_item.rb +33 -0
  268. data/lib/trophy/types/patch_points_triggers_request_item_event_attributes_item.rb +11 -0
  269. data/lib/trophy/types/patch_points_triggers_request_item_status.rb +12 -0
  270. data/lib/trophy/types/patch_points_triggers_request_item_time_unit.rb +12 -0
  271. data/lib/trophy/types/patch_points_triggers_request_item_type.rb +15 -0
  272. data/lib/trophy/types/patch_points_triggers_request_item_user_attributes_item.rb +11 -0
  273. data/lib/trophy/types/patch_points_triggers_response.rb +12 -0
  274. data/lib/trophy/types/points_award.rb +19 -0
  275. data/lib/trophy/types/points_boost.rb +21 -0
  276. data/lib/trophy/types/points_boost_rounding.rb +13 -0
  277. data/lib/trophy/types/points_boost_status.rb +13 -0
  278. data/lib/trophy/types/points_boost_webhook_payload.rb +30 -0
  279. data/lib/trophy/types/points_boost_webhook_payload_rounding.rb +13 -0
  280. data/lib/trophy/types/points_boost_webhook_payload_status.rb +12 -0
  281. data/lib/trophy/types/points_level.rb +20 -0
  282. data/lib/trophy/types/points_level_summary_response.rb +23 -0
  283. data/lib/trophy/types/points_level_summary_response_item.rb +11 -0
  284. data/lib/trophy/types/points_range.rb +13 -0
  285. data/lib/trophy/types/points_response.rb +20 -0
  286. data/lib/trophy/types/points_summary_response.rb +23 -0
  287. data/lib/trophy/types/points_system_response.rb +19 -0
  288. data/lib/trophy/types/points_trigger.rb +41 -0
  289. data/lib/trophy/types/points_trigger_event_attribute.rb +13 -0
  290. data/lib/trophy/types/points_trigger_event_attributes_item.rb +11 -0
  291. data/lib/trophy/types/points_trigger_status.rb +13 -0
  292. data/lib/trophy/types/points_trigger_time_unit.rb +12 -0
  293. data/lib/trophy/types/points_trigger_type.rb +15 -0
  294. data/lib/trophy/types/points_trigger_user_attributes_item.rb +11 -0
  295. data/lib/trophy/types/reset_streaks_response.rb +12 -0
  296. data/lib/trophy/types/restore_streaks_response.rb +12 -0
  297. data/lib/trophy/types/streak_evaluation_mode_preference.rb +12 -0
  298. data/lib/{trophy_api_client/users/types/users_metric_event_summary_request_aggregation.rb → trophy/types/streak_frequency.rb} +5 -3
  299. data/lib/trophy/types/streak_metric_preference.rb +12 -0
  300. data/lib/trophy/types/streak_preferences.rb +17 -0
  301. data/lib/trophy/types/streak_response.rb +34 -0
  302. data/lib/trophy/types/streak_response_pauses_item.rb +14 -0
  303. data/lib/trophy/types/streak_response_streak_history_item.rb +20 -0
  304. data/lib/trophy/types/streak_settings.rb +20 -0
  305. data/lib/trophy/types/streak_settings_freezes.rb +16 -0
  306. data/lib/trophy/types/streak_settings_metric.rb +12 -0
  307. data/lib/trophy/types/update_achievement_request_item.rb +37 -0
  308. data/lib/trophy/types/update_achievement_request_item_badge.rb +9 -0
  309. data/lib/trophy/types/update_achievement_request_item_event_attributes_item.rb +11 -0
  310. data/lib/trophy/types/update_achievement_request_item_status.rb +13 -0
  311. data/lib/trophy/types/update_achievement_request_item_trigger.rb +15 -0
  312. data/lib/trophy/types/update_achievement_request_item_user_attributes_item.rb +11 -0
  313. data/lib/trophy/types/update_achievements_request.rb +23 -0
  314. data/lib/trophy/types/update_achievements_response.rb +12 -0
  315. data/lib/trophy/types/update_admin_settings_branding.rb +20 -0
  316. data/lib/trophy/types/update_admin_settings_branding_app_icon.rb +9 -0
  317. data/lib/trophy/types/update_admin_settings_branding_logo.rb +9 -0
  318. data/lib/trophy/types/update_admin_settings_experimentation.rb +12 -0
  319. data/lib/trophy/types/update_attribute_request_item.rb +13 -0
  320. data/lib/trophy/types/update_attributes_request.rb +23 -0
  321. data/lib/trophy/types/update_attributes_response.rb +12 -0
  322. data/lib/trophy/types/update_leaderboard_request_item.rb +41 -0
  323. data/lib/trophy/types/update_leaderboard_request_item_rank_by.rb +13 -0
  324. data/lib/trophy/types/update_leaderboard_request_item_run_unit.rb +13 -0
  325. data/lib/trophy/types/update_leaderboard_request_item_status.rb +14 -0
  326. data/lib/trophy/types/update_leaderboards_request.rb +23 -0
  327. data/lib/trophy/types/update_leaderboards_response.rb +12 -0
  328. data/lib/trophy/types/update_metric_request_item.rb +17 -0
  329. data/lib/trophy/types/update_metric_request_item_unit_type.rb +12 -0
  330. data/lib/trophy/types/update_metrics_request.rb +23 -0
  331. data/lib/trophy/types/update_metrics_response.rb +12 -0
  332. data/lib/trophy/types/update_points_system_request_item.rb +18 -0
  333. data/lib/trophy/types/update_points_system_request_item_badge.rb +9 -0
  334. data/lib/trophy/types/update_points_systems_request.rb +23 -0
  335. data/lib/trophy/types/update_points_systems_response.rb +12 -0
  336. data/lib/trophy/types/update_streak_settings_freezes.rb +17 -0
  337. data/lib/trophy/types/update_tenant_request_item.rb +14 -0
  338. data/lib/trophy/types/update_tenants_request.rb +23 -0
  339. data/lib/trophy/types/update_tenants_response.rb +12 -0
  340. data/lib/trophy/types/updated_user.rb +22 -0
  341. data/lib/trophy/types/upserted_user.rb +24 -0
  342. data/lib/trophy/types/user.rb +30 -0
  343. data/lib/trophy/types/user_achievement_response.rb +39 -0
  344. data/lib/trophy/types/user_achievement_with_stats_response.rb +43 -0
  345. data/lib/trophy/types/user_leaderboard_response.rb +48 -0
  346. data/lib/trophy/types/user_leaderboard_response_with_history.rb +50 -0
  347. data/lib/trophy/types/user_preferences_response.rb +12 -0
  348. data/lib/trophy/types/webhook_user_leaderboard_response.rb +52 -0
  349. data/lib/trophy/types/webhooks_achievement_completed_payload.rb +13 -0
  350. data/lib/trophy/types/webhooks_emails_achievement_due_payload.rb +15 -0
  351. data/lib/trophy/types/webhooks_emails_reactivation_due_payload.rb +15 -0
  352. data/lib/trophy/types/webhooks_emails_reactivation_due_payload_reactivation.rb +12 -0
  353. data/lib/trophy/types/webhooks_emails_recap_due_payload.rb +15 -0
  354. data/lib/trophy/types/webhooks_emails_recap_due_payload_recap.rb +12 -0
  355. data/lib/trophy/types/webhooks_emails_streak_reminder_due_payload.rb +15 -0
  356. data/lib/trophy/types/webhooks_leaderboard_changed_payload.rb +11 -0
  357. data/lib/trophy/types/webhooks_leaderboard_finished_payload.rb +11 -0
  358. data/lib/trophy/types/webhooks_leaderboard_rank_changed_payload.rb +13 -0
  359. data/lib/trophy/types/webhooks_leaderboard_started_payload.rb +11 -0
  360. data/lib/trophy/types/webhooks_points_boost_finished_payload.rb +13 -0
  361. data/lib/trophy/types/webhooks_points_boost_started_payload.rb +13 -0
  362. data/lib/trophy/types/webhooks_points_changed_payload.rb +13 -0
  363. data/lib/trophy/types/webhooks_points_level_changed_payload.rb +17 -0
  364. data/lib/trophy/types/webhooks_points_level_changed_payload_points.rb +22 -0
  365. data/lib/trophy/types/webhooks_streak_extended_payload.rb +13 -0
  366. data/lib/trophy/types/webhooks_streak_freeze_consumed_payload.rb +15 -0
  367. data/lib/trophy/types/webhooks_streak_freeze_earned_payload.rb +15 -0
  368. data/lib/trophy/types/webhooks_streak_lost_payload.rb +13 -0
  369. data/lib/trophy/types/webhooks_streak_started_payload.rb +13 -0
  370. data/lib/trophy/types/wrapped_activity.rb +22 -0
  371. data/lib/trophy/types/wrapped_activity_period.rb +16 -0
  372. data/lib/trophy/types/wrapped_entire_year.rb +18 -0
  373. data/lib/trophy/types/wrapped_metric.rb +22 -0
  374. data/lib/trophy/types/wrapped_metric_by_attribute_value_value.rb +19 -0
  375. data/lib/trophy/types/wrapped_most_active_day.rb +18 -0
  376. data/lib/trophy/types/wrapped_most_active_month.rb +18 -0
  377. data/lib/trophy/types/wrapped_most_active_week.rb +20 -0
  378. data/lib/trophy/types/wrapped_points.rb +20 -0
  379. data/lib/trophy/types/wrapped_response.rb +13 -0
  380. data/lib/trophy/types/wrapped_streak.rb +18 -0
  381. data/lib/trophy/users/client.rb +612 -0
  382. data/lib/trophy/users/types/update_user_preferences_request.rb +15 -0
  383. data/lib/trophy/users/types/users_achievements_request.rb +13 -0
  384. data/lib/trophy/users/types/users_leaderboard_request.rb +17 -0
  385. data/lib/trophy/users/types/users_metric_event_summary_request.rb +19 -0
  386. data/lib/trophy/users/types/users_metric_event_summary_request_aggregation.rb +15 -0
  387. data/lib/trophy/users/types/users_metric_event_summary_response_item.rb +15 -0
  388. data/lib/trophy/users/types/users_points_event_summary_request.rb +19 -0
  389. data/lib/trophy/users/types/users_points_event_summary_request_aggregation.rb +15 -0
  390. data/lib/trophy/users/types/users_points_event_summary_response_item.rb +15 -0
  391. data/lib/trophy/users/types/users_points_request.rb +15 -0
  392. data/lib/trophy/users/types/users_streak_request.rb +13 -0
  393. data/lib/trophy/users/types/users_wrapped_request.rb +13 -0
  394. data/lib/trophy/version.rb +5 -0
  395. data/lib/trophy.rb +390 -0
  396. data/lib/trophy_api_client.rb +4 -101
  397. data/reference.md +6128 -0
  398. metadata +403 -333
  399. data/lib/requests.rb +0 -189
  400. data/lib/trophy_api_client/achievements/client.rb +0 -196
  401. data/lib/trophy_api_client/admin/attributes/client.rb +0 -378
  402. data/lib/trophy_api_client/admin/client.rb +0 -65
  403. data/lib/trophy_api_client/admin/leaderboards/client.rb +0 -381
  404. data/lib/trophy_api_client/admin/metrics/client.rb +0 -376
  405. data/lib/trophy_api_client/admin/points/boosts/client.rb +0 -410
  406. data/lib/trophy_api_client/admin/points/client.rb +0 -53
  407. data/lib/trophy_api_client/admin/points/levels/client.rb +0 -412
  408. data/lib/trophy_api_client/admin/points/systems/client.rb +0 -384
  409. data/lib/trophy_api_client/admin/points/triggers/client.rb +0 -412
  410. data/lib/trophy_api_client/admin/streaks/client.rb +0 -106
  411. data/lib/trophy_api_client/admin/streaks/freezes/client.rb +0 -100
  412. data/lib/trophy_api_client/admin/streaks/freezes/types/create_streak_freezes_request_freezes_item.rb +0 -62
  413. data/lib/trophy_api_client/admin/streaks/types/restore_streaks_request_users_item.rb +0 -59
  414. data/lib/trophy_api_client/admin/tenants/client.rb +0 -376
  415. data/lib/trophy_api_client/leaderboards/client.rb +0 -225
  416. data/lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item.rb +0 -202
  417. data/lib/trophy_api_client/metrics/client.rb +0 -142
  418. data/lib/trophy_api_client/points/client.rb +0 -424
  419. data/lib/trophy_api_client/streaks/client.rb +0 -104
  420. data/lib/trophy_api_client/types/achievement_completion_response.rb +0 -83
  421. data/lib/trophy_api_client/types/achievement_response.rb +0 -198
  422. data/lib/trophy_api_client/types/achievement_response_event_attribute.rb +0 -67
  423. data/lib/trophy_api_client/types/achievement_response_event_attributes_item.rb +0 -66
  424. data/lib/trophy_api_client/types/achievement_response_trigger.rb +0 -11
  425. data/lib/trophy_api_client/types/achievement_response_user_attributes_item.rb +0 -66
  426. data/lib/trophy_api_client/types/achievement_with_stats_response.rb +0 -214
  427. data/lib/trophy_api_client/types/admin_attribute.rb +0 -81
  428. data/lib/trophy_api_client/types/admin_attribute_type.rb +0 -9
  429. data/lib/trophy_api_client/types/admin_issue.rb +0 -98
  430. data/lib/trophy_api_client/types/admin_issue_severity.rb +0 -9
  431. data/lib/trophy_api_client/types/admin_leaderboard.rb +0 -171
  432. data/lib/trophy_api_client/types/admin_leaderboard_rank_by.rb +0 -10
  433. data/lib/trophy_api_client/types/admin_leaderboard_run_unit.rb +0 -10
  434. data/lib/trophy_api_client/types/admin_leaderboard_status.rb +0 -11
  435. data/lib/trophy_api_client/types/admin_points_boost.rb +0 -138
  436. data/lib/trophy_api_client/types/admin_points_boost_rounding.rb +0 -10
  437. data/lib/trophy_api_client/types/admin_points_boost_status.rb +0 -10
  438. data/lib/trophy_api_client/types/admin_points_boost_user_attributes_item.rb +0 -65
  439. data/lib/trophy_api_client/types/admin_points_level.rb +0 -109
  440. data/lib/trophy_api_client/types/admin_points_level_badge.rb +0 -55
  441. data/lib/trophy_api_client/types/admin_points_system.rb +0 -118
  442. data/lib/trophy_api_client/types/admin_points_system_badge.rb +0 -55
  443. data/lib/trophy_api_client/types/admin_points_system_status.rb +0 -9
  444. data/lib/trophy_api_client/types/admin_points_trigger.rb +0 -175
  445. data/lib/trophy_api_client/types/admin_points_trigger_event_attributes_item.rb +0 -66
  446. data/lib/trophy_api_client/types/admin_points_trigger_status.rb +0 -9
  447. data/lib/trophy_api_client/types/admin_points_trigger_time_unit.rb +0 -9
  448. data/lib/trophy_api_client/types/admin_points_trigger_type.rb +0 -12
  449. data/lib/trophy_api_client/types/admin_points_trigger_user_attributes_item.rb +0 -65
  450. data/lib/trophy_api_client/types/admin_tenant.rb +0 -103
  451. data/lib/trophy_api_client/types/admin_tenant_status.rb +0 -9
  452. data/lib/trophy_api_client/types/base_streak_response.rb +0 -144
  453. data/lib/trophy_api_client/types/bulk_streak_response.rb +0 -7
  454. data/lib/trophy_api_client/types/bulk_streak_response_item.rb +0 -76
  455. data/lib/trophy_api_client/types/create_attribute_request_item.rb +0 -76
  456. data/lib/trophy_api_client/types/create_attribute_request_item_type.rb +0 -9
  457. data/lib/trophy_api_client/types/create_attributes_request.rb +0 -7
  458. data/lib/trophy_api_client/types/create_attributes_response.rb +0 -74
  459. data/lib/trophy_api_client/types/create_leaderboard_request_item.rb +0 -171
  460. data/lib/trophy_api_client/types/create_leaderboard_request_item_rank_by.rb +0 -10
  461. data/lib/trophy_api_client/types/create_leaderboard_request_item_run_unit.rb +0 -11
  462. data/lib/trophy_api_client/types/create_leaderboard_request_item_status.rb +0 -13
  463. data/lib/trophy_api_client/types/create_leaderboards_request.rb +0 -7
  464. data/lib/trophy_api_client/types/create_leaderboards_response.rb +0 -74
  465. data/lib/trophy_api_client/types/create_metric_request_item.rb +0 -87
  466. data/lib/trophy_api_client/types/create_metric_request_item_unit_type.rb +0 -9
  467. data/lib/trophy_api_client/types/create_metrics_request.rb +0 -7
  468. data/lib/trophy_api_client/types/create_metrics_response.rb +0 -74
  469. data/lib/trophy_api_client/types/create_points_boost_request_item.rb +0 -125
  470. data/lib/trophy_api_client/types/create_points_boost_request_item_rounding.rb +0 -10
  471. data/lib/trophy_api_client/types/create_points_boost_request_item_user_attributes_item.rb +0 -67
  472. data/lib/trophy_api_client/types/create_points_boosts_request.rb +0 -7
  473. data/lib/trophy_api_client/types/create_points_boosts_response.rb +0 -75
  474. data/lib/trophy_api_client/types/create_points_level_request_item.rb +0 -103
  475. data/lib/trophy_api_client/types/create_points_level_request_item_badge.rb +0 -56
  476. data/lib/trophy_api_client/types/create_points_levels_request.rb +0 -7
  477. data/lib/trophy_api_client/types/create_points_levels_response.rb +0 -74
  478. data/lib/trophy_api_client/types/create_points_system_request_item.rb +0 -140
  479. data/lib/trophy_api_client/types/create_points_system_request_item_badge.rb +0 -55
  480. data/lib/trophy_api_client/types/create_points_systems_request.rb +0 -7
  481. data/lib/trophy_api_client/types/create_points_systems_response.rb +0 -74
  482. data/lib/trophy_api_client/types/create_points_trigger_request_item.rb +0 -167
  483. data/lib/trophy_api_client/types/create_points_trigger_request_item_event_attributes_item.rb +0 -67
  484. data/lib/trophy_api_client/types/create_points_trigger_request_item_status.rb +0 -9
  485. data/lib/trophy_api_client/types/create_points_trigger_request_item_time_unit.rb +0 -9
  486. data/lib/trophy_api_client/types/create_points_trigger_request_item_type.rb +0 -12
  487. data/lib/trophy_api_client/types/create_points_trigger_request_item_user_attributes_item.rb +0 -67
  488. data/lib/trophy_api_client/types/create_points_triggers_request.rb +0 -7
  489. data/lib/trophy_api_client/types/create_points_triggers_response.rb +0 -74
  490. data/lib/trophy_api_client/types/create_streak_freezes_response.rb +0 -60
  491. data/lib/trophy_api_client/types/create_tenant_request_item.rb +0 -66
  492. data/lib/trophy_api_client/types/create_tenants_request.rb +0 -7
  493. data/lib/trophy_api_client/types/create_tenants_response.rb +0 -74
  494. data/lib/trophy_api_client/types/created_admin_points_system.rb +0 -163
  495. data/lib/trophy_api_client/types/created_metric.rb +0 -88
  496. data/lib/trophy_api_client/types/created_metric_unit_type.rb +0 -9
  497. data/lib/trophy_api_client/types/delete_attributes_response.rb +0 -75
  498. data/lib/trophy_api_client/types/delete_leaderboards_response.rb +0 -75
  499. data/lib/trophy_api_client/types/delete_metrics_response.rb +0 -75
  500. data/lib/trophy_api_client/types/delete_points_boosts_response.rb +0 -74
  501. data/lib/trophy_api_client/types/delete_points_levels_response.rb +0 -74
  502. data/lib/trophy_api_client/types/delete_points_systems_response.rb +0 -74
  503. data/lib/trophy_api_client/types/delete_points_triggers_response.rb +0 -75
  504. data/lib/trophy_api_client/types/delete_tenants_response.rb +0 -74
  505. data/lib/trophy_api_client/types/deleted_resource.rb +0 -56
  506. data/lib/trophy_api_client/types/error_body.rb +0 -55
  507. data/lib/trophy_api_client/types/event_response.rb +0 -147
  508. data/lib/trophy_api_client/types/get_user_points_response.rb +0 -139
  509. data/lib/trophy_api_client/types/leaderboard_event.rb +0 -110
  510. data/lib/trophy_api_client/types/leaderboard_ranking.rb +0 -82
  511. data/lib/trophy_api_client/types/leaderboard_response.rb +0 -192
  512. data/lib/trophy_api_client/types/leaderboard_response_rank_by.rb +0 -10
  513. data/lib/trophy_api_client/types/leaderboard_response_run_unit.rb +0 -11
  514. data/lib/trophy_api_client/types/leaderboard_response_with_rankings.rb +0 -212
  515. data/lib/trophy_api_client/types/leaderboard_response_with_rankings_status.rb +0 -10
  516. data/lib/trophy_api_client/types/list_attributes_response.rb +0 -7
  517. data/lib/trophy_api_client/types/list_leaderboards_response.rb +0 -7
  518. data/lib/trophy_api_client/types/list_metrics_response.rb +0 -7
  519. data/lib/trophy_api_client/types/list_points_boosts_response.rb +0 -7
  520. data/lib/trophy_api_client/types/list_points_levels_response.rb +0 -7
  521. data/lib/trophy_api_client/types/list_points_systems_response.rb +0 -7
  522. data/lib/trophy_api_client/types/list_points_triggers_response.rb +0 -7
  523. data/lib/trophy_api_client/types/list_tenants_response.rb +0 -7
  524. data/lib/trophy_api_client/types/metric_event_leaderboard_response.rb +0 -245
  525. data/lib/trophy_api_client/types/metric_event_leaderboard_response_breakdown_attribute_values_item.rb +0 -67
  526. data/lib/trophy_api_client/types/metric_event_points_response.rb +0 -148
  527. data/lib/trophy_api_client/types/metric_event_streak_response.rb +0 -153
  528. data/lib/trophy_api_client/types/metric_response.rb +0 -90
  529. data/lib/trophy_api_client/types/notification_channel.rb +0 -9
  530. data/lib/trophy_api_client/types/notification_preferences.rb +0 -89
  531. data/lib/trophy_api_client/types/patch_points_boosts_request.rb +0 -7
  532. data/lib/trophy_api_client/types/patch_points_boosts_request_item.rb +0 -118
  533. data/lib/trophy_api_client/types/patch_points_boosts_request_item_rounding.rb +0 -10
  534. data/lib/trophy_api_client/types/patch_points_boosts_request_item_user_attributes_item.rb +0 -67
  535. data/lib/trophy_api_client/types/patch_points_boosts_response.rb +0 -74
  536. data/lib/trophy_api_client/types/patch_points_levels_request.rb +0 -7
  537. data/lib/trophy_api_client/types/patch_points_levels_request_item.rb +0 -100
  538. data/lib/trophy_api_client/types/patch_points_levels_request_item_badge.rb +0 -55
  539. data/lib/trophy_api_client/types/patch_points_levels_response.rb +0 -74
  540. data/lib/trophy_api_client/types/patch_points_triggers_request.rb +0 -7
  541. data/lib/trophy_api_client/types/patch_points_triggers_request_item.rb +0 -174
  542. data/lib/trophy_api_client/types/patch_points_triggers_request_item_event_attributes_item.rb +0 -67
  543. data/lib/trophy_api_client/types/patch_points_triggers_request_item_status.rb +0 -9
  544. data/lib/trophy_api_client/types/patch_points_triggers_request_item_time_unit.rb +0 -9
  545. data/lib/trophy_api_client/types/patch_points_triggers_request_item_type.rb +0 -13
  546. data/lib/trophy_api_client/types/patch_points_triggers_request_item_user_attributes_item.rb +0 -67
  547. data/lib/trophy_api_client/types/patch_points_triggers_response.rb +0 -74
  548. data/lib/trophy_api_client/types/points_award.rb +0 -113
  549. data/lib/trophy_api_client/types/points_boost.rb +0 -112
  550. data/lib/trophy_api_client/types/points_boost_rounding.rb +0 -10
  551. data/lib/trophy_api_client/types/points_boost_status.rb +0 -10
  552. data/lib/trophy_api_client/types/points_boost_webhook_payload.rb +0 -149
  553. data/lib/trophy_api_client/types/points_boost_webhook_payload_rounding.rb +0 -10
  554. data/lib/trophy_api_client/types/points_boost_webhook_payload_status.rb +0 -9
  555. data/lib/trophy_api_client/types/points_level.rb +0 -103
  556. data/lib/trophy_api_client/types/points_level_summary_response.rb +0 -7
  557. data/lib/trophy_api_client/types/points_level_summary_response_item.rb +0 -71
  558. data/lib/trophy_api_client/types/points_range.rb +0 -72
  559. data/lib/trophy_api_client/types/points_response.rb +0 -103
  560. data/lib/trophy_api_client/types/points_summary_response.rb +0 -7
  561. data/lib/trophy_api_client/types/points_system_response.rb +0 -107
  562. data/lib/trophy_api_client/types/points_trigger.rb +0 -227
  563. data/lib/trophy_api_client/types/points_trigger_event_attribute.rb +0 -67
  564. data/lib/trophy_api_client/types/points_trigger_event_attributes_item.rb +0 -65
  565. data/lib/trophy_api_client/types/points_trigger_status.rb +0 -10
  566. data/lib/trophy_api_client/types/points_trigger_time_unit.rb +0 -9
  567. data/lib/trophy_api_client/types/points_trigger_type.rb +0 -12
  568. data/lib/trophy_api_client/types/points_trigger_user_attributes_item.rb +0 -65
  569. data/lib/trophy_api_client/types/restore_streaks_response.rb +0 -70
  570. data/lib/trophy_api_client/types/streak_evaluation_mode_preference.rb +0 -11
  571. data/lib/trophy_api_client/types/streak_frequency.rb +0 -9
  572. data/lib/trophy_api_client/types/streak_metric_preference.rb +0 -66
  573. data/lib/trophy_api_client/types/streak_preferences.rb +0 -83
  574. data/lib/trophy_api_client/types/streak_response.rb +0 -170
  575. data/lib/trophy_api_client/types/streak_response_streak_history_item.rb +0 -89
  576. data/lib/trophy_api_client/types/update_attribute_request_item.rb +0 -69
  577. data/lib/trophy_api_client/types/update_attributes_request.rb +0 -7
  578. data/lib/trophy_api_client/types/update_attributes_response.rb +0 -75
  579. data/lib/trophy_api_client/types/update_leaderboard_request_item.rb +0 -179
  580. data/lib/trophy_api_client/types/update_leaderboard_request_item_rank_by.rb +0 -11
  581. data/lib/trophy_api_client/types/update_leaderboard_request_item_run_unit.rb +0 -9
  582. data/lib/trophy_api_client/types/update_leaderboard_request_item_status.rb +0 -12
  583. data/lib/trophy_api_client/types/update_leaderboards_request.rb +0 -7
  584. data/lib/trophy_api_client/types/update_leaderboards_response.rb +0 -75
  585. data/lib/trophy_api_client/types/update_metric_request_item.rb +0 -86
  586. data/lib/trophy_api_client/types/update_metric_request_item_unit_type.rb +0 -9
  587. data/lib/trophy_api_client/types/update_metrics_request.rb +0 -7
  588. data/lib/trophy_api_client/types/update_metrics_response.rb +0 -75
  589. data/lib/trophy_api_client/types/update_points_system_request_item.rb +0 -102
  590. data/lib/trophy_api_client/types/update_points_system_request_item_badge.rb +0 -55
  591. data/lib/trophy_api_client/types/update_points_systems_request.rb +0 -7
  592. data/lib/trophy_api_client/types/update_points_systems_response.rb +0 -74
  593. data/lib/trophy_api_client/types/update_tenant_request_item.rb +0 -75
  594. data/lib/trophy_api_client/types/update_tenants_request.rb +0 -7
  595. data/lib/trophy_api_client/types/update_tenants_response.rb +0 -74
  596. data/lib/trophy_api_client/types/updated_user.rb +0 -108
  597. data/lib/trophy_api_client/types/upserted_user.rb +0 -116
  598. data/lib/trophy_api_client/types/user.rb +0 -141
  599. data/lib/trophy_api_client/types/user_achievement_response.rb +0 -209
  600. data/lib/trophy_api_client/types/user_achievement_with_stats_response.rb +0 -225
  601. data/lib/trophy_api_client/types/user_leaderboard_response.rb +0 -212
  602. data/lib/trophy_api_client/types/user_leaderboard_response_with_history.rb +0 -224
  603. data/lib/trophy_api_client/types/user_preferences_response.rb +0 -80
  604. data/lib/trophy_api_client/types/webhook_user_leaderboard_response.rb +0 -228
  605. data/lib/trophy_api_client/types/webhooks_achievement_completed_payload.rb +0 -84
  606. data/lib/trophy_api_client/types/webhooks_leaderboard_changed_payload.rb +0 -71
  607. data/lib/trophy_api_client/types/webhooks_leaderboard_finished_payload.rb +0 -71
  608. data/lib/trophy_api_client/types/webhooks_leaderboard_rank_changed_payload.rb +0 -85
  609. data/lib/trophy_api_client/types/webhooks_leaderboard_started_payload.rb +0 -71
  610. data/lib/trophy_api_client/types/webhooks_points_boost_finished_payload.rb +0 -79
  611. data/lib/trophy_api_client/types/webhooks_points_boost_started_payload.rb +0 -79
  612. data/lib/trophy_api_client/types/webhooks_points_changed_payload.rb +0 -84
  613. data/lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb +0 -117
  614. data/lib/trophy_api_client/types/webhooks_points_level_changed_payload_points.rb +0 -114
  615. data/lib/trophy_api_client/types/webhooks_streak_extended_payload.rb +0 -84
  616. data/lib/trophy_api_client/types/webhooks_streak_freeze_consumed_payload.rb +0 -85
  617. data/lib/trophy_api_client/types/webhooks_streak_freeze_earned_payload.rb +0 -85
  618. data/lib/trophy_api_client/types/webhooks_streak_lost_payload.rb +0 -78
  619. data/lib/trophy_api_client/types/webhooks_streak_started_payload.rb +0 -84
  620. data/lib/trophy_api_client/types/wrapped_activity.rb +0 -134
  621. data/lib/trophy_api_client/types/wrapped_activity_period.rb +0 -95
  622. data/lib/trophy_api_client/types/wrapped_entire_year.rb +0 -114
  623. data/lib/trophy_api_client/types/wrapped_metric.rb +0 -119
  624. data/lib/trophy_api_client/types/wrapped_metric_by_attribute_value_value.rb +0 -103
  625. data/lib/trophy_api_client/types/wrapped_most_active_day.rb +0 -108
  626. data/lib/trophy_api_client/types/wrapped_most_active_month.rb +0 -108
  627. data/lib/trophy_api_client/types/wrapped_most_active_week.rb +0 -116
  628. data/lib/trophy_api_client/types/wrapped_points.rb +0 -106
  629. data/lib/trophy_api_client/types/wrapped_response.rb +0 -79
  630. data/lib/trophy_api_client/types/wrapped_streak.rb +0 -96
  631. data/lib/trophy_api_client/users/client.rb +0 -1356
  632. data/lib/trophy_api_client/users/types/users_metric_event_summary_response_item.rb +0 -76
  633. data/lib/trophy_api_client/users/types/users_points_event_summary_response_item.rb +0 -76
  634. data/lib/trophy_api_client/version.rb +0 -3
  635. data/lib/types_export.rb +0 -221
@@ -1,209 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require "date"
4
- require_relative "achievement_response_trigger"
5
- require_relative "achievement_response_user_attributes_item"
6
- require_relative "achievement_response_event_attribute"
7
- require_relative "achievement_response_event_attributes_item"
8
- require "ostruct"
9
- require "json"
10
-
11
- module TrophyApiClient
12
- class UserAchievementResponse
13
- # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format. Null if the
14
- # achievement has not been completed.
15
- attr_reader :achieved_at
16
- # @return [String] The unique ID of the achievement.
17
- attr_reader :id
18
- # @return [String] The name of this achievement.
19
- attr_reader :name
20
- # @return [TrophyApiClient::AchievementResponseTrigger] The trigger of the achievement.
21
- attr_reader :trigger
22
- # @return [String] The description of this achievement.
23
- attr_reader :description
24
- # @return [String] The URL of the badge image for the achievement, if one has been uploaded.
25
- attr_reader :badge_url
26
- # @return [String] The key used to reference this achievement in the API (only applicable if
27
- # trigger = 'api')
28
- attr_reader :key
29
- # @return [Integer] The length of the streak required to complete the achievement (only applicable
30
- # if trigger = 'streak')
31
- attr_reader :streak_length
32
- # @return [Array<String>] The IDs of the prerequisite achievements that must be completed to earn this
33
- # achievement (only applicable if trigger = 'achievement')
34
- attr_reader :achievement_ids
35
- # @return [String] The ID of the metric associated with this achievement (only applicable if
36
- # trigger = 'metric')
37
- attr_reader :metric_id
38
- # @return [Float] The value of the metric required to complete the achievement (only applicable if
39
- # trigger = 'metric')
40
- attr_reader :metric_value
41
- # @return [String] The name of the metric associated with this achievement (only applicable if
42
- # trigger = 'metric')
43
- attr_reader :metric_name
44
- # @return [Array<TrophyApiClient::AchievementResponseUserAttributesItem>] User attribute filters that must be met for this achievement to be completed.
45
- attr_reader :user_attributes
46
- # @return [TrophyApiClient::AchievementResponseEventAttribute] Deprecated. Event attribute filter that must be met for this achievement to be
47
- # completed. Only present if the achievement has an event filter configured.
48
- attr_reader :event_attribute
49
- # @return [Array<TrophyApiClient::AchievementResponseEventAttributesItem>] Event attribute filters that must be met for this achievement to be completed.
50
- # Omitted for non-metric achievements.
51
- attr_reader :event_attributes
52
- # @return [OpenStruct] Additional properties unmapped to the current class definition
53
- attr_reader :additional_properties
54
- # @return [Object]
55
- attr_reader :_field_set
56
- protected :_field_set
57
-
58
- OMIT = Object.new
59
-
60
- # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format. Null if the
61
- # achievement has not been completed.
62
- # @param id [String] The unique ID of the achievement.
63
- # @param name [String] The name of this achievement.
64
- # @param trigger [TrophyApiClient::AchievementResponseTrigger] The trigger of the achievement.
65
- # @param description [String] The description of this achievement.
66
- # @param badge_url [String] The URL of the badge image for the achievement, if one has been uploaded.
67
- # @param key [String] The key used to reference this achievement in the API (only applicable if
68
- # trigger = 'api')
69
- # @param streak_length [Integer] The length of the streak required to complete the achievement (only applicable
70
- # if trigger = 'streak')
71
- # @param achievement_ids [Array<String>] The IDs of the prerequisite achievements that must be completed to earn this
72
- # achievement (only applicable if trigger = 'achievement')
73
- # @param metric_id [String] The ID of the metric associated with this achievement (only applicable if
74
- # trigger = 'metric')
75
- # @param metric_value [Float] The value of the metric required to complete the achievement (only applicable if
76
- # trigger = 'metric')
77
- # @param metric_name [String] The name of the metric associated with this achievement (only applicable if
78
- # trigger = 'metric')
79
- # @param user_attributes [Array<TrophyApiClient::AchievementResponseUserAttributesItem>] User attribute filters that must be met for this achievement to be completed.
80
- # @param event_attribute [TrophyApiClient::AchievementResponseEventAttribute] Deprecated. Event attribute filter that must be met for this achievement to be
81
- # completed. Only present if the achievement has an event filter configured.
82
- # @param event_attributes [Array<TrophyApiClient::AchievementResponseEventAttributesItem>] Event attribute filters that must be met for this achievement to be completed.
83
- # Omitted for non-metric achievements.
84
- # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
85
- # @return [TrophyApiClient::UserAchievementResponse]
86
- def initialize(id:, name:, trigger:, user_attributes:, achieved_at: OMIT, description: OMIT, badge_url: OMIT, key: OMIT,
87
- streak_length: OMIT, achievement_ids: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, event_attribute: OMIT, event_attributes: OMIT, additional_properties: nil)
88
- @achieved_at = achieved_at if achieved_at != OMIT
89
- @id = id
90
- @name = name
91
- @trigger = trigger
92
- @description = description if description != OMIT
93
- @badge_url = badge_url if badge_url != OMIT
94
- @key = key if key != OMIT
95
- @streak_length = streak_length if streak_length != OMIT
96
- @achievement_ids = achievement_ids if achievement_ids != OMIT
97
- @metric_id = metric_id if metric_id != OMIT
98
- @metric_value = metric_value if metric_value != OMIT
99
- @metric_name = metric_name if metric_name != OMIT
100
- @user_attributes = user_attributes
101
- @event_attribute = event_attribute if event_attribute != OMIT
102
- @event_attributes = event_attributes if event_attributes != OMIT
103
- @additional_properties = additional_properties
104
- @_field_set = {
105
- "achievedAt": achieved_at,
106
- "id": id,
107
- "name": name,
108
- "trigger": trigger,
109
- "description": description,
110
- "badgeUrl": badge_url,
111
- "key": key,
112
- "streakLength": streak_length,
113
- "achievementIds": achievement_ids,
114
- "metricId": metric_id,
115
- "metricValue": metric_value,
116
- "metricName": metric_name,
117
- "userAttributes": user_attributes,
118
- "eventAttribute": event_attribute,
119
- "eventAttributes": event_attributes
120
- }.reject do |_k, v|
121
- v == OMIT
122
- end
123
- end
124
-
125
- # Deserialize a JSON object to an instance of UserAchievementResponse
126
- #
127
- # @param json_object [String]
128
- # @return [TrophyApiClient::UserAchievementResponse]
129
- def self.from_json(json_object:)
130
- struct = JSON.parse(json_object, object_class: OpenStruct)
131
- parsed_json = JSON.parse(json_object)
132
- achieved_at = (DateTime.parse(parsed_json["achievedAt"]) unless parsed_json["achievedAt"].nil?)
133
- id = parsed_json["id"]
134
- name = parsed_json["name"]
135
- trigger = parsed_json["trigger"]
136
- description = parsed_json["description"]
137
- badge_url = parsed_json["badgeUrl"]
138
- key = parsed_json["key"]
139
- streak_length = parsed_json["streakLength"]
140
- achievement_ids = parsed_json["achievementIds"]
141
- metric_id = parsed_json["metricId"]
142
- metric_value = parsed_json["metricValue"]
143
- metric_name = parsed_json["metricName"]
144
- user_attributes = parsed_json["userAttributes"]&.map do |item|
145
- item = item.to_json
146
- TrophyApiClient::AchievementResponseUserAttributesItem.from_json(json_object: item)
147
- end
148
- if parsed_json["eventAttribute"].nil?
149
- event_attribute = nil
150
- else
151
- event_attribute = parsed_json["eventAttribute"].to_json
152
- event_attribute = TrophyApiClient::AchievementResponseEventAttribute.from_json(json_object: event_attribute)
153
- end
154
- event_attributes = parsed_json["eventAttributes"]&.map do |item|
155
- item = item.to_json
156
- TrophyApiClient::AchievementResponseEventAttributesItem.from_json(json_object: item)
157
- end
158
- new(
159
- achieved_at: achieved_at,
160
- id: id,
161
- name: name,
162
- trigger: trigger,
163
- description: description,
164
- badge_url: badge_url,
165
- key: key,
166
- streak_length: streak_length,
167
- achievement_ids: achievement_ids,
168
- metric_id: metric_id,
169
- metric_value: metric_value,
170
- metric_name: metric_name,
171
- user_attributes: user_attributes,
172
- event_attribute: event_attribute,
173
- event_attributes: event_attributes,
174
- additional_properties: struct
175
- )
176
- end
177
-
178
- # Serialize an instance of UserAchievementResponse to a JSON object
179
- #
180
- # @return [String]
181
- def to_json(*_args)
182
- @_field_set&.to_json
183
- end
184
-
185
- # Leveraged for Union-type generation, validate_raw attempts to parse the given
186
- # hash and check each fields type against the current object's property
187
- # definitions.
188
- #
189
- # @param obj [Object]
190
- # @return [Void]
191
- def self.validate_raw(obj:)
192
- obj.achieved_at&.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")
193
- obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
194
- obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
195
- obj.trigger.is_a?(TrophyApiClient::AchievementResponseTrigger) != false || raise("Passed value for field obj.trigger is not the expected type, validation failed.")
196
- obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
197
- obj.badge_url&.is_a?(String) != false || raise("Passed value for field obj.badge_url is not the expected type, validation failed.")
198
- obj.key&.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
199
- obj.streak_length&.is_a?(Integer) != false || raise("Passed value for field obj.streak_length is not the expected type, validation failed.")
200
- obj.achievement_ids&.is_a?(Array) != false || raise("Passed value for field obj.achievement_ids is not the expected type, validation failed.")
201
- obj.metric_id&.is_a?(String) != false || raise("Passed value for field obj.metric_id is not the expected type, validation failed.")
202
- obj.metric_value&.is_a?(Float) != false || raise("Passed value for field obj.metric_value is not the expected type, validation failed.")
203
- obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
204
- obj.user_attributes.is_a?(Array) != false || raise("Passed value for field obj.user_attributes is not the expected type, validation failed.")
205
- obj.event_attribute.nil? || TrophyApiClient::AchievementResponseEventAttribute.validate_raw(obj: obj.event_attribute)
206
- obj.event_attributes&.is_a?(Array) != false || raise("Passed value for field obj.event_attributes is not the expected type, validation failed.")
207
- end
208
- end
209
- end
@@ -1,225 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require "date"
4
- require_relative "achievement_response_trigger"
5
- require_relative "achievement_response_user_attributes_item"
6
- require_relative "achievement_response_event_attribute"
7
- require_relative "achievement_response_event_attributes_item"
8
- require "ostruct"
9
- require "json"
10
-
11
- module TrophyApiClient
12
- class UserAchievementWithStatsResponse
13
- # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format. Null if the
14
- # achievement has not been completed.
15
- attr_reader :achieved_at
16
- # @return [Integer] The number of users who have completed this achievement.
17
- attr_reader :completions
18
- # @return [Float] The percentage of all users who have completed this achievement.
19
- attr_reader :rarity
20
- # @return [String] The unique ID of the achievement.
21
- attr_reader :id
22
- # @return [String] The name of this achievement.
23
- attr_reader :name
24
- # @return [TrophyApiClient::AchievementResponseTrigger] The trigger of the achievement.
25
- attr_reader :trigger
26
- # @return [String] The description of this achievement.
27
- attr_reader :description
28
- # @return [String] The URL of the badge image for the achievement, if one has been uploaded.
29
- attr_reader :badge_url
30
- # @return [String] The key used to reference this achievement in the API (only applicable if
31
- # trigger = 'api')
32
- attr_reader :key
33
- # @return [Integer] The length of the streak required to complete the achievement (only applicable
34
- # if trigger = 'streak')
35
- attr_reader :streak_length
36
- # @return [Array<String>] The IDs of the prerequisite achievements that must be completed to earn this
37
- # achievement (only applicable if trigger = 'achievement')
38
- attr_reader :achievement_ids
39
- # @return [String] The ID of the metric associated with this achievement (only applicable if
40
- # trigger = 'metric')
41
- attr_reader :metric_id
42
- # @return [Float] The value of the metric required to complete the achievement (only applicable if
43
- # trigger = 'metric')
44
- attr_reader :metric_value
45
- # @return [String] The name of the metric associated with this achievement (only applicable if
46
- # trigger = 'metric')
47
- attr_reader :metric_name
48
- # @return [Array<TrophyApiClient::AchievementResponseUserAttributesItem>] User attribute filters that must be met for this achievement to be completed.
49
- attr_reader :user_attributes
50
- # @return [TrophyApiClient::AchievementResponseEventAttribute] Deprecated. Event attribute filter that must be met for this achievement to be
51
- # completed. Only present if the achievement has an event filter configured.
52
- attr_reader :event_attribute
53
- # @return [Array<TrophyApiClient::AchievementResponseEventAttributesItem>] Event attribute filters that must be met for this achievement to be completed.
54
- # Omitted for non-metric achievements.
55
- attr_reader :event_attributes
56
- # @return [OpenStruct] Additional properties unmapped to the current class definition
57
- attr_reader :additional_properties
58
- # @return [Object]
59
- attr_reader :_field_set
60
- protected :_field_set
61
-
62
- OMIT = Object.new
63
-
64
- # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format. Null if the
65
- # achievement has not been completed.
66
- # @param completions [Integer] The number of users who have completed this achievement.
67
- # @param rarity [Float] The percentage of all users who have completed this achievement.
68
- # @param id [String] The unique ID of the achievement.
69
- # @param name [String] The name of this achievement.
70
- # @param trigger [TrophyApiClient::AchievementResponseTrigger] The trigger of the achievement.
71
- # @param description [String] The description of this achievement.
72
- # @param badge_url [String] The URL of the badge image for the achievement, if one has been uploaded.
73
- # @param key [String] The key used to reference this achievement in the API (only applicable if
74
- # trigger = 'api')
75
- # @param streak_length [Integer] The length of the streak required to complete the achievement (only applicable
76
- # if trigger = 'streak')
77
- # @param achievement_ids [Array<String>] The IDs of the prerequisite achievements that must be completed to earn this
78
- # achievement (only applicable if trigger = 'achievement')
79
- # @param metric_id [String] The ID of the metric associated with this achievement (only applicable if
80
- # trigger = 'metric')
81
- # @param metric_value [Float] The value of the metric required to complete the achievement (only applicable if
82
- # trigger = 'metric')
83
- # @param metric_name [String] The name of the metric associated with this achievement (only applicable if
84
- # trigger = 'metric')
85
- # @param user_attributes [Array<TrophyApiClient::AchievementResponseUserAttributesItem>] User attribute filters that must be met for this achievement to be completed.
86
- # @param event_attribute [TrophyApiClient::AchievementResponseEventAttribute] Deprecated. Event attribute filter that must be met for this achievement to be
87
- # completed. Only present if the achievement has an event filter configured.
88
- # @param event_attributes [Array<TrophyApiClient::AchievementResponseEventAttributesItem>] Event attribute filters that must be met for this achievement to be completed.
89
- # Omitted for non-metric achievements.
90
- # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
91
- # @return [TrophyApiClient::UserAchievementWithStatsResponse]
92
- def initialize(completions:, rarity:, id:, name:, trigger:, user_attributes:, achieved_at: OMIT, description: OMIT, badge_url: OMIT,
93
- key: OMIT, streak_length: OMIT, achievement_ids: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, event_attribute: OMIT, event_attributes: OMIT, additional_properties: nil)
94
- @achieved_at = achieved_at if achieved_at != OMIT
95
- @completions = completions
96
- @rarity = rarity
97
- @id = id
98
- @name = name
99
- @trigger = trigger
100
- @description = description if description != OMIT
101
- @badge_url = badge_url if badge_url != OMIT
102
- @key = key if key != OMIT
103
- @streak_length = streak_length if streak_length != OMIT
104
- @achievement_ids = achievement_ids if achievement_ids != OMIT
105
- @metric_id = metric_id if metric_id != OMIT
106
- @metric_value = metric_value if metric_value != OMIT
107
- @metric_name = metric_name if metric_name != OMIT
108
- @user_attributes = user_attributes
109
- @event_attribute = event_attribute if event_attribute != OMIT
110
- @event_attributes = event_attributes if event_attributes != OMIT
111
- @additional_properties = additional_properties
112
- @_field_set = {
113
- "achievedAt": achieved_at,
114
- "completions": completions,
115
- "rarity": rarity,
116
- "id": id,
117
- "name": name,
118
- "trigger": trigger,
119
- "description": description,
120
- "badgeUrl": badge_url,
121
- "key": key,
122
- "streakLength": streak_length,
123
- "achievementIds": achievement_ids,
124
- "metricId": metric_id,
125
- "metricValue": metric_value,
126
- "metricName": metric_name,
127
- "userAttributes": user_attributes,
128
- "eventAttribute": event_attribute,
129
- "eventAttributes": event_attributes
130
- }.reject do |_k, v|
131
- v == OMIT
132
- end
133
- end
134
-
135
- # Deserialize a JSON object to an instance of UserAchievementWithStatsResponse
136
- #
137
- # @param json_object [String]
138
- # @return [TrophyApiClient::UserAchievementWithStatsResponse]
139
- def self.from_json(json_object:)
140
- struct = JSON.parse(json_object, object_class: OpenStruct)
141
- parsed_json = JSON.parse(json_object)
142
- achieved_at = (DateTime.parse(parsed_json["achievedAt"]) unless parsed_json["achievedAt"].nil?)
143
- completions = parsed_json["completions"]
144
- rarity = parsed_json["rarity"]
145
- id = parsed_json["id"]
146
- name = parsed_json["name"]
147
- trigger = parsed_json["trigger"]
148
- description = parsed_json["description"]
149
- badge_url = parsed_json["badgeUrl"]
150
- key = parsed_json["key"]
151
- streak_length = parsed_json["streakLength"]
152
- achievement_ids = parsed_json["achievementIds"]
153
- metric_id = parsed_json["metricId"]
154
- metric_value = parsed_json["metricValue"]
155
- metric_name = parsed_json["metricName"]
156
- user_attributes = parsed_json["userAttributes"]&.map do |item|
157
- item = item.to_json
158
- TrophyApiClient::AchievementResponseUserAttributesItem.from_json(json_object: item)
159
- end
160
- if parsed_json["eventAttribute"].nil?
161
- event_attribute = nil
162
- else
163
- event_attribute = parsed_json["eventAttribute"].to_json
164
- event_attribute = TrophyApiClient::AchievementResponseEventAttribute.from_json(json_object: event_attribute)
165
- end
166
- event_attributes = parsed_json["eventAttributes"]&.map do |item|
167
- item = item.to_json
168
- TrophyApiClient::AchievementResponseEventAttributesItem.from_json(json_object: item)
169
- end
170
- new(
171
- achieved_at: achieved_at,
172
- completions: completions,
173
- rarity: rarity,
174
- id: id,
175
- name: name,
176
- trigger: trigger,
177
- description: description,
178
- badge_url: badge_url,
179
- key: key,
180
- streak_length: streak_length,
181
- achievement_ids: achievement_ids,
182
- metric_id: metric_id,
183
- metric_value: metric_value,
184
- metric_name: metric_name,
185
- user_attributes: user_attributes,
186
- event_attribute: event_attribute,
187
- event_attributes: event_attributes,
188
- additional_properties: struct
189
- )
190
- end
191
-
192
- # Serialize an instance of UserAchievementWithStatsResponse to a JSON object
193
- #
194
- # @return [String]
195
- def to_json(*_args)
196
- @_field_set&.to_json
197
- end
198
-
199
- # Leveraged for Union-type generation, validate_raw attempts to parse the given
200
- # hash and check each fields type against the current object's property
201
- # definitions.
202
- #
203
- # @param obj [Object]
204
- # @return [Void]
205
- def self.validate_raw(obj:)
206
- obj.achieved_at&.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")
207
- obj.completions.is_a?(Integer) != false || raise("Passed value for field obj.completions is not the expected type, validation failed.")
208
- obj.rarity.is_a?(Float) != false || raise("Passed value for field obj.rarity is not the expected type, validation failed.")
209
- obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
210
- obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
211
- obj.trigger.is_a?(TrophyApiClient::AchievementResponseTrigger) != false || raise("Passed value for field obj.trigger is not the expected type, validation failed.")
212
- obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
213
- obj.badge_url&.is_a?(String) != false || raise("Passed value for field obj.badge_url is not the expected type, validation failed.")
214
- obj.key&.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
215
- obj.streak_length&.is_a?(Integer) != false || raise("Passed value for field obj.streak_length is not the expected type, validation failed.")
216
- obj.achievement_ids&.is_a?(Array) != false || raise("Passed value for field obj.achievement_ids is not the expected type, validation failed.")
217
- obj.metric_id&.is_a?(String) != false || raise("Passed value for field obj.metric_id is not the expected type, validation failed.")
218
- obj.metric_value&.is_a?(Float) != false || raise("Passed value for field obj.metric_value is not the expected type, validation failed.")
219
- obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
220
- obj.user_attributes.is_a?(Array) != false || raise("Passed value for field obj.user_attributes is not the expected type, validation failed.")
221
- obj.event_attribute.nil? || TrophyApiClient::AchievementResponseEventAttribute.validate_raw(obj: obj.event_attribute)
222
- obj.event_attributes&.is_a?(Array) != false || raise("Passed value for field obj.event_attributes is not the expected type, validation failed.")
223
- end
224
- end
225
- end
@@ -1,212 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative "leaderboard_response_rank_by"
4
- require_relative "leaderboard_response_run_unit"
5
- require "ostruct"
6
- require "json"
7
-
8
- module TrophyApiClient
9
- # A user's data for a specific leaderboard including rank, value, and history.
10
- class UserLeaderboardResponse
11
- # @return [Integer] The user's current rank in this leaderboard. Null if the user is not on the
12
- # leaderboard.
13
- attr_reader :rank
14
- # @return [Integer] The user's current value in this leaderboard. Null if the user is not on the
15
- # leaderboard.
16
- attr_reader :value
17
- # @return [String] The unique ID of the leaderboard.
18
- attr_reader :id
19
- # @return [String] The user-facing name of the leaderboard.
20
- attr_reader :name
21
- # @return [String] The unique key used to reference the leaderboard in APIs.
22
- attr_reader :key
23
- # @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
24
- attr_reader :rank_by
25
- # @return [String] Deprecated. The key of the attribute to break down this leaderboard by.
26
- attr_reader :breakdown_attribute
27
- # @return [Array<String>] The user attribute keys that this leaderboard is broken down by.
28
- attr_reader :breakdown_attributes
29
- # @return [String] The key of the metric to rank by, if rankBy is 'metric'.
30
- attr_reader :metric_key
31
- # @return [String] The name of the metric to rank by, if rankBy is 'metric'.
32
- attr_reader :metric_name
33
- # @return [String] The key of the points system to rank by, if rankBy is 'points'.
34
- attr_reader :points_system_key
35
- # @return [String] The name of the points system to rank by, if rankBy is 'points'.
36
- attr_reader :points_system_name
37
- # @return [String] The user-facing description of the leaderboard.
38
- attr_reader :description
39
- # @return [String] The start date of the leaderboard in YYYY-MM-DD format.
40
- attr_reader :start
41
- # @return [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
42
- # forever.
43
- attr_reader :end_
44
- # @return [Integer] The maximum number of participants in the leaderboard.
45
- attr_reader :max_participants
46
- # @return [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
47
- # leaderboards.
48
- attr_reader :run_unit
49
- # @return [Integer] The interval between repetitions, relative to the start date and repetition
50
- # type. Null for one-time leaderboards.
51
- attr_reader :run_interval
52
- # @return [OpenStruct] Additional properties unmapped to the current class definition
53
- attr_reader :additional_properties
54
- # @return [Object]
55
- attr_reader :_field_set
56
- protected :_field_set
57
-
58
- OMIT = Object.new
59
-
60
- # @param rank [Integer] The user's current rank in this leaderboard. Null if the user is not on the
61
- # leaderboard.
62
- # @param value [Integer] The user's current value in this leaderboard. Null if the user is not on the
63
- # leaderboard.
64
- # @param id [String] The unique ID of the leaderboard.
65
- # @param name [String] The user-facing name of the leaderboard.
66
- # @param key [String] The unique key used to reference the leaderboard in APIs.
67
- # @param rank_by [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
68
- # @param breakdown_attribute [String] Deprecated. The key of the attribute to break down this leaderboard by.
69
- # @param breakdown_attributes [Array<String>] The user attribute keys that this leaderboard is broken down by.
70
- # @param metric_key [String] The key of the metric to rank by, if rankBy is 'metric'.
71
- # @param metric_name [String] The name of the metric to rank by, if rankBy is 'metric'.
72
- # @param points_system_key [String] The key of the points system to rank by, if rankBy is 'points'.
73
- # @param points_system_name [String] The name of the points system to rank by, if rankBy is 'points'.
74
- # @param description [String] The user-facing description of the leaderboard.
75
- # @param start [String] The start date of the leaderboard in YYYY-MM-DD format.
76
- # @param end_ [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
77
- # forever.
78
- # @param max_participants [Integer] The maximum number of participants in the leaderboard.
79
- # @param run_unit [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
80
- # leaderboards.
81
- # @param run_interval [Integer] The interval between repetitions, relative to the start date and repetition
82
- # type. Null for one-time leaderboards.
83
- # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
84
- # @return [TrophyApiClient::UserLeaderboardResponse]
85
- def initialize(id:, name:, key:, rank_by:, breakdown_attributes:, start:, rank: OMIT, value: OMIT,
86
- breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, max_participants: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
87
- @rank = rank if rank != OMIT
88
- @value = value if value != OMIT
89
- @id = id
90
- @name = name
91
- @key = key
92
- @rank_by = rank_by
93
- @breakdown_attribute = breakdown_attribute if breakdown_attribute != OMIT
94
- @breakdown_attributes = breakdown_attributes
95
- @metric_key = metric_key if metric_key != OMIT
96
- @metric_name = metric_name if metric_name != OMIT
97
- @points_system_key = points_system_key if points_system_key != OMIT
98
- @points_system_name = points_system_name if points_system_name != OMIT
99
- @description = description if description != OMIT
100
- @start = start
101
- @end_ = end_ if end_ != OMIT
102
- @max_participants = max_participants if max_participants != OMIT
103
- @run_unit = run_unit if run_unit != OMIT
104
- @run_interval = run_interval if run_interval != OMIT
105
- @additional_properties = additional_properties
106
- @_field_set = {
107
- "rank": rank,
108
- "value": value,
109
- "id": id,
110
- "name": name,
111
- "key": key,
112
- "rankBy": rank_by,
113
- "breakdownAttribute": breakdown_attribute,
114
- "breakdownAttributes": breakdown_attributes,
115
- "metricKey": metric_key,
116
- "metricName": metric_name,
117
- "pointsSystemKey": points_system_key,
118
- "pointsSystemName": points_system_name,
119
- "description": description,
120
- "start": start,
121
- "end": end_,
122
- "maxParticipants": max_participants,
123
- "runUnit": run_unit,
124
- "runInterval": run_interval
125
- }.reject do |_k, v|
126
- v == OMIT
127
- end
128
- end
129
-
130
- # Deserialize a JSON object to an instance of UserLeaderboardResponse
131
- #
132
- # @param json_object [String]
133
- # @return [TrophyApiClient::UserLeaderboardResponse]
134
- def self.from_json(json_object:)
135
- struct = JSON.parse(json_object, object_class: OpenStruct)
136
- parsed_json = JSON.parse(json_object)
137
- rank = parsed_json["rank"]
138
- value = parsed_json["value"]
139
- id = parsed_json["id"]
140
- name = parsed_json["name"]
141
- key = parsed_json["key"]
142
- rank_by = parsed_json["rankBy"]
143
- breakdown_attribute = parsed_json["breakdownAttribute"]
144
- breakdown_attributes = parsed_json["breakdownAttributes"]
145
- metric_key = parsed_json["metricKey"]
146
- metric_name = parsed_json["metricName"]
147
- points_system_key = parsed_json["pointsSystemKey"]
148
- points_system_name = parsed_json["pointsSystemName"]
149
- description = parsed_json["description"]
150
- start = parsed_json["start"]
151
- end_ = parsed_json["end"]
152
- max_participants = parsed_json["maxParticipants"]
153
- run_unit = parsed_json["runUnit"]
154
- run_interval = parsed_json["runInterval"]
155
- new(
156
- rank: rank,
157
- value: value,
158
- id: id,
159
- name: name,
160
- key: key,
161
- rank_by: rank_by,
162
- breakdown_attribute: breakdown_attribute,
163
- breakdown_attributes: breakdown_attributes,
164
- metric_key: metric_key,
165
- metric_name: metric_name,
166
- points_system_key: points_system_key,
167
- points_system_name: points_system_name,
168
- description: description,
169
- start: start,
170
- end_: end_,
171
- max_participants: max_participants,
172
- run_unit: run_unit,
173
- run_interval: run_interval,
174
- additional_properties: struct
175
- )
176
- end
177
-
178
- # Serialize an instance of UserLeaderboardResponse to a JSON object
179
- #
180
- # @return [String]
181
- def to_json(*_args)
182
- @_field_set&.to_json
183
- end
184
-
185
- # Leveraged for Union-type generation, validate_raw attempts to parse the given
186
- # hash and check each fields type against the current object's property
187
- # definitions.
188
- #
189
- # @param obj [Object]
190
- # @return [Void]
191
- def self.validate_raw(obj:)
192
- obj.rank&.is_a?(Integer) != false || raise("Passed value for field obj.rank is not the expected type, validation failed.")
193
- obj.value&.is_a?(Integer) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
194
- obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
195
- obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
196
- obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
197
- obj.rank_by.is_a?(TrophyApiClient::LeaderboardResponseRankBy) != false || raise("Passed value for field obj.rank_by is not the expected type, validation failed.")
198
- obj.breakdown_attribute&.is_a?(String) != false || raise("Passed value for field obj.breakdown_attribute is not the expected type, validation failed.")
199
- obj.breakdown_attributes.is_a?(Array) != false || raise("Passed value for field obj.breakdown_attributes is not the expected type, validation failed.")
200
- obj.metric_key&.is_a?(String) != false || raise("Passed value for field obj.metric_key is not the expected type, validation failed.")
201
- obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
202
- obj.points_system_key&.is_a?(String) != false || raise("Passed value for field obj.points_system_key is not the expected type, validation failed.")
203
- obj.points_system_name&.is_a?(String) != false || raise("Passed value for field obj.points_system_name is not the expected type, validation failed.")
204
- obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
205
- obj.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
206
- obj.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
207
- obj.max_participants&.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
208
- obj.run_unit&.is_a?(TrophyApiClient::LeaderboardResponseRunUnit) != false || raise("Passed value for field obj.run_unit is not the expected type, validation failed.")
209
- obj.run_interval&.is_a?(Integer) != false || raise("Passed value for field obj.run_interval is not the expected type, validation failed.")
210
- end
211
- end
212
- end