trophy_api_client 1.0.35 → 1.0.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7e733021198dea1940f317242551238106a113bbcacdc42842c1f0a1bac227a
-  data.tar.gz: b7c8c709ec771024cff3b54e77d4f1df7a8644a1b64e2be2c470256aee08d214
+  metadata.gz: 2eaf3a319672f092fa93d7ffe2ece952a7985823368161cef8271f07f5af7b57
+  data.tar.gz: 4d49f9784188682c249b707cd9192d7d90637fd38b551625b29ee0e5aa33d607
 SHA512:
-  metadata.gz: edb848789103d0159d69f8fe6b852e562bf408f47ae7724dce1984b5d03715f7fc0135975214c787425d13821ddc2dc047fe6a356a4879671af79cba9f721287
-  data.tar.gz: 0117550ff5bfc745e68c913d18304861ae75b460c62391cda21b08cb21cae56a141f87457e5dd91f04e9f846af4fe3fd7875bdf11e0c6bf1d26131a68e3f78ef
+  metadata.gz: 1af2a8abf9c52a8e5ea7287f14abdc4176d013f4c4e7f52601d9fd823ddd8cc732204996e87592e2d0f9bfad33c4b2813caf180c0def5c876c3649d938c4638f
+  data.tar.gz: 31f76b9458bac7cabe5fb9b85e9b1f4d89236f1af8de9ebf54697e4f763be764ce24ebdc25f9af978dbc7f4910a4ca086a462802a04ebeb1e78704c424cc73bb

data/lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   module Gemconfig
-    VERSION = "1.0.35"
+    VERSION = "1.0.38"
     AUTHORS = ["Trophy Labs, Inc"].freeze
     EMAIL = ""
     SUMMARY = "Ruby library for the Trophy API."

data/lib/trophy_api_client/admin/client.rb

@@ -6,24 +6,24 @@ require_relative "streaks/client"
 module TrophyApiClient
   module Admin
     class Client
-      # @return [TrophyApiClient::Admin::Streaks::Client]
-      attr_reader :admin
+      # @return [TrophyApiClient::Admin::StreaksClient]
+      attr_reader :streaks
 
       # @param request_client [TrophyApiClient::RequestClient]
       # @return [TrophyApiClient::Admin::Client]
       def initialize(request_client:)
-        @admin = TrophyApiClient::Admin::Streaks::Client.new(request_client: request_client)
+        @streaks = TrophyApiClient::Admin::StreaksClient.new(request_client: request_client)
       end
     end
 
     class AsyncClient
-      # @return [TrophyApiClient::Admin::Streaks::AsyncClient]
-      attr_reader :admin
+      # @return [TrophyApiClient::Admin::AsyncStreaksClient]
+      attr_reader :streaks
 
       # @param request_client [TrophyApiClient::AsyncRequestClient]
       # @return [TrophyApiClient::Admin::AsyncClient]
       def initialize(request_client:)
-        @admin = TrophyApiClient::Admin::Streaks::AsyncClient.new(request_client: request_client)
+        @streaks = TrophyApiClient::Admin::AsyncStreaksClient.new(request_client: request_client)
       end
     end
   end

data/lib/trophy_api_client/admin/streaks/client.rb

@@ -1,30 +1,95 @@
 # frozen_string_literal: true
 
 require_relative "../../../requests"
-require_relative "freezes/client"
+require_relative "../../types/restore_streaks_response"
+require "async"
 
 module TrophyApiClient
   module Admin
-    module Streaks
-      class Client
-        # @return [TrophyApiClient::Admin::Streaks::FreezesClient]
-        attr_reader :freezes
+    class StreaksClient
+      # @return [TrophyApiClient::RequestClient]
+      attr_reader :request_client
 
