trophy_api_client 1.0.29 → 1.0.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 057cf20c78c80caa66eff19b3a3252ba56e92d84645219cc40a996afda1b6a83
-  data.tar.gz: 13b109f1d873161c2328189bfb54aebcf9f83dcc1d00570629a357f71ad34028
+  metadata.gz: ae06f4ad10f6292d25008af408ba0947190adfdda8bf9a243333e21b3d1b2bd8
+  data.tar.gz: c54d6136018d217c6236c43f9683d362903060538d5429e5a35266d2a7e0983c
 SHA512:
-  metadata.gz: 597eba515aec1cb420d4de9cc034175a52872a494042f15ff6e05a76843ec6c953ef87f8431fae75a80195c55aaa6572982d069afb03b01eec600e4693b4252e
-  data.tar.gz: 6ff81aa42cc68cccf65381bac4eddf79ce6eb7e36b194e3d5b0090126baffa3a311074b33c90575baadbde6030e02ea8eefe9528c30fa9dbe3beaea44d8064ac
+  metadata.gz: 255581f34cedb5460cbed75b5c8a946150f5e2c768c445fd01a532d0f4dc3986d3bf0318eb2580a1126229e1a88c0f1a53291708011e57623700c2aee1cf28dd
+  data.tar.gz: eedad3138a96ca0f72d3e661c03db489db53cde53cc9a8dc652600db1c9964ebdab6553daf089b791c54183d40bcf4db255db38d26f4819fdd67555dea592c28

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/achievements/client.rb

@@ -20,6 +20,9 @@ module TrophyApiClient
 
     # Get all achievements and their completion stats.
     #
+    # @param user_attributes [String] Optional colon-delimited user attributes in the format
+    #  attribute:value,attribute:value. Only achievements accessible to a user with the
+    #  provided attributes will be returned.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [Array<TrophyApiClient::AchievementWithStatsResponse>]
     # @example
@@ -28,8 +31,8 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.all
-    def all(request_options: nil)
+    #  api.achievements.all(user_attributes: "plan-type:premium,region:us-east")
+    def all(user_attributes: 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?
@@ -38,9 +41,10 @@ module TrophyApiClient
       **@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.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "userAttributes": user_attributes
+        }.compact
         unless request_options.nil? || request_options&.additional_body_parameters.nil?
           req.body = { **(request_options&.additional_body_parameters || {}) }.compact
         end
@@ -72,7 +76,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", tz: "Europe/London", id: "user-id" })
+    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "user-id" })
     def complete(key:, user:, 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?
@@ -105,6 +109,9 @@ module TrophyApiClient
 
     # Get all achievements and their completion stats.
     #
+    # @param user_attributes [String] Optional colon-delimited user attributes in the format
+    #  attribute:value,attribute:value. Only achievements accessible to a user with the
+    #  provided attributes will be returned.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [Array<TrophyApiClient::AchievementWithStatsResponse>]
     # @example
@@ -113,8 +120,8 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.all
-    def all(request_options: nil)
+    #  api.achievements.all(user_attributes: "plan-type:premium,region:us-east")
+    def all(user_attributes: 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?
@@ -124,9 +131,10 @@ module TrophyApiClient
         **@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.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "userAttributes": user_attributes
+          }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
           end
@@ -159,7 +167,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", tz: "Europe/London", id: "user-id" })
+    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "user-id" })
     def complete(key:, user:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|

data/lib/trophy_api_client/leaderboards/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
-require_relative "../types/leaderboard_response"
+require_relative "types/leaderboards_all_response_item"
 require "json"
 require_relative "../types/leaderboard_response_with_rankings"
 require "async"
@@ -20,7 +20,7 @@ module TrophyApiClient
     # Get all active leaderboards for your organization.
     #
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::LeaderboardResponse>]
+    # @return [Array<TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem>]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -48,7 +48,7 @@ module TrophyApiClient
       parsed_json = JSON.parse(response.body)
       parsed_json&.map do |item|
         item = item.to_json
