trophy_api_client 1.26.1 → 1.28.0

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 (85) hide show
  1. checksums.yaml +4 -4
  2. data/lib/trophy/admin/client.rb +5 -0
  3. data/lib/trophy/admin/rewards/client.rb +207 -0
  4. data/lib/trophy/admin/rewards/triggers/client.rb +209 -0
  5. data/lib/trophy/admin/rewards/triggers/types/triggers_delete_request.rb +17 -0
  6. data/lib/trophy/admin/rewards/triggers/types/triggers_list_request.rb +19 -0
  7. data/lib/trophy/admin/rewards/types/rewards_delete_request.rb +13 -0
  8. data/lib/trophy/admin/rewards/types/rewards_list_request.rb +15 -0
  9. data/lib/trophy/client.rb +6 -1
  10. data/lib/trophy/leaderboards/types/leaderboards_all_response_item.rb +2 -0
  11. data/lib/trophy/rewards/client.rb +57 -0
  12. data/lib/trophy/rewards/types/rewards_redeem_request.rb +13 -0
  13. data/lib/trophy/types/achievement_completion_response.rb +4 -0
  14. data/lib/trophy/types/admin_leaderboard.rb +2 -0
  15. data/lib/trophy/types/admin_leaderboard_user_attributes_item.rb +11 -0
  16. data/lib/trophy/types/admin_reward.rb +28 -0
  17. data/lib/trophy/types/admin_reward_status.rb +12 -0
  18. data/lib/trophy/types/admin_reward_trigger.rb +30 -0
  19. data/lib/trophy/types/admin_reward_trigger_event_attributes_item.rb +11 -0
  20. data/lib/trophy/types/admin_reward_trigger_status.rb +12 -0
  21. data/lib/trophy/types/admin_reward_trigger_type.rb +14 -0
  22. data/lib/trophy/types/admin_reward_trigger_user_attributes_item.rb +11 -0
  23. data/lib/trophy/types/admin_reward_type.rb +12 -0
  24. data/lib/trophy/types/admin_reward_user_attributes_item.rb +11 -0
  25. data/lib/trophy/types/create_leaderboard_request_item.rb +2 -0
  26. data/lib/trophy/types/create_leaderboard_request_item_user_attributes_item.rb +11 -0
  27. data/lib/trophy/types/create_reward_request_item.rb +28 -0
  28. data/lib/trophy/types/create_reward_request_item_status.rb +12 -0
  29. data/lib/trophy/types/create_reward_request_item_type.rb +12 -0
  30. data/lib/trophy/types/create_reward_request_item_user_attributes_item.rb +11 -0
  31. data/lib/trophy/types/create_reward_trigger_request_item.rb +28 -0
  32. data/lib/trophy/types/create_reward_trigger_request_item_event_attributes_item.rb +11 -0
  33. data/lib/trophy/types/create_reward_trigger_request_item_status.rb +12 -0
  34. data/lib/trophy/types/create_reward_trigger_request_item_type.rb +14 -0
  35. data/lib/trophy/types/create_reward_trigger_request_item_user_attributes_item.rb +11 -0
  36. data/lib/trophy/types/create_reward_triggers_request.rb +23 -0
  37. data/lib/trophy/types/create_reward_triggers_response.rb +12 -0
  38. data/lib/trophy/types/create_rewards_request.rb +23 -0
  39. data/lib/trophy/types/create_rewards_response.rb +12 -0
  40. data/lib/trophy/types/created_admin_reward.rb +31 -0
  41. data/lib/trophy/types/delete_reward_triggers_response.rb +12 -0
  42. data/lib/trophy/types/delete_rewards_response.rb +12 -0
  43. data/lib/trophy/types/event_response.rb +2 -0
  44. data/lib/trophy/types/leaderboard_response.rb +2 -0
  45. data/lib/trophy/types/leaderboard_response_user_attributes_item.rb +11 -0
  46. data/lib/trophy/types/leaderboard_response_with_rankings.rb +2 -0
  47. data/lib/trophy/types/list_reward_triggers_response.rb +23 -0
  48. data/lib/trophy/types/list_rewards_response.rb +23 -0
  49. data/lib/trophy/types/metric_event_leaderboard_response.rb +2 -0
  50. data/lib/trophy/types/points_trigger.rb +4 -0
  51. data/lib/trophy/types/points_trigger_type.rb +1 -0
  52. data/lib/trophy/types/redeem_reward_response.rb +15 -0
  53. data/lib/trophy/types/redeemed_reward.rb +13 -0
  54. data/lib/trophy/types/reward_summary.rb +23 -0
  55. data/lib/trophy/types/reward_summary_type.rb +12 -0
  56. data/lib/trophy/types/reward_webhook_event.rb +17 -0
  57. data/lib/trophy/types/reward_webhook_event_redemption.rb +17 -0
  58. data/lib/trophy/types/reward_webhook_event_type.rb +12 -0
  59. data/lib/trophy/types/update_leaderboard_request_item.rb +2 -0
  60. data/lib/trophy/types/update_leaderboard_request_item_user_attributes_item.rb +11 -0
  61. data/lib/trophy/types/update_reward_request_item.rb +27 -0
  62. data/lib/trophy/types/update_reward_request_item_status.rb +12 -0
  63. data/lib/trophy/types/update_reward_request_item_type.rb +12 -0
  64. data/lib/trophy/types/update_reward_request_item_user_attributes_item.rb +11 -0
  65. data/lib/trophy/types/update_reward_triggers_request.rb +23 -0
  66. data/lib/trophy/types/update_reward_triggers_request_item.rb +29 -0
  67. data/lib/trophy/types/update_reward_triggers_request_item_event_attributes_item.rb +11 -0
  68. data/lib/trophy/types/update_reward_triggers_request_item_status.rb +12 -0
  69. data/lib/trophy/types/update_reward_triggers_request_item_type.rb +14 -0
  70. data/lib/trophy/types/update_reward_triggers_request_item_user_attributes_item.rb +11 -0
  71. data/lib/trophy/types/update_reward_triggers_response.rb +12 -0
  72. data/lib/trophy/types/update_rewards_request.rb +23 -0
  73. data/lib/trophy/types/update_rewards_response.rb +12 -0
  74. data/lib/trophy/types/user_leaderboard_response.rb +2 -0
  75. data/lib/trophy/types/user_leaderboard_response_with_history.rb +2 -0
  76. data/lib/trophy/types/user_reward_response.rb +19 -0
  77. data/lib/trophy/types/user_reward_trigger.rb +25 -0
  78. data/lib/trophy/types/user_reward_trigger_type.rb +14 -0
  79. data/lib/trophy/types/webhook_user_leaderboard_response.rb +2 -0
  80. data/lib/trophy/users/client.rb +45 -0
  81. data/lib/trophy/users/types/users_rewards_request.rb +21 -0
  82. data/lib/trophy/version.rb +1 -1
  83. data/lib/trophy.rb +63 -0
  84. data/reference.md +1274 -368
  85. metadata +64 -1
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: trophy_api_client
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.26.1
4
+ version: 1.28.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Trophy
@@ -56,6 +56,12 @@ files:
56
56
  - lib/trophy/admin/points/triggers/client.rb
