trophy_api_client 1.0.40 → 1.0.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccada1b1f574255085097fba1ef98806380bead4795e66a98db917bf82391e4b
-  data.tar.gz: c27e60901c8bb55bba1b03b62fac00e247bebdbb16bbd64e9049e27cb7a36cab
+  metadata.gz: 77265cbb3258c3a5737b4f7649d1b12a3924b65189193ce24a7d7d585c05abbc
+  data.tar.gz: d9fe18d5ec1d18e0d4bbb4ceeb03b604f4182dcd3b36061246402cdad68cae01
 SHA512:
-  metadata.gz: d8b112fe94fffcf2c31241bcc91279d184d55dd9b95c0ab10f82d3c122ce60b1427b324f76eb895c9b3f3ef00e9a0b8325f8a0f915ea98eaa1e160180e83d1ae
-  data.tar.gz: 28e86210d2381bf56dfba0c43822085ed6042aa955c2bf462147ef097cf0fe9f852ea99d11bbdbe9a0f0fd5618b3179ba6b3d70eb993d673b735424670a6188e
+  metadata.gz: 6d456b11f213ebcade5b49769e45a93c7cfea3f2e2caa26c22cc2f9ae740955bd37c1e4ad36773011386d49765388cca31ac5c4be1470b72b0f7e8eae9895dc7
+  data.tar.gz: 19cceac7fbc0c7c077de7c42cc0c12eb11ff85fed52f87548accfc28bc3e39f6dbdaf3d6366b98bea37c472a9f9a6a10c677e03d1f1aac993edbd2df48d9aee6

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/types/notification_channel.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # A notification delivery channel.
+  class NotificationChannel
+    EMAIL = "email"
+    PUSH = "push"
+  end
+end

data/lib/trophy_api_client/types/notification_preferences.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require_relative "notification_channel"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Notification preferences for each notification type.
+  class NotificationPreferences
+    # @return [Array<TrophyApiClient::NotificationChannel>] Channels to receive achievement completion notifications on.
+    attr_reader :achievement_completed
+    # @return [Array<TrophyApiClient::NotificationChannel>] Channels to receive recap notifications on.
+    attr_reader :recap
+    # @return [Array<TrophyApiClient::NotificationChannel>] Channels to receive reactivation notifications on.
+    attr_reader :reactivation
+    # @return [Array<TrophyApiClient::NotificationChannel>] Channels to receive streak reminder notifications on.
+    attr_reader :streak_reminder
+    # @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 achievement_completed [Array<TrophyApiClient::NotificationChannel>] Channels to receive achievement completion notifications on.
+    # @param recap [Array<TrophyApiClient::NotificationChannel>] Channels to receive recap notifications on.
+    # @param reactivation [Array<TrophyApiClient::NotificationChannel>] Channels to receive reactivation notifications on.
+    # @param streak_reminder [Array<TrophyApiClient::NotificationChannel>] Channels to receive streak reminder notifications on.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::NotificationPreferences]
+    def initialize(achievement_completed: OMIT, recap: OMIT, reactivation: OMIT, streak_reminder: OMIT,
+                   additional_properties: nil)
+      @achievement_completed = achievement_completed if achievement_completed != OMIT
+      @recap = recap if recap != OMIT
+      @reactivation = reactivation if reactivation != OMIT
+      @streak_reminder = streak_reminder if streak_reminder != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "achievement_completed": achievement_completed,
+        "recap": recap,
+        "reactivation": reactivation,
+        "streak_reminder": streak_reminder
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of NotificationPreferences
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::NotificationPreferences]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      achievement_completed = parsed_json["achievement_completed"]
+      recap = parsed_json["recap"]
+      reactivation = parsed_json["reactivation"]
+      streak_reminder = parsed_json["streak_reminder"]
+      new(
+        achievement_completed: achievement_completed,
+        recap: recap,
+        reactivation: reactivation,
+        streak_reminder: streak_reminder,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of NotificationPreferences 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.achievement_completed&.is_a?(Array) != false || raise("Passed value for field obj.achievement_completed is not the expected type, validation failed.")
+      obj.recap&.is_a?(Array) != false || raise("Passed value for field obj.recap is not the expected type, validation failed.")
+      obj.reactivation&.is_a?(Array) != false || raise("Passed value for field obj.reactivation is not the expected type, validation failed.")
+      obj.streak_reminder&.is_a?(Array) != false || raise("Passed value for field obj.streak_reminder is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/notification_type.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # A type of notification that can be configured.
+  class NotificationType
+    ACHIEVEMENT_COMPLETED = "achievement_completed"
+    RECAP = "recap"
+    REACTIVATION = "reactivation"
+    STREAK_REMINDER = "streak_reminder"
+  end
+end

data/lib/trophy_api_client/types/user_preferences_response.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "notification_preferences"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A user's preferences.
+  class UserPreferencesResponse
+    # @return [TrophyApiClient::NotificationPreferences]
+    attr_reader :notifications
+    # @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 notifications [TrophyApiClient::NotificationPreferences]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::UserPreferencesResponse]
+    def initialize(notifications:, additional_properties: nil)
+      @notifications = notifications
+      @additional_properties = additional_properties
+      @_field_set = { "notifications": notifications }
+    end
+
+    # Deserialize a JSON object to an instance of UserPreferencesResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::UserPreferencesResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      if parsed_json["notifications"].nil?
+        notifications = nil
+      else
+        notifications = parsed_json["notifications"].to_json
+        notifications = TrophyApiClient::NotificationPreferences.from_json(json_object: notifications)
+      end
+      new(notifications: notifications, additional_properties: struct)
+    end
+
+    # Serialize an instance of UserPreferencesResponse 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:)
+      TrophyApiClient::NotificationPreferences.validate_raw(obj: obj.notifications)
+    end
+  end
+end

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"
@@ -171,6 +173,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
@@ -697,6 +766,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

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.40"
+  VERSION = "1.0.42"
 end

data/lib/types_export.rb

@@ -51,6 +51,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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.40
+  version: 1.0.42
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -139,6 +139,9 @@ 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_range.rb
 - lib/trophy_api_client/types/points_summary_response.rb
@@ -164,6 +167,7 @@ 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
@@ -214,7 +218,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: []