trophy_api_client 1.13.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 -74
  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 -1354
  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,412 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative "../../../../requests"
4
- require_relative "../../../types/list_points_triggers_response"
5
- require "json"
6
- require_relative "../../../types/create_points_triggers_request"
7
- require_relative "../../../types/create_points_triggers_response"
8
- require_relative "../../../types/delete_points_triggers_response"
9
- require_relative "../../../types/patch_points_triggers_request"
10
- require_relative "../../../types/patch_points_triggers_response"
11
- require_relative "../../../types/admin_points_trigger"
12
- require "async"
13
-
14
- module TrophyApiClient
15
- module Admin
16
- module Points
17
- class TriggersClient
18
- # @return [TrophyApiClient::RequestClient]
19
- attr_reader :request_client
20
-
21
- # @param request_client [TrophyApiClient::RequestClient]
22
- # @return [TrophyApiClient::Admin::Points::TriggersClient]
23
- def initialize(request_client:)
24
- @request_client = request_client
25
- end
26
-
27
- # List points triggers for a system.
28
- #
29
- # @param system_id [String] The UUID of the points system.
30
- # @param limit [Integer] Maximum number of results to return (1-100, default 10).
31
- # @param skip [Integer] Number of results to skip for pagination (default 0).
32
- # @param request_options [TrophyApiClient::RequestOptions]
33
- # @return [TrophyApiClient::LIST_POINTS_TRIGGERS_RESPONSE]
34
- # @example
35
- # api = TrophyApiClient::Client.new(
36
- # base_url: "https://api.example.com",
37
- # environment: TrophyApiClient::Environment::PRODUCTION,
38
- # api_key: "YOUR_API_KEY"
39
- # )
40
- # api.admin.points.triggers.list(
41
- # system_id: "550e8400-e29b-41d4-a716-446655440000",
42
- # limit: 1,
43
- # skip: 1
44
- # )
45
- def list(system_id:, limit: nil, skip: nil, request_options: nil)
46
- response = @request_client.conn.get do |req|
47
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
48
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
49
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
50
- req.headers = {
51
- **(req.headers || {}),
52
- **@request_client.get_headers,
53
- **(request_options&.additional_headers || {})
54
- }.compact
55
- req.params = {
56
- **(request_options&.additional_query_parameters || {}),
57
- "limit": limit,
58
- "skip": skip
59
- }.compact
60
- unless request_options.nil? || request_options&.additional_body_parameters.nil?
61
- req.body = { **(request_options&.additional_body_parameters || {}) }.compact
62
- end
63
- req.url "#{@request_client.get_url(environment: admin,
64
- request_options: request_options)}/points/#{system_id}/triggers"
65
- end
66
- parsed_json = JSON.parse(response.body)
67
- parsed_json&.map do |item|
68
- item = item.to_json
69
- TrophyApiClient::AdminPointsTrigger.from_json(json_object: item)
70
- end
71
- end
72
-
73
- # Create points triggers in bulk. Maximum 100 triggers per request.
74
- #
75
- # @param system_id [String] The UUID of the points system.
76
- # @param request [TrophyApiClient::CREATE_POINTS_TRIGGERS_REQUEST]
77
- # @param request_options [TrophyApiClient::RequestOptions]
78
- # @return [TrophyApiClient::CreatePointsTriggersResponse]
79
- # @example
80
- # api = TrophyApiClient::Client.new(
81
- # base_url: "https://api.example.com",
82
- # environment: TrophyApiClient::Environment::PRODUCTION,
83
- # api_key: "YOUR_API_KEY"
84
- # )
85
- # api.admin.points.triggers.create(system_id: "550e8400-e29b-41d4-a716-446655440000", request: [{ type: METRIC, points: 10 }])
86
- def create(system_id:, request:, request_options: nil)
87
- response = @request_client.conn.post do |req|
88
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
89
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
90
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
91
- req.headers = {
92
- **(req.headers || {}),
93
- **@request_client.get_headers,
94
- **(request_options&.additional_headers || {})
95
- }.compact
96
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
97
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
98
- end
99
- req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
100
- req.url "#{@request_client.get_url(environment: admin,
101
- request_options: request_options)}/points/#{system_id}/triggers"
102
- end
103
- TrophyApiClient::CreatePointsTriggersResponse.from_json(json_object: response.body)
104
- end
105
-
106
- # Delete (archive) points triggers by ID. Maximum 100 trigger IDs per request.
107
- #
108
- # @param system_id [String] The UUID of the points system.
109
- # @param ids [String] Trigger IDs to delete. Can be repeated or comma-separated.
110
- # @param request_options [TrophyApiClient::RequestOptions]
111
- # @return [TrophyApiClient::DeletePointsTriggersResponse]
112
- # @example
113
- # api = TrophyApiClient::Client.new(
114
- # base_url: "https://api.example.com",
115
- # environment: TrophyApiClient::Environment::PRODUCTION,
116
- # api_key: "YOUR_API_KEY"
117
- # )
118
- # api.admin.points.triggers.delete
119
- def delete(system_id:, ids: nil, request_options: nil)
120
- response = @request_client.conn.delete do |req|
121
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
122
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
123
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
124
- req.headers = {
125
- **(req.headers || {}),
126
- **@request_client.get_headers,
127
- **(request_options&.additional_headers || {})
128
- }.compact
129
- req.params = { **(request_options&.additional_query_parameters || {}), "ids": ids }.compact
130
- unless request_options.nil? || request_options&.additional_body_parameters.nil?
131
- req.body = { **(request_options&.additional_body_parameters || {}) }.compact
132
- end
133
- req.url "#{@request_client.get_url(environment: admin,
134
- request_options: request_options)}/points/#{system_id}/triggers"
135
- end
136
- TrophyApiClient::DeletePointsTriggersResponse.from_json(json_object: response.body)
137
- end
138
-
139
- # Update points triggers in bulk. Maximum 100 triggers per request. Only provided
140
- # fields are updated; omitted fields are preserved.
141
- #
142
- # @param system_id [String] The UUID of the points system.
143
- # @param request [TrophyApiClient::PATCH_POINTS_TRIGGERS_REQUEST]
144
- # @param request_options [TrophyApiClient::RequestOptions]
145
- # @return [TrophyApiClient::PatchPointsTriggersResponse]
146
- # @example
147
- # api = TrophyApiClient::Client.new(
148
- # base_url: "https://api.example.com",
149
- # environment: TrophyApiClient::Environment::PRODUCTION,
150
- # api_key: "YOUR_API_KEY"
151
- # )
152
- # api.admin.points.triggers.update(system_id: "550e8400-e29b-41d4-a716-446655440000", request: [{ id: "id" }])
153
- def update(system_id:, request:, request_options: nil)
154
- response = @request_client.conn.patch do |req|
155
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
156
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
157
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
158
- req.headers = {
159
- **(req.headers || {}),
160
- **@request_client.get_headers,
161
- **(request_options&.additional_headers || {})
162
- }.compact
163
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
164
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
165
- end
166
- req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
167
- req.url "#{@request_client.get_url(environment: admin,
168
- request_options: request_options)}/points/#{system_id}/triggers"
169
- end
170
- TrophyApiClient::PatchPointsTriggersResponse.from_json(json_object: response.body)
171
- end
172
-
173
- # Get a single points trigger by ID.
174
- #
175
- # @param system_id [String] The UUID of the points system.
176
- # @param id [String] The UUID of the points trigger.
177
- # @param request_options [TrophyApiClient::RequestOptions]
178
- # @return [TrophyApiClient::AdminPointsTrigger]
179
- # @example
180
- # api = TrophyApiClient::Client.new(
181
- # base_url: "https://api.example.com",
182
- # environment: TrophyApiClient::Environment::PRODUCTION,
183
- # api_key: "YOUR_API_KEY"
184
- # )
185
- # api.admin.points.triggers.get(system_id: "550e8400-e29b-41d4-a716-446655440000", id: "660f9500-f30c-42e5-b827-557766550001")
186
- def get(system_id:, id:, request_options: nil)
187
- response = @request_client.conn.get do |req|
188
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
189
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
190
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
191
- req.headers = {
192
- **(req.headers || {}),
193
- **@request_client.get_headers,
194
- **(request_options&.additional_headers || {})
195
- }.compact
196
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
197
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
198
- end
199
- unless request_options.nil? || request_options&.additional_body_parameters.nil?
200
- req.body = { **(request_options&.additional_body_parameters || {}) }.compact
201
- end
202
- req.url "#{@request_client.get_url(environment: admin,
203
- request_options: request_options)}/points/#{system_id}/triggers/#{id}"
204
- end
205
- TrophyApiClient::AdminPointsTrigger.from_json(json_object: response.body)
206
- end
207
- end
208
-
209
- class AsyncTriggersClient
210
- # @return [TrophyApiClient::AsyncRequestClient]
211
- attr_reader :request_client
212
-
213
- # @param request_client [TrophyApiClient::AsyncRequestClient]
214
- # @return [TrophyApiClient::Admin::Points::AsyncTriggersClient]
215
- def initialize(request_client:)
216
- @request_client = request_client
217
- end
218
-
219
- # List points triggers for a system.
220
- #
221
- # @param system_id [String] The UUID of the points system.
222
- # @param limit [Integer] Maximum number of results to return (1-100, default 10).
223
- # @param skip [Integer] Number of results to skip for pagination (default 0).
224
- # @param request_options [TrophyApiClient::RequestOptions]
225
- # @return [TrophyApiClient::LIST_POINTS_TRIGGERS_RESPONSE]
226
- # @example
227
- # api = TrophyApiClient::Client.new(
228
- # base_url: "https://api.example.com",
229
- # environment: TrophyApiClient::Environment::PRODUCTION,
230
- # api_key: "YOUR_API_KEY"
231
- # )
232
- # api.admin.points.triggers.list(
233
- # system_id: "550e8400-e29b-41d4-a716-446655440000",
234
- # limit: 1,
235
- # skip: 1
236
- # )
237
- def list(system_id:, limit: nil, skip: nil, request_options: nil)
238
- Async do
239
- response = @request_client.conn.get do |req|
240
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
241
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
242
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
243
- req.headers = {
244
- **(req.headers || {}),
245
- **@request_client.get_headers,
246
- **(request_options&.additional_headers || {})
247
- }.compact
248
- req.params = {
249
- **(request_options&.additional_query_parameters || {}),
250
- "limit": limit,
251
- "skip": skip
252
- }.compact
253
- unless request_options.nil? || request_options&.additional_body_parameters.nil?
254
- req.body = { **(request_options&.additional_body_parameters || {}) }.compact
255
- end
256
- req.url "#{@request_client.get_url(environment: admin,
257
- request_options: request_options)}/points/#{system_id}/triggers"
258
- end
259
- parsed_json = JSON.parse(response.body)
260
- parsed_json&.map do |item|
261
- item = item.to_json
262
- TrophyApiClient::AdminPointsTrigger.from_json(json_object: item)
263
- end
264
- end
265
- end
266
-
267
- # Create points triggers in bulk. Maximum 100 triggers per request.
268
- #
269
- # @param system_id [String] The UUID of the points system.
270
- # @param request [TrophyApiClient::CREATE_POINTS_TRIGGERS_REQUEST]
271
- # @param request_options [TrophyApiClient::RequestOptions]
272
- # @return [TrophyApiClient::CreatePointsTriggersResponse]
273
- # @example
274
- # api = TrophyApiClient::Client.new(
275
- # base_url: "https://api.example.com",
276
- # environment: TrophyApiClient::Environment::PRODUCTION,
277
- # api_key: "YOUR_API_KEY"
278
- # )
279
- # api.admin.points.triggers.create(system_id: "550e8400-e29b-41d4-a716-446655440000", request: [{ type: METRIC, points: 10 }])
280
- def create(system_id:, request:, request_options: nil)
281
- Async do
282
- response = @request_client.conn.post do |req|
283
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
284
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
285
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
286
- req.headers = {
287
- **(req.headers || {}),
288
- **@request_client.get_headers,
289
- **(request_options&.additional_headers || {})
290
- }.compact
291
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
292
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
293
- end
294
- req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
295
- req.url "#{@request_client.get_url(environment: admin,
296
- request_options: request_options)}/points/#{system_id}/triggers"
297
- end
298
- TrophyApiClient::CreatePointsTriggersResponse.from_json(json_object: response.body)
299
- end
300
- end
301
-
302
- # Delete (archive) points triggers by ID. Maximum 100 trigger IDs per request.
303
- #
304
- # @param system_id [String] The UUID of the points system.
305
- # @param ids [String] Trigger IDs to delete. Can be repeated or comma-separated.
306
- # @param request_options [TrophyApiClient::RequestOptions]
307
- # @return [TrophyApiClient::DeletePointsTriggersResponse]
308
- # @example
309
- # api = TrophyApiClient::Client.new(
310
- # base_url: "https://api.example.com",
311
- # environment: TrophyApiClient::Environment::PRODUCTION,
312
- # api_key: "YOUR_API_KEY"
313
- # )
314
- # api.admin.points.triggers.delete
315
- def delete(system_id:, ids: nil, request_options: nil)
316
- Async do
317
- response = @request_client.conn.delete do |req|
318
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
319
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
320
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
321
- req.headers = {
322
- **(req.headers || {}),
323
- **@request_client.get_headers,
324
- **(request_options&.additional_headers || {})
325
- }.compact
326
- req.params = { **(request_options&.additional_query_parameters || {}), "ids": ids }.compact
327
- unless request_options.nil? || request_options&.additional_body_parameters.nil?
328
- req.body = { **(request_options&.additional_body_parameters || {}) }.compact
329
- end
330
- req.url "#{@request_client.get_url(environment: admin,
331
- request_options: request_options)}/points/#{system_id}/triggers"
332
- end
333
- TrophyApiClient::DeletePointsTriggersResponse.from_json(json_object: response.body)
334
- end
335
- end
336
-
337
- # Update points triggers in bulk. Maximum 100 triggers per request. Only provided
338
- # fields are updated; omitted fields are preserved.
339
- #
340
- # @param system_id [String] The UUID of the points system.
341
- # @param request [TrophyApiClient::PATCH_POINTS_TRIGGERS_REQUEST]
342
- # @param request_options [TrophyApiClient::RequestOptions]
343
- # @return [TrophyApiClient::PatchPointsTriggersResponse]
344
- # @example
345
- # api = TrophyApiClient::Client.new(
346
- # base_url: "https://api.example.com",
347
- # environment: TrophyApiClient::Environment::PRODUCTION,
348
- # api_key: "YOUR_API_KEY"
349
- # )
350
- # api.admin.points.triggers.update(system_id: "550e8400-e29b-41d4-a716-446655440000", request: [{ id: "id" }])
351
- def update(system_id:, request:, request_options: nil)
352
- Async do
353
- response = @request_client.conn.patch do |req|
354
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
355
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
356
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
357
- req.headers = {
358
- **(req.headers || {}),
359
- **@request_client.get_headers,
360
- **(request_options&.additional_headers || {})
361
- }.compact
362
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
363
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
364
- end
365
- req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
366
- req.url "#{@request_client.get_url(environment: admin,
367
- request_options: request_options)}/points/#{system_id}/triggers"
368
- end
369
- TrophyApiClient::PatchPointsTriggersResponse.from_json(json_object: response.body)
370
- end
371
- end
372
-
373
- # Get a single points trigger by ID.
374
- #
375
- # @param system_id [String] The UUID of the points system.
376
- # @param id [String] The UUID of the points trigger.
377
- # @param request_options [TrophyApiClient::RequestOptions]
378
- # @return [TrophyApiClient::AdminPointsTrigger]
379
- # @example
380
- # api = TrophyApiClient::Client.new(
381
- # base_url: "https://api.example.com",
382
- # environment: TrophyApiClient::Environment::PRODUCTION,
383
- # api_key: "YOUR_API_KEY"
384
- # )
385
- # api.admin.points.triggers.get(system_id: "550e8400-e29b-41d4-a716-446655440000", id: "660f9500-f30c-42e5-b827-557766550001")
386
- def get(system_id:, id:, request_options: nil)
387
- Async do
388
- response = @request_client.conn.get do |req|
389
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
390
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
391
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
392
- req.headers = {
393
- **(req.headers || {}),
394
- **@request_client.get_headers,
395
- **(request_options&.additional_headers || {})
396
- }.compact
397
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
398
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
399
- end
400
- unless request_options.nil? || request_options&.additional_body_parameters.nil?
401
- req.body = { **(request_options&.additional_body_parameters || {}) }.compact
402
- end
403
- req.url "#{@request_client.get_url(environment: admin,
404
- request_options: request_options)}/points/#{system_id}/triggers/#{id}"
405
- end
406
- TrophyApiClient::AdminPointsTrigger.from_json(json_object: response.body)
407
- end
408
- end
409
- end
410
- end
411
- end
412
- end
@@ -1,106 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative "../../../requests"
4
- require_relative "types/restore_streaks_request_users_item"
5
- require_relative "../../types/restore_streaks_response"
6
- require "async"
7
-
8
- module TrophyApiClient
9
- module Admin
10
- class StreaksClient
11
- # @return [TrophyApiClient::RequestClient]
12
- attr_reader :request_client
13
-
14
- # @param request_client [TrophyApiClient::RequestClient]
15
- # @return [TrophyApiClient::Admin::StreaksClient]
16
- def initialize(request_client:)
17
- @request_client = request_client
18
- end
19
-
20
- # Restore streaks for multiple users to the maximum previously achieved streak
21
- # length found within the current restore window: the last 90 days for daily
22
- # streaks, weekly periods starting with the week containing the start of the
23
- # current calendar year for weekly streaks, and monthly periods starting at the
24
- # beginning of the previous calendar year for monthly streaks.
25
- #
26
- # @param users [Array<Hash>] Array of users to restore streaks for. Maximum 100 users per request.Request of type Array<TrophyApiClient::Admin::Streaks::RestoreStreaksRequestUsersItem>, as a Hash
27
- # * :id (String)
28
- # @param request_options [TrophyApiClient::RequestOptions]
29
- # @return [TrophyApiClient::RestoreStreaksResponse]
30
- # @example
31
- # api = TrophyApiClient::Client.new(
32
- # base_url: "https://api.example.com",
33
- # environment: TrophyApiClient::Environment::PRODUCTION,
34
- # api_key: "YOUR_API_KEY"
35
- # )
36
- # api.admin.streaks.restore(users: [{ id: "user-123" }, { id: "user-456" }])
37
- def restore(users:, request_options: nil)
38
- response = @request_client.conn.post do |req|
39
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
40
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
41
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
42
- req.headers = {
43
- **(req.headers || {}),
44
- **@request_client.get_headers,
45
- **(request_options&.additional_headers || {})
46
- }.compact
47
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
48
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
49
- end
50
- req.body = { **(request_options&.additional_body_parameters || {}), users: users }.compact
51
- req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/streaks/restore"
52
- end
53
- TrophyApiClient::RestoreStreaksResponse.from_json(json_object: response.body)
54
- end
55
- end
56
-
57
- class AsyncStreaksClient
58
- # @return [TrophyApiClient::AsyncRequestClient]
59
- attr_reader :request_client
60
-
61
- # @param request_client [TrophyApiClient::AsyncRequestClient]
62
- # @return [TrophyApiClient::Admin::AsyncStreaksClient]
63
- def initialize(request_client:)
64
- @request_client = request_client
65
- end
66
-
67
- # Restore streaks for multiple users to the maximum previously achieved streak
68
- # length found within the current restore window: the last 90 days for daily
69
- # streaks, weekly periods starting with the week containing the start of the
70
- # current calendar year for weekly streaks, and monthly periods starting at the
71
- # beginning of the previous calendar year for monthly streaks.
72
- #
73
- # @param users [Array<Hash>] Array of users to restore streaks for. Maximum 100 users per request.Request of type Array<TrophyApiClient::Admin::Streaks::RestoreStreaksRequestUsersItem>, as a Hash
74
- # * :id (String)
75
- # @param request_options [TrophyApiClient::RequestOptions]
76
- # @return [TrophyApiClient::RestoreStreaksResponse]
77
- # @example
78
- # api = TrophyApiClient::Client.new(
79
- # base_url: "https://api.example.com",
80
- # environment: TrophyApiClient::Environment::PRODUCTION,
81
- # api_key: "YOUR_API_KEY"
82
- # )
83
- # api.admin.streaks.restore(users: [{ id: "user-123" }, { id: "user-456" }])
84
- def restore(users:, request_options: nil)
85
- Async do
86
- response = @request_client.conn.post do |req|
87
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
88
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
89
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
90
- req.headers = {
91
- **(req.headers || {}),
92
- **@request_client.get_headers,
93
- **(request_options&.additional_headers || {})
94
- }.compact
95
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
96
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
97
- end
98
- req.body = { **(request_options&.additional_body_parameters || {}), users: users }.compact
99
- req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/streaks/restore"
100
- end
101
- TrophyApiClient::RestoreStreaksResponse.from_json(json_object: response.body)
102
- end
103
- end
104
- end
105
- end
106
- end
@@ -1,100 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- require_relative "../../../../requests"
4
- require_relative "types/create_streak_freezes_request_freezes_item"
5
- require_relative "../../../types/create_streak_freezes_response"
6
- require "async"
7
-
8
- module TrophyApiClient
9
- module Admin
10
- module Streaks
11
- class FreezesClient
12
- # @return [TrophyApiClient::RequestClient]
13
- attr_reader :request_client
14
-
15
- # @param request_client [TrophyApiClient::RequestClient]
16
- # @return [TrophyApiClient::Admin::Streaks::FreezesClient]
17
- def initialize(request_client:)
18
- @request_client = request_client
19
- end
20
-
21
- # Create streak freezes for multiple users.
22
- #
23
- # @param freezes [Array<Hash>] Array of freezes to create. Maximum 100 freezes per request.Request of type Array<TrophyApiClient::Admin::Streaks::Freezes::CreateStreakFreezesRequestFreezesItem>, as a Hash
24
- # * :user_id (String)
25
- # @param request_options [TrophyApiClient::RequestOptions]
26
- # @return [TrophyApiClient::CreateStreakFreezesResponse]
27
- # @example
28
- # api = TrophyApiClient::Client.new(
29
- # base_url: "https://api.example.com",
30
- # environment: TrophyApiClient::Environment::PRODUCTION,
31
- # api_key: "YOUR_API_KEY"
32
- # )
33
- # api.admin.streaks.freezes.create(freezes: [{ user_id: "user-123" }, { user_id: "user-456" }, { user_id: "user-123" }])
34
- def create(freezes:, request_options: nil)
35
- response = @request_client.conn.post do |req|
36
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
37
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
38
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
39
- req.headers = {
40
- **(req.headers || {}),
41
- **@request_client.get_headers,
42
- **(request_options&.additional_headers || {})
43
- }.compact
44
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
45
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
46
- end
47
- req.body = { **(request_options&.additional_body_parameters || {}), freezes: freezes }.compact
48
- req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/streaks/freezes"
49
- end
50
- TrophyApiClient::CreateStreakFreezesResponse.from_json(json_object: response.body)
51
- end
52
- end
53
-
54
- class AsyncFreezesClient
55
- # @return [TrophyApiClient::AsyncRequestClient]
56
- attr_reader :request_client
57
-
58
- # @param request_client [TrophyApiClient::AsyncRequestClient]
59
- # @return [TrophyApiClient::Admin::Streaks::AsyncFreezesClient]
60
- def initialize(request_client:)
61
- @request_client = request_client
62
- end
63
-
64
- # Create streak freezes for multiple users.
65
- #
66
- # @param freezes [Array<Hash>] Array of freezes to create. Maximum 100 freezes per request.Request of type Array<TrophyApiClient::Admin::Streaks::Freezes::CreateStreakFreezesRequestFreezesItem>, as a Hash
67
- # * :user_id (String)
68
- # @param request_options [TrophyApiClient::RequestOptions]
69
- # @return [TrophyApiClient::CreateStreakFreezesResponse]
70
- # @example
71
- # api = TrophyApiClient::Client.new(
72
- # base_url: "https://api.example.com",
73
- # environment: TrophyApiClient::Environment::PRODUCTION,
74
- # api_key: "YOUR_API_KEY"
75
- # )
76
- # api.admin.streaks.freezes.create(freezes: [{ user_id: "user-123" }, { user_id: "user-456" }, { user_id: "user-123" }])
77
- def create(freezes:, request_options: nil)
78
- Async do
79
- response = @request_client.conn.post do |req|
80
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
81
- req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
82
- req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
83
- req.headers = {
84
- **(req.headers || {}),
85
- **@request_client.get_headers,
86
- **(request_options&.additional_headers || {})
87
- }.compact
88
- unless request_options.nil? || request_options&.additional_query_parameters.nil?
89
- req.params = { **(request_options&.additional_query_parameters || {}) }.compact
90
- end
91
- req.body = { **(request_options&.additional_body_parameters || {}), freezes: freezes }.compact
92
- req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/streaks/freezes"
93
- end
94
- TrophyApiClient::CreateStreakFreezesResponse.from_json(json_object: response.body)
95
- end
96
- end
97
- end
98
- end
99
- end
100
- end