57
57
  - lib/trophy/admin/points/triggers/types/triggers_delete_request.rb
58
58
  - lib/trophy/admin/points/triggers/types/triggers_list_request.rb
59
+ - lib/trophy/admin/rewards/client.rb
60
+ - lib/trophy/admin/rewards/triggers/client.rb
61
+ - lib/trophy/admin/rewards/triggers/types/triggers_delete_request.rb
62
+ - lib/trophy/admin/rewards/triggers/types/triggers_list_request.rb
63
+ - lib/trophy/admin/rewards/types/rewards_delete_request.rb
64
+ - lib/trophy/admin/rewards/types/rewards_list_request.rb
59
65
  - lib/trophy/admin/settings/client.rb
60
66
  - lib/trophy/admin/settings/types/update_admin_settings_request.rb
61
67
  - lib/trophy/admin/streaks/client.rb
@@ -118,6 +124,8 @@ files:
118
124
  - lib/trophy/points/client.rb
119
125
  - lib/trophy/points/types/points_boosts_request.rb
120
126
  - lib/trophy/points/types/points_summary_request.rb
127
+ - lib/trophy/rewards/client.rb
128
+ - lib/trophy/rewards/types/rewards_redeem_request.rb
121
129
  - lib/trophy/streaks/client.rb
122
130
  - lib/trophy/streaks/types/streaks_list_request.rb
123
131
  - lib/trophy/types/achievement_completion_response.rb
@@ -145,6 +153,7 @@ files:
145
153
  - lib/trophy/types/admin_leaderboard_rank_by.rb
146
154
  - lib/trophy/types/admin_leaderboard_run_unit.rb
147
155
  - lib/trophy/types/admin_leaderboard_status.rb
156
+ - lib/trophy/types/admin_leaderboard_user_attributes_item.rb
148
157
  - lib/trophy/types/admin_points_boost.rb
149
158
  - lib/trophy/types/admin_points_boost_rounding.rb
150
159
  - lib/trophy/types/admin_points_boost_status.rb
@@ -160,6 +169,15 @@ files:
160
169
  - lib/trophy/types/admin_points_trigger_time_unit.rb
161
170
  - lib/trophy/types/admin_points_trigger_type.rb
162
171
  - lib/trophy/types/admin_points_trigger_user_attributes_item.rb