-        # @param request_client [TrophyApiClient::RequestClient]
-        # @return [TrophyApiClient::Admin::Streaks::Client]
-        def initialize(request_client:)
-          @freezes = TrophyApiClient::Admin::Streaks::FreezesClient.new(request_client: request_client)
+      # @param request_client [TrophyApiClient::RequestClient]
+      # @return [TrophyApiClient::Admin::StreaksClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Restore streaks for multiple users to the maximum length in the last 90 days (in
+      #  the case of daily streaks), one year (in the case of weekly streaks), or two
+      #  years (in the case of monthly streaks).
+      #
+      # @param user_ids [Array<String>] Array of user IDs to restore streaks for. Maximum 100 users per request.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::RestoreStreaksResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.streaks.restore(user_ids: ["user-123", "user-456"])
+      def restore(user_ids:, request_options: nil)
+        response = @request_client.conn.post 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
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = { **(request_options&.additional_body_parameters || {}), userIds: user_ids }.compact
+          req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/streaks/restore"
         end
+        TrophyApiClient::RestoreStreaksResponse.from_json(json_object: response.body)
       end
+    end
 
-      class AsyncClient
-        # @return [TrophyApiClient::Admin::Streaks::AsyncFreezesClient]
-        attr_reader :freezes
+    class AsyncStreaksClient
+      # @return [TrophyApiClient::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [TrophyApiClient::AsyncRequestClient]
+      # @return [TrophyApiClient::Admin::AsyncStreaksClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
 
-        # @param request_client [TrophyApiClient::AsyncRequestClient]
-        # @return [TrophyApiClient::Admin::Streaks::AsyncClient]
-        def initialize(request_client:)
-          @freezes = TrophyApiClient::Admin::Streaks::AsyncFreezesClient.new(request_client: request_client)
+      # Restore streaks for multiple users to the maximum length in the last 90 days (in
+      #  the case of daily streaks), one year (in the case of weekly streaks), or two
+      #  years (in the case of monthly streaks).
+      #
+      # @param user_ids [Array<String>] Array of user IDs to restore streaks for. Maximum 100 users per request.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::RestoreStreaksResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.streaks.restore(user_ids: ["user-123", "user-456"])
+      def restore(user_ids:, request_options: nil)
+        Async do
+          response = @request_client.conn.post 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
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            req.body = { **(request_options&.additional_body_parameters || {}), userIds: user_ids }.compact
+            req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/streaks/restore"
+          end
+          TrophyApiClient::RestoreStreaksResponse.from_json(json_object: response.body)
         end
       end
     end

data/lib/trophy_api_client/types/achievement_completion_response_achievement.rb

@@ -2,6 +2,8 @@
 
 require_relative "metric_event_streak_response"
 require "date"
+require_relative "achievement_with_stats_response_user_attributes_item"
+require_relative "achievement_with_stats_response_event_attribute"
 require_relative "achievement_response_trigger"
 require "ostruct"
 require "json"
@@ -10,8 +12,19 @@ module TrophyApiClient
   class AchievementCompletionResponseAchievement
     # @return [TrophyApiClient::MetricEventStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
     attr_reader :current_streak
-    # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format. Null if the
+    #  achievement has not been completed.
     attr_reader :achieved_at
+    # @return [Integer] The number of users who have completed this achievement.
+    attr_reader :completions
+    # @return [Float] The percentage of all users who have completed this achievement.
+    attr_reader :rarity
+    # @return [Array<TrophyApiClient::AchievementWithStatsResponseUserAttributesItem>] User attribute filters that must be met for this achievement to be completed.
+    #  Only present if the achievement has user attribute filters configured.
+    attr_reader :user_attributes
+    # @return [TrophyApiClient::AchievementWithStatsResponseEventAttribute] Event attribute filter that must be met for this achievement to be completed.
+    #  Only present if the achievement has an event filter configured.
+    attr_reader :event_attribute
     # @return [String] The unique ID of the achievement.
     attr_reader :id
     # @return [String] The name of this achievement.
@@ -46,7 +59,14 @@ module TrophyApiClient
     OMIT = Object.new
 
     # @param current_streak [TrophyApiClient::MetricEventStreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
