trophy_api_client 1.0.42 → 1.1.0.pre.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77265cbb3258c3a5737b4f7649d1b12a3924b65189193ce24a7d7d585c05abbc
-  data.tar.gz: d9fe18d5ec1d18e0d4bbb4ceeb03b604f4182dcd3b36061246402cdad68cae01
+  metadata.gz: 84037a3c1bb14f574aa104a7221aff8070d2f6366587204798cd5bf663181a5a
+  data.tar.gz: 6e53759b78f13e9688ea98a40111e3f73e39a30b05fb312aee23b22ccee8d5ee
 SHA512:
-  metadata.gz: 6d456b11f213ebcade5b49769e45a93c7cfea3f2e2caa26c22cc2f9ae740955bd37c1e4ad36773011386d49765388cca31ac5c4be1470b72b0f7e8eae9895dc7
-  data.tar.gz: 19cceac7fbc0c7c077de7c42cc0c12eb11ff85fed52f87548accfc28bc3e39f6dbdaf3d6366b98bea37c472a9f9a6a10c677e03d1f1aac993edbd2df48d9aee6
+  metadata.gz: 1df8fb6bc8ac268da8de24d71e92bdc5ce964c78eaaa096568b97136afbf0c96dfb13370263312fd294a4aa9e853818d6b8a8b5d4a8d1821d3c3fe49855d1b10
+  data.tar.gz: 03b69808c5c0a369cbad11e3bdfe4e70282ea37c565d02a4d9a86be72be47d7482f10e3b1483c6604ca8369f1a5dff7e16ae1881b34422c862a86c8d14d5a3e2

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/admin/client.rb

@@ -2,28 +2,35 @@
 
 require_relative "../../requests"
 require_relative "streaks/client"
+require_relative "points/client"
 
 module TrophyApiClient
   module Admin
     class Client
       # @return [TrophyApiClient::Admin::StreaksClient]
       attr_reader :streaks
+      # @return [TrophyApiClient::Admin::Points::Client]
+      attr_reader :admin
 
       # @param request_client [TrophyApiClient::RequestClient]
       # @return [TrophyApiClient::Admin::Client]
       def initialize(request_client:)
         @streaks = TrophyApiClient::Admin::StreaksClient.new(request_client: request_client)
+        @admin = TrophyApiClient::Admin::Points::Client.new(request_client: request_client)
       end
     end
 
     class AsyncClient
       # @return [TrophyApiClient::Admin::AsyncStreaksClient]
       attr_reader :streaks
+      # @return [TrophyApiClient::Admin::Points::AsyncClient]
+      attr_reader :admin
 
       # @param request_client [TrophyApiClient::AsyncRequestClient]
       # @return [TrophyApiClient::Admin::AsyncClient]
       def initialize(request_client:)
         @streaks = TrophyApiClient::Admin::AsyncStreaksClient.new(request_client: request_client)
+        @admin = TrophyApiClient::Admin::Points::AsyncClient.new(request_client: request_client)
       end
     end
   end