-        TrophyApiClient::LeaderboardResponse.from_json(json_object: item)
+        TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem.from_json(json_object: item)
       end
     end
 
@@ -61,6 +61,9 @@ module TrophyApiClient
     #  run.
     # @param user_id [String] When provided, offset is relative to this user's position on the leaderboard. If
     #  the user is not found in the leaderboard, returns empty rankings array.
+    # @param user_attributes [String] Attribute key and value to filter the rankings by, separated by a colon. This
+    #  parameter is required, and only valid for leaderboards with a breakdown
+    #  attribute.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::LeaderboardResponseWithRankings]
     # @example
@@ -71,10 +74,13 @@ module TrophyApiClient
     #  )
     #  api.leaderboards.get(
     #    key: "weekly-words",
+    #    offset: 1,
+    #    limit: 1,
     #    run: "2025-01-15",
-    #    user_id: "user-123"
+    #    user_id: "user-123",
+    #    user_attributes: "city:London"
     #  )
-    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, request_options: nil)
+    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, user_attributes: 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?
@@ -88,7 +94,8 @@ module TrophyApiClient
           "offset": offset,
           "limit": limit,
           "run": run,
-          "userId": user_id
+          "userId": user_id,
+          "userAttributes": user_attributes
         }.compact
         unless request_options.nil? || request_options&.additional_body_parameters.nil?
           req.body = { **(request_options&.additional_body_parameters || {}) }.compact
@@ -112,7 +119,7 @@ module TrophyApiClient
     # Get all active leaderboards for your organization.
     #
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::LeaderboardResponse>]
+    # @return [Array<TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem>]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -141,7 +148,7 @@ module TrophyApiClient
         parsed_json = JSON.parse(response.body)
         parsed_json&.map do |item|
           item = item.to_json
-          TrophyApiClient::LeaderboardResponse.from_json(json_object: item)
+          TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem.from_json(json_object: item)
         end
       end
     end
@@ -155,6 +162,9 @@ module TrophyApiClient
     #  run.
     # @param user_id [String] When provided, offset is relative to this user's position on the leaderboard. If
     #  the user is not found in the leaderboard, returns empty rankings array.
+    # @param user_attributes [String] Attribute key and value to filter the rankings by, separated by a colon. This
+    #  parameter is required, and only valid for leaderboards with a breakdown
+    #  attribute.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::LeaderboardResponseWithRankings]
     # @example
@@ -165,10 +175,13 @@ module TrophyApiClient
     #  )
     #  api.leaderboards.get(
     #    key: "weekly-words",
+    #    offset: 1,
+    #    limit: 1,
     #    run: "2025-01-15",
-    #    user_id: "user-123"
+    #    user_id: "user-123",
+    #    user_attributes: "city:London"
     #  )
-    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, request_options: nil)
+    def get(key:, offset: nil, limit: nil, run: nil, user_id: nil, user_attributes: 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?
@@ -183,7 +196,8 @@ module TrophyApiClient
             "offset": offset,
             "limit": limit,
             "run": run,
-            "userId": user_id
+            "userId": user_id,
+            "userAttributes": user_attributes
           }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact

