trophy_api_client 1.0.19 → 1.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d767c67c359d85255fda71dfc5b23dfdbd7ec7703a02843e025c593da2604a
-  data.tar.gz: d661b2fb934daeb5f28d2189646fb3c09294f3f05db4b3454f3f4c2cc337babd
+  metadata.gz: 68357394d52195a47c44fc9355befe6eca436547e932e74dd0efa10f7c01821e
+  data.tar.gz: d081f45005de17054f0acefc19e113e0a7788b73e8e3c1e942e66b7dbb4d90ee
 SHA512:
-  metadata.gz: 6310df4c2f5a5fcf9a10a1134bbe38860c32fb0ab7af8715c07335152461d8bf8fd1cd1026dd3286a28e80ac31d4e3f9e3d06413ad91d138ba834d26d1773cbb
-  data.tar.gz: 41ec09de29b07a35735a5f188aabcf7cf29e0e14f9c661caf0f15138efc8c153403edec02346e05d89d2fd3b095367f83f7c747c1ef81920355f9e98b33eb902
+  metadata.gz: d955c1f044f150e062e4740398028483d22935eb76a475f45a7fc13118767c6b6c3f2ac4dd032b7cd7a013e8e2aae7113598efe220c4e9f4d1f6fc0b1531894d
+  data.tar.gz: b5b9402673a5981686b77aae50db69e28ddb683dddcd2db4a02471e23299868313361dcaa683d4ce9128cd767476854fe6d6e57bc9d925ac1e9ea9e0c3c7ded9

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/streaks/client.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
+require_relative "../types/bulk_streak_response"
+require "json"
 require_relative "types/streaks_rankings_request_type"
 require_relative "../types/streak_ranking_user"
-require "json"
 require "async"
 
 module TrophyApiClient
@@ -17,6 +18,41 @@ module TrophyApiClient
       @request_client = request_client
     end
 
+    # Get the streak lengths of a list of users, ranked by streak length from longest
+    #  to shortest.
+    #
+    # @param user_ids [String] A list of up to 100 user IDs.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::BULK_STREAK_RESPONSE]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.streaks.list
+    def list(user_ids: 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 || {}), "userIds": user_ids }.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(request_options: request_options)}/streaks"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::BulkStreakResponseItem.from_json(json_object: item)
+      end
+    end
+
     # Get the top users by streak length (active or longest).
     #
     # @param limit [Integer] Number of users to return. Must be between 1 and 100.
@@ -63,6 +99,43 @@ module TrophyApiClient
       @request_client = request_client
     end
 
+    # Get the streak lengths of a list of users, ranked by streak length from longest
+    #  to shortest.
+    #
+    # @param user_ids [String] A list of up to 100 user IDs.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::BULK_STREAK_RESPONSE]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.streaks.list
+    def list(user_ids: 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 || {}), "userIds": user_ids }.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(request_options: request_options)}/streaks"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::BulkStreakResponseItem.from_json(json_object: item)
+        end
+      end
+    end
+
     # Get the top users by streak length (active or longest).
     #
     # @param limit [Integer] Number of users to return. Must be between 1 and 100.

data/lib/trophy_api_client/types/bulk_streak_response.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "bulk_streak_response_item"
+
+module TrophyApiClient
+  BULK_STREAK_RESPONSE = Array
+end

