trophy_api_client 1.0.40 → 1.1.0.pre.beta.4

data/lib/trophy_api_client/users/client.rb

@@ -4,6 +4,8 @@ require_relative "../../requests"
 require_relative "../types/upserted_user"
 require_relative "../types/user"
 require_relative "../types/updated_user"
+require_relative "../types/user_preferences_response"
+require_relative "../types/notification_preferences"
 require_relative "../types/metric_response"
 require "json"
 require_relative "types/users_metric_event_summary_request_aggregation"
@@ -11,6 +13,7 @@ require_relative "types/users_metric_event_summary_response_item"
 require_relative "../types/user_achievement_with_stats_response"
 require_relative "../types/streak_response"
 require_relative "../types/get_user_points_response"
+require_relative "../types/points_boost"
 require_relative "types/users_points_event_summary_request_aggregation"
 require_relative "types/users_points_event_summary_response_item"
 require_relative "../types/user_leaderboard_response_with_history"
@@ -171,6 +174,73 @@ module TrophyApiClient
       TrophyApiClient::User.from_json(json_object: response.body)
     end
 
+    # Get a user's notification preferences.
+    #
+    # @param id [String] The user's ID in your database.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::UserPreferencesResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.get_preferences(id: "user-123")
+    def get_preferences(id:, 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
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(environment: api, request_options: request_options)}/users/#{id}/preferences"
+      end
+      TrophyApiClient::UserPreferencesResponse.from_json(json_object: response.body)
+    end
+
+    # Update a user's notification preferences.
+    #
+    # @param id [String] The user's ID in your database.
+    # @param notifications [Hash] Request of type TrophyApiClient::NotificationPreferences, as a Hash
+    #   * :achievement_completed (Array<TrophyApiClient::NotificationChannel>)
+    #   * :recap (Array<TrophyApiClient::NotificationChannel>)
+    #   * :reactivation (Array<TrophyApiClient::NotificationChannel>)
+    #   * :streak_reminder (Array<TrophyApiClient::NotificationChannel>)
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::UserPreferencesResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.update_preferences(id: "user-123", notifications: { streak_reminder: [EMAIL] })
+    def update_preferences(id:, notifications: nil, 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?
+        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 || {}), notifications: notifications }.compact
+        req.url "#{@request_client.get_url(environment: api, request_options: request_options)}/users/#{id}/preferences"
+      end
+      TrophyApiClient::UserPreferencesResponse.from_json(json_object: response.body)
+    end
+
     # Get a single user's progress against all active metrics.
     #
     # @param id [String] ID of the user
@@ -406,6 +476,45 @@ module TrophyApiClient
       TrophyApiClient::GetUserPointsResponse.from_json(json_object: response.body)
     end
 
+    # Get active points boosts for a user in a specific points system. Returns both
+    #  global boosts the user is eligible for and user-specific boosts.
+    #
+    # @param id [String] ID of the user.
+    # @param key [String] Key of the points system.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::PointsBoost>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.points_boosts(id: "userId", key: "points-system-key")
+    def points_boosts(id:, key:, 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
+        unless request_options.nil? || request_options&.additional_query_parameters.nil?
+          req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+        end
+        unless request_options.nil? || request_options&.additional_body_parameters.nil?
+          req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        req.url "#{@request_client.get_url(environment: api,
+                                           request_options: request_options)}/users/#{id}/points/#{key}/boosts"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::PointsBoost.from_json(json_object: item)
+      end
+    end
+
     # Get a summary of points awards over time for a user for a specific points
     #  system.
     #
@@ -697,6 +806,79 @@ module TrophyApiClient
       end
     end
 
+    # Get a user's notification preferences.
+    #
+    # @param id [String] The user's ID in your database.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::UserPreferencesResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.get_preferences(id: "user-123")
+    def get_preferences(id:, 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
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(environment: api,
+                                             request_options: request_options)}/users/#{id}/preferences"
+        end
+        TrophyApiClient::UserPreferencesResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Update a user's notification preferences.
+    #
+    # @param id [String] The user's ID in your database.
+    # @param notifications [Hash] Request of type TrophyApiClient::NotificationPreferences, as a Hash
+    #   * :achievement_completed (Array<TrophyApiClient::NotificationChannel>)
+    #   * :recap (Array<TrophyApiClient::NotificationChannel>)
+    #   * :reactivation (Array<TrophyApiClient::NotificationChannel>)
+    #   * :streak_reminder (Array<TrophyApiClient::NotificationChannel>)
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::UserPreferencesResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.update_preferences(id: "user-123", notifications: { streak_reminder: [EMAIL] })
+    def update_preferences(id:, notifications: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.patch 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 || {}), notifications: notifications }.compact
+          req.url "#{@request_client.get_url(environment: api,
+                                             request_options: request_options)}/users/#{id}/preferences"
+        end
+        TrophyApiClient::UserPreferencesResponse.from_json(json_object: response.body)
+      end
+    end
+
     # Get a single user's progress against all active metrics.
     #
     # @param id [String] ID of the user
@@ -944,6 +1126,47 @@ module TrophyApiClient
       end
     end
 
+    # Get active points boosts for a user in a specific points system. Returns both
+    #  global boosts the user is eligible for and user-specific boosts.
+    #
+    # @param id [String] ID of the user.
+    # @param key [String] Key of the points system.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::PointsBoost>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::PRODUCTION,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.points_boosts(id: "userId", key: "points-system-key")
+    def points_boosts(id:, key:, 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
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(environment: api,
+                                             request_options: request_options)}/users/#{id}/points/#{key}/boosts"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::PointsBoost.from_json(json_object: item)
+        end
+      end
+    end
+
     # Get a summary of points awards over time for a user for a specific points
     #  system.
     #

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.40"
+  VERSION = "1.1.0-beta.4"
 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/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/types/restore_streaks_request_users_item"