data/lib/trophy_api_client/admin/points/boosts/client.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+require_relative "../../../../requests"
+require_relative "types/create_points_boosts_request_boosts_item"
+require_relative "../../../types/create_points_boosts_response"
+require_relative "../../../types/archive_points_boosts_response"
+require "async"
+
+module TrophyApiClient
+  module Admin
+    module Points
+      class BoostsClient
+        # @return [TrophyApiClient::RequestClient]
+        attr_reader :request_client
+
+        # @param request_client [TrophyApiClient::RequestClient]
+        # @return [TrophyApiClient::Admin::Points::BoostsClient]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # Create points boosts for multiple users.
+        #
+        # @param system_key [String] The key of the points system to create boosts for.
+        # @param boosts [Array<Hash>] Array of boosts to create. Maximum 1,000 boosts per request.Request of type Array<TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItem>, as a Hash
+        #   * :user_id (String)
+        #   * :name (String)
+        #   * :start (String)
+        #   * :end_ (String)
+        #   * :multiplier (Float)
+        #   * :rounding (TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItemRounding)
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [TrophyApiClient::CreatePointsBoostsResponse]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.create(system_key: "xp", boosts: [{ user_id: "user-123", name: "Double XP Weekend", start: "2024-01-01", end_: "2024-01-03", multiplier: 2 }, { user_id: "user-456", name: "Holiday Bonus", start: "2024-12-25", multiplier: 1.5, rounding: UP }])
+        def create(system_key:, boosts:, 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?
+            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 || {}),
+              systemKey: system_key,
+              boosts: boosts
+            }.compact
+            req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/points/boosts"
+          end
+          TrophyApiClient::CreatePointsBoostsResponse.from_json(json_object: response.body)
+        end
+
+        # Archive multiple points boosts by ID.
+        #
+        # @param ids [String] A list of up to 100 boost IDs.
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [TrophyApiClient::ArchivePointsBoostsResponse]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.batch_archive
+        def batch_archive(ids: nil, request_options: nil)
+          response = @request_client.conn.delete 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 || {}), "ids": 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(environment: admin, request_options: request_options)}/points/boosts"
+          end
+          TrophyApiClient::ArchivePointsBoostsResponse.from_json(json_object: response.body)
+        end
+
+        # Archive a points boost by ID.
+        #
+        # @param id [String] The UUID of the points boost to archive
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [Void]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.archive(id: "id")
+        def archive(id:, request_options: nil)
+          @request_client.conn.delete 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: admin,
+                                               request_options: request_options)}/points/boosts/#{id}"
+          end
+        end
+      end
+
+      class AsyncBoostsClient
+        # @return [TrophyApiClient::AsyncRequestClient]
+        attr_reader :request_client
+
+        # @param request_client [TrophyApiClient::AsyncRequestClient]
+        # @return [TrophyApiClient::Admin::Points::AsyncBoostsClient]
+        def initialize(request_client:)
+          @request_client = request_client
+        end
+
+        # Create points boosts for multiple users.
+        #
+        # @param system_key [String] The key of the points system to create boosts for.
+        # @param boosts [Array<Hash>] Array of boosts to create. Maximum 1,000 boosts per request.Request of type Array<TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItem>, as a Hash
+        #   * :user_id (String)
+        #   * :name (String)
+        #   * :start (String)
+        #   * :end_ (String)
+        #   * :multiplier (Float)
+        #   * :rounding (TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItemRounding)
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [TrophyApiClient::CreatePointsBoostsResponse]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.create(system_key: "xp", boosts: [{ user_id: "user-123", name: "Double XP Weekend", start: "2024-01-01", end_: "2024-01-03", multiplier: 2 }, { user_id: "user-456", name: "Holiday Bonus", start: "2024-12-25", multiplier: 1.5, rounding: UP }])
+        def create(system_key:, boosts:, request_options: nil)
+          Async do
+            response = @request_client.conn.post 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 || {}),
+                systemKey: system_key,
+                boosts: boosts
+              }.compact
+              req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/points/boosts"
+            end
+            TrophyApiClient::CreatePointsBoostsResponse.from_json(json_object: response.body)
+          end
+        end
+
+        # Archive multiple points boosts by ID.
+        #
+        # @param ids [String] A list of up to 100 boost IDs.
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [TrophyApiClient::ArchivePointsBoostsResponse]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.batch_archive
+        def batch_archive(ids: nil, request_options: nil)
+          Async do
+            response = @request_client.conn.delete 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 || {}), "ids": 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(environment: admin, request_options: request_options)}/points/boosts"
+            end
+            TrophyApiClient::ArchivePointsBoostsResponse.from_json(json_object: response.body)
+          end
+        end
+
+        # Archive a points boost by ID.
+        #
+        # @param id [String] The UUID of the points boost to archive
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [Void]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.archive(id: "id")
+        def archive(id:, request_options: nil)
+          Async do
+            @request_client.conn.delete 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: admin,
+                                                 request_options: request_options)}/points/boosts/#{id}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trophy_api_client/admin/points/boosts/types/create_points_boosts_request_boosts_item.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require_relative "create_points_boosts_request_boosts_item_rounding"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  module Admin
+    module Points
+      class Boosts
+        class CreatePointsBoostsRequestBoostsItem
+          # @return [String] The ID of the user to create a boost for.
+          attr_reader :user_id
+          # @return [String] The name of the boost.
+          attr_reader :name
+          # @return [String] The start date of the boost (YYYY-MM-DD).
+          attr_reader :start
+          # @return [String] The end date of the boost (YYYY-MM-DD). If null, the boost has no end date.
+          attr_reader :end_
+          # @return [Float] The points multiplier. Must be greater than 0, not equal to 1, and less than
+          #  100.
+          attr_reader :multiplier
+          # @return [TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItemRounding] How to round the boosted points. Defaults to 'down'.
+          attr_reader :rounding
+          # @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 to create a boost for.
+          # @param name [String] The name of the boost.
+          # @param start [String] The start date of the boost (YYYY-MM-DD).
+          # @param end_ [String] The end date of the boost (YYYY-MM-DD). If null, the boost has no end date.
+          # @param multiplier [Float] The points multiplier. Must be greater than 0, not equal to 1, and less than
+          #  100.
+          # @param rounding [TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItemRounding] How to round the boosted points. Defaults to 'down'.
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItem]
+          def initialize(user_id:, name:, start:, multiplier:, end_: OMIT, rounding: OMIT, additional_properties: nil)
+            @user_id = user_id
+            @name = name
+            @start = start
+            @end_ = end_ if end_ != OMIT
+            @multiplier = multiplier
+            @rounding = rounding if rounding != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "userId": user_id,
+              "name": name,
+              "start": start,
+              "end": end_,
+              "multiplier": multiplier,
+              "rounding": rounding
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of CreatePointsBoostsRequestBoostsItem
+          #
+          # @param json_object [String]
+          # @return [TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItem]
+          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"]
+            name = parsed_json["name"]
+            start = parsed_json["start"]
+            end_ = parsed_json["end"]
+            multiplier = parsed_json["multiplier"]
+            rounding = parsed_json["rounding"]
+            new(
+              user_id: user_id,
+              name: name,
+              start: start,
+              end_: end_,
+              multiplier: multiplier,
+              rounding: rounding,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of CreatePointsBoostsRequestBoostsItem 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+            obj.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
+            obj.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
+            obj.multiplier.is_a?(Float) != false || raise("Passed value for field obj.multiplier is not the expected type, validation failed.")
+            obj.rounding&.is_a?(TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItemRounding) != false || raise("Passed value for field obj.rounding is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trophy_api_client/admin/points/boosts/types/create_points_boosts_request_boosts_item_rounding.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  module Admin
+    module Points
+      class Boosts
+        # How to round the boosted points. Defaults to 'down'.
+        class CreatePointsBoostsRequestBoostsItemRounding
+          DOWN = "down"
+          UP = "up"
+          NEAREST = "nearest"
+        end
+      end
+    end
+  end
+end

data/lib/trophy_api_client/admin/points/client.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "boosts/client"
+
+module TrophyApiClient
+  module Admin
+    module Points
+      class Client
+        # @return [TrophyApiClient::Admin::Points::BoostsClient]
+        attr_reader :boosts
+
+        # @param request_client [TrophyApiClient::RequestClient]
+        # @return [TrophyApiClient::Admin::Points::Client]
+        def initialize(request_client:)
+          @boosts = TrophyApiClient::Admin::Points::BoostsClient.new(request_client: request_client)
+        end
+      end
+
+      class AsyncClient
+        # @return [TrophyApiClient::Admin::Points::AsyncBoostsClient]
+        attr_reader :boosts
+
+        # @param request_client [TrophyApiClient::AsyncRequestClient]
+        # @return [TrophyApiClient::Admin::Points::AsyncClient]
+        def initialize(request_client:)
+          @boosts = TrophyApiClient::Admin::Points::AsyncBoostsClient.new(request_client: request_client)
+        end
+      end
+    end
+  end
+end

data/lib/trophy_api_client/leaderboards/client.rb

@@ -17,8 +17,11 @@ module TrophyApiClient
       @request_client = request_client
     end
 
-    # Get all active leaderboards for your organization.
+    # Get all leaderboards for your organization. Finished leaderboards are excluded
+    #  by default.
     #
+    # @param include_finished [Boolean] When set to 'true', leaderboards with status 'finished' will be included in the
+    #  response. By default, finished leaderboards are excluded.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [Array<TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem>]
     # @example
@@ -27,8 +30,8 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.leaderboards.all
-    def all(request_options: nil)
+    #  api.leaderboards.all(include_finished: true)
+    def all(include_finished: 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?
@@ -37,9 +40,10 @@ module TrophyApiClient
       **@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.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "includeFinished": include_finished
+        }.compact
         unless request_options.nil? || request_options&.additional_body_parameters.nil?
           req.body = { **(request_options&.additional_body_parameters || {}) }.compact
         end
@@ -117,8 +121,11 @@ module TrophyApiClient
       @request_client = request_client
     end
 
-    # Get all active leaderboards for your organization.
+    # Get all leaderboards for your organization. Finished leaderboards are excluded
+    #  by default.
     #
+    # @param include_finished [Boolean] When set to 'true', leaderboards with status 'finished' will be included in the
+    #  response. By default, finished leaderboards are excluded.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [Array<TrophyApiClient::Leaderboards::LeaderboardsAllResponseItem>]
     # @example
@@ -127,8 +134,8 @@ module TrophyApiClient
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.leaderboards.all
-    def all(request_options: nil)
+    #  api.leaderboards.all(include_finished: true)
+    def all(include_finished: 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?
@@ -138,9 +145,10 @@ module TrophyApiClient
         **@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.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "includeFinished": include_finished
+          }.compact
           unless request_options.nil? || request_options&.additional_body_parameters.nil?
             req.body = { **(request_options&.additional_body_parameters || {}) }.compact
           end

data/lib/trophy_api_client/points/client.rb

@@ -4,6 +4,7 @@ require_relative "../../requests"
 require_relative "../types/points_summary_response"
 require "json"
 require_relative "../types/points_system_response"
+require_relative "../types/points_boost"
 require "async"
 
 module TrophyApiClient
@@ -57,7 +58,7 @@ module TrophyApiClient
       end
     end
 
-    # Get a points system with all its triggers.
+    # Get a points system with its triggers.
     #
     # @param key [String] Key of the points system.
     # @param request_options [TrophyApiClient::RequestOptions]
@@ -88,6 +89,46 @@ module TrophyApiClient
       end
       TrophyApiClient::PointsSystemResponse.from_json(json_object: response.body)
     end
+
+    # Get all global boosts for a points system. Finished boosts are excluded by
+    #  default.
+    #
+    # @param key [String] Key of the points system.
+    # @param include_finished [Boolean] When set to 'true', boosts that have finished (past their end date) will be
+    #  included in the response. By default, finished boosts are excluded.
+    # @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.points.boosts(key: "points-system-key", include_finished: true)
+    def boosts(key:, include_finished: 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 || {}),
+          "includeFinished": include_finished
+        }.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(environment: api, request_options: request_options)}/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
 
   class AsyncPointsClient
@@ -142,7 +183,7 @@ module TrophyApiClient
       end
     end
 
-    # Get a points system with all its triggers.
+    # Get a points system with its triggers.
     #
     # @param key [String] Key of the points system.
     # @param request_options [TrophyApiClient::RequestOptions]
@@ -175,5 +216,47 @@ module TrophyApiClient
         TrophyApiClient::PointsSystemResponse.from_json(json_object: response.body)
       end
     end
+
+    # Get all global boosts for a points system. Finished boosts are excluded by
+    #  default.
+    #
+    # @param key [String] Key of the points system.
+    # @param include_finished [Boolean] When set to 'true', boosts that have finished (past their end date) will be
+    #  included in the response. By default, finished boosts are excluded.
+    # @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.points.boosts(key: "points-system-key", include_finished: true)
+    def boosts(key:, include_finished: 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 || {}),
+            "includeFinished": include_finished
+          }.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(environment: api, request_options: request_options)}/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
   end
 end