172
+ - lib/trophy/types/admin_reward.rb
173
+ - lib/trophy/types/admin_reward_status.rb
174
+ - lib/trophy/types/admin_reward_trigger.rb
175
+ - lib/trophy/types/admin_reward_trigger_event_attributes_item.rb
176
+ - lib/trophy/types/admin_reward_trigger_status.rb
177
+ - lib/trophy/types/admin_reward_trigger_type.rb
178
+ - lib/trophy/types/admin_reward_trigger_user_attributes_item.rb
179
+ - lib/trophy/types/admin_reward_type.rb
180
+ - lib/trophy/types/admin_reward_user_attributes_item.rb
163
181
  - lib/trophy/types/admin_settings.rb
164
182
  - lib/trophy/types/admin_settings_branding.rb
165
183
  - lib/trophy/types/admin_settings_branding_app_icon.rb
@@ -196,6 +214,7 @@ files:
196
214
  - lib/trophy/types/create_leaderboard_request_item_rank_by.rb
197
215
  - lib/trophy/types/create_leaderboard_request_item_run_unit.rb
198
216
  - lib/trophy/types/create_leaderboard_request_item_status.rb
217
+ - lib/trophy/types/create_leaderboard_request_item_user_attributes_item.rb
199
218
  - lib/trophy/types/create_leaderboards_request.rb
200
219
  - lib/trophy/types/create_leaderboards_response.rb
201
220
  - lib/trophy/types/create_metric_request_item.rb
@@ -223,12 +242,26 @@ files:
223
242
  - lib/trophy/types/create_points_trigger_request_item_user_attributes_item.rb
224
243
  - lib/trophy/types/create_points_triggers_request.rb
225
244
  - lib/trophy/types/create_points_triggers_response.rb
245
+ - lib/trophy/types/create_reward_request_item.rb
246
+ - lib/trophy/types/create_reward_request_item_status.rb
247
+ - lib/trophy/types/create_reward_request_item_type.rb
248
+ - lib/trophy/types/create_reward_request_item_user_attributes_item.rb
249
+ - lib/trophy/types/create_reward_trigger_request_item.rb
250
+ - lib/trophy/types/create_reward_trigger_request_item_event_attributes_item.rb
251
+ - lib/trophy/types/create_reward_trigger_request_item_status.rb
252
+ - lib/trophy/types/create_reward_trigger_request_item_type.rb
253
+ - lib/trophy/types/create_reward_trigger_request_item_user_attributes_item.rb
254
+ - lib/trophy/types/create_reward_triggers_request.rb
255
+ - lib/trophy/types/create_reward_triggers_response.rb
256
+ - lib/trophy/types/create_rewards_request.rb
257
+ - lib/trophy/types/create_rewards_response.rb
226
258
  - lib/trophy/types/create_streak_freezes_response.rb
227
259
  - lib/trophy/types/create_streak_pauses_response.rb
228
260
  - lib/trophy/types/create_tenant_request_item.rb
229
261
  - lib/trophy/types/create_tenants_request.rb
230
262
  - lib/trophy/types/create_tenants_response.rb
231
263
  - lib/trophy/types/created_admin_points_system.rb
264
+ - lib/trophy/types/created_admin_reward.rb
232
265
  - lib/trophy/types/created_application_key.rb
233
266
  - lib/trophy/types/created_metric.rb
234
267
  - lib/trophy/types/created_metric_unit_type.rb
@@ -241,6 +274,8 @@ files:
241
274
  - lib/trophy/types/delete_points_levels_response.rb
242
275
  - lib/trophy/types/delete_points_systems_response.rb
243
276
  - lib/trophy/types/delete_points_triggers_response.rb
277
+ - lib/trophy/types/delete_reward_triggers_response.rb
278
+ - lib/trophy/types/delete_rewards_response.rb
244
279
  - lib/trophy/types/delete_streak_pauses_response.rb
245
280
  - lib/trophy/types/delete_tenants_response.rb
246
281
  - lib/trophy/types/deleted_resource.rb
@@ -252,6 +287,7 @@ files:
252
287
  - lib/trophy/types/leaderboard_response.rb
253
288
  - lib/trophy/types/leaderboard_response_rank_by.rb
254
289
  - lib/trophy/types/leaderboard_response_run_unit.rb
290
+ - lib/trophy/types/leaderboard_response_user_attributes_item.rb
255
291
  - lib/trophy/types/leaderboard_response_with_rankings.rb
256
292
  - lib/trophy/types/leaderboard_response_with_rankings_status.rb
257
293
  - lib/trophy/types/list_achievements_response.rb
@@ -263,6 +299,8 @@ files:
263
299
  - lib/trophy/types/list_points_levels_response.rb
264
300
  - lib/trophy/types/list_points_systems_response.rb
265
301
  - lib/trophy/types/list_points_triggers_response.rb
