trophy_api_client 1.0.10 → 1.0.11

data/lib/trophy_api_client/users/client.rb

@@ -10,6 +10,9 @@ require_relative "types/users_metric_event_summary_request_aggregation"
 require_relative "types/users_metric_event_summary_response_item"
 require_relative "../types/completed_achievement_response"
 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 "async"
 
 module TrophyApiClient
@@ -315,6 +318,86 @@ module TrophyApiClient
       end
       TrophyApiClient::StreakResponse.from_json(json_object: response.body)
     end
+
+    # Get a user's points.
+    #
+    # @param id [String] ID of the user.
+    # @param awards [Integer] The number of recent point awards to return.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::GetUserPointsResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.points(id: "userId")
+    def points(id:, 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?
+        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 || {}), "awards": awards }.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)}/users/#{id}/points"
+      end
+      TrophyApiClient::GetUserPointsResponse.from_json(json_object: response.body)
+    end
+
+    # Get a summary of points awards over time for a user.
+    #
+    # @param id [String] ID of the user.
+    # @param aggregation [TrophyApiClient::Users::UsersPointsEventSummaryRequestAggregation] The time period over which to aggregate the event data.
+    # @param start_date [String] The start date for the data range in YYYY-MM-DD format. The startDate must be
+    #  before the endDate, and the date range must not exceed 400 days.
+    # @param end_date [String] The end date for the data range in YYYY-MM-DD format. The endDate must be after
+    #  the startDate, and the date range must not exceed 400 days.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::Users::UsersPointsEventSummaryResponseItem>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.points_event_summary(
+    #    id: "userId",
+    #    aggregation: DAILY,
+    #    start_date: "2024-01-01",
+    #    end_date: "2024-01-31"
+    #  )
+    def points_event_summary(id:, aggregation:, start_date:, end_date:, 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 || {}),
+          "aggregation": aggregation,
+          "startDate": start_date,
+          "endDate": end_date
+        }.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)}/users/#{id}/points/event-summary"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        TrophyApiClient::Users::UsersPointsEventSummaryResponseItem.from_json(json_object: item)
+      end
+    end
   end
 
   class AsyncUsersClient
@@ -635,5 +718,89 @@ module TrophyApiClient
         TrophyApiClient::StreakResponse.from_json(json_object: response.body)
       end
     end
+
+    # Get a user's points.
+    #
+    # @param id [String] ID of the user.
+    # @param awards [Integer] The number of recent point awards to return.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::GetUserPointsResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.points(id: "userId")
+    def points(id:, awards: 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 || {}), "awards": awards }.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)}/users/#{id}/points"
+        end
+        TrophyApiClient::GetUserPointsResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Get a summary of points awards over time for a user.
+    #
+    # @param id [String] ID of the user.
+    # @param aggregation [TrophyApiClient::Users::UsersPointsEventSummaryRequestAggregation] The time period over which to aggregate the event data.
+    # @param start_date [String] The start date for the data range in YYYY-MM-DD format. The startDate must be
+    #  before the endDate, and the date range must not exceed 400 days.
+    # @param end_date [String] The end date for the data range in YYYY-MM-DD format. The endDate must be after
+    #  the startDate, and the date range must not exceed 400 days.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [Array<TrophyApiClient::Users::UsersPointsEventSummaryResponseItem>]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.users.points_event_summary(
+    #    id: "userId",
+    #    aggregation: DAILY,
+    #    start_date: "2024-01-01",
+    #    end_date: "2024-01-31"
+    #  )
+    def points_event_summary(id:, aggregation:, start_date:, end_date:, 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 || {}),
+            "aggregation": aggregation,
+            "startDate": start_date,
+            "endDate": end_date
+          }.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)}/users/#{id}/points/event-summary"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::Users::UsersPointsEventSummaryResponseItem.from_json(json_object: item)
+        end
+      end
+    end
   end
 end

data/lib/trophy_api_client/users/types/users_points_event_summary_request_aggregation.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  class Users
+    class UsersPointsEventSummaryRequestAggregation
+      DAILY = "daily"
+      WEEKLY = "weekly"
+      MONTHLY = "monthly"
+    end
+  end
+end

