trophy_api_client 1.14.0 → 1.27.0

data/lib/trophy/types/webhooks_leaderboard_started_payload.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class WebhooksLeaderboardStartedPayload < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :leaderboard, -> { Trophy::Types::LeaderboardResponseWithRankings }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/webhooks_points_boost_finished_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class WebhooksPointsBoostFinishedPayload < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :timestamp, -> { String }, optional: false, nullable: false
+
+      field :boost, -> { Trophy::Types::PointsBoostWebhookPayload }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/webhooks_points_boost_started_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class WebhooksPointsBoostStartedPayload < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :timestamp, -> { String }, optional: false, nullable: false
+
+      field :boost, -> { Trophy::Types::PointsBoostWebhookPayload }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/webhooks_points_changed_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class WebhooksPointsChangedPayload < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :user, -> { Trophy::Types::User }, optional: false, nullable: false
+
+      field :points, -> { Trophy::Types::MetricEventPointsResponse }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/webhooks_points_level_changed_payload.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class WebhooksPointsLevelChangedPayload < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :user, -> { Trophy::Types::User }, optional: false, nullable: false
+
+      field :points, -> { Trophy::Types::WebhooksPointsLevelChangedPayloadPoints }, optional: false, nullable: false
+
+      field :previous_level, -> { Trophy::Types::PointsLevel }, optional: true, nullable: false, api_name: "previousLevel"
+
+      field :new_level, -> { Trophy::Types::PointsLevel }, optional: true, nullable: false, api_name: "newLevel"
+    end
+  end
+end

data/lib/trophy/types/webhooks_points_level_changed_payload_points.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The points system in which the level changed.
+    class WebhooksPointsLevelChangedPayloadPoints < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :badge_url, -> { String }, optional: true, nullable: false, api_name: "badgeUrl"
+
+      field :max_points, -> { Integer }, optional: true, nullable: false, api_name: "maxPoints"
+
+      field :total, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/webhooks_streak_extended_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class WebhooksStreakExtendedPayload < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :user, -> { Trophy::Types::User }, optional: false, nullable: false
+
+      field :streak, -> { Trophy::Types::BaseStreakResponse }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/webhooks_streak_freeze_consumed_payload.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class WebhooksStreakFreezeConsumedPayload < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :user, -> { Trophy::Types::User }, optional: false, nullable: false
+
+      field :consumed, -> { Integer }, optional: false, nullable: false
+
+      field :freezes, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/webhooks_streak_freeze_earned_payload.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class WebhooksStreakFreezeEarnedPayload < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :user, -> { Trophy::Types::User }, optional: false, nullable: false
+
+      field :earned, -> { Integer }, optional: false, nullable: false
+
+      field :freezes, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/webhooks_streak_lost_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class WebhooksStreakLostPayload < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :user, -> { Trophy::Types::User }, optional: false, nullable: false
+
+      field :length, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/webhooks_streak_started_payload.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class WebhooksStreakStartedPayload < Internal::Types::Model
+      field :type, -> { String }, optional: false, nullable: false
+
+      field :user, -> { Trophy::Types::User }, optional: false, nullable: false
+
+      field :streak, -> { Trophy::Types::BaseStreakResponse }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/wrapped_activity.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The user's activity summary for the wrapped year.
+    class WrappedActivity < Internal::Types::Model
+      field :days_active, -> { Integer }, optional: false, nullable: false, api_name: "daysActive"
+
+      field :weeks_active, -> { Integer }, optional: false, nullable: false, api_name: "weeksActive"
+
+      field :months_active, -> { Integer }, optional: false, nullable: false, api_name: "monthsActive"
+
+      field :most_active_day, -> { Trophy::Types::WrappedMostActiveDay }, optional: false, nullable: false, api_name: "mostActiveDay"
+
+      field :most_active_week, -> { Trophy::Types::WrappedMostActiveWeek }, optional: false, nullable: false, api_name: "mostActiveWeek"
+
+      field :most_active_month, -> { Trophy::Types::WrappedMostActiveMonth }, optional: false, nullable: false, api_name: "mostActiveMonth"
+
+      field :entire_year, -> { Trophy::Types::WrappedEntireYear }, optional: false, nullable: false, api_name: "entireYear"
+    end
+  end
+end