data/lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+require_relative "leaderboards_all_response_item_status"
+require_relative "../../types/leaderboard_response_rank_by"
+require_relative "../../types/leaderboard_response_run_unit"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class Leaderboards
+    class LeaderboardsAllResponseItem
+      # @return [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItemStatus] The status of the leaderboard.
+      attr_reader :status
+      # @return [String] The unique ID of the leaderboard.
+      attr_reader :id
+      # @return [String] The user-facing name of the leaderboard.
+      attr_reader :name
+      # @return [String] The unique key used to reference the leaderboard in APIs.
+      attr_reader :key
+      # @return [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
+      attr_reader :rank_by
+      # @return [String] The key of the attribute to break down this leaderboard by.
+      attr_reader :breakdown_attribute
+      # @return [String] The key of the metric to rank by, if rankBy is 'metric'.
+      attr_reader :metric_key
+      # @return [String] The name of the metric to rank by, if rankBy is 'metric'.
+      attr_reader :metric_name
+      # @return [String] The key of the points system to rank by, if rankBy is 'points'.
+      attr_reader :points_system_key
+      # @return [String] The name of the points system to rank by, if rankBy is 'points'.
+      attr_reader :points_system_name
+      # @return [String] The user-facing description of the leaderboard.
+      attr_reader :description
+      # @return [String] The start date of the leaderboard in YYYY-MM-DD format.
+      attr_reader :start
+      # @return [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
+      #  forever.
+      attr_reader :end_
+      # @return [Integer] The maximum number of participants in the leaderboard.
+      attr_reader :max_participants
+      # @return [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
+      #  leaderboards.
+      attr_reader :run_unit
+      # @return [Integer] The interval between repetitions, relative to the start date and repetition
+      #  type.
+      attr_reader :run_interval
+      # @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 status [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItemStatus] The status of the leaderboard.
+      # @param id [String] The unique ID of the leaderboard.
+      # @param name [String] The user-facing name of the leaderboard.
+      # @param key [String] The unique key used to reference the leaderboard in APIs.
+      # @param rank_by [TrophyApiClient::LeaderboardResponseRankBy] What the leaderboard ranks by.
+      # @param breakdown_attribute [String] The key of the attribute to break down this leaderboard by.
+      # @param metric_key [String] The key of the metric to rank by, if rankBy is 'metric'.
+      # @param metric_name [String] The name of the metric to rank by, if rankBy is 'metric'.
+      # @param points_system_key [String] The key of the points system to rank by, if rankBy is 'points'.
+      # @param points_system_name [String] The name of the points system to rank by, if rankBy is 'points'.
+      # @param description [String] The user-facing description of the leaderboard.
+      # @param start [String] The start date of the leaderboard in YYYY-MM-DD format.
+      # @param end_ [String] The end date of the leaderboard in YYYY-MM-DD format, or null if it runs
+      #  forever.
+      # @param max_participants [Integer] The maximum number of participants in the leaderboard.
+      # @param run_unit [TrophyApiClient::LeaderboardResponseRunUnit] The repetition type for recurring leaderboards, or null for one-time
+      #  leaderboards.
+      # @param run_interval [Integer] The interval between repetitions, relative to the start date and repetition
+      #  type.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem]
+      def initialize(status:, id:, name:, key:, rank_by:, description:, start:, max_participants:, run_interval:, breakdown_attribute: OMIT, metric_key: OMIT,
+                     metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, end_: OMIT, run_unit: OMIT, additional_properties: nil)
+        @status = status
+        @id = id
+        @name = name
+        @key = key
+        @rank_by = rank_by
+        @breakdown_attribute = breakdown_attribute if breakdown_attribute != OMIT
+        @metric_key = metric_key if metric_key != OMIT
+        @metric_name = metric_name if metric_name != OMIT
+        @points_system_key = points_system_key if points_system_key != OMIT
+        @points_system_name = points_system_name if points_system_name != OMIT
+        @description = description
+        @start = start
+        @end_ = end_ if end_ != OMIT
+        @max_participants = max_participants
+        @run_unit = run_unit if run_unit != OMIT
+        @run_interval = run_interval
+        @additional_properties = additional_properties
+        @_field_set = {
+          "status": status,
+          "id": id,
+          "name": name,
+          "key": key,
+          "rankBy": rank_by,
+          "breakdownAttribute": breakdown_attribute,
+          "metricKey": metric_key,
+          "metricName": metric_name,
+          "pointsSystemKey": points_system_key,
+          "pointsSystemName": points_system_name,
+          "description": description,
+          "start": start,
+          "end": end_,
+          "maxParticipants": max_participants,
+          "runUnit": run_unit,
+          "runInterval": run_interval
+        }.reject do |_k, v|
+          v == OMIT
+        end
+      end
+
+      # Deserialize a JSON object to an instance of LeaderboardsAllResponseItem
+      #
+      # @param json_object [String]
+      # @return [TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        status = parsed_json["status"]
+        id = parsed_json["id"]
+        name = parsed_json["name"]
+        key = parsed_json["key"]
+        rank_by = parsed_json["rankBy"]
+        breakdown_attribute = parsed_json["breakdownAttribute"]
+        metric_key = parsed_json["metricKey"]
+        metric_name = parsed_json["metricName"]
+        points_system_key = parsed_json["pointsSystemKey"]
+        points_system_name = parsed_json["pointsSystemName"]
+        description = parsed_json["description"]
+        start = parsed_json["start"]
+        end_ = parsed_json["end"]
+        max_participants = parsed_json["maxParticipants"]
+        run_unit = parsed_json["runUnit"]
+        run_interval = parsed_json["runInterval"]
+        new(
+          status: status,
+          id: id,
+          name: name,
+          key: key,
+          rank_by: rank_by,
+          breakdown_attribute: breakdown_attribute,
+          metric_key: metric_key,
+          metric_name: metric_name,
+          points_system_key: points_system_key,
+          points_system_name: points_system_name,
+          description: description,
+          start: start,
+          end_: end_,
+          max_participants: max_participants,
+          run_unit: run_unit,
+          run_interval: run_interval,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of LeaderboardsAllResponseItem 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.status.is_a?(TrophyApiClient::Leaderboards::LeaderboardsAllResponseItemStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        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.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
+        obj.rank_by.is_a?(TrophyApiClient::LeaderboardResponseRankBy) != false || raise("Passed value for field obj.rank_by is not the expected type, validation failed.")
+        obj.breakdown_attribute&.is_a?(String) != false || raise("Passed value for field obj.breakdown_attribute is not the expected type, validation failed.")
+        obj.metric_key&.is_a?(String) != false || raise("Passed value for field obj.metric_key is not the expected type, validation failed.")
+        obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
+        obj.points_system_key&.is_a?(String) != false || raise("Passed value for field obj.points_system_key is not the expected type, validation failed.")
+        obj.points_system_name&.is_a?(String) != false || raise("Passed value for field obj.points_system_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.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.max_participants.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
+        obj.run_unit&.is_a?(TrophyApiClient::LeaderboardResponseRunUnit) != false || raise("Passed value for field obj.run_unit is not the expected type, validation failed.")
+        obj.run_interval.is_a?(Integer) != false || raise("Passed value for field obj.run_interval is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  class Leaderboards
+    # The status of the leaderboard.
+    class LeaderboardsAllResponseItemStatus
+      ACTIVE = "active"
+      SCHEDULED = "scheduled"
+      FINISHED = "finished"
+    end
+  end
+end

data/lib/trophy_api_client/metrics/client.rb

@@ -42,7 +42,7 @@ module TrophyApiClient
     #  api.metrics.event(
     #    idempotency_key: "e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f",
     #    key: "words-written",
-    #    user: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" }, id: "18" },
+    #    user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "18" },
     #    value: 750,
     #    attributes: { "category": "writing", "source": "mobile-app" }
     #  )
@@ -107,7 +107,7 @@ module TrophyApiClient
     #  api.metrics.event(
     #    idempotency_key: "e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f",
     #    key: "words-written",
-    #    user: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" }, id: "18" },
+    #    user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "18" },
     #    value: 750,
     #    attributes: { "category": "writing", "source": "mobile-app" }
     #  )

data/lib/trophy_api_client/points/client.rb

@@ -21,8 +21,8 @@ module TrophyApiClient
     #
     # @param key [String] Key of the points system.
     # @param user_attributes [String] Optional colon-delimited user attribute filters in the format
-    #  attributeKey:value,attributeKey:value. Only users matching ALL specified
-    #  attributes will be included in the points breakdown.
+    #  attribute:value,attribute:value. Only users matching ALL specified attributes
+    #  will be included in the points breakdown.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::POINTS_SUMMARY_RESPONSE]
     # @example
@@ -104,8 +104,8 @@ module TrophyApiClient
     #
     # @param key [String] Key of the points system.
     # @param user_attributes [String] Optional colon-delimited user attribute filters in the format
-    #  attributeKey:value,attributeKey:value. Only users matching ALL specified
-    #  attributes will be included in the points breakdown.
+    #  attribute:value,attribute:value. Only users matching ALL specified attributes
+    #  will be included in the points breakdown.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::POINTS_SUMMARY_RESPONSE]
     # @example

data/lib/trophy_api_client/streaks/client.rb

@@ -65,7 +65,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.streaks.rankings
+    #  api.streaks.rankings(limit: 1, type: ACTIVE)
     def rankings(limit: nil, type: 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?
@@ -148,7 +148,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.streaks.rankings
+    #  api.streaks.rankings(limit: 1, type: ACTIVE)
     def rankings(limit: nil, type: nil, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|

data/lib/trophy_api_client/types/achievement_completion_response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "completed_achievement_response"
+require_relative "achievement_completion_response_achievement"
 require "ostruct"
 require "json"
 
@@ -8,7 +8,7 @@ module TrophyApiClient
   class AchievementCompletionResponse
     # @return [String] The unique ID of the completion.
     attr_reader :completion_id
-    # @return [TrophyApiClient::CompletedAchievementResponse]
+    # @return [TrophyApiClient::AchievementCompletionResponseAchievement]
     attr_reader :achievement
     # @return [Hash{String => TrophyApiClient::MetricEventPointsResponse}] A map of points systems by key that were affected by this achievement
     #  completion.
@@ -22,19 +22,17 @@ module TrophyApiClient
     OMIT = Object.new
 
     # @param completion_id [String] The unique ID of the completion.
-    # @param achievement [TrophyApiClient::CompletedAchievementResponse]
+    # @param achievement [TrophyApiClient::AchievementCompletionResponseAchievement]
     # @param points [Hash{String => TrophyApiClient::MetricEventPointsResponse}] A map of points systems by key that were affected by this achievement
     #  completion.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::AchievementCompletionResponse]
-    def initialize(completion_id:, achievement:, points: OMIT, additional_properties: nil)
+    def initialize(completion_id:, achievement:, points:, additional_properties: nil)
       @completion_id = completion_id
       @achievement = achievement
-      @points = points if points != OMIT
+      @points = points
       @additional_properties = additional_properties
-      @_field_set = { "completionId": completion_id, "achievement": achievement, "points": points }.reject do |_k, v|
-        v == OMIT
-      end
+      @_field_set = { "completionId": completion_id, "achievement": achievement, "points": points }
     end
 
     # Deserialize a JSON object to an instance of AchievementCompletionResponse
@@ -49,7 +47,7 @@ module TrophyApiClient
         achievement = nil
       else
         achievement = parsed_json["achievement"].to_json
-        achievement = TrophyApiClient::CompletedAchievementResponse.from_json(json_object: achievement)
+        achievement = TrophyApiClient::AchievementCompletionResponseAchievement.from_json(json_object: achievement)
       end
       points = parsed_json["points"]&.transform_values do |value|
         value = value.to_json
@@ -78,8 +76,8 @@ module TrophyApiClient
     # @return [Void]
     def self.validate_raw(obj:)
       obj.completion_id.is_a?(String) != false || raise("Passed value for field obj.completion_id is not the expected type, validation failed.")
-      TrophyApiClient::CompletedAchievementResponse.validate_raw(obj: obj.achievement)
-      obj.points&.is_a?(Hash) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+      TrophyApiClient::AchievementCompletionResponseAchievement.validate_raw(obj: obj.achievement)
+      obj.points.is_a?(Hash) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
     end
   end
 end