302
+ - lib/trophy/types/list_reward_triggers_response.rb
303
+ - lib/trophy/types/list_rewards_response.rb
266
304
  - lib/trophy/types/list_tenants_response.rb
267
305
  - lib/trophy/types/metric_event_leaderboard_response.rb
268
306
  - lib/trophy/types/metric_event_leaderboard_response_breakdown_attribute_values_item.rb
@@ -309,8 +347,15 @@ files:
309
347
  - lib/trophy/types/points_trigger_time_unit.rb
310
348
  - lib/trophy/types/points_trigger_type.rb
311
349
  - lib/trophy/types/points_trigger_user_attributes_item.rb
350
+ - lib/trophy/types/redeem_reward_response.rb
351
+ - lib/trophy/types/redeemed_reward.rb
312
352
  - lib/trophy/types/reset_streaks_response.rb
313
353
  - lib/trophy/types/restore_streaks_response.rb
354
+ - lib/trophy/types/reward_summary.rb
355
+ - lib/trophy/types/reward_summary_type.rb
356
+ - lib/trophy/types/reward_webhook_event.rb
357
+ - lib/trophy/types/reward_webhook_event_redemption.rb
358
+ - lib/trophy/types/reward_webhook_event_type.rb
314
359
  - lib/trophy/types/streak_evaluation_mode_preference.rb
315
360
  - lib/trophy/types/streak_frequency.rb
316
361
  - lib/trophy/types/streak_metric_preference.rb
@@ -340,6 +385,7 @@ files:
340
385
  - lib/trophy/types/update_leaderboard_request_item_rank_by.rb
341
386
  - lib/trophy/types/update_leaderboard_request_item_run_unit.rb
342
387
  - lib/trophy/types/update_leaderboard_request_item_status.rb
388
+ - lib/trophy/types/update_leaderboard_request_item_user_attributes_item.rb
343
389
  - lib/trophy/types/update_leaderboards_request.rb
344
390
  - lib/trophy/types/update_leaderboards_response.rb
345
391
  - lib/trophy/types/update_metric_request_item.rb
@@ -350,6 +396,19 @@ files:
350
396
  - lib/trophy/types/update_points_system_request_item_badge.rb
351
397
  - lib/trophy/types/update_points_systems_request.rb
352
398
  - lib/trophy/types/update_points_systems_response.rb
399
+ - lib/trophy/types/update_reward_request_item.rb
400
+ - lib/trophy/types/update_reward_request_item_status.rb
401
+ - lib/trophy/types/update_reward_request_item_type.rb
402
+ - lib/trophy/types/update_reward_request_item_user_attributes_item.rb
403
+ - lib/trophy/types/update_reward_triggers_request.rb
404
+ - lib/trophy/types/update_reward_triggers_request_item.rb
405
+ - lib/trophy/types/update_reward_triggers_request_item_event_attributes_item.rb
406
+ - lib/trophy/types/update_reward_triggers_request_item_status.rb
407
+ - lib/trophy/types/update_reward_triggers_request_item_type.rb
408
+ - lib/trophy/types/update_reward_triggers_request_item_user_attributes_item.rb
409
+ - lib/trophy/types/update_reward_triggers_response.rb
410
+ - lib/trophy/types/update_rewards_request.rb
411
+ - lib/trophy/types/update_rewards_response.rb
353
412
  - lib/trophy/types/update_streak_settings_freezes.rb
354
413
  - lib/trophy/types/update_tenant_request_item.rb
355
414
  - lib/trophy/types/update_tenants_request.rb
@@ -362,6 +421,9 @@ files:
362
421
  - lib/trophy/types/user_leaderboard_response.rb
363
422
  - lib/trophy/types/user_leaderboard_response_with_history.rb
364
423
  - lib/trophy/types/user_preferences_response.rb
424
+ - lib/trophy/types/user_reward_response.rb
425
+ - lib/trophy/types/user_reward_trigger.rb
426
+ - lib/trophy/types/user_reward_trigger_type.rb
365
427
  - lib/trophy/types/webhook_user_leaderboard_response.rb
366
428
  - lib/trophy/types/webhooks_achievement_completed_payload.rb
367
429
  - lib/trophy/types/webhooks_emails_achievement_due_payload.rb
@@ -406,6 +468,7 @@ files:
406
468
  - lib/trophy/users/types/users_points_event_summary_request_aggregation.rb
407
469
  - lib/trophy/users/types/users_points_event_summary_response_item.rb
408
470
  - lib/trophy/users/types/users_points_request.rb
471
+ - lib/trophy/users/types/users_rewards_request.rb
409
472
  - lib/trophy/users/types/users_streak_request.rb
410
473
  - lib/trophy/users/types/users_wrapped_request.rb
411
474
  - lib/trophy/version.rb