trophy_api_client 1.0.29 → 1.0.30

data/lib/trophy_api_client/users/client.rb

@@ -13,7 +13,7 @@ require_relative "../types/streak_response"
 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"
+require_relative "../types/user_leaderboard_response_with_history"
 require "async"
 
 module TrophyApiClient
@@ -45,7 +45,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.create(request: { id: "user-id" })
+    #  api.users.create(request: { email: "user@example.com", name: "User", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "user-id" })
     def create(request:, 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?
@@ -114,7 +114,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.identify(id: "id", request: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" } })
+    #  api.users.identify(id: "id", request: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" } })
     def identify(id:, request:, request_options: nil)
       response = @request_client.conn.put do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -151,7 +151,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.update(id: "id", request: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" } })
+    #  api.users.update(id: "id", request: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" } })
     def update(id:, request:, request_options: nil)
       response = @request_client.conn.patch do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -306,7 +306,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.achievements(id: "userId")
+    #  api.users.achievements(id: "userId", include_incomplete: "true")
     def achievements(id:, include_incomplete: 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?
@@ -346,7 +346,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.streak(id: "userId")
+    #  api.users.streak(id: "userId", history_periods: 1)
     def streak(id:, history_periods: 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?
@@ -381,7 +381,11 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.points(id: "userId", key: "points-system-key")
+    #  api.users.points(
+    #    id: "userId",
+    #    key: "points-system-key",
+    #    awards: 1
+    #  )
     def points(id:, key:, awards: 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?
@@ -461,7 +465,7 @@ module TrophyApiClient
     # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
     #  run.
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [TrophyApiClient::UserLeaderboardResponse]
+    # @return [TrophyApiClient::UserLeaderboardResponseWithHistory]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -489,7 +493,7 @@ module TrophyApiClient
         req.url "#{@request_client.get_url(environment: api,
                                            request_options: request_options)}/users/#{id}/leaderboards/#{key}"
       end
-      TrophyApiClient::UserLeaderboardResponse.from_json(json_object: response.body)
+      TrophyApiClient::UserLeaderboardResponseWithHistory.from_json(json_object: response.body)
     end
   end
 
@@ -521,7 +525,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.create(request: { id: "user-id" })
+    #  api.users.create(request: { email: "user@example.com", name: "User", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "user-id" })
     def create(request:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|
@@ -594,7 +598,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.identify(id: "id", request: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" } })
+    #  api.users.identify(id: "id", request: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" } })
     def identify(id:, request:, request_options: nil)
       Async do
         response = @request_client.conn.put do |req|
@@ -633,7 +637,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.update(id: "id", request: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" } })
+    #  api.users.update(id: "id", request: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" } })
     def update(id:, request:, request_options: nil)
       Async do
         response = @request_client.conn.patch do |req|
@@ -796,7 +800,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.achievements(id: "userId")
+    #  api.users.achievements(id: "userId", include_incomplete: "true")
     def achievements(id:, include_incomplete: nil, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
@@ -838,7 +842,7 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.streak(id: "userId")
+    #  api.users.streak(id: "userId", history_periods: 1)
     def streak(id:, history_periods: nil, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
@@ -875,7 +879,11 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.users.points(id: "userId", key: "points-system-key")
+    #  api.users.points(
+    #    id: "userId",
+    #    key: "points-system-key",
+    #    awards: 1
+    #  )
     def points(id:, key:, awards: nil, request_options: nil)
       Async do
         response = @request_client.conn.get do |req|
@@ -959,7 +967,7 @@ module TrophyApiClient
     # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
     #  run.
     # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [TrophyApiClient::UserLeaderboardResponse]
+    # @return [TrophyApiClient::UserLeaderboardResponseWithHistory]
     # @example
     #  api = TrophyApiClient::Client.new(
     #    base_url: "https://api.example.com",
@@ -988,7 +996,7 @@ module TrophyApiClient
           req.url "#{@request_client.get_url(environment: api,
                                              request_options: request_options)}/users/#{id}/leaderboards/#{key}"
         end
-        TrophyApiClient::UserLeaderboardResponse.from_json(json_object: response.body)
+        TrophyApiClient::UserLeaderboardResponseWithHistory.from_json(json_object: response.body)
       end
     end
   end

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.29"
+  VERSION = "1.0.30"
 end

data/lib/types_export.rb

@@ -5,7 +5,20 @@ require_relative "trophy_api_client/users/types/users_metric_event_summary_respo
 require_relative "trophy_api_client/users/types/users_points_event_summary_request_aggregation"
 require_relative "trophy_api_client/users/types/users_points_event_summary_response_item"
 require_relative "trophy_api_client/streaks/types/streaks_rankings_request_type"
+require_relative "trophy_api_client/leaderboards/types/leaderboards_all_response_item_status"
+require_relative "trophy_api_client/leaderboards/types/leaderboards_all_response_item"
 require_relative "trophy_api_client/admin/streaks/freezes/types/create_streak_freezes_request_freezes_item"
+require_relative "trophy_api_client/types/webhooks_achievement_completed_payload"
+require_relative "trophy_api_client/types/webhooks_streak_started_payload"
+require_relative "trophy_api_client/types/webhooks_streak_extended_payload"
+require_relative "trophy_api_client/types/webhooks_streak_lost_payload"
+require_relative "trophy_api_client/types/webhooks_streak_freeze_consumed_payload"
+require_relative "trophy_api_client/types/webhooks_streak_freeze_earned_payload"
+require_relative "trophy_api_client/types/webhooks_points_changed_payload"
+require_relative "trophy_api_client/types/webhooks_leaderboard_started_payload"
+require_relative "trophy_api_client/types/webhooks_leaderboard_changed_payload"
+require_relative "trophy_api_client/types/webhooks_leaderboard_finished_payload"
+require_relative "trophy_api_client/types/webhooks_leaderboard_rank_changed_payload"
 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"
@@ -15,12 +28,14 @@ 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"
 require_relative "trophy_api_client/types/points_trigger_type"
+require_relative "trophy_api_client/types/points_trigger_time_unit"
 require_relative "trophy_api_client/types/points_trigger"
 require_relative "trophy_api_client/types/points_award"
 require_relative "trophy_api_client/types/get_user_points_response"
-require_relative "trophy_api_client/types/leaderboard_response_status"
 require_relative "trophy_api_client/types/leaderboard_response_rank_by"
+require_relative "trophy_api_client/types/leaderboard_response_run_unit"
 require_relative "trophy_api_client/types/leaderboard_response"
+require_relative "trophy_api_client/types/leaderboard_response_with_rankings_status"
 require_relative "trophy_api_client/types/leaderboard_response_with_rankings"
 require_relative "trophy_api_client/types/metric_event_points_response"
 require_relative "trophy_api_client/types/metric_event_leaderboard_response"
@@ -35,12 +50,14 @@ require_relative "trophy_api_client/types/updated_user"
 require_relative "trophy_api_client/types/upserted_user"
 require_relative "trophy_api_client/types/user"
 require_relative "trophy_api_client/types/error_body"
+require_relative "trophy_api_client/types/achievement_completion_response_achievement"
 require_relative "trophy_api_client/types/achievement_completion_response"
 require_relative "trophy_api_client/types/event_response"
 require_relative "trophy_api_client/types/points_range"
 require_relative "trophy_api_client/types/points_summary_response"
 require_relative "trophy_api_client/types/points_trigger_response_type"
 require_relative "trophy_api_client/types/points_trigger_response_status"
+require_relative "trophy_api_client/types/points_trigger_response_time_unit"
 require_relative "trophy_api_client/types/points_trigger_response_user_attributes_item"
 require_relative "trophy_api_client/types/points_trigger_response_event_attribute"
 require_relative "trophy_api_client/types/points_trigger_response"
@@ -49,6 +66,8 @@ require_relative "trophy_api_client/types/streak_ranking_user"
 require_relative "trophy_api_client/types/leaderboard_ranking"
 require_relative "trophy_api_client/types/leaderboard_event"
 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/bulk_insert_issue_level"
 require_relative "trophy_api_client/types/bulk_insert_issue"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.29
+  version: 1.0.30
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -105,11 +105,14 @@ files:
 - lib/trophy_api_client/admin/streaks/freezes/client.rb
 - lib/trophy_api_client/admin/streaks/freezes/types/create_streak_freezes_request_freezes_item.rb
 - lib/trophy_api_client/leaderboards/client.rb
+- lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item.rb
+- lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item_status.rb
 - lib/trophy_api_client/metrics/client.rb
 - lib/trophy_api_client/points/client.rb
 - lib/trophy_api_client/streaks/client.rb
 - lib/trophy_api_client/streaks/types/streaks_rankings_request_type.rb
 - lib/trophy_api_client/types/achievement_completion_response.rb
+- lib/trophy_api_client/types/achievement_completion_response_achievement.rb
 - lib/trophy_api_client/types/achievement_response.rb
 - lib/trophy_api_client/types/achievement_response_trigger.rb
 - lib/trophy_api_client/types/achievement_with_stats_response.rb
@@ -129,8 +132,9 @@ files:
 - lib/trophy_api_client/types/leaderboard_ranking.rb
 - lib/trophy_api_client/types/leaderboard_response.rb
 - lib/trophy_api_client/types/leaderboard_response_rank_by.rb
-- lib/trophy_api_client/types/leaderboard_response_status.rb
+- lib/trophy_api_client/types/leaderboard_response_run_unit.rb
 - lib/trophy_api_client/types/leaderboard_response_with_rankings.rb
+- lib/trophy_api_client/types/leaderboard_response_with_rankings_status.rb
 - lib/trophy_api_client/types/metric_event_leaderboard_response.rb
 - lib/trophy_api_client/types/metric_event_points_response.rb
 - lib/trophy_api_client/types/metric_event_streak_response.rb
@@ -144,8 +148,10 @@ files:
 - lib/trophy_api_client/types/points_trigger_response.rb
 - lib/trophy_api_client/types/points_trigger_response_event_attribute.rb
 - lib/trophy_api_client/types/points_trigger_response_status.rb
+- lib/trophy_api_client/types/points_trigger_response_time_unit.rb
 - lib/trophy_api_client/types/points_trigger_response_type.rb
 - 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/streak_frequency.rb
 - lib/trophy_api_client/types/streak_ranking_user.rb
@@ -155,6 +161,19 @@ files:
 - lib/trophy_api_client/types/upserted_user.rb
 - lib/trophy_api_client/types/user.rb
 - lib/trophy_api_client/types/user_leaderboard_response.rb
+- lib/trophy_api_client/types/user_leaderboard_response_with_history.rb
+- lib/trophy_api_client/types/webhook_user_leaderboard_response.rb
+- lib/trophy_api_client/types/webhooks_achievement_completed_payload.rb
+- lib/trophy_api_client/types/webhooks_leaderboard_changed_payload.rb
+- lib/trophy_api_client/types/webhooks_leaderboard_finished_payload.rb
+- lib/trophy_api_client/types/webhooks_leaderboard_rank_changed_payload.rb
+- lib/trophy_api_client/types/webhooks_leaderboard_started_payload.rb
+- lib/trophy_api_client/types/webhooks_points_changed_payload.rb
+- lib/trophy_api_client/types/webhooks_streak_extended_payload.rb
+- lib/trophy_api_client/types/webhooks_streak_freeze_consumed_payload.rb
+- 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/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