+require_relative "trophy_api_client/admin/points/boosts/types/create_points_boosts_request_boosts_item_rounding"
+require_relative "trophy_api_client/admin/points/boosts/types/create_points_boosts_request_boosts_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"
@@ -16,6 +18,8 @@ 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_points_boost_started_payload"
+require_relative "trophy_api_client/types/webhooks_points_boost_finished_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"
@@ -32,6 +36,12 @@ 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/points_boost_status"
+require_relative "trophy_api_client/types/points_boost_rounding"
+require_relative "trophy_api_client/types/points_boost"
+require_relative "trophy_api_client/types/points_boost_webhook_payload_status"
+require_relative "trophy_api_client/types/points_boost_webhook_payload_rounding"
+require_relative "trophy_api_client/types/points_boost_webhook_payload"
 require_relative "trophy_api_client/types/get_user_points_response"
 require_relative "trophy_api_client/types/leaderboard_response_rank_by"
 require_relative "trophy_api_client/types/leaderboard_response_run_unit"
@@ -51,6 +61,10 @@ require_relative "trophy_api_client/types/metric_response"
 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/notification_channel"
+require_relative "trophy_api_client/types/notification_type"
+require_relative "trophy_api_client/types/notification_preferences"
+require_relative "trophy_api_client/types/user_preferences_response"
 require_relative "trophy_api_client/types/error_body"
 require_relative "trophy_api_client/types/achievement_completion_response"
 require_relative "trophy_api_client/types/event_response"
@@ -70,6 +84,11 @@ 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/created_points_boost_status"
+require_relative "trophy_api_client/types/created_points_boost_rounding"
+require_relative "trophy_api_client/types/created_points_boost"
+require_relative "trophy_api_client/types/create_points_boosts_response"
+require_relative "trophy_api_client/types/archive_points_boosts_response"
 require_relative "trophy_api_client/types/restore_streaks_response"
 require_relative "trophy_api_client/types/bulk_insert_issue_level"
 require_relative "trophy_api_client/types/bulk_insert_issue"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.40
+  version: 1.1.0.pre.beta.4
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -101,6 +101,10 @@ files:
 - lib/trophy_api_client.rb
 - lib/trophy_api_client/achievements/client.rb
 - lib/trophy_api_client/admin/client.rb
+- lib/trophy_api_client/admin/points/boosts/client.rb
+- lib/trophy_api_client/admin/points/boosts/types/create_points_boosts_request_boosts_item.rb
+- lib/trophy_api_client/admin/points/boosts/types/create_points_boosts_request_boosts_item_rounding.rb
+- lib/trophy_api_client/admin/points/client.rb
 - lib/trophy_api_client/admin/streaks/client.rb
 - lib/trophy_api_client/admin/streaks/freezes/client.rb
 - lib/trophy_api_client/admin/streaks/freezes/types/create_streak_freezes_request_freezes_item.rb
@@ -118,12 +122,17 @@ files:
 - lib/trophy_api_client/types/achievement_response_trigger.rb
 - lib/trophy_api_client/types/achievement_response_user_attributes_item.rb
 - lib/trophy_api_client/types/achievement_with_stats_response.rb
+- lib/trophy_api_client/types/archive_points_boosts_response.rb
 - lib/trophy_api_client/types/base_streak_response.rb
 - lib/trophy_api_client/types/bulk_insert_issue.rb
 - lib/trophy_api_client/types/bulk_insert_issue_level.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/create_points_boosts_response.rb
 - lib/trophy_api_client/types/create_streak_freezes_response.rb
+- lib/trophy_api_client/types/created_points_boost.rb
+- lib/trophy_api_client/types/created_points_boost_rounding.rb
+- lib/trophy_api_client/types/created_points_boost_status.rb
 - lib/trophy_api_client/types/error_body.rb
 - lib/trophy_api_client/types/event_response.rb
 - lib/trophy_api_client/types/get_user_points_response.rb
@@ -139,7 +148,16 @@ files:
 - lib/trophy_api_client/types/metric_event_streak_response.rb
 - lib/trophy_api_client/types/metric_response.rb
 - lib/trophy_api_client/types/metric_status.rb
+- lib/trophy_api_client/types/notification_channel.rb
+- lib/trophy_api_client/types/notification_preferences.rb
+- lib/trophy_api_client/types/notification_type.rb
 - lib/trophy_api_client/types/points_award.rb
+- lib/trophy_api_client/types/points_boost.rb
+- lib/trophy_api_client/types/points_boost_rounding.rb
+- lib/trophy_api_client/types/points_boost_status.rb
+- lib/trophy_api_client/types/points_boost_webhook_payload.rb
+- lib/trophy_api_client/types/points_boost_webhook_payload_rounding.rb
+- lib/trophy_api_client/types/points_boost_webhook_payload_status.rb
 - lib/trophy_api_client/types/points_range.rb
 - lib/trophy_api_client/types/points_summary_response.rb
 - lib/trophy_api_client/types/points_system_response.rb
@@ -164,12 +182,15 @@ files:
 - lib/trophy_api_client/types/user_achievement_with_stats_response.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/user_preferences_response.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_boost_finished_payload.rb
+- lib/trophy_api_client/types/webhooks_points_boost_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
@@ -214,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Ruby library for the Trophy API.
 test_files: []