-    # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format. Null if the
+    #  achievement has not been completed.
+    # @param completions [Integer] The number of users who have completed this achievement.
+    # @param rarity [Float] The percentage of all users who have completed this achievement.
+    # @param user_attributes [Array<TrophyApiClient::AchievementWithStatsResponseUserAttributesItem>] User attribute filters that must be met for this achievement to be completed.
+    #  Only present if the achievement has user attribute filters configured.
+    # @param event_attribute [TrophyApiClient::AchievementWithStatsResponseEventAttribute] Event attribute filter that must be met for this achievement to be completed.
+    #  Only present if the achievement has an event filter configured.
     # @param id [String] The unique ID of the achievement.
     # @param name [String] The name of this achievement.
     # @param trigger [TrophyApiClient::AchievementResponseTrigger] The trigger of the achievement.
@@ -64,10 +84,14 @@ module TrophyApiClient
     #  trigger = 'metric')
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::AchievementCompletionResponseAchievement]
-    def initialize(achieved_at:, id:, name:, trigger:, key:, current_streak: OMIT, description: OMIT, badge_url: OMIT,
-                   streak_length: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, additional_properties: nil)
+    def initialize(completions:, rarity:, id:, name:, trigger:, key:, current_streak: OMIT, achieved_at: OMIT, user_attributes: OMIT,
+                   event_attribute: OMIT, description: OMIT, badge_url: OMIT, streak_length: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, additional_properties: nil)
       @current_streak = current_streak if current_streak != OMIT
-      @achieved_at = achieved_at
+      @achieved_at = achieved_at if achieved_at != OMIT
+      @completions = completions
+      @rarity = rarity
+      @user_attributes = user_attributes if user_attributes != OMIT
+      @event_attribute = event_attribute if event_attribute != OMIT
       @id = id
       @name = name
       @trigger = trigger
