trophy_api_client 1.0.36 → 1.0.38

data/lib/trophy_api_client/types/wrapped_most_active_week.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require_relative "completed_achievement_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # The user's most active week during the year.
+  class WrappedMostActiveWeek
+    # @return [String] The start date of the most active week in YYYY-MM-DD format.
+    attr_reader :start
+    # @return [String] The end date of the most active week in YYYY-MM-DD format.
+    attr_reader :end_
+    # @return [Hash{String => TrophyApiClient::WrappedMetric}] The user's metrics during this period, keyed by metric key.
+    attr_reader :metrics
+    # @return [Hash{String => TrophyApiClient::WrappedPoints}] The user's points during this period, keyed by points system key.
+    attr_reader :points
+    # @return [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed during this period.
+    attr_reader :achievements
+    # @return [Hash{String => TrophyApiClient::UserLeaderboardResponse}] The user's best leaderboard rankings during this period, keyed by leaderboard
+    #  key.
+    attr_reader :leaderboards
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param start [String] The start date of the most active week in YYYY-MM-DD format.
+    # @param end_ [String] The end date of the most active week in YYYY-MM-DD format.
+    # @param metrics [Hash{String => TrophyApiClient::WrappedMetric}] The user's metrics during this period, keyed by metric key.
+    # @param points [Hash{String => TrophyApiClient::WrappedPoints}] The user's points during this period, keyed by points system key.
+    # @param achievements [Array<TrophyApiClient::CompletedAchievementResponse>] Achievements completed during this period.
+    # @param leaderboards [Hash{String => TrophyApiClient::UserLeaderboardResponse}] The user's best leaderboard rankings during this period, keyed by leaderboard
+    #  key.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WrappedMostActiveWeek]
+    def initialize(start:, end_:, metrics:, points:, achievements:, leaderboards:, additional_properties: nil)
+      @start = start
+      @end_ = end_
+      @metrics = metrics
+      @points = points
+      @achievements = achievements
+      @leaderboards = leaderboards
+      @additional_properties = additional_properties
+      @_field_set = {
+        "start": start,
+        "end": end_,
+        "metrics": metrics,
+        "points": points,
+        "achievements": achievements,
+        "leaderboards": leaderboards
+      }
+    end
+
+    # Deserialize a JSON object to an instance of WrappedMostActiveWeek
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WrappedMostActiveWeek]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      start = parsed_json["start"]
+      end_ = parsed_json["end"]
+      metrics = parsed_json["metrics"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::WrappedMetric.from_json(json_object: value)
+      end
+      points = parsed_json["points"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::WrappedPoints.from_json(json_object: value)
+      end
+      achievements = parsed_json["achievements"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::CompletedAchievementResponse.from_json(json_object: item)
+      end
+      leaderboards = parsed_json["leaderboards"]&.transform_values do |value|
+        value = value.to_json
+        TrophyApiClient::UserLeaderboardResponse.from_json(json_object: value)
+      end
+      new(
+        start: start,
+        end_: end_,
+        metrics: metrics,
+        points: points,
+        achievements: achievements,
+        leaderboards: leaderboards,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WrappedMostActiveWeek to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
+      obj.end_.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
+      obj.metrics.is_a?(Hash) != false || raise("Passed value for field obj.metrics is not the expected type, validation failed.")
+      obj.points.is_a?(Hash) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+      obj.achievements.is_a?(Array) != false || raise("Passed value for field obj.achievements is not the expected type, validation failed.")
+      obj.leaderboards.is_a?(Hash) != false || raise("Passed value for field obj.leaderboards is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/wrapped_points.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A user's points data for a wrapped period.
+  class WrappedPoints
+    # @return [String] The name of the points system.
+    attr_reader :name
+    # @return [String] The description of the points system.
+    attr_reader :description
+    # @return [Float] The user's current total points.
+    attr_reader :current_total
+    # @return [Float] The change in points during the period.
+    attr_reader :change_this_period
+    # @return [Float] The percentage change in points during the period.
+    attr_reader :percent_change
+    # @return [Float] The user's percentile rank for this points system during the period. Only
+    #  included for weekly, monthly, and yearly aggregation periods.
+    attr_reader :percentile_this_period
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param name [String] The name of the points system.
+    # @param description [String] The description of the points system.
+    # @param current_total [Float] The user's current total points.
+    # @param change_this_period [Float] The change in points during the period.
+    # @param percent_change [Float] The percentage change in points during the period.
+    # @param percentile_this_period [Float] The user's percentile rank for this points system during the period. Only
+    #  included for weekly, monthly, and yearly aggregation periods.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WrappedPoints]
+    def initialize(name:, current_total:, change_this_period:, percent_change:, description: OMIT,
+                   percentile_this_period: OMIT, additional_properties: nil)
+      @name = name
+      @description = description if description != OMIT
+      @current_total = current_total
+      @change_this_period = change_this_period
+      @percent_change = percent_change
+      @percentile_this_period = percentile_this_period if percentile_this_period != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "name": name,
+        "description": description,
+        "currentTotal": current_total,
+        "changeThisPeriod": change_this_period,
+        "percentChange": percent_change,
+        "percentileThisPeriod": percentile_this_period
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of WrappedPoints
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WrappedPoints]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      description = parsed_json["description"]
+      current_total = parsed_json["currentTotal"]
+      change_this_period = parsed_json["changeThisPeriod"]
+      percent_change = parsed_json["percentChange"]
+      percentile_this_period = parsed_json["percentileThisPeriod"]
+      new(
+        name: name,
+        description: description,
+        current_total: current_total,
+        change_this_period: change_this_period,
+        percent_change: percent_change,
+        percentile_this_period: percentile_this_period,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WrappedPoints to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.current_total.is_a?(Float) != false || raise("Passed value for field obj.current_total is not the expected type, validation failed.")
+      obj.change_this_period.is_a?(Float) != false || raise("Passed value for field obj.change_this_period is not the expected type, validation failed.")
+      obj.percent_change.is_a?(Float) != false || raise("Passed value for field obj.percent_change is not the expected type, validation failed.")
+      obj.percentile_this_period&.is_a?(Float) != false || raise("Passed value for field obj.percentile_this_period is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/wrapped_response.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require_relative "user"
+require_relative "wrapped_activity"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A user's year-in-review wrapped data including activity summaries, metrics,
+  #  points, achievements, streaks, and leaderboard rankings.
+  class WrappedResponse
+    # @return [TrophyApiClient::User] The user's profile information.
+    attr_reader :user
+    # @return [TrophyApiClient::WrappedActivity] The user's activity data for the wrapped year.
+    attr_reader :activity
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param user [TrophyApiClient::User] The user's profile information.
+    # @param activity [TrophyApiClient::WrappedActivity] The user's activity data for the wrapped year.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WrappedResponse]
+    def initialize(user:, activity:, additional_properties: nil)
+      @user = user
+      @activity = activity
+      @additional_properties = additional_properties
+      @_field_set = { "user": user, "activity": activity }
+    end
+
+    # Deserialize a JSON object to an instance of WrappedResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WrappedResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["user"].nil?
+        user = nil
+      else
+        user = parsed_json["user"].to_json
+        user = TrophyApiClient::User.from_json(json_object: user)
+      end
+      if parsed_json["activity"].nil?
+        activity = nil
+      else
+        activity = parsed_json["activity"].to_json
+        activity = TrophyApiClient::WrappedActivity.from_json(json_object: activity)
+      end
+      new(
+        user: user,
+        activity: activity,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WrappedResponse to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      TrophyApiClient::User.validate_raw(obj: obj.user)
+      TrophyApiClient::WrappedActivity.validate_raw(obj: obj.activity)
+    end
+  end
+end

data/lib/trophy_api_client/types/wrapped_streak.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "streak_frequency"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # The user's longest streak during the wrapped period.
+  class WrappedStreak
+    # @return [Integer] The length of the streak.
+    attr_reader :length
+    # @return [TrophyApiClient::StreakFrequency] The frequency of the streak.
+    attr_reader :frequency
+    # @return [String] The start date of the streak period.
+    attr_reader :period_start
+    # @return [String] The end date of the streak period.
+    attr_reader :period_end
+    # @return [String] The date the streak started.
+    attr_reader :started
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param length [Integer] The length of the streak.
+    # @param frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
+    # @param period_start [String] The start date of the streak period.
+    # @param period_end [String] The end date of the streak period.
+    # @param started [String] The date the streak started.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WrappedStreak]
+    def initialize(length:, frequency:, period_start: OMIT, period_end: OMIT, started: OMIT, additional_properties: nil)
+      @length = length
+      @frequency = frequency
+      @period_start = period_start if period_start != OMIT
+      @period_end = period_end if period_end != OMIT
+      @started = started if started != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "length": length,
+        "frequency": frequency,
+        "periodStart": period_start,
+        "periodEnd": period_end,
+        "started": started
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of WrappedStreak
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WrappedStreak]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      length = parsed_json["length"]
+      frequency = parsed_json["frequency"]
+      period_start = parsed_json["periodStart"]
+      period_end = parsed_json["periodEnd"]
+      started = parsed_json["started"]
+      new(
+        length: length,
+        frequency: frequency,
+        period_start: period_start,
+        period_end: period_end,
+        started: started,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WrappedStreak to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
+      obj.frequency.is_a?(TrophyApiClient::StreakFrequency) != false || raise("Passed value for field obj.frequency is not the expected type, validation failed.")
+      obj.period_start&.is_a?(String) != false || raise("Passed value for field obj.period_start is not the expected type, validation failed.")
+      obj.period_end&.is_a?(String) != false || raise("Passed value for field obj.period_end is not the expected type, validation failed.")
+      obj.started&.is_a?(String) != false || raise("Passed value for field obj.started is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/users/client.rb

@@ -14,6 +14,7 @@ require_relative "../types/get_user_points_response"
 require_relative "types/users_points_event_summary_request_aggregation"
 require_relative "types/users_points_event_summary_response_item"
 require_relative "../types/user_leaderboard_response_with_history"
+require_relative "../types/wrapped_response"
 require "async"
 
 module TrophyApiClient
@@ -501,6 +502,38 @@ module TrophyApiClient
       end
       TrophyApiClient::UserLeaderboardResponseWithHistory.from_json(json_object: response.body)
     end
+
+    # Get a user's year-in-review wrapped data.
+    #
+    # @param id [String] The user's ID in your database.
+    # @param year [Integer] The year to get wrapped data for. Defaults to the current year. Must be an
+    #  integer between 1 and the current year.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::WrappedResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.wrapped(id: "user-123", year: 1)
+    def wrapped(id:, year: nil, request_options: nil)
+      response = @request_client.conn.get do |req|
+        req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+        req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = { **(request_options&.additional_query_parameters || {}), "year": year }.compact
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(environment: api, request_options: request_options)}/users/#{id}/wrapped"
+      end
+      TrophyApiClient::WrappedResponse.from_json(json_object: response.body)
+    end
   end
 
   class AsyncUsersClient
@@ -1011,5 +1044,39 @@ module TrophyApiClient
         TrophyApiClient::UserLeaderboardResponseWithHistory.from_json(json_object: response.body)
       end
     end
+
+    # Get a user's year-in-review wrapped data.
+    #
+    # @param id [String] The user's ID in your database.
+    # @param year [Integer] The year to get wrapped data for. Defaults to the current year. Must be an
+    #  integer between 1 and the current year.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::WrappedResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.wrapped(id: "user-123", year: 1)
+    def wrapped(id:, year: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "year": year }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(environment: api, request_options: request_options)}/users/#{id}/wrapped"
+        end
+        TrophyApiClient::WrappedResponse.from_json(json_object: response.body)
+      end
+    end
   end
 end

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.36"
+  VERSION = "1.0.38"
 end

data/lib/types_export.rb

@@ -69,5 +69,17 @@ require_relative "trophy_api_client/types/user_leaderboard_response"
 require_relative "trophy_api_client/types/user_leaderboard_response_with_history"
 require_relative "trophy_api_client/types/webhook_user_leaderboard_response"
 require_relative "trophy_api_client/types/create_streak_freezes_response"
+require_relative "trophy_api_client/types/restore_streaks_response"
 require_relative "trophy_api_client/types/bulk_insert_issue_level"
 require_relative "trophy_api_client/types/bulk_insert_issue"
+require_relative "trophy_api_client/types/wrapped_metric_by_attribute_value_value"
+require_relative "trophy_api_client/types/wrapped_metric"
+require_relative "trophy_api_client/types/wrapped_points"
+require_relative "trophy_api_client/types/wrapped_streak"
+require_relative "trophy_api_client/types/wrapped_activity_period"
+require_relative "trophy_api_client/types/wrapped_most_active_day"
+require_relative "trophy_api_client/types/wrapped_most_active_week"
+require_relative "trophy_api_client/types/wrapped_most_active_month"
+require_relative "trophy_api_client/types/wrapped_entire_year"
+require_relative "trophy_api_client/types/wrapped_activity"
+require_relative "trophy_api_client/types/wrapped_response"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.36
+  version: 1.0.38
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -153,6 +153,7 @@ files:
 - lib/trophy_api_client/types/points_trigger_response_user_attributes_item.rb
 - lib/trophy_api_client/types/points_trigger_time_unit.rb
 - lib/trophy_api_client/types/points_trigger_type.rb
+- lib/trophy_api_client/types/restore_streaks_response.rb
 - lib/trophy_api_client/types/streak_frequency.rb
 - lib/trophy_api_client/types/streak_ranking_user.rb
 - lib/trophy_api_client/types/streak_response.rb
@@ -174,6 +175,17 @@ files:
 - lib/trophy_api_client/types/webhooks_streak_freeze_earned_payload.rb
 - lib/trophy_api_client/types/webhooks_streak_lost_payload.rb
 - lib/trophy_api_client/types/webhooks_streak_started_payload.rb
+- lib/trophy_api_client/types/wrapped_activity.rb
+- lib/trophy_api_client/types/wrapped_activity_period.rb
+- lib/trophy_api_client/types/wrapped_entire_year.rb
+- lib/trophy_api_client/types/wrapped_metric.rb
+- lib/trophy_api_client/types/wrapped_metric_by_attribute_value_value.rb
+- lib/trophy_api_client/types/wrapped_most_active_day.rb
+- lib/trophy_api_client/types/wrapped_most_active_month.rb
+- lib/trophy_api_client/types/wrapped_most_active_week.rb
+- lib/trophy_api_client/types/wrapped_points.rb
+- lib/trophy_api_client/types/wrapped_response.rb
+- lib/trophy_api_client/types/wrapped_streak.rb
 - lib/trophy_api_client/users/client.rb
 - lib/trophy_api_client/users/types/users_metric_event_summary_request_aggregation.rb
 - lib/trophy_api_client/users/types/users_metric_event_summary_response_item.rb