data/lib/trophy_api_client/types/bulk_streak_response_item.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class BulkStreakResponseItem
+    # @return [String] The ID of the user.
+    attr_reader :user_id
+    # @return [Integer] The length of the user's streak.
+    attr_reader :streak_length
+    # @return [String] The timestamp the streak was extended, as a string.
+    attr_reader :extended
+    # @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_id [String] The ID of the user.
+    # @param streak_length [Integer] The length of the user's streak.
+    # @param extended [String] The timestamp the streak was extended, as a string.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::BulkStreakResponseItem]
+    def initialize(user_id:, streak_length:, extended: OMIT, additional_properties: nil)
+      @user_id = user_id
+      @streak_length = streak_length
+      @extended = extended if extended != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "userId": user_id, "streakLength": streak_length, "extended": extended }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of BulkStreakResponseItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::BulkStreakResponseItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      user_id = parsed_json["userId"]
+      streak_length = parsed_json["streakLength"]
+      extended = parsed_json["extended"]
+      new(
+        user_id: user_id,
+        streak_length: streak_length,
+        extended: extended,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of BulkStreakResponseItem 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.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
+      obj.streak_length.is_a?(Integer) != false || raise("Passed value for field obj.streak_length is not the expected type, validation failed.")
+      obj.extended&.is_a?(String) != false || raise("Passed value for field obj.extended is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/streak_response.rb

@@ -11,6 +11,8 @@ module TrophyApiClient
     # @return [Array<TrophyApiClient::StreakResponseStreakHistoryItem>] A list of the user's past streak periods up through the current period. Each
     #  period includes the start and end dates and the length of the streak.
     attr_reader :streak_history
+    # @return [Integer] The user's rank across all users. Null if the user has no active streak.
+    attr_reader :rank
     # @return [Integer] The length of the user's current streak.
     attr_reader :length
     # @return [TrophyApiClient::StreakFrequency] The frequency of the streak.
@@ -33,6 +35,7 @@ module TrophyApiClient
 
     # @param streak_history [Array<TrophyApiClient::StreakResponseStreakHistoryItem>] A list of the user's past streak periods up through the current period. Each
     #  period includes the start and end dates and the length of the streak.
+    # @param rank [Integer] The user's rank across all users. Null if the user has no active streak.
     # @param length [Integer] The length of the user's current streak.
     # @param frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
     # @param started [String] The date the streak started.
@@ -41,9 +44,10 @@ module TrophyApiClient
     # @param expires [String] The date the streak will expire if the user does not increment a metric.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::StreakResponse]
-    def initialize(length:, frequency:, streak_history: OMIT, started: OMIT, period_start: OMIT, period_end: OMIT,
-                   expires: OMIT, additional_properties: nil)
+    def initialize(length:, frequency:, streak_history: OMIT, rank: OMIT, started: OMIT, period_start: OMIT,
+                   period_end: OMIT, expires: OMIT, additional_properties: nil)
       @streak_history = streak_history if streak_history != OMIT
+      @rank = rank if rank != OMIT
       @length = length
       @frequency = frequency
       @started = started if started != OMIT
@@ -53,6 +57,7 @@ module TrophyApiClient
       @additional_properties = additional_properties
       @_field_set = {
         "streakHistory": streak_history,
+        "rank": rank,
         "length": length,
         "frequency": frequency,
         "started": started,
@@ -75,6 +80,7 @@ module TrophyApiClient
         item = item.to_json
         TrophyApiClient::StreakResponseStreakHistoryItem.from_json(json_object: item)
       end
+      rank = parsed_json["rank"]
       length = parsed_json["length"]
       frequency = parsed_json["frequency"]
       started = parsed_json["started"]
@@ -83,6 +89,7 @@ module TrophyApiClient
       expires = parsed_json["expires"]
       new(
         streak_history: streak_history,
+        rank: rank,
         length: length,
         frequency: frequency,
         started: started,
@@ -108,6 +115,7 @@ module TrophyApiClient
     # @return [Void]
     def self.validate_raw(obj:)
       obj.streak_history&.is_a?(Array) != false || raise("Passed value for field obj.streak_history is not the expected type, validation failed.")
+      obj.rank&.is_a?(Integer) != false || raise("Passed value for field obj.rank is not the expected type, validation failed.")
       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.started&.is_a?(String) != false || raise("Passed value for field obj.started is not the expected type, validation failed.")

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.19"
+  VERSION = "1.0.21"
 end

data/lib/types_export.rb

@@ -8,6 +8,8 @@ require_relative "trophy_api_client/streaks/types/streaks_rankings_request_type"
 require_relative "trophy_api_client/types/metric_status"
 require_relative "trophy_api_client/types/streak_frequency"
 require_relative "trophy_api_client/types/base_streak_response"
+require_relative "trophy_api_client/types/bulk_streak_response_item"
+require_relative "trophy_api_client/types/bulk_streak_response"
 require_relative "trophy_api_client/types/metric_event_streak_response"
 require_relative "trophy_api_client/types/streak_response_streak_history_item"
 require_relative "trophy_api_client/types/streak_response"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.19
+  version: 1.0.21
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -111,6 +111,8 @@ files:
 - lib/trophy_api_client/types/achievement_with_stats_response_event_attribute.rb
 - lib/trophy_api_client/types/achievement_with_stats_response_user_attributes_item.rb
 - lib/trophy_api_client/types/base_streak_response.rb
+- lib/trophy_api_client/types/bulk_streak_response.rb
+- lib/trophy_api_client/types/bulk_streak_response_item.rb
 - lib/trophy_api_client/types/completed_achievement_response.rb
 - lib/trophy_api_client/types/error_body.rb
 - lib/trophy_api_client/types/event_response.rb