data/lib/trophy/types/wrapped_activity_period.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Activity data for a specific period (day, week, month, or year).
+    class WrappedActivityPeriod < Internal::Types::Model
+      field :metrics, -> { Internal::Types::Hash[String, Trophy::Types::WrappedMetric] }, optional: false, nullable: false
+
+      field :points, -> { Internal::Types::Hash[String, Trophy::Types::WrappedPoints] }, optional: false, nullable: false
+
+      field :achievements, -> { Internal::Types::Array[Trophy::Types::UserAchievementResponse] }, optional: false, nullable: false
+
+      field :leaderboards, -> { Internal::Types::Hash[String, Trophy::Types::UserLeaderboardResponse] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/wrapped_entire_year.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The user's activity data for the entire year.
+    class WrappedEntireYear < Internal::Types::Model
+      field :metrics, -> { Internal::Types::Hash[String, Trophy::Types::WrappedMetric] }, optional: false, nullable: false
+
+      field :points, -> { Internal::Types::Hash[String, Trophy::Types::WrappedPoints] }, optional: false, nullable: false
+
+      field :achievements, -> { Internal::Types::Array[Trophy::Types::UserAchievementResponse] }, optional: false, nullable: false
+
+      field :leaderboards, -> { Internal::Types::Hash[String, Trophy::Types::UserLeaderboardResponse] }, optional: false, nullable: false
+
+      field :longest_streak, -> { Trophy::Types::WrappedStreak }, optional: false, nullable: false, api_name: "longestStreak"
+    end
+  end
+end

data/lib/trophy/types/wrapped_metric.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A user's metric data for a wrapped period.
+    class WrappedMetric < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :units, -> { String }, optional: true, nullable: false
+
+      field :current_total, -> { Integer }, optional: false, nullable: false, api_name: "currentTotal"
+
+      field :change_this_period, -> { Integer }, optional: false, nullable: false, api_name: "changeThisPeriod"
+
+      field :percent_change, -> { Integer }, optional: false, nullable: false, api_name: "percentChange"
+
+      field :percentile_this_period, -> { Integer }, optional: true, nullable: false, api_name: "percentileThisPeriod"
+
+      field :by_attribute, -> { Internal::Types::Hash[String, Internal::Types::Hash[String, Trophy::Types::WrappedMetricByAttributeValueValue]] }, optional: false, nullable: false, api_name: "byAttribute"
+    end
+  end
+end

data/lib/trophy/types/wrapped_metric_by_attribute_value_value.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class WrappedMetricByAttributeValueValue < Internal::Types::Model
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :units, -> { String }, optional: true, nullable: false
+
+      field :current_total, -> { Integer }, optional: true, nullable: false, api_name: "currentTotal"
+
+      field :change_this_period, -> { Integer }, optional: true, nullable: false, api_name: "changeThisPeriod"
+
+      field :percent_change, -> { Integer }, optional: true, nullable: false, api_name: "percentChange"
+
+      field :percentile_this_period, -> { Integer }, optional: true, nullable: false, api_name: "percentileThisPeriod"
+    end
+  end
+end

data/lib/trophy/types/wrapped_most_active_day.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The user's most active day during the year.
+    class WrappedMostActiveDay < Internal::Types::Model
+      field :metrics, -> { Internal::Types::Hash[String, Trophy::Types::WrappedMetric] }, optional: false, nullable: false
+
+      field :points, -> { Internal::Types::Hash[String, Trophy::Types::WrappedPoints] }, optional: false, nullable: false
+
+      field :achievements, -> { Internal::Types::Array[Trophy::Types::UserAchievementResponse] }, optional: false, nullable: false
+
+      field :leaderboards, -> { Internal::Types::Hash[String, Trophy::Types::UserLeaderboardResponse] }, optional: false, nullable: false
+
+      field :date, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/wrapped_most_active_month.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The user's most active month during the year.
+    class WrappedMostActiveMonth < Internal::Types::Model
+      field :metrics, -> { Internal::Types::Hash[String, Trophy::Types::WrappedMetric] }, optional: false, nullable: false
+
+      field :points, -> { Internal::Types::Hash[String, Trophy::Types::WrappedPoints] }, optional: false, nullable: false
+
+      field :achievements, -> { Internal::Types::Array[Trophy::Types::UserAchievementResponse] }, optional: false, nullable: false
+
+      field :leaderboards, -> { Internal::Types::Hash[String, Trophy::Types::UserLeaderboardResponse] }, optional: false, nullable: false
+
+      field :month, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/wrapped_most_active_week.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The user's most active week during the year.
+    class WrappedMostActiveWeek < Internal::Types::Model
+      field :metrics, -> { Internal::Types::Hash[String, Trophy::Types::WrappedMetric] }, optional: false, nullable: false
+
+      field :points, -> { Internal::Types::Hash[String, Trophy::Types::WrappedPoints] }, optional: false, nullable: false
+
+      field :achievements, -> { Internal::Types::Array[Trophy::Types::UserAchievementResponse] }, optional: false, nullable: false
+
+      field :leaderboards, -> { Internal::Types::Hash[String, Trophy::Types::UserLeaderboardResponse] }, optional: false, nullable: false
+
+      field :start, -> { String }, optional: false, nullable: false
+
+      field :end_, -> { String }, optional: false, nullable: false, api_name: "end"
+    end
+  end
+end

data/lib/trophy/types/wrapped_points.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A user's points data for a wrapped period.
+    class WrappedPoints < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :current_total, -> { Integer }, optional: false, nullable: false, api_name: "currentTotal"
+
+      field :change_this_period, -> { Integer }, optional: false, nullable: false, api_name: "changeThisPeriod"
+
+      field :percent_change, -> { Integer }, optional: false, nullable: false, api_name: "percentChange"
+
+      field :percentile_this_period, -> { Integer }, optional: true, nullable: false, api_name: "percentileThisPeriod"
+    end
+  end
+end

data/lib/trophy/types/wrapped_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A user's year-in-review wrapped data including activity summaries, metrics, points, achievements, streaks, and
+    # leaderboard rankings.
+    class WrappedResponse < Internal::Types::Model
+      field :user, -> { Trophy::Types::User }, optional: false, nullable: false
+
+      field :activity, -> { Trophy::Types::WrappedActivity }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/wrapped_streak.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The user's longest streak during the wrapped period.
+    class WrappedStreak < Internal::Types::Model
+      field :length, -> { Integer }, optional: false, nullable: false
+
+      field :frequency, -> { Trophy::Types::StreakFrequency }, optional: false, nullable: false
+
+      field :period_start, -> { String }, optional: true, nullable: false, api_name: "periodStart"
+
+      field :period_end, -> { String }, optional: true, nullable: false, api_name: "periodEnd"
+
+      field :started, -> { String }, optional: true, nullable: false
+    end
+  end
+end