data/lib/trophy_api_client/users/types/users_points_event_summary_response_item.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class Users
+    class UsersPointsEventSummaryResponseItem
+      # @return [String] The date of the data point. For weekly or monthly aggregations, this is the
+      #  first date of the period.
+      attr_reader :date
+      # @return [Float] The user's total points at the end of this date.
+      attr_reader :total
+      # @return [Float] The change in the user's total points during this period.
+      attr_reader :change
+      # @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 date [String] The date of the data point. For weekly or monthly aggregations, this is the
+      #  first date of the period.
+      # @param total [Float] The user's total points at the end of this date.
+      # @param change [Float] The change in the user's total points during this period.
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [TrophyApiClient::Users::UsersPointsEventSummaryResponseItem]
+      def initialize(date:, total:, change:, additional_properties: nil)
+        @date = date
+        @total = total
+        @change = change
+        @additional_properties = additional_properties
+        @_field_set = { "date": date, "total": total, "change": change }
+      end
+
+      # Deserialize a JSON object to an instance of UsersPointsEventSummaryResponseItem
+      #
+      # @param json_object [String]
+      # @return [TrophyApiClient::Users::UsersPointsEventSummaryResponseItem]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        date = parsed_json["date"]
+        total = parsed_json["total"]
+        change = parsed_json["change"]
+        new(
+          date: date,
+          total: total,
+          change: change,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of UsersPointsEventSummaryResponseItem 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.date.is_a?(String) != false || raise("Passed value for field obj.date is not the expected type, validation failed.")
+        obj.total.is_a?(Float) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
+        obj.change.is_a?(Float) != false || raise("Passed value for field obj.change is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.0.10"
+  VERSION = "1.0.11"
 end

data/lib/trophy_api_client.rb

@@ -6,6 +6,7 @@ require_relative "requests"
 require_relative "trophy_api_client/achievements/client"
 require_relative "trophy_api_client/metrics/client"
 require_relative "trophy_api_client/users/client"
+require_relative "trophy_api_client/points/client"
 
 module TrophyApiClient
   class Client
@@ -15,6 +16,8 @@ module TrophyApiClient
     attr_reader :metrics
     # @return [TrophyApiClient::UsersClient]
     attr_reader :users
+    # @return [TrophyApiClient::PointsClient]
+    attr_reader :points
 
     # @param base_url [String]
     # @param environment [TrophyApiClient::Environment]
@@ -34,6 +37,7 @@ module TrophyApiClient
       @achievements = TrophyApiClient::AchievementsClient.new(request_client: @request_client)
       @metrics = TrophyApiClient::MetricsClient.new(request_client: @request_client)
       @users = TrophyApiClient::UsersClient.new(request_client: @request_client)
+      @points = TrophyApiClient::PointsClient.new(request_client: @request_client)
     end
   end
 
@@ -44,6 +48,8 @@ module TrophyApiClient
     attr_reader :metrics
     # @return [TrophyApiClient::AsyncUsersClient]
     attr_reader :users
+    # @return [TrophyApiClient::AsyncPointsClient]
+    attr_reader :points
 
     # @param base_url [String]
     # @param environment [TrophyApiClient::Environment]
@@ -63,6 +69,7 @@ module TrophyApiClient
       @achievements = TrophyApiClient::AsyncAchievementsClient.new(request_client: @async_request_client)
       @metrics = TrophyApiClient::AsyncMetricsClient.new(request_client: @async_request_client)
       @users = TrophyApiClient::AsyncUsersClient.new(request_client: @async_request_client)
+      @points = TrophyApiClient::AsyncPointsClient.new(request_client: @async_request_client)
     end
   end
 end

data/lib/types_export.rb

@@ -2,12 +2,20 @@
 
 require_relative "trophy_api_client/users/types/users_metric_event_summary_request_aggregation"
 require_relative "trophy_api_client/users/types/users_metric_event_summary_response_item"
+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/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/increment_metric_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"
+require_relative "trophy_api_client/types/points_trigger_type"
+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/metric_event_points_response"
+require_relative "trophy_api_client/types/achievement_response_trigger"
 require_relative "trophy_api_client/types/achievement_response"
 require_relative "trophy_api_client/types/completed_achievement_response"
 require_relative "trophy_api_client/types/achievement_with_stats_response"
@@ -18,3 +26,8 @@ require_relative "trophy_api_client/types/user"
 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"
+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"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.11
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -101,16 +101,28 @@ files:
 - lib/trophy_api_client.rb
 - lib/trophy_api_client/achievements/client.rb
 - lib/trophy_api_client/metrics/client.rb
+- lib/trophy_api_client/points/client.rb
 - lib/trophy_api_client/types/achievement_completion_response.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
 - lib/trophy_api_client/types/base_streak_response.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
-- lib/trophy_api_client/types/increment_metric_streak_response.rb
+- lib/trophy_api_client/types/get_user_points_response.rb
+- lib/trophy_api_client/types/metric_event_points_response.rb
+- 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/points_award.rb
+- lib/trophy_api_client/types/points_range.rb
+- lib/trophy_api_client/types/points_summary_response.rb
+- lib/trophy_api_client/types/points_trigger.rb
+- lib/trophy_api_client/types/points_trigger_response.rb
+- lib/trophy_api_client/types/points_trigger_response_status.rb
+- lib/trophy_api_client/types/points_trigger_response_type.rb
+- lib/trophy_api_client/types/points_trigger_type.rb
 - lib/trophy_api_client/types/streak_frequency.rb
 - lib/trophy_api_client/types/streak_response.rb
 - lib/trophy_api_client/types/streak_response_streak_history_item.rb
@@ -120,6 +132,8 @@ files:
 - 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
+- lib/trophy_api_client/users/types/users_points_event_summary_request_aggregation.rb
+- lib/trophy_api_client/users/types/users_points_event_summary_response_item.rb
 - lib/trophy_api_client/version.rb
 - lib/types_export.rb
 homepage: https://github.com/trophyso/trophy-ruby