@@ -82,6 +106,10 @@ module TrophyApiClient
       @_field_set = {
         "currentStreak": current_streak,
         "achievedAt": achieved_at,
+        "completions": completions,
+        "rarity": rarity,
+        "userAttributes": user_attributes,
+        "eventAttribute": event_attribute,
         "id": id,
         "name": name,
         "trigger": trigger,
@@ -112,6 +140,18 @@ module TrophyApiClient
         current_streak = TrophyApiClient::MetricEventStreakResponse.from_json(json_object: current_streak)
       end
       achieved_at = (DateTime.parse(parsed_json["achievedAt"]) unless parsed_json["achievedAt"].nil?)
+      completions = parsed_json["completions"]
+      rarity = parsed_json["rarity"]
+      user_attributes = parsed_json["userAttributes"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AchievementWithStatsResponseUserAttributesItem.from_json(json_object: item)
+      end
+      if parsed_json["eventAttribute"].nil?
+        event_attribute = nil
+      else
+        event_attribute = parsed_json["eventAttribute"].to_json
+        event_attribute = TrophyApiClient::AchievementWithStatsResponseEventAttribute.from_json(json_object: event_attribute)
+      end
       id = parsed_json["id"]
       name = parsed_json["name"]
       trigger = parsed_json["trigger"]
@@ -125,6 +165,10 @@ module TrophyApiClient
       new(
         current_streak: current_streak,
         achieved_at: achieved_at,
+        completions: completions,
+        rarity: rarity,
+        user_attributes: user_attributes,
+        event_attribute: event_attribute,
         id: id,
         name: name,
         trigger: trigger,
@@ -155,7 +199,11 @@ module TrophyApiClient
     # @return [Void]
     def self.validate_raw(obj:)
       obj.current_streak.nil? || TrophyApiClient::MetricEventStreakResponse.validate_raw(obj: obj.current_streak)
-      obj.achieved_at.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")
+      obj.achieved_at&.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")
+      obj.completions.is_a?(Integer) != false || raise("Passed value for field obj.completions is not the expected type, validation failed.")
+      obj.rarity.is_a?(Float) != false || raise("Passed value for field obj.rarity is not the expected type, validation failed.")
+      obj.user_attributes&.is_a?(Array) != false || raise("Passed value for field obj.user_attributes is not the expected type, validation failed.")
+      obj.event_attribute.nil? || TrophyApiClient::AchievementWithStatsResponseEventAttribute.validate_raw(obj: obj.event_attribute)
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
       obj.trigger.is_a?(TrophyApiClient::AchievementResponseTrigger) != false || raise("Passed value for field obj.trigger is not the expected type, validation failed.")

data/lib/trophy_api_client/types/completed_achievement_response.rb

@@ -1,14 +1,27 @@
 # frozen_string_literal: true
 
 require "date"
+require_relative "achievement_with_stats_response_user_attributes_item"
+require_relative "achievement_with_stats_response_event_attribute"
 require_relative "achievement_response_trigger"
 require "ostruct"
 require "json"
 
 module TrophyApiClient
   class CompletedAchievementResponse
-    # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format. Null if the
+    #  achievement has not been completed.
     attr_reader :achieved_at
+    # @return [Integer] The number of users who have completed this achievement.
+    attr_reader :completions
+    # @return [Float] The percentage of all users who have completed this achievement.
+    attr_reader :rarity
+    # @return [Array<TrophyApiClient::AchievementWithStatsResponseUserAttributesItem>] User attribute filters that must be met for this achievement to be completed.
+    #  Only present if the achievement has user attribute filters configured.
+    attr_reader :user_attributes
+    # @return [TrophyApiClient::AchievementWithStatsResponseEventAttribute] Event attribute filter that must be met for this achievement to be completed.
+    #  Only present if the achievement has an event filter configured.
+    attr_reader :event_attribute
     # @return [String] The unique ID of the achievement.
     attr_reader :id
     # @return [String] The name of this achievement.
@@ -42,7 +55,14 @@ module TrophyApiClient
 
     OMIT = Object.new
 
-    # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format. Null if the
+    #  achievement has not been completed.
+    # @param completions [Integer] The number of users who have completed this achievement.
+    # @param rarity [Float] The percentage of all users who have completed this achievement.
+    # @param user_attributes [Array<TrophyApiClient::AchievementWithStatsResponseUserAttributesItem>] User attribute filters that must be met for this achievement to be completed.
+    #  Only present if the achievement has user attribute filters configured.
+    # @param event_attribute [TrophyApiClient::AchievementWithStatsResponseEventAttribute] Event attribute filter that must be met for this achievement to be completed.
+    #  Only present if the achievement has an event filter configured.
     # @param id [String] The unique ID of the achievement.
     # @param name [String] The name of this achievement.
     # @param trigger [TrophyApiClient::AchievementResponseTrigger] The trigger of the achievement.
@@ -60,9 +80,13 @@ module TrophyApiClient
     #  trigger = 'metric')
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::CompletedAchievementResponse]
-    def initialize(achieved_at:, id:, name:, trigger:, key:, description: OMIT, badge_url: OMIT, streak_length: OMIT,
-                   metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, additional_properties: nil)
-      @achieved_at = achieved_at
+    def initialize(completions:, rarity:, id:, name:, trigger:, key:, achieved_at: OMIT, user_attributes: OMIT,
+                   event_attribute: OMIT, description: OMIT, badge_url: OMIT, streak_length: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, additional_properties: nil)
+      @achieved_at = achieved_at if achieved_at != OMIT
+      @completions = completions
+      @rarity = rarity
+      @user_attributes = user_attributes if user_attributes != OMIT
+      @event_attribute = event_attribute if event_attribute != OMIT
       @id = id
       @name = name
       @trigger = trigger
@@ -76,6 +100,10 @@ module TrophyApiClient
       @additional_properties = additional_properties
       @_field_set = {
         "achievedAt": achieved_at,
+        "completions": completions,
+        "rarity": rarity,
+        "userAttributes": user_attributes,
+        "eventAttribute": event_attribute,
         "id": id,
         "name": name,
         "trigger": trigger,
@@ -99,6 +127,18 @@ module TrophyApiClient
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
       achieved_at = (DateTime.parse(parsed_json["achievedAt"]) unless parsed_json["achievedAt"].nil?)
+      completions = parsed_json["completions"]
+      rarity = parsed_json["rarity"]
+      user_attributes = parsed_json["userAttributes"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AchievementWithStatsResponseUserAttributesItem.from_json(json_object: item)
+      end
+      if parsed_json["eventAttribute"].nil?
+        event_attribute = nil
+      else
+        event_attribute = parsed_json["eventAttribute"].to_json
+        event_attribute = TrophyApiClient::AchievementWithStatsResponseEventAttribute.from_json(json_object: event_attribute)
+      end
       id = parsed_json["id"]
       name = parsed_json["name"]
       trigger = parsed_json["trigger"]
@@ -111,6 +151,10 @@ module TrophyApiClient
       metric_name = parsed_json["metricName"]
       new(
         achieved_at: achieved_at,
+        completions: completions,
+        rarity: rarity,
+        user_attributes: user_attributes,
+        event_attribute: event_attribute,
         id: id,
         name: name,
         trigger: trigger,
@@ -139,7 +183,11 @@ module TrophyApiClient
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.achieved_at.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")
+      obj.achieved_at&.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")
+      obj.completions.is_a?(Integer) != false || raise("Passed value for field obj.completions is not the expected type, validation failed.")
+      obj.rarity.is_a?(Float) != false || raise("Passed value for field obj.rarity is not the expected type, validation failed.")
+      obj.user_attributes&.is_a?(Array) != false || raise("Passed value for field obj.user_attributes is not the expected type, validation failed.")
+      obj.event_attribute.nil? || TrophyApiClient::AchievementWithStatsResponseEventAttribute.validate_raw(obj: obj.event_attribute)
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
       obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
       obj.trigger.is_a?(TrophyApiClient::AchievementResponseTrigger) != false || raise("Passed value for field obj.trigger is not the expected type, validation failed.")

data/lib/trophy_api_client/types/restore_streaks_response.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "bulk_insert_issue"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Response containing restored users and any issues encountered.
+  class RestoreStreaksResponse
+    # @return [Array<String>] Array of user IDs whose streaks were successfully restored.
+    attr_reader :restored_users
+    # @return [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during streak restoration.
+    attr_reader :issues
+    # @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 restored_users [Array<String>] Array of user IDs whose streaks were successfully restored.
+    # @param issues [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during streak restoration.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::RestoreStreaksResponse]
+    def initialize(restored_users:, issues:, additional_properties: nil)
+      @restored_users = restored_users
+      @issues = issues
+      @additional_properties = additional_properties
+      @_field_set = { "restoredUsers": restored_users, "issues": issues }
+    end
+
+    # Deserialize a JSON object to an instance of RestoreStreaksResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::RestoreStreaksResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      restored_users = parsed_json["restoredUsers"]
+      issues = parsed_json["issues"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::BulkInsertIssue.from_json(json_object: item)
+      end
+      new(
+        restored_users: restored_users,
+        issues: issues,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of RestoreStreaksResponse 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.restored_users.is_a?(Array) != false || raise("Passed value for field obj.restored_users is not the expected type, validation failed.")
+      obj.issues.is_a?(Array) != false || raise("Passed value for field obj.issues is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/wrapped_activity.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require_relative "wrapped_most_active_day"
+require_relative "wrapped_most_active_week"
+require_relative "wrapped_most_active_month"
+require_relative "wrapped_entire_year"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # The user's activity summary for the wrapped year.
+  class WrappedActivity
+    # @return [Integer] The number of days the user was active during the year.
+    attr_reader :days_active
+    # @return [Integer] The number of weeks the user was active during the year.
+    attr_reader :weeks_active
+    # @return [Integer] The number of months the user was active during the year.
+    attr_reader :months_active
+    # @return [TrophyApiClient::WrappedMostActiveDay] Data about the user's most active day.
+    attr_reader :most_active_day
+    # @return [TrophyApiClient::WrappedMostActiveWeek] Data about the user's most active week.
+    attr_reader :most_active_week
+    # @return [TrophyApiClient::WrappedMostActiveMonth] Data about the user's most active month.
+    attr_reader :most_active_month
+    # @return [TrophyApiClient::WrappedEntireYear] Data about the user's activity for the entire year.
+    attr_reader :entire_year
+    # @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 days_active [Integer] The number of days the user was active during the year.
+    # @param weeks_active [Integer] The number of weeks the user was active during the year.
+    # @param months_active [Integer] The number of months the user was active during the year.
+    # @param most_active_day [TrophyApiClient::WrappedMostActiveDay] Data about the user's most active day.
+    # @param most_active_week [TrophyApiClient::WrappedMostActiveWeek] Data about the user's most active week.
+    # @param most_active_month [TrophyApiClient::WrappedMostActiveMonth] Data about the user's most active month.
+    # @param entire_year [TrophyApiClient::WrappedEntireYear] Data about the user's activity for the entire year.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::WrappedActivity]
+    def initialize(days_active:, weeks_active:, months_active:, most_active_day:, most_active_week:,
+                   most_active_month:, entire_year:, additional_properties: nil)
+      @days_active = days_active
+      @weeks_active = weeks_active
+      @months_active = months_active
+      @most_active_day = most_active_day
+      @most_active_week = most_active_week
+      @most_active_month = most_active_month
+      @entire_year = entire_year
+      @additional_properties = additional_properties
+      @_field_set = {
+        "daysActive": days_active,
+        "weeksActive": weeks_active,
+        "monthsActive": months_active,
+        "mostActiveDay": most_active_day,
+        "mostActiveWeek": most_active_week,
+        "mostActiveMonth": most_active_month,
+        "entireYear": entire_year
+      }
+    end
+
+    # Deserialize a JSON object to an instance of WrappedActivity
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::WrappedActivity]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      days_active = parsed_json["daysActive"]
+      weeks_active = parsed_json["weeksActive"]
+      months_active = parsed_json["monthsActive"]
+      if parsed_json["mostActiveDay"].nil?
+        most_active_day = nil
+      else
+        most_active_day = parsed_json["mostActiveDay"].to_json
+        most_active_day = TrophyApiClient::WrappedMostActiveDay.from_json(json_object: most_active_day)
+      end
+      if parsed_json["mostActiveWeek"].nil?
+        most_active_week = nil
+      else
+        most_active_week = parsed_json["mostActiveWeek"].to_json
+        most_active_week = TrophyApiClient::WrappedMostActiveWeek.from_json(json_object: most_active_week)
+      end
+      if parsed_json["mostActiveMonth"].nil?
+        most_active_month = nil
+      else
+        most_active_month = parsed_json["mostActiveMonth"].to_json
+        most_active_month = TrophyApiClient::WrappedMostActiveMonth.from_json(json_object: most_active_month)
+      end
+      if parsed_json["entireYear"].nil?
+        entire_year = nil
+      else
+        entire_year = parsed_json["entireYear"].to_json
+        entire_year = TrophyApiClient::WrappedEntireYear.from_json(json_object: entire_year)
+      end
+      new(
+        days_active: days_active,
+        weeks_active: weeks_active,
+        months_active: months_active,
+        most_active_day: most_active_day,
+        most_active_week: most_active_week,
+        most_active_month: most_active_month,
+        entire_year: entire_year,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of WrappedActivity 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.days_active.is_a?(Integer) != false || raise("Passed value for field obj.days_active is not the expected type, validation failed.")
+      obj.weeks_active.is_a?(Integer) != false || raise("Passed value for field obj.weeks_active is not the expected type, validation failed.")
+      obj.months_active.is_a?(Integer) != false || raise("Passed value for field obj.months_active is not the expected type, validation failed.")
+      TrophyApiClient::WrappedMostActiveDay.validate_raw(obj: obj.most_active_day)
+      TrophyApiClient::WrappedMostActiveWeek.validate_raw(obj: obj.most_active_week)
+      TrophyApiClient::WrappedMostActiveMonth.validate_raw(obj: obj.most_active_month)
+      TrophyApiClient::WrappedEntireYear.validate_raw(obj: obj.entire_year)
+    end
+  end
+end