trophy_api_client 1.14.0 → 1.27.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.
- checksums.yaml +4 -4
- data/.fern/metadata.json +9 -0
- data/.rubocop.yml +103 -0
- data/CONTRIBUTING.md +120 -0
- data/LICENSE +21 -0
- data/README.md +50 -0
- data/Rakefile +13 -0
- data/custom.gemspec.rb +5 -0
- data/lib/gemconfig.rb +1 -1
- data/lib/trophy/achievements/client.rb +93 -0
- data/lib/trophy/achievements/types/achievements_all_request.rb +11 -0
- data/lib/trophy/achievements/types/achievements_complete_request.rb +13 -0
- data/lib/trophy/admin/achievements/client.rb +201 -0
- data/lib/trophy/admin/achievements/types/achievements_delete_request.rb +13 -0
- data/lib/trophy/admin/achievements/types/achievements_list_request.rb +15 -0
- data/lib/trophy/admin/application_api_keys/client.rb +93 -0
- data/lib/trophy/admin/application_api_keys/types/application_api_keys_delete_request.rb +13 -0
- data/lib/trophy/admin/attributes/client.rb +200 -0
- data/lib/trophy/admin/attributes/types/attributes_delete_request.rb +13 -0
- data/lib/trophy/admin/attributes/types/attributes_list_request.rb +15 -0
- data/lib/trophy/admin/client.rb +68 -0
- data/lib/trophy/admin/environments/client.rb +52 -0
- data/lib/trophy/admin/leaderboards/client.rb +201 -0
- data/lib/trophy/admin/leaderboards/types/leaderboards_delete_request.rb +13 -0
- data/lib/trophy/admin/leaderboards/types/leaderboards_list_request.rb +15 -0
- data/lib/trophy/admin/metrics/client.rb +234 -0
- data/lib/trophy/admin/metrics/types/metrics_delete_request.rb +13 -0
- data/lib/trophy/admin/metrics/types/metrics_list_request.rb +15 -0
- data/lib/trophy/admin/points/boosts/client.rb +207 -0
- data/lib/trophy/admin/points/boosts/types/boosts_delete_request.rb +17 -0
- data/lib/trophy/admin/points/boosts/types/boosts_list_request.rb +19 -0
- data/lib/trophy/admin/points/client.rb +40 -0
- data/lib/trophy/admin/points/levels/client.rb +207 -0
- data/lib/trophy/admin/points/levels/types/levels_delete_request.rb +17 -0
- data/lib/trophy/admin/points/levels/types/levels_list_request.rb +19 -0
- data/lib/trophy/admin/points/systems/client.rb +203 -0
- data/lib/trophy/admin/points/systems/types/systems_delete_request.rb +15 -0
- data/lib/trophy/admin/points/systems/types/systems_list_request.rb +17 -0
- data/lib/trophy/admin/points/triggers/client.rb +208 -0
- data/lib/trophy/admin/points/triggers/types/triggers_delete_request.rb +17 -0
- data/lib/trophy/admin/points/triggers/types/triggers_list_request.rb +19 -0
- data/lib/trophy/admin/settings/client.rb +86 -0
- data/lib/trophy/admin/settings/types/update_admin_settings_request.rb +17 -0
- data/lib/trophy/admin/streaks/client.rb +106 -0
- data/lib/trophy/admin/streaks/freezes/client.rb +56 -0
- data/lib/trophy/admin/streaks/freezes/types/create_streak_freezes_request.rb +15 -0
- data/lib/trophy/admin/streaks/freezes/types/create_streak_freezes_request_freezes_item.rb +15 -0
- data/lib/trophy/admin/streaks/pauses/client.rb +95 -0
- data/lib/trophy/admin/streaks/pauses/types/create_streak_pauses_request.rb +15 -0
- data/lib/trophy/admin/streaks/pauses/types/create_streak_pauses_request_pauses_item.rb +19 -0
- data/lib/trophy/admin/streaks/pauses/types/pauses_delete_request.rb +15 -0
- data/lib/trophy/admin/streaks/settings/client.rb +88 -0
- data/lib/trophy/admin/streaks/settings/types/update_streak_settings_request.rb +25 -0
- data/lib/trophy/admin/streaks/types/reset_streaks_request.rb +13 -0
- data/lib/trophy/admin/streaks/types/reset_streaks_request_users_item.rb +13 -0
- data/lib/trophy/admin/streaks/types/restore_streaks_request.rb +13 -0
- data/lib/trophy/admin/streaks/types/restore_streaks_request_users_item.rb +13 -0
- data/lib/trophy/admin/tenants/client.rb +200 -0
- data/lib/trophy/admin/tenants/types/tenants_delete_request.rb +13 -0
- data/lib/trophy/admin/tenants/types/tenants_list_request.rb +15 -0
- data/lib/trophy/client.rb +62 -0
- data/lib/{environment.rb → trophy/environment.rb} +1 -1
- data/lib/trophy/errors/api_error.rb +8 -0
- data/lib/trophy/errors/client_error.rb +17 -0
- data/lib/trophy/errors/redirect_error.rb +8 -0
- data/lib/trophy/errors/response_error.rb +42 -0
- data/lib/trophy/errors/server_error.rb +11 -0
- data/lib/trophy/errors/timeout_error.rb +8 -0
- data/lib/trophy/internal/errors/constraint_error.rb +10 -0
- data/lib/trophy/internal/errors/type_error.rb +10 -0
- data/lib/trophy/internal/http/base_request.rb +51 -0
- data/lib/trophy/internal/http/raw_client.rb +215 -0
- data/lib/trophy/internal/iterators/cursor_item_iterator.rb +28 -0
- data/lib/trophy/internal/iterators/cursor_page_iterator.rb +63 -0
- data/lib/trophy/internal/iterators/item_iterator.rb +65 -0
- data/lib/trophy/internal/iterators/offset_item_iterator.rb +30 -0
- data/lib/trophy/internal/iterators/offset_page_iterator.rb +103 -0
- data/lib/trophy/internal/json/request.rb +41 -0
- data/lib/trophy/internal/json/serializable.rb +25 -0
- data/lib/trophy/internal/multipart/multipart_encoder.rb +141 -0
- data/lib/trophy/internal/multipart/multipart_form_data.rb +78 -0
- data/lib/trophy/internal/multipart/multipart_form_data_part.rb +51 -0
- data/lib/trophy/internal/multipart/multipart_request.rb +40 -0
- data/lib/trophy/internal/types/array.rb +47 -0
- data/lib/trophy/internal/types/boolean.rb +34 -0
- data/lib/trophy/internal/types/enum.rb +56 -0
- data/lib/trophy/internal/types/hash.rb +36 -0
- data/lib/trophy/internal/types/model/field.rb +38 -0
- data/lib/trophy/internal/types/model.rb +208 -0
- data/lib/trophy/internal/types/type.rb +35 -0
- data/lib/trophy/internal/types/union.rb +161 -0
- data/lib/trophy/internal/types/unknown.rb +15 -0
- data/lib/trophy/internal/types/utils.rb +116 -0
- data/lib/trophy/leaderboards/client.rb +101 -0
- data/lib/trophy/leaderboards/types/leaderboards_all_request.rb +11 -0
- data/lib/trophy/leaderboards/types/leaderboards_all_response_item.rb +49 -0
- data/lib/trophy/leaderboards/types/leaderboards_all_response_item_status.rb +15 -0
- data/lib/trophy/leaderboards/types/leaderboards_get_request.rb +21 -0
- data/lib/trophy/metrics/client.rb +62 -0
- data/lib/trophy/metrics/types/metrics_event_request.rb +19 -0
- data/lib/trophy/points/client.rb +194 -0
- data/lib/trophy/points/types/points_boosts_request.rb +13 -0
- data/lib/trophy/points/types/points_summary_request.rb +13 -0
- data/lib/trophy/streaks/client.rb +56 -0
- data/lib/trophy/streaks/types/streaks_list_request.rb +11 -0
- data/lib/trophy/types/achievement_completion_response.rb +13 -0
- data/lib/trophy/types/achievement_response.rb +37 -0
- data/lib/trophy/types/achievement_response_event_attribute.rb +13 -0
- data/lib/trophy/types/achievement_response_event_attributes_item.rb +11 -0
- data/lib/trophy/types/achievement_response_trigger.rb +15 -0
- data/lib/trophy/types/achievement_response_user_attributes_item.rb +11 -0
- data/lib/trophy/types/achievement_with_stats_response.rb +41 -0
- data/lib/trophy/types/admin_achievement.rb +37 -0
- data/lib/trophy/types/admin_achievement_badge.rb +9 -0
- data/lib/trophy/types/admin_achievement_event_attributes_item.rb +11 -0
- data/lib/trophy/types/admin_achievement_status.rb +13 -0
- data/lib/trophy/types/admin_achievement_trigger.rb +15 -0
- data/lib/trophy/types/admin_achievement_user_attributes_item.rb +11 -0
- data/lib/trophy/types/admin_aggregation_period.rb +12 -0
- data/lib/trophy/types/admin_attribute.rb +16 -0
- data/lib/trophy/types/admin_attribute_type.rb +12 -0
- data/lib/trophy/types/admin_environment.rb +14 -0
- data/lib/trophy/types/admin_error_body.rb +9 -0
- data/lib/trophy/types/admin_font_family.rb +19 -0
- data/lib/trophy/types/admin_issue.rb +20 -0
- data/lib/trophy/types/admin_issue_severity.rb +12 -0
- data/lib/trophy/types/admin_leaderboard.rb +42 -0
- data/lib/trophy/types/admin_leaderboard_rank_by.rb +13 -0
- data/lib/trophy/types/admin_leaderboard_run_unit.rb +13 -0
- data/lib/trophy/types/admin_leaderboard_status.rb +14 -0
- data/lib/trophy/types/admin_leaderboard_user_attributes_item.rb +11 -0
- data/lib/trophy/types/admin_points_boost.rb +26 -0
- data/lib/trophy/types/admin_points_boost_rounding.rb +13 -0
- data/lib/{trophy_api_client/leaderboards/types/leaderboards_all_response_item_status.rb → trophy/types/admin_points_boost_status.rb} +5 -4
- data/lib/trophy/types/admin_points_boost_user_attributes_item.rb +11 -0
- data/lib/trophy/types/admin_points_level.rb +20 -0
- data/lib/trophy/types/admin_points_level_badge.rb +9 -0
- data/lib/trophy/types/admin_points_system.rb +22 -0
- data/lib/trophy/types/admin_points_system_badge.rb +9 -0
- data/lib/trophy/types/admin_points_system_status.rb +12 -0
- data/lib/trophy/types/admin_points_trigger.rb +34 -0
- data/lib/trophy/types/admin_points_trigger_event_attributes_item.rb +11 -0
- data/lib/trophy/types/admin_points_trigger_status.rb +12 -0
- data/lib/trophy/types/admin_points_trigger_time_unit.rb +12 -0
- data/lib/trophy/types/admin_points_trigger_type.rb +15 -0
- data/lib/trophy/types/admin_points_trigger_user_attributes_item.rb +11 -0
- data/lib/trophy/types/admin_settings.rb +14 -0
- data/lib/trophy/types/admin_settings_branding.rb +20 -0
- data/lib/trophy/types/admin_settings_branding_app_icon.rb +9 -0
- data/lib/trophy/types/admin_settings_branding_logo.rb +9 -0
- data/lib/trophy/types/admin_settings_experimentation.rb +12 -0
- data/lib/trophy/types/admin_streak_evaluation_mode.rb +12 -0
- data/lib/{trophy_api_client/users/types/users_points_event_summary_request_aggregation.rb → trophy/types/admin_streak_frequency.rb} +5 -3
- data/lib/trophy/types/admin_streak_pause.rb +18 -0
- data/lib/trophy/types/admin_streak_pause_status.rb +12 -0
- data/lib/trophy/types/admin_tenant.rb +20 -0
- data/lib/trophy/types/admin_tenant_status.rb +12 -0
- data/lib/trophy/types/base_streak_response.rb +27 -0
- data/lib/trophy/types/batch_events_response.rb +10 -0
- data/lib/trophy/types/batch_metric_event.rb +19 -0
- data/lib/trophy/types/batch_metric_event_user.rb +22 -0
- data/lib/trophy/types/bulk_streak_response.rb +23 -0
- data/lib/trophy/types/bulk_streak_response_item.rb +13 -0
- data/lib/trophy/types/create_achievement_request_item.rb +35 -0
- data/lib/trophy/types/create_achievement_request_item_badge.rb +10 -0
- data/lib/trophy/types/create_achievement_request_item_event_attributes_item.rb +11 -0
- data/lib/trophy/types/create_achievement_request_item_status.rb +13 -0
- data/lib/trophy/types/create_achievement_request_item_trigger.rb +15 -0
- data/lib/trophy/types/create_achievement_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/create_achievements_request.rb +23 -0
- data/lib/trophy/types/create_achievements_response.rb +12 -0
- data/lib/trophy/types/create_application_key_request_item.rb +10 -0
- data/lib/trophy/types/create_application_keys_request.rb +23 -0
- data/lib/trophy/types/create_application_keys_response.rb +12 -0
- data/lib/trophy/types/create_attribute_request_item.rb +14 -0
- data/lib/trophy/types/create_attribute_request_item_type.rb +12 -0
- data/lib/trophy/types/create_attributes_request.rb +23 -0
- data/lib/trophy/types/create_attributes_response.rb +12 -0
- data/lib/trophy/types/create_leaderboard_request_item.rb +40 -0
- data/lib/trophy/types/create_leaderboard_request_item_rank_by.rb +13 -0
- data/lib/trophy/types/create_leaderboard_request_item_run_unit.rb +13 -0
- data/lib/trophy/types/create_leaderboard_request_item_status.rb +14 -0
- data/lib/trophy/types/create_leaderboard_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/create_leaderboards_request.rb +23 -0
- data/lib/trophy/types/create_leaderboards_response.rb +12 -0
- data/lib/trophy/types/create_metric_request_item.rb +16 -0
- data/lib/trophy/types/create_metric_request_item_unit_type.rb +12 -0
- data/lib/trophy/types/create_metrics_request.rb +23 -0
- data/lib/trophy/types/create_metrics_response.rb +12 -0
- data/lib/trophy/types/create_points_boost_request_item.rb +23 -0
- data/lib/trophy/types/create_points_boost_request_item_rounding.rb +13 -0
- data/lib/trophy/types/create_points_boost_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/create_points_boosts_request.rb +23 -0
- data/lib/trophy/types/create_points_boosts_response.rb +12 -0
- data/lib/trophy/types/create_points_level_request_item.rb +18 -0
- data/lib/trophy/types/create_points_level_request_item_badge.rb +10 -0
- data/lib/trophy/types/create_points_levels_request.rb +23 -0
- data/lib/trophy/types/create_points_levels_response.rb +12 -0
- data/lib/trophy/types/create_points_system_request_item.rb +24 -0
- data/lib/trophy/types/create_points_system_request_item_badge.rb +9 -0
- data/lib/trophy/types/create_points_systems_request.rb +23 -0
- data/lib/trophy/types/create_points_systems_response.rb +12 -0
- data/lib/trophy/types/create_points_trigger_request_item.rb +32 -0
- data/lib/trophy/types/create_points_trigger_request_item_event_attributes_item.rb +11 -0
- data/lib/trophy/types/create_points_trigger_request_item_status.rb +12 -0
- data/lib/trophy/types/create_points_trigger_request_item_time_unit.rb +12 -0
- data/lib/trophy/types/create_points_trigger_request_item_type.rb +15 -0
- data/lib/trophy/types/create_points_trigger_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/create_points_triggers_request.rb +23 -0
- data/lib/trophy/types/create_points_triggers_response.rb +12 -0
- data/lib/trophy/types/create_streak_freezes_response.rb +10 -0
- data/lib/trophy/types/create_streak_pauses_response.rb +12 -0
- data/lib/trophy/types/create_tenant_request_item.rb +12 -0
- data/lib/trophy/types/create_tenants_request.rb +23 -0
- data/lib/trophy/types/create_tenants_response.rb +12 -0
- data/lib/trophy/types/created_admin_points_system.rb +29 -0
- data/lib/trophy/types/created_application_key.rb +16 -0
- data/lib/trophy/types/created_metric.rb +18 -0
- data/lib/trophy/types/created_metric_unit_type.rb +12 -0
- data/lib/trophy/types/delete_achievements_response.rb +13 -0
- data/lib/trophy/types/delete_application_keys_response.rb +12 -0
- data/lib/trophy/types/delete_attributes_response.rb +13 -0
- data/lib/trophy/types/delete_leaderboards_response.rb +12 -0
- data/lib/trophy/types/delete_metrics_response.rb +13 -0
- data/lib/trophy/types/delete_points_boosts_response.rb +12 -0
- data/lib/trophy/types/delete_points_levels_response.rb +12 -0
- data/lib/trophy/types/delete_points_systems_response.rb +12 -0
- data/lib/trophy/types/delete_points_triggers_response.rb +12 -0
- data/lib/trophy/types/delete_streak_pauses_response.rb +12 -0
- data/lib/trophy/types/delete_tenants_response.rb +12 -0
- data/lib/trophy/types/deleted_resource.rb +10 -0
- data/lib/trophy/types/error_body.rb +9 -0
- data/lib/trophy/types/event_response.rb +25 -0
- data/lib/trophy/types/get_user_points_response.rb +25 -0
- data/lib/trophy/types/leaderboard_event.rb +20 -0
- data/lib/trophy/types/leaderboard_ranking.rb +16 -0
- data/lib/trophy/types/leaderboard_response.rb +46 -0
- data/lib/trophy/types/leaderboard_response_rank_by.rb +13 -0
- data/lib/trophy/types/leaderboard_response_run_unit.rb +13 -0
- data/lib/trophy/types/leaderboard_response_user_attributes_item.rb +11 -0
- data/lib/trophy/types/leaderboard_response_with_rankings.rb +49 -0
- data/lib/trophy/types/leaderboard_response_with_rankings_status.rb +13 -0
- data/lib/trophy/types/list_achievements_response.rb +23 -0
- data/lib/trophy/types/list_attributes_response.rb +23 -0
- data/lib/trophy/types/list_environments_response.rb +23 -0
- data/lib/trophy/types/list_leaderboards_response.rb +23 -0
- data/lib/trophy/types/list_metrics_response.rb +23 -0
- data/lib/trophy/types/list_points_boosts_response.rb +23 -0
- data/lib/trophy/types/list_points_levels_response.rb +23 -0
- data/lib/trophy/types/list_points_systems_response.rb +23 -0
- data/lib/trophy/types/list_points_triggers_response.rb +23 -0
- data/lib/trophy/types/list_tenants_response.rb +23 -0
- data/lib/trophy/types/metric_event_leaderboard_response.rb +55 -0
- data/lib/trophy/types/metric_event_leaderboard_response_breakdown_attribute_values_item.rb +11 -0
- data/lib/trophy/types/metric_event_points_response.rb +28 -0
- data/lib/trophy/types/metric_event_streak_response.rb +30 -0
- data/lib/trophy/types/metric_response.rb +17 -0
- data/lib/trophy/types/notification_channel.rb +12 -0
- data/lib/trophy/types/notification_preferences.rb +16 -0
- data/lib/trophy/types/patch_points_boosts_request.rb +23 -0
- data/lib/trophy/types/patch_points_boosts_request_item.rb +21 -0
- data/lib/trophy/types/patch_points_boosts_request_item_rounding.rb +13 -0
- data/lib/trophy/types/patch_points_boosts_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/patch_points_boosts_response.rb +12 -0
- data/lib/trophy/types/patch_points_levels_request.rb +23 -0
- data/lib/trophy/types/patch_points_levels_request_item.rb +17 -0
- data/lib/trophy/types/patch_points_levels_request_item_badge.rb +9 -0
- data/lib/trophy/types/patch_points_levels_response.rb +12 -0
- data/lib/trophy/types/patch_points_triggers_request.rb +23 -0
- data/lib/trophy/types/patch_points_triggers_request_item.rb +33 -0
- data/lib/trophy/types/patch_points_triggers_request_item_event_attributes_item.rb +11 -0
- data/lib/trophy/types/patch_points_triggers_request_item_status.rb +12 -0
- data/lib/trophy/types/patch_points_triggers_request_item_time_unit.rb +12 -0
- data/lib/trophy/types/patch_points_triggers_request_item_type.rb +15 -0
- data/lib/trophy/types/patch_points_triggers_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/patch_points_triggers_response.rb +12 -0
- data/lib/trophy/types/points_award.rb +19 -0
- data/lib/trophy/types/points_boost.rb +21 -0
- data/lib/trophy/types/points_boost_rounding.rb +13 -0
- data/lib/trophy/types/points_boost_status.rb +13 -0
- data/lib/trophy/types/points_boost_webhook_payload.rb +30 -0
- data/lib/trophy/types/points_boost_webhook_payload_rounding.rb +13 -0
- data/lib/trophy/types/points_boost_webhook_payload_status.rb +12 -0
- data/lib/trophy/types/points_level.rb +20 -0
- data/lib/trophy/types/points_level_summary_response.rb +23 -0
- data/lib/trophy/types/points_level_summary_response_item.rb +11 -0
- data/lib/trophy/types/points_range.rb +13 -0
- data/lib/trophy/types/points_response.rb +20 -0
- data/lib/trophy/types/points_summary_response.rb +23 -0
- data/lib/trophy/types/points_system_response.rb +19 -0
- data/lib/trophy/types/points_trigger.rb +41 -0
- data/lib/trophy/types/points_trigger_event_attribute.rb +13 -0
- data/lib/trophy/types/points_trigger_event_attributes_item.rb +11 -0
- data/lib/trophy/types/points_trigger_status.rb +13 -0
- data/lib/trophy/types/points_trigger_time_unit.rb +12 -0
- data/lib/trophy/types/points_trigger_type.rb +15 -0
- data/lib/trophy/types/points_trigger_user_attributes_item.rb +11 -0
- data/lib/trophy/types/reset_streaks_response.rb +12 -0
- data/lib/trophy/types/restore_streaks_response.rb +12 -0
- data/lib/trophy/types/streak_evaluation_mode_preference.rb +12 -0
- data/lib/{trophy_api_client/users/types/users_metric_event_summary_request_aggregation.rb → trophy/types/streak_frequency.rb} +5 -3
- data/lib/trophy/types/streak_metric_preference.rb +12 -0
- data/lib/trophy/types/streak_preferences.rb +17 -0
- data/lib/trophy/types/streak_response.rb +34 -0
- data/lib/trophy/types/streak_response_pauses_item.rb +14 -0
- data/lib/trophy/types/streak_response_streak_history_item.rb +20 -0
- data/lib/trophy/types/streak_settings.rb +20 -0
- data/lib/trophy/types/streak_settings_freezes.rb +16 -0
- data/lib/trophy/types/streak_settings_metric.rb +12 -0
- data/lib/trophy/types/update_achievement_request_item.rb +37 -0
- data/lib/trophy/types/update_achievement_request_item_badge.rb +9 -0
- data/lib/trophy/types/update_achievement_request_item_event_attributes_item.rb +11 -0
- data/lib/trophy/types/update_achievement_request_item_status.rb +13 -0
- data/lib/trophy/types/update_achievement_request_item_trigger.rb +15 -0
- data/lib/trophy/types/update_achievement_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/update_achievements_request.rb +23 -0
- data/lib/trophy/types/update_achievements_response.rb +12 -0
- data/lib/trophy/types/update_admin_settings_branding.rb +20 -0
- data/lib/trophy/types/update_admin_settings_branding_app_icon.rb +9 -0
- data/lib/trophy/types/update_admin_settings_branding_logo.rb +9 -0
- data/lib/trophy/types/update_admin_settings_experimentation.rb +12 -0
- data/lib/trophy/types/update_attribute_request_item.rb +13 -0
- data/lib/trophy/types/update_attributes_request.rb +23 -0
- data/lib/trophy/types/update_attributes_response.rb +12 -0
- data/lib/trophy/types/update_leaderboard_request_item.rb +43 -0
- data/lib/trophy/types/update_leaderboard_request_item_rank_by.rb +13 -0
- data/lib/trophy/types/update_leaderboard_request_item_run_unit.rb +13 -0
- data/lib/trophy/types/update_leaderboard_request_item_status.rb +14 -0
- data/lib/trophy/types/update_leaderboard_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/update_leaderboards_request.rb +23 -0
- data/lib/trophy/types/update_leaderboards_response.rb +12 -0
- data/lib/trophy/types/update_metric_request_item.rb +17 -0
- data/lib/trophy/types/update_metric_request_item_unit_type.rb +12 -0
- data/lib/trophy/types/update_metrics_request.rb +23 -0
- data/lib/trophy/types/update_metrics_response.rb +12 -0
- data/lib/trophy/types/update_points_system_request_item.rb +18 -0
- data/lib/trophy/types/update_points_system_request_item_badge.rb +9 -0
- data/lib/trophy/types/update_points_systems_request.rb +23 -0
- data/lib/trophy/types/update_points_systems_response.rb +12 -0
- data/lib/trophy/types/update_streak_settings_freezes.rb +17 -0
- data/lib/trophy/types/update_tenant_request_item.rb +14 -0
- data/lib/trophy/types/update_tenants_request.rb +23 -0
- data/lib/trophy/types/update_tenants_response.rb +12 -0
- data/lib/trophy/types/updated_user.rb +22 -0
- data/lib/trophy/types/upserted_user.rb +24 -0
- data/lib/trophy/types/user.rb +30 -0
- data/lib/trophy/types/user_achievement_response.rb +39 -0
- data/lib/trophy/types/user_achievement_with_stats_response.rb +43 -0
- data/lib/trophy/types/user_leaderboard_response.rb +50 -0
- data/lib/trophy/types/user_leaderboard_response_with_history.rb +52 -0
- data/lib/trophy/types/user_preferences_response.rb +12 -0
- data/lib/trophy/types/webhook_user_leaderboard_response.rb +54 -0
- data/lib/trophy/types/webhooks_achievement_completed_payload.rb +13 -0
- data/lib/trophy/types/webhooks_emails_achievement_due_payload.rb +15 -0
- data/lib/trophy/types/webhooks_emails_reactivation_due_payload.rb +15 -0
- data/lib/trophy/types/webhooks_emails_reactivation_due_payload_reactivation.rb +12 -0
- data/lib/trophy/types/webhooks_emails_recap_due_payload.rb +15 -0
- data/lib/trophy/types/webhooks_emails_recap_due_payload_recap.rb +12 -0
- data/lib/trophy/types/webhooks_emails_streak_reminder_due_payload.rb +15 -0
- data/lib/trophy/types/webhooks_leaderboard_changed_payload.rb +11 -0
- data/lib/trophy/types/webhooks_leaderboard_finished_payload.rb +11 -0
- data/lib/trophy/types/webhooks_leaderboard_rank_changed_payload.rb +13 -0
- data/lib/trophy/types/webhooks_leaderboard_started_payload.rb +11 -0
- data/lib/trophy/types/webhooks_points_boost_finished_payload.rb +13 -0
- data/lib/trophy/types/webhooks_points_boost_started_payload.rb +13 -0
- data/lib/trophy/types/webhooks_points_changed_payload.rb +13 -0
- data/lib/trophy/types/webhooks_points_level_changed_payload.rb +17 -0
- data/lib/trophy/types/webhooks_points_level_changed_payload_points.rb +22 -0
- data/lib/trophy/types/webhooks_streak_extended_payload.rb +13 -0
- data/lib/trophy/types/webhooks_streak_freeze_consumed_payload.rb +15 -0
- data/lib/trophy/types/webhooks_streak_freeze_earned_payload.rb +15 -0
- data/lib/trophy/types/webhooks_streak_lost_payload.rb +13 -0
- data/lib/trophy/types/webhooks_streak_started_payload.rb +13 -0
- data/lib/trophy/types/wrapped_activity.rb +22 -0
- data/lib/trophy/types/wrapped_activity_period.rb +16 -0
- data/lib/trophy/types/wrapped_entire_year.rb +18 -0
- data/lib/trophy/types/wrapped_metric.rb +22 -0
- data/lib/trophy/types/wrapped_metric_by_attribute_value_value.rb +19 -0
- data/lib/trophy/types/wrapped_most_active_day.rb +18 -0
- data/lib/trophy/types/wrapped_most_active_month.rb +18 -0
- data/lib/trophy/types/wrapped_most_active_week.rb +20 -0
- data/lib/trophy/types/wrapped_points.rb +20 -0
- data/lib/trophy/types/wrapped_response.rb +13 -0
- data/lib/trophy/types/wrapped_streak.rb +18 -0
- data/lib/trophy/users/client.rb +612 -0
- data/lib/trophy/users/types/update_user_preferences_request.rb +15 -0
- data/lib/trophy/users/types/users_achievements_request.rb +13 -0
- data/lib/trophy/users/types/users_leaderboard_request.rb +17 -0
- data/lib/trophy/users/types/users_metric_event_summary_request.rb +19 -0
- data/lib/trophy/users/types/users_metric_event_summary_request_aggregation.rb +15 -0
- data/lib/trophy/users/types/users_metric_event_summary_response_item.rb +15 -0
- data/lib/trophy/users/types/users_points_event_summary_request.rb +19 -0
- data/lib/trophy/users/types/users_points_event_summary_request_aggregation.rb +15 -0
- data/lib/trophy/users/types/users_points_event_summary_response_item.rb +15 -0
- data/lib/trophy/users/types/users_points_request.rb +15 -0
- data/lib/trophy/users/types/users_streak_request.rb +13 -0
- data/lib/trophy/users/types/users_wrapped_request.rb +13 -0
- data/lib/trophy/version.rb +5 -0
- data/lib/trophy.rb +394 -0
- data/lib/trophy_api_client.rb +4 -101
- data/reference.md +6128 -0
- metadata +407 -333
- data/lib/requests.rb +0 -189
- data/lib/trophy_api_client/achievements/client.rb +0 -196
- data/lib/trophy_api_client/admin/attributes/client.rb +0 -378
- data/lib/trophy_api_client/admin/client.rb +0 -65
- data/lib/trophy_api_client/admin/leaderboards/client.rb +0 -381
- data/lib/trophy_api_client/admin/metrics/client.rb +0 -376
- data/lib/trophy_api_client/admin/points/boosts/client.rb +0 -410
- data/lib/trophy_api_client/admin/points/client.rb +0 -53
- data/lib/trophy_api_client/admin/points/levels/client.rb +0 -412
- data/lib/trophy_api_client/admin/points/systems/client.rb +0 -384
- data/lib/trophy_api_client/admin/points/triggers/client.rb +0 -412
- data/lib/trophy_api_client/admin/streaks/client.rb +0 -106
- data/lib/trophy_api_client/admin/streaks/freezes/client.rb +0 -100
- data/lib/trophy_api_client/admin/streaks/freezes/types/create_streak_freezes_request_freezes_item.rb +0 -62
- data/lib/trophy_api_client/admin/streaks/types/restore_streaks_request_users_item.rb +0 -59
- data/lib/trophy_api_client/admin/tenants/client.rb +0 -376
- data/lib/trophy_api_client/leaderboards/client.rb +0 -225
- data/lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item.rb +0 -202
- data/lib/trophy_api_client/metrics/client.rb +0 -142
- data/lib/trophy_api_client/points/client.rb +0 -424
- data/lib/trophy_api_client/streaks/client.rb +0 -104
- data/lib/trophy_api_client/types/achievement_completion_response.rb +0 -83
- data/lib/trophy_api_client/types/achievement_response.rb +0 -198
- data/lib/trophy_api_client/types/achievement_response_event_attribute.rb +0 -67
- data/lib/trophy_api_client/types/achievement_response_event_attributes_item.rb +0 -66
- data/lib/trophy_api_client/types/achievement_response_trigger.rb +0 -11
- data/lib/trophy_api_client/types/achievement_response_user_attributes_item.rb +0 -66
- data/lib/trophy_api_client/types/achievement_with_stats_response.rb +0 -214
- data/lib/trophy_api_client/types/admin_attribute.rb +0 -81
- data/lib/trophy_api_client/types/admin_attribute_type.rb +0 -9
- data/lib/trophy_api_client/types/admin_issue.rb +0 -98
- data/lib/trophy_api_client/types/admin_issue_severity.rb +0 -9
- data/lib/trophy_api_client/types/admin_leaderboard.rb +0 -171
- data/lib/trophy_api_client/types/admin_leaderboard_rank_by.rb +0 -10
- data/lib/trophy_api_client/types/admin_leaderboard_run_unit.rb +0 -10
- data/lib/trophy_api_client/types/admin_leaderboard_status.rb +0 -11
- data/lib/trophy_api_client/types/admin_points_boost.rb +0 -138
- data/lib/trophy_api_client/types/admin_points_boost_rounding.rb +0 -10
- data/lib/trophy_api_client/types/admin_points_boost_status.rb +0 -10
- data/lib/trophy_api_client/types/admin_points_boost_user_attributes_item.rb +0 -65
- data/lib/trophy_api_client/types/admin_points_level.rb +0 -109
- data/lib/trophy_api_client/types/admin_points_level_badge.rb +0 -55
- data/lib/trophy_api_client/types/admin_points_system.rb +0 -118
- data/lib/trophy_api_client/types/admin_points_system_badge.rb +0 -55
- data/lib/trophy_api_client/types/admin_points_system_status.rb +0 -9
- data/lib/trophy_api_client/types/admin_points_trigger.rb +0 -175
- data/lib/trophy_api_client/types/admin_points_trigger_event_attributes_item.rb +0 -66
- data/lib/trophy_api_client/types/admin_points_trigger_status.rb +0 -9
- data/lib/trophy_api_client/types/admin_points_trigger_time_unit.rb +0 -9
- data/lib/trophy_api_client/types/admin_points_trigger_type.rb +0 -12
- data/lib/trophy_api_client/types/admin_points_trigger_user_attributes_item.rb +0 -65
- data/lib/trophy_api_client/types/admin_tenant.rb +0 -103
- data/lib/trophy_api_client/types/admin_tenant_status.rb +0 -9
- data/lib/trophy_api_client/types/base_streak_response.rb +0 -144
- data/lib/trophy_api_client/types/bulk_streak_response.rb +0 -7
- data/lib/trophy_api_client/types/bulk_streak_response_item.rb +0 -76
- data/lib/trophy_api_client/types/create_attribute_request_item.rb +0 -76
- data/lib/trophy_api_client/types/create_attribute_request_item_type.rb +0 -9
- data/lib/trophy_api_client/types/create_attributes_request.rb +0 -7
- data/lib/trophy_api_client/types/create_attributes_response.rb +0 -74
- data/lib/trophy_api_client/types/create_leaderboard_request_item.rb +0 -171
- data/lib/trophy_api_client/types/create_leaderboard_request_item_rank_by.rb +0 -10
- data/lib/trophy_api_client/types/create_leaderboard_request_item_run_unit.rb +0 -11
- data/lib/trophy_api_client/types/create_leaderboard_request_item_status.rb +0 -13
- data/lib/trophy_api_client/types/create_leaderboards_request.rb +0 -7
- data/lib/trophy_api_client/types/create_leaderboards_response.rb +0 -74
- data/lib/trophy_api_client/types/create_metric_request_item.rb +0 -87
- data/lib/trophy_api_client/types/create_metric_request_item_unit_type.rb +0 -9
- data/lib/trophy_api_client/types/create_metrics_request.rb +0 -7
- data/lib/trophy_api_client/types/create_metrics_response.rb +0 -74
- data/lib/trophy_api_client/types/create_points_boost_request_item.rb +0 -125
- data/lib/trophy_api_client/types/create_points_boost_request_item_rounding.rb +0 -10
- data/lib/trophy_api_client/types/create_points_boost_request_item_user_attributes_item.rb +0 -67
- data/lib/trophy_api_client/types/create_points_boosts_request.rb +0 -7
- data/lib/trophy_api_client/types/create_points_boosts_response.rb +0 -75
- data/lib/trophy_api_client/types/create_points_level_request_item.rb +0 -103
- data/lib/trophy_api_client/types/create_points_level_request_item_badge.rb +0 -56
- data/lib/trophy_api_client/types/create_points_levels_request.rb +0 -7
- data/lib/trophy_api_client/types/create_points_levels_response.rb +0 -74
- data/lib/trophy_api_client/types/create_points_system_request_item.rb +0 -140
- data/lib/trophy_api_client/types/create_points_system_request_item_badge.rb +0 -55
- data/lib/trophy_api_client/types/create_points_systems_request.rb +0 -7
- data/lib/trophy_api_client/types/create_points_systems_response.rb +0 -74
- data/lib/trophy_api_client/types/create_points_trigger_request_item.rb +0 -167
- data/lib/trophy_api_client/types/create_points_trigger_request_item_event_attributes_item.rb +0 -67
- data/lib/trophy_api_client/types/create_points_trigger_request_item_status.rb +0 -9
- data/lib/trophy_api_client/types/create_points_trigger_request_item_time_unit.rb +0 -9
- data/lib/trophy_api_client/types/create_points_trigger_request_item_type.rb +0 -12
- data/lib/trophy_api_client/types/create_points_trigger_request_item_user_attributes_item.rb +0 -67
- data/lib/trophy_api_client/types/create_points_triggers_request.rb +0 -7
- data/lib/trophy_api_client/types/create_points_triggers_response.rb +0 -74
- data/lib/trophy_api_client/types/create_streak_freezes_response.rb +0 -60
- data/lib/trophy_api_client/types/create_tenant_request_item.rb +0 -66
- data/lib/trophy_api_client/types/create_tenants_request.rb +0 -7
- data/lib/trophy_api_client/types/create_tenants_response.rb +0 -74
- data/lib/trophy_api_client/types/created_admin_points_system.rb +0 -163
- data/lib/trophy_api_client/types/created_metric.rb +0 -88
- data/lib/trophy_api_client/types/created_metric_unit_type.rb +0 -9
- data/lib/trophy_api_client/types/delete_attributes_response.rb +0 -75
- data/lib/trophy_api_client/types/delete_leaderboards_response.rb +0 -75
- data/lib/trophy_api_client/types/delete_metrics_response.rb +0 -75
- data/lib/trophy_api_client/types/delete_points_boosts_response.rb +0 -74
- data/lib/trophy_api_client/types/delete_points_levels_response.rb +0 -74
- data/lib/trophy_api_client/types/delete_points_systems_response.rb +0 -74
- data/lib/trophy_api_client/types/delete_points_triggers_response.rb +0 -75
- data/lib/trophy_api_client/types/delete_tenants_response.rb +0 -74
- data/lib/trophy_api_client/types/deleted_resource.rb +0 -56
- data/lib/trophy_api_client/types/error_body.rb +0 -55
- data/lib/trophy_api_client/types/event_response.rb +0 -147
- data/lib/trophy_api_client/types/get_user_points_response.rb +0 -139
- data/lib/trophy_api_client/types/leaderboard_event.rb +0 -110
- data/lib/trophy_api_client/types/leaderboard_ranking.rb +0 -82
- data/lib/trophy_api_client/types/leaderboard_response.rb +0 -192
- data/lib/trophy_api_client/types/leaderboard_response_rank_by.rb +0 -10
- data/lib/trophy_api_client/types/leaderboard_response_run_unit.rb +0 -11
- data/lib/trophy_api_client/types/leaderboard_response_with_rankings.rb +0 -212
- data/lib/trophy_api_client/types/leaderboard_response_with_rankings_status.rb +0 -10
- data/lib/trophy_api_client/types/list_attributes_response.rb +0 -7
- data/lib/trophy_api_client/types/list_leaderboards_response.rb +0 -7
- data/lib/trophy_api_client/types/list_metrics_response.rb +0 -7
- data/lib/trophy_api_client/types/list_points_boosts_response.rb +0 -7
- data/lib/trophy_api_client/types/list_points_levels_response.rb +0 -7
- data/lib/trophy_api_client/types/list_points_systems_response.rb +0 -7
- data/lib/trophy_api_client/types/list_points_triggers_response.rb +0 -7
- data/lib/trophy_api_client/types/list_tenants_response.rb +0 -7
- data/lib/trophy_api_client/types/metric_event_leaderboard_response.rb +0 -245
- data/lib/trophy_api_client/types/metric_event_leaderboard_response_breakdown_attribute_values_item.rb +0 -67
- data/lib/trophy_api_client/types/metric_event_points_response.rb +0 -148
- data/lib/trophy_api_client/types/metric_event_streak_response.rb +0 -153
- data/lib/trophy_api_client/types/metric_response.rb +0 -90
- data/lib/trophy_api_client/types/notification_channel.rb +0 -9
- data/lib/trophy_api_client/types/notification_preferences.rb +0 -89
- data/lib/trophy_api_client/types/patch_points_boosts_request.rb +0 -7
- data/lib/trophy_api_client/types/patch_points_boosts_request_item.rb +0 -118
- data/lib/trophy_api_client/types/patch_points_boosts_request_item_rounding.rb +0 -10
- data/lib/trophy_api_client/types/patch_points_boosts_request_item_user_attributes_item.rb +0 -67
- data/lib/trophy_api_client/types/patch_points_boosts_response.rb +0 -74
- data/lib/trophy_api_client/types/patch_points_levels_request.rb +0 -7
- data/lib/trophy_api_client/types/patch_points_levels_request_item.rb +0 -100
- data/lib/trophy_api_client/types/patch_points_levels_request_item_badge.rb +0 -55
- data/lib/trophy_api_client/types/patch_points_levels_response.rb +0 -74
- data/lib/trophy_api_client/types/patch_points_triggers_request.rb +0 -7
- data/lib/trophy_api_client/types/patch_points_triggers_request_item.rb +0 -174
- data/lib/trophy_api_client/types/patch_points_triggers_request_item_event_attributes_item.rb +0 -67
- data/lib/trophy_api_client/types/patch_points_triggers_request_item_status.rb +0 -9
- data/lib/trophy_api_client/types/patch_points_triggers_request_item_time_unit.rb +0 -9
- data/lib/trophy_api_client/types/patch_points_triggers_request_item_type.rb +0 -13
- data/lib/trophy_api_client/types/patch_points_triggers_request_item_user_attributes_item.rb +0 -67
- data/lib/trophy_api_client/types/patch_points_triggers_response.rb +0 -74
- data/lib/trophy_api_client/types/points_award.rb +0 -113
- data/lib/trophy_api_client/types/points_boost.rb +0 -112
- data/lib/trophy_api_client/types/points_boost_rounding.rb +0 -10
- data/lib/trophy_api_client/types/points_boost_status.rb +0 -10
- data/lib/trophy_api_client/types/points_boost_webhook_payload.rb +0 -149
- data/lib/trophy_api_client/types/points_boost_webhook_payload_rounding.rb +0 -10
- data/lib/trophy_api_client/types/points_boost_webhook_payload_status.rb +0 -9
- data/lib/trophy_api_client/types/points_level.rb +0 -103
- data/lib/trophy_api_client/types/points_level_summary_response.rb +0 -7
- data/lib/trophy_api_client/types/points_level_summary_response_item.rb +0 -71
- data/lib/trophy_api_client/types/points_range.rb +0 -72
- data/lib/trophy_api_client/types/points_response.rb +0 -103
- data/lib/trophy_api_client/types/points_summary_response.rb +0 -7
- data/lib/trophy_api_client/types/points_system_response.rb +0 -107
- data/lib/trophy_api_client/types/points_trigger.rb +0 -227
- data/lib/trophy_api_client/types/points_trigger_event_attribute.rb +0 -67
- data/lib/trophy_api_client/types/points_trigger_event_attributes_item.rb +0 -65
- data/lib/trophy_api_client/types/points_trigger_status.rb +0 -10
- data/lib/trophy_api_client/types/points_trigger_time_unit.rb +0 -9
- data/lib/trophy_api_client/types/points_trigger_type.rb +0 -12
- data/lib/trophy_api_client/types/points_trigger_user_attributes_item.rb +0 -65
- data/lib/trophy_api_client/types/restore_streaks_response.rb +0 -70
- data/lib/trophy_api_client/types/streak_evaluation_mode_preference.rb +0 -11
- data/lib/trophy_api_client/types/streak_frequency.rb +0 -9
- data/lib/trophy_api_client/types/streak_metric_preference.rb +0 -66
- data/lib/trophy_api_client/types/streak_preferences.rb +0 -83
- data/lib/trophy_api_client/types/streak_response.rb +0 -170
- data/lib/trophy_api_client/types/streak_response_streak_history_item.rb +0 -89
- data/lib/trophy_api_client/types/update_attribute_request_item.rb +0 -69
- data/lib/trophy_api_client/types/update_attributes_request.rb +0 -7
- data/lib/trophy_api_client/types/update_attributes_response.rb +0 -75
- data/lib/trophy_api_client/types/update_leaderboard_request_item.rb +0 -179
- data/lib/trophy_api_client/types/update_leaderboard_request_item_rank_by.rb +0 -11
- data/lib/trophy_api_client/types/update_leaderboard_request_item_run_unit.rb +0 -9
- data/lib/trophy_api_client/types/update_leaderboard_request_item_status.rb +0 -12
- data/lib/trophy_api_client/types/update_leaderboards_request.rb +0 -7
- data/lib/trophy_api_client/types/update_leaderboards_response.rb +0 -75
- data/lib/trophy_api_client/types/update_metric_request_item.rb +0 -86
- data/lib/trophy_api_client/types/update_metric_request_item_unit_type.rb +0 -9
- data/lib/trophy_api_client/types/update_metrics_request.rb +0 -7
- data/lib/trophy_api_client/types/update_metrics_response.rb +0 -75
- data/lib/trophy_api_client/types/update_points_system_request_item.rb +0 -102
- data/lib/trophy_api_client/types/update_points_system_request_item_badge.rb +0 -55
- data/lib/trophy_api_client/types/update_points_systems_request.rb +0 -7
- data/lib/trophy_api_client/types/update_points_systems_response.rb +0 -74
- data/lib/trophy_api_client/types/update_tenant_request_item.rb +0 -75
- data/lib/trophy_api_client/types/update_tenants_request.rb +0 -7
- data/lib/trophy_api_client/types/update_tenants_response.rb +0 -74
- data/lib/trophy_api_client/types/updated_user.rb +0 -108
- data/lib/trophy_api_client/types/upserted_user.rb +0 -116
- data/lib/trophy_api_client/types/user.rb +0 -141
- data/lib/trophy_api_client/types/user_achievement_response.rb +0 -209
- data/lib/trophy_api_client/types/user_achievement_with_stats_response.rb +0 -225
- data/lib/trophy_api_client/types/user_leaderboard_response.rb +0 -212
- data/lib/trophy_api_client/types/user_leaderboard_response_with_history.rb +0 -224
- data/lib/trophy_api_client/types/user_preferences_response.rb +0 -80
- data/lib/trophy_api_client/types/webhook_user_leaderboard_response.rb +0 -228
- data/lib/trophy_api_client/types/webhooks_achievement_completed_payload.rb +0 -84
- data/lib/trophy_api_client/types/webhooks_leaderboard_changed_payload.rb +0 -71
- data/lib/trophy_api_client/types/webhooks_leaderboard_finished_payload.rb +0 -71
- data/lib/trophy_api_client/types/webhooks_leaderboard_rank_changed_payload.rb +0 -85
- data/lib/trophy_api_client/types/webhooks_leaderboard_started_payload.rb +0 -71
- data/lib/trophy_api_client/types/webhooks_points_boost_finished_payload.rb +0 -79
- data/lib/trophy_api_client/types/webhooks_points_boost_started_payload.rb +0 -79
- data/lib/trophy_api_client/types/webhooks_points_changed_payload.rb +0 -84
- data/lib/trophy_api_client/types/webhooks_points_level_changed_payload.rb +0 -117
- data/lib/trophy_api_client/types/webhooks_points_level_changed_payload_points.rb +0 -114
- data/lib/trophy_api_client/types/webhooks_streak_extended_payload.rb +0 -84
- data/lib/trophy_api_client/types/webhooks_streak_freeze_consumed_payload.rb +0 -85
- data/lib/trophy_api_client/types/webhooks_streak_freeze_earned_payload.rb +0 -85
- data/lib/trophy_api_client/types/webhooks_streak_lost_payload.rb +0 -78
- data/lib/trophy_api_client/types/webhooks_streak_started_payload.rb +0 -84
- data/lib/trophy_api_client/types/wrapped_activity.rb +0 -134
- data/lib/trophy_api_client/types/wrapped_activity_period.rb +0 -95
- data/lib/trophy_api_client/types/wrapped_entire_year.rb +0 -114
- data/lib/trophy_api_client/types/wrapped_metric.rb +0 -119
- data/lib/trophy_api_client/types/wrapped_metric_by_attribute_value_value.rb +0 -103
- data/lib/trophy_api_client/types/wrapped_most_active_day.rb +0 -108
- data/lib/trophy_api_client/types/wrapped_most_active_month.rb +0 -108
- data/lib/trophy_api_client/types/wrapped_most_active_week.rb +0 -116
- data/lib/trophy_api_client/types/wrapped_points.rb +0 -106
- data/lib/trophy_api_client/types/wrapped_response.rb +0 -79
- data/lib/trophy_api_client/types/wrapped_streak.rb +0 -96
- data/lib/trophy_api_client/users/client.rb +0 -1356
- data/lib/trophy_api_client/users/types/users_metric_event_summary_response_item.rb +0 -76
- data/lib/trophy_api_client/users/types/users_points_event_summary_response_item.rb +0 -76
- data/lib/trophy_api_client/version.rb +0 -3
- data/lib/types_export.rb +0 -221
|
@@ -1,110 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
require "date"
|
|
4
|
-
require "ostruct"
|
|
5
|
-
require "json"
|
|
6
|
-
|
|
7
|
-
module TrophyApiClient
|
|
8
|
-
# A daily leaderboard snapshot entry representing the user's rank/value state and
|
|
9
|
-
# the previous persisted state.
|
|
10
|
-
class LeaderboardEvent
|
|
11
|
-
# @return [String] The leaderboard snapshot date in YYYY-MM-DD format.
|
|
12
|
-
attr_reader :date
|
|
13
|
-
# @return [DateTime] Deprecated ISO timestamp for the snapshot day boundary. Use `date` instead.
|
|
14
|
-
attr_reader :timestamp
|
|
15
|
-
# @return [Integer] The user's rank before this event, or null if they were not on the leaderboard.
|
|
16
|
-
attr_reader :previous_rank
|
|
17
|
-
# @return [Integer] The user's rank after this event, or null if they are no longer on the
|
|
18
|
-
# leaderboard.
|
|
19
|
-
attr_reader :rank
|
|
20
|
-
# @return [Integer] The user's value before this event, or null if they were not on the leaderboard.
|
|
21
|
-
attr_reader :previous_value
|
|
22
|
-
# @return [Integer] The user's value after this event, or null if they are no longer on the
|
|
23
|
-
# leaderboard.
|
|
24
|
-
attr_reader :value
|
|
25
|
-
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
|
26
|
-
attr_reader :additional_properties
|
|
27
|
-
# @return [Object]
|
|
28
|
-
attr_reader :_field_set
|
|
29
|
-
protected :_field_set
|
|
30
|
-
|
|
31
|
-
OMIT = Object.new
|
|
32
|
-
|
|
33
|
-
# @param date [String] The leaderboard snapshot date in YYYY-MM-DD format.
|
|
34
|
-
# @param timestamp [DateTime] Deprecated ISO timestamp for the snapshot day boundary. Use `date` instead.
|
|
35
|
-
# @param previous_rank [Integer] The user's rank before this event, or null if they were not on the leaderboard.
|
|
36
|
-
# @param rank [Integer] The user's rank after this event, or null if they are no longer on the
|
|
37
|
-
# leaderboard.
|
|
38
|
-
# @param previous_value [Integer] The user's value before this event, or null if they were not on the leaderboard.
|
|
39
|
-
# @param value [Integer] The user's value after this event, or null if they are no longer on the
|
|
40
|
-
# leaderboard.
|
|
41
|
-
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
|
42
|
-
# @return [TrophyApiClient::LeaderboardEvent]
|
|
43
|
-
def initialize(date:, timestamp:, previous_rank: OMIT, rank: OMIT, previous_value: OMIT, value: OMIT,
|
|
44
|
-
additional_properties: nil)
|
|
45
|
-
@date = date
|
|
46
|
-
@timestamp = timestamp
|
|
47
|
-
@previous_rank = previous_rank if previous_rank != OMIT
|
|
48
|
-
@rank = rank if rank != OMIT
|
|
49
|
-
@previous_value = previous_value if previous_value != OMIT
|
|
50
|
-
@value = value if value != OMIT
|
|
51
|
-
@additional_properties = additional_properties
|
|
52
|
-
@_field_set = {
|
|
53
|
-
"date": date,
|
|
54
|
-
"timestamp": timestamp,
|
|
55
|
-
"previousRank": previous_rank,
|
|
56
|
-
"rank": rank,
|
|
57
|
-
"previousValue": previous_value,
|
|
58
|
-
"value": value
|
|
59
|
-
}.reject do |_k, v|
|
|
60
|
-
v == OMIT
|
|
61
|
-
end
|
|
62
|
-
end
|
|
63
|
-
|
|
64
|
-
# Deserialize a JSON object to an instance of LeaderboardEvent
|
|
65
|
-
#
|
|
66
|
-
# @param json_object [String]
|
|
67
|
-
# @return [TrophyApiClient::LeaderboardEvent]
|
|
68
|
-
def self.from_json(json_object:)
|
|
69
|
-
struct = JSON.parse(json_object, object_class: OpenStruct)
|
|
70
|
-
parsed_json = JSON.parse(json_object)
|
|
71
|
-
date = parsed_json["date"]
|
|
72
|
-
timestamp = (DateTime.parse(parsed_json["timestamp"]) unless parsed_json["timestamp"].nil?)
|
|
73
|
-
previous_rank = parsed_json["previousRank"]
|
|
74
|
-
rank = parsed_json["rank"]
|
|
75
|
-
previous_value = parsed_json["previousValue"]
|
|
76
|
-
value = parsed_json["value"]
|
|
77
|
-
new(
|
|
78
|
-
date: date,
|
|
79
|
-
timestamp: timestamp,
|
|
80
|
-
previous_rank: previous_rank,
|
|
81
|
-
rank: rank,
|
|
82
|
-
previous_value: previous_value,
|
|
83
|
-
value: value,
|
|
84
|
-
additional_properties: struct
|
|
85
|
-
)
|
|
86
|
-
end
|
|
87
|
-
|
|
88
|
-
# Serialize an instance of LeaderboardEvent to a JSON object
|
|
89
|
-
#
|
|
90
|
-
# @return [String]
|
|
91
|
-
def to_json(*_args)
|
|
92
|
-
@_field_set&.to_json
|
|
93
|
-
end
|
|
94
|
-
|
|
95
|
-
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
|
96
|
-
# hash and check each fields type against the current object's property
|
|
97
|
-
# definitions.
|
|
98
|
-
#
|
|
99
|
-
# @param obj [Object]
|
|
100
|
-
# @return [Void]
|
|
101
|
-
def self.validate_raw(obj:)
|
|
102
|
-
obj.date.is_a?(String) != false || raise("Passed value for field obj.date is not the expected type, validation failed.")
|
|
103
|
-
obj.timestamp.is_a?(DateTime) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
|
|
104
|
-
obj.previous_rank&.is_a?(Integer) != false || raise("Passed value for field obj.previous_rank is not the expected type, validation failed.")
|
|
105
|
-
obj.rank&.is_a?(Integer) != false || raise("Passed value for field obj.rank is not the expected type, validation failed.")
|
|
106
|
-
obj.previous_value&.is_a?(Integer) != false || raise("Passed value for field obj.previous_value is not the expected type, validation failed.")
|
|
107
|
-
obj.value&.is_a?(Integer) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
|
|
108
|
-
end
|
|
109
|
-
end
|
|
110
|
-
end
|
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
require "ostruct"
|
|
4
|
-
require "json"
|
|
5
|
-
|
|
6
|
-
module TrophyApiClient
|
|
7
|
-
# A user's ranking in a leaderboard.
|
|
8
|
-
class LeaderboardRanking
|
|
9
|
-
# @return [String] The ID of the user.
|
|
10
|
-
attr_reader :user_id
|
|
11
|
-
# @return [String] The name of the user. May be null if no name is set.
|
|
12
|
-
attr_reader :user_name
|
|
13
|
-
# @return [Integer] The user's rank in the leaderboard.
|
|
14
|
-
attr_reader :rank
|
|
15
|
-
# @return [Integer] The user's value for this leaderboard (points, metric value, etc.).
|
|
16
|
-
attr_reader :value
|
|
17
|
-
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
|
18
|
-
attr_reader :additional_properties
|
|
19
|
-
# @return [Object]
|
|
20
|
-
attr_reader :_field_set
|
|
21
|
-
protected :_field_set
|
|
22
|
-
|
|
23
|
-
OMIT = Object.new
|
|
24
|
-
|
|
25
|
-
# @param user_id [String] The ID of the user.
|
|
26
|
-
# @param user_name [String] The name of the user. May be null if no name is set.
|
|
27
|
-
# @param rank [Integer] The user's rank in the leaderboard.
|
|
28
|
-
# @param value [Integer] The user's value for this leaderboard (points, metric value, etc.).
|
|
29
|
-
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
|
30
|
-
# @return [TrophyApiClient::LeaderboardRanking]
|
|
31
|
-
def initialize(user_id:, rank:, value:, user_name: OMIT, additional_properties: nil)
|
|
32
|
-
@user_id = user_id
|
|
33
|
-
@user_name = user_name if user_name != OMIT
|
|
34
|
-
@rank = rank
|
|
35
|
-
@value = value
|
|
36
|
-
@additional_properties = additional_properties
|
|
37
|
-
@_field_set = { "userId": user_id, "userName": user_name, "rank": rank, "value": value }.reject do |_k, v|
|
|
38
|
-
v == OMIT
|
|
39
|
-
end
|
|
40
|
-
end
|
|
41
|
-
|
|
42
|
-
# Deserialize a JSON object to an instance of LeaderboardRanking
|
|
43
|
-
#
|
|
44
|
-
# @param json_object [String]
|
|
45
|
-
# @return [TrophyApiClient::LeaderboardRanking]
|
|
46
|
-
def self.from_json(json_object:)
|
|
47
|
-
struct = JSON.parse(json_object, object_class: OpenStruct)
|
|
48
|
-
parsed_json = JSON.parse(json_object)
|
|
49
|
-
user_id = parsed_json["userId"]
|
|
50
|
-
user_name = parsed_json["userName"]
|
|
51
|
-
rank = parsed_json["rank"]
|
|
52
|
-
value = parsed_json["value"]
|
|
53
|
-
new(
|
|
54
|
-
user_id: user_id,
|
|
55
|
-
user_name: user_name,
|
|
56
|
-
rank: rank,
|
|
57
|
-
value: value,
|
|
58
|
-
additional_properties: struct
|
|
59
|
-
)
|
|
60
|
-
end
|
|
61
|
-
|
|
62
|
-
# Serialize an instance of LeaderboardRanking to a JSON object
|
|
63
|
-
#
|
|
64
|
-
# @return [String]
|
|
65
|
-
def to_json(*_args)
|
|
66
|
-
@_field_set&.to_json
|
|
67
|
-
end
|
|
68
|
-
|
|
69
|
-
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
|
70
|
-
# hash and check each fields type against the current object's property
|
|
71
|
-
# definitions.
|
|
72
|
-
#
|
|
73
|
-
# @param obj [Object]
|
|
74
|
-
# @return [Void]
|
|
75
|
-
def self.validate_raw(obj:)
|
|
76
|
-
obj.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
|
|
77
|
-
obj.user_name&.is_a?(String) != false || raise("Passed value for field obj.user_name is not the expected type, validation failed.")
|
|
78
|
-
obj.rank.is_a?(Integer) != false || raise("Passed value for field obj.rank is not the expected type, validation failed.")
|
|
79
|
-
obj.value.is_a?(Integer) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
|
|
80
|
-
end
|
|
81
|
-
end
|
|
82
|
-
end
|
|
@@ -1,192 +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 leaderboard with its configuration details.
|
|
10
|
-
class LeaderboardResponse
|
|
11
|
-
# @return [String] The unique ID of the leaderboard.
|
|
12
|
-
attr_reader :id
|
|
13
|
-
# @return [String] The user-facing name of the leaderboard.
|
|
14
|
-
attr_reader :name
|
|
15
|
-
# @return [String] The unique key used to reference the leaderboard in APIs.
|
|
16
|
-
attr_reader :key
|
|
17
|
-
# @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
|
|
18
|
-
attr_reader :rank_by
|
|
19
|
-
# @return [String] Deprecated. The key of the attribute to break down this leaderboard by.
|
|
20
|
-
attr_reader :breakdown_attribute
|
|
21
|
-
# @return [Array<String>] The user attribute keys that this leaderboard is broken down by.
|
|
22
|
-
attr_reader :breakdown_attributes
|
|
23
|
-
# @return [String] The key of the metric to rank by, if rankBy is 'metric'.
|
|
24
|
-
attr_reader :metric_key
|
|
25
|
-
# @return [String] The name of the metric to rank by, if rankBy is 'metric'.
|
|
26
|
-
attr_reader :metric_name
|
|
27
|
-
# @return [String] The key of the points system to rank by, if rankBy is 'points'.
|
|
28
|
-
attr_reader :points_system_key
|
|
29
|
-
# @return [String] The name of the points system to rank by, if rankBy is 'points'.
|
|
30
|
-
attr_reader :points_system_name
|
|
31
|
-
# @return [String] The user-facing description of the leaderboard.
|
|
32
|
-
attr_reader :description
|
|
33
|
-
# @return [String] The start date of the leaderboard in YYYY-MM-DD format.
|
|
34
|
-
attr_reader :start
|
|
35
|
-
# @return [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
|
|
36
|
-
# forever.
|
|
37
|
-
attr_reader :end_
|
|
38
|
-
# @return [Integer] The maximum number of participants in the leaderboard.
|
|
39
|
-
attr_reader :max_participants
|
|
40
|
-
# @return [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
|
|
41
|
-
# leaderboards.
|
|
42
|
-
attr_reader :run_unit
|
|
43
|
-
# @return [Integer] The interval between repetitions, relative to the start date and repetition
|
|
44
|
-
# type. Null for one-time leaderboards.
|
|
45
|
-
attr_reader :run_interval
|
|
46
|
-
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
|
47
|
-
attr_reader :additional_properties
|
|
48
|
-
# @return [Object]
|
|
49
|
-
attr_reader :_field_set
|
|
50
|
-
protected :_field_set
|
|
51
|
-
|
|
52
|
-
OMIT = Object.new
|
|
53
|
-
|
|
54
|
-
# @param id [String] The unique ID of the leaderboard.
|
|
55
|
-
# @param name [String] The user-facing name of the leaderboard.
|
|
56
|
-
# @param key [String] The unique key used to reference the leaderboard in APIs.
|
|
57
|
-
# @param rank_by [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
|
|
58
|
-
# @param breakdown_attribute [String] Deprecated. The key of the attribute to break down this leaderboard by.
|
|
59
|
-
# @param breakdown_attributes [Array<String>] The user attribute keys that this leaderboard is broken down by.
|
|
60
|
-
# @param metric_key [String] The key of the metric to rank by, if rankBy is 'metric'.
|
|
61
|
-
# @param metric_name [String] The name of the metric to rank by, if rankBy is 'metric'.
|
|
62
|
-
# @param points_system_key [String] The key of the points system to rank by, if rankBy is 'points'.
|
|
63
|
-
# @param points_system_name [String] The name of the points system to rank by, if rankBy is 'points'.
|
|
64
|
-
# @param description [String] The user-facing description of the leaderboard.
|
|
65
|
-
# @param start [String] The start date of the leaderboard in YYYY-MM-DD format.
|
|
66
|
-
# @param end_ [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
|
|
67
|
-
# forever.
|
|
68
|
-
# @param max_participants [Integer] The maximum number of participants in the leaderboard.
|
|
69
|
-
# @param run_unit [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
|
|
70
|
-
# leaderboards.
|
|
71
|
-
# @param run_interval [Integer] The interval between repetitions, relative to the start date and repetition
|
|
72
|
-
# type. Null for one-time leaderboards.
|
|
73
|
-
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
|
74
|
-
# @return [TrophyApiClient::LeaderboardResponse]
|
|
75
|
-
def initialize(id:, name:, key:, rank_by:, breakdown_attributes:, start:, breakdown_attribute: OMIT, metric_key: OMIT,
|
|
76
|
-
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)
|
|
77
|
-
@id = id
|
|
78
|
-
@name = name
|
|
79
|
-
@key = key
|
|
80
|
-
@rank_by = rank_by
|
|
81
|
-
@breakdown_attribute = breakdown_attribute if breakdown_attribute != OMIT
|
|
82
|
-
@breakdown_attributes = breakdown_attributes
|
|
83
|
-
@metric_key = metric_key if metric_key != OMIT
|
|
84
|
-
@metric_name = metric_name if metric_name != OMIT
|
|
85
|
-
@points_system_key = points_system_key if points_system_key != OMIT
|
|
86
|
-
@points_system_name = points_system_name if points_system_name != OMIT
|
|
87
|
-
@description = description if description != OMIT
|
|
88
|
-
@start = start
|
|
89
|
-
@end_ = end_ if end_ != OMIT
|
|
90
|
-
@max_participants = max_participants if max_participants != OMIT
|
|
91
|
-
@run_unit = run_unit if run_unit != OMIT
|
|
92
|
-
@run_interval = run_interval if run_interval != OMIT
|
|
93
|
-
@additional_properties = additional_properties
|
|
94
|
-
@_field_set = {
|
|
95
|
-
"id": id,
|
|
96
|
-
"name": name,
|
|
97
|
-
"key": key,
|
|
98
|
-
"rankBy": rank_by,
|
|
99
|
-
"breakdownAttribute": breakdown_attribute,
|
|
100
|
-
"breakdownAttributes": breakdown_attributes,
|
|
101
|
-
"metricKey": metric_key,
|
|
102
|
-
"metricName": metric_name,
|
|
103
|
-
"pointsSystemKey": points_system_key,
|
|
104
|
-
"pointsSystemName": points_system_name,
|
|
105
|
-
"description": description,
|
|
106
|
-
"start": start,
|
|
107
|
-
"end": end_,
|
|
108
|
-
"maxParticipants": max_participants,
|
|
109
|
-
"runUnit": run_unit,
|
|
110
|
-
"runInterval": run_interval
|
|
111
|
-
}.reject do |_k, v|
|
|
112
|
-
v == OMIT
|
|
113
|
-
end
|
|
114
|
-
end
|
|
115
|
-
|
|
116
|
-
# Deserialize a JSON object to an instance of LeaderboardResponse
|
|
117
|
-
#
|
|
118
|
-
# @param json_object [String]
|
|
119
|
-
# @return [TrophyApiClient::LeaderboardResponse]
|
|
120
|
-
def self.from_json(json_object:)
|
|
121
|
-
struct = JSON.parse(json_object, object_class: OpenStruct)
|
|
122
|
-
parsed_json = JSON.parse(json_object)
|
|
123
|
-
id = parsed_json["id"]
|
|
124
|
-
name = parsed_json["name"]
|
|
125
|
-
key = parsed_json["key"]
|
|
126
|
-
rank_by = parsed_json["rankBy"]
|
|
127
|
-
breakdown_attribute = parsed_json["breakdownAttribute"]
|
|
128
|
-
breakdown_attributes = parsed_json["breakdownAttributes"]
|
|
129
|
-
metric_key = parsed_json["metricKey"]
|
|
130
|
-
metric_name = parsed_json["metricName"]
|
|
131
|
-
points_system_key = parsed_json["pointsSystemKey"]
|
|
132
|
-
points_system_name = parsed_json["pointsSystemName"]
|
|
133
|
-
description = parsed_json["description"]
|
|
134
|
-
start = parsed_json["start"]
|
|
135
|
-
end_ = parsed_json["end"]
|
|
136
|
-
max_participants = parsed_json["maxParticipants"]
|
|
137
|
-
run_unit = parsed_json["runUnit"]
|
|
138
|
-
run_interval = parsed_json["runInterval"]
|
|
139
|
-
new(
|
|
140
|
-
id: id,
|
|
141
|
-
name: name,
|
|
142
|
-
key: key,
|
|
143
|
-
rank_by: rank_by,
|
|
144
|
-
breakdown_attribute: breakdown_attribute,
|
|
145
|
-
breakdown_attributes: breakdown_attributes,
|
|
146
|
-
metric_key: metric_key,
|
|
147
|
-
metric_name: metric_name,
|
|
148
|
-
points_system_key: points_system_key,
|
|
149
|
-
points_system_name: points_system_name,
|
|
150
|
-
description: description,
|
|
151
|
-
start: start,
|
|
152
|
-
end_: end_,
|
|
153
|
-
max_participants: max_participants,
|
|
154
|
-
run_unit: run_unit,
|
|
155
|
-
run_interval: run_interval,
|
|
156
|
-
additional_properties: struct
|
|
157
|
-
)
|
|
158
|
-
end
|
|
159
|
-
|
|
160
|
-
# Serialize an instance of LeaderboardResponse to a JSON object
|
|
161
|
-
#
|
|
162
|
-
# @return [String]
|
|
163
|
-
def to_json(*_args)
|
|
164
|
-
@_field_set&.to_json
|
|
165
|
-
end
|
|
166
|
-
|
|
167
|
-
# Leveraged for Union-type generation, validate_raw attempts to parse the given
|
|
168
|
-
# hash and check each fields type against the current object's property
|
|
169
|
-
# definitions.
|
|
170
|
-
#
|
|
171
|
-
# @param obj [Object]
|
|
172
|
-
# @return [Void]
|
|
173
|
-
def self.validate_raw(obj:)
|
|
174
|
-
obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
|
|
175
|
-
obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
|
|
176
|
-
obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
|
|
177
|
-
obj.rank_by.is_a?(TrophyApiClient::LeaderboardResponseRankBy) != false || raise("Passed value for field obj.rank_by is not the expected type, validation failed.")
|
|
178
|
-
obj.breakdown_attribute&.is_a?(String) != false || raise("Passed value for field obj.breakdown_attribute is not the expected type, validation failed.")
|
|
179
|
-
obj.breakdown_attributes.is_a?(Array) != false || raise("Passed value for field obj.breakdown_attributes is not the expected type, validation failed.")
|
|
180
|
-
obj.metric_key&.is_a?(String) != false || raise("Passed value for field obj.metric_key is not the expected type, validation failed.")
|
|
181
|
-
obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
|
|
182
|
-
obj.points_system_key&.is_a?(String) != false || raise("Passed value for field obj.points_system_key is not the expected type, validation failed.")
|
|
183
|
-
obj.points_system_name&.is_a?(String) != false || raise("Passed value for field obj.points_system_name is not the expected type, validation failed.")
|
|
184
|
-
obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
|
|
185
|
-
obj.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
|
|
186
|
-
obj.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
|
|
187
|
-
obj.max_participants&.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
|
|
188
|
-
obj.run_unit&.is_a?(TrophyApiClient::LeaderboardResponseRunUnit) != false || raise("Passed value for field obj.run_unit is not the expected type, validation failed.")
|
|
189
|
-
obj.run_interval&.is_a?(Integer) != false || raise("Passed value for field obj.run_interval is not the expected type, validation failed.")
|
|
190
|
-
end
|
|
191
|
-
end
|
|
192
|
-
end
|
|
@@ -1,212 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
require_relative "leaderboard_response_with_rankings_status"
|
|
4
|
-
require_relative "leaderboard_ranking"
|
|
5
|
-
require_relative "leaderboard_response_rank_by"
|
|
6
|
-
require_relative "leaderboard_response_run_unit"
|
|
7
|
-
require "ostruct"
|
|
8
|
-
require "json"
|
|
9
|
-
|
|
10
|
-
module TrophyApiClient
|
|
11
|
-
class LeaderboardResponseWithRankings
|
|
12
|
-
# @return [TrophyApiClient::LeaderboardResponseWithRankingsStatus] The status of the leaderboard.
|
|
13
|
-
attr_reader :status
|
|
14
|
-
# @return [Array<TrophyApiClient::LeaderboardRanking>] Array of user rankings for the leaderboard.
|
|
15
|
-
attr_reader :rankings
|
|
16
|
-
# @return [String] The unique ID of the leaderboard.
|
|
17
|
-
attr_reader :id
|
|
18
|
-
# @return [String] The user-facing name of the leaderboard.
|
|
19
|
-
attr_reader :name
|
|
20
|
-
# @return [String] The unique key used to reference the leaderboard in APIs.
|
|
21
|
-
attr_reader :key
|
|
22
|
-
# @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
|
|
23
|
-
attr_reader :rank_by
|
|
24
|
-
# @return [String] Deprecated. The key of the attribute to break down this leaderboard by.
|
|
25
|
-
attr_reader :breakdown_attribute
|
|
26
|
-
# @return [Array<String>] The user attribute keys that this leaderboard is broken down by.
|
|
27
|
-
attr_reader :breakdown_attributes
|
|
28
|
-
# @return [String] The key of the metric to rank by, if rankBy is 'metric'.
|
|
29
|
-
attr_reader :metric_key
|
|
30
|
-
# @return [String] The name of the metric to rank by, if rankBy is 'metric'.
|
|
31
|
-
attr_reader :metric_name
|
|
32
|
-
# @return [String] The key of the points system to rank by, if rankBy is 'points'.
|
|
33
|
-
attr_reader :points_system_key
|
|
34
|
-
# @return [String] The name of the points system to rank by, if rankBy is 'points'.
|
|
35
|
-
attr_reader :points_system_name
|
|
36
|
-
# @return [String] The user-facing description of the leaderboard.
|
|
37
|
-
attr_reader :description
|
|
38
|
-
# @return [String] The start date of the leaderboard in YYYY-MM-DD format.
|
|
39
|
-
attr_reader :start
|
|
40
|
-
# @return [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
|
|
41
|
-
# forever.
|
|
42
|
-
attr_reader :end_
|
|
43
|
-
# @return [Integer] The maximum number of participants in the leaderboard.
|
|
44
|
-
attr_reader :max_participants
|
|
45
|
-
# @return [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
|
|
46
|
-
# leaderboards.
|
|
47
|
-
attr_reader :run_unit
|
|
48
|
-
# @return [Integer] The interval between repetitions, relative to the start date and repetition
|
|
49
|
-
# type. Null for one-time leaderboards.
|
|
50
|
-
attr_reader :run_interval
|
|
51
|
-
# @return [OpenStruct] Additional properties unmapped to the current class definition
|
|
52
|
-
attr_reader :additional_properties
|
|
53
|
-
# @return [Object]
|
|
54
|
-
attr_reader :_field_set
|
|
55
|
-
protected :_field_set
|
|
56
|
-
|
|
57
|
-
OMIT = Object.new
|
|
58
|
-
|
|
59
|
-
# @param status [TrophyApiClient::LeaderboardResponseWithRankingsStatus] The status of the leaderboard.
|
|
60
|
-
# @param rankings [Array<TrophyApiClient::LeaderboardRanking>] Array of user rankings for the leaderboard.
|
|
61
|
-
# @param id [String] The unique ID of the leaderboard.
|
|
62
|
-
# @param name [String] The user-facing name of the leaderboard.
|
|
63
|
-
# @param key [String] The unique key used to reference the leaderboard in APIs.
|
|
64
|
-
# @param rank_by [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
|
|
65
|
-
# @param breakdown_attribute [String] Deprecated. The key of the attribute to break down this leaderboard by.
|
|
66
|
-
# @param breakdown_attributes [Array<String>] The user attribute keys that this leaderboard is broken down by.
|
|
67
|
-
# @param metric_key [String] The key of the metric to rank by, if rankBy is 'metric'.
|
|
68
|
-
# @param metric_name [String] The name of the metric to rank by, if rankBy is 'metric'.
|
|
69
|
-
# @param points_system_key [String] The key of the points system to rank by, if rankBy is 'points'.
|
|
70
|
-
# @param points_system_name [String] The name of the points system to rank by, if rankBy is 'points'.
|
|
71
|
-
# @param description [String] The user-facing description of the leaderboard.
|
|
72
|
-
# @param start [String] The start date of the leaderboard in YYYY-MM-DD format.
|
|
73
|
-
# @param end_ [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
|
|
74
|
-
# forever.
|
|
75
|
-
# @param max_participants [Integer] The maximum number of participants in the leaderboard.
|
|
76
|
-
# @param run_unit [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
|
|
77
|
-
# leaderboards.
|
|
78
|
-
# @param run_interval [Integer] The interval between repetitions, relative to the start date and repetition
|
|
79
|
-
# type. Null for one-time leaderboards.
|
|
80
|
-
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
|
81
|
-
# @return [TrophyApiClient::LeaderboardResponseWithRankings]
|
|
82
|
-
def initialize(status:, rankings:, id:, name:, key:, rank_by:, breakdown_attributes:, start:, breakdown_attribute: OMIT,
|
|
83
|
-
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)
|
|
84
|
-
@status = status
|
|
85
|
-
@rankings = rankings
|
|
86
|
-
@id = id
|
|
87
|
-
@name = name
|
|
88
|
-
@key = key
|
|
89
|
-
@rank_by = rank_by
|
|
90
|
-
@breakdown_attribute = breakdown_attribute if breakdown_attribute != OMIT
|
|
91
|
-
@breakdown_attributes = breakdown_attributes
|
|
92
|
-
@metric_key = metric_key if metric_key != OMIT
|
|
93
|
-
@metric_name = metric_name if metric_name != OMIT
|
|
94
|
-
@points_system_key = points_system_key if points_system_key != OMIT
|
|
95
|
-
@points_system_name = points_system_name if points_system_name != OMIT
|
|
96
|
-
@description = description if description != OMIT
|
|
97
|
-
@start = start
|
|
98
|
-
@end_ = end_ if end_ != OMIT
|
|
99
|
-
@max_participants = max_participants if max_participants != OMIT
|
|
100
|
-
@run_unit = run_unit if run_unit != OMIT
|
|
101
|
-
@run_interval = run_interval if run_interval != OMIT
|
|
102
|
-
@additional_properties = additional_properties
|
|
103
|
-
@_field_set = {
|
|
104
|
-
"status": status,
|
|
105
|
-
"rankings": rankings,
|
|
106
|
-
"id": id,
|
|
107
|
-
"name": name,
|
|
108
|
-
"key": key,
|
|
109
|
-
"rankBy": rank_by,
|
|
110
|
-
"breakdownAttribute": breakdown_attribute,
|
|
111
|
-
"breakdownAttributes": breakdown_attributes,
|
|
112
|
-
"metricKey": metric_key,
|
|
113
|
-
"metricName": metric_name,
|
|
114
|
-
"pointsSystemKey": points_system_key,
|
|
115
|
-
"pointsSystemName": points_system_name,
|
|
116
|
-
"description": description,
|
|
117
|
-
"start": start,
|
|
118
|
-
"end": end_,
|
|
119
|
-
"maxParticipants": max_participants,
|
|
120
|
-
"runUnit": run_unit,
|
|
121
|
-
"runInterval": run_interval
|
|
122
|
-
}.reject do |_k, v|
|
|
123
|
-
v == OMIT
|
|
124
|
-
end
|
|
125
|
-
end
|
|
126
|
-
|
|
127
|
-
# Deserialize a JSON object to an instance of LeaderboardResponseWithRankings
|
|
128
|
-
#
|
|
129
|
-
# @param json_object [String]
|
|
130
|
-
# @return [TrophyApiClient::LeaderboardResponseWithRankings]
|
|
131
|
-
def self.from_json(json_object:)
|
|
132
|
-
struct = JSON.parse(json_object, object_class: OpenStruct)
|
|
133
|
-
parsed_json = JSON.parse(json_object)
|
|
134
|
-
status = parsed_json["status"]
|
|
135
|
-
rankings = parsed_json["rankings"]&.map do |item|
|
|
136
|
-
item = item.to_json
|
|
137
|
-
TrophyApiClient::LeaderboardRanking.from_json(json_object: item)
|
|
138
|
-
end
|
|
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
|
-
status: status,
|
|
157
|
-
rankings: rankings,
|
|
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 LeaderboardResponseWithRankings 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.status.is_a?(TrophyApiClient::LeaderboardResponseWithRankingsStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
|
|
193
|
-
obj.rankings.is_a?(Array) != false || raise("Passed value for field obj.rankings 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
|