trophy_api_client 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bca4f0a4b33b4764665874e1091b268c9a30d496bc684bbe5d0a6278e4c94c32
-  data.tar.gz: b7ed5377499eced710ba24c76946f5c4502ca4973a3dba684c369dc0a92479ef
+  metadata.gz: d240a20a2e41b128afca2d98893f8c2442aeced7d0c565c9458efdb8f6ff0efa
+  data.tar.gz: 0e6698405fbc5e02e29b59cc97322237a7291c03a472430ddb45d25b6689c403
 SHA512:
-  metadata.gz: f72261a738ecae4692446dc9dbe37fa205dc3ce177fcabd9847dc1f6af1613d7c19cf5be5d99b3cd24b0558450f06098e39fa6415f15046785a6226f2590f0bb
-  data.tar.gz: d8feb721e3fa1b4ee49635d3d7f330cc93f3fdf8692792d947eb3dd0131cf8876985d84b01d17da5e050d773f6224ef4310786e55533e17480cc0fb8affa8718
+  metadata.gz: 160583d898a66ec511045b0a89441016a527ff0d45e586e6b26f23d17a046765589333c22d21811ba98bb32a6e45fa7ac36fbae07f9724b29a6b36ea29be7e74
+  data.tar.gz: 7cfd1a899f7182d554377516f23a2641ab30ed5a35c891da819f9b02ee8f05ba207f84ff66d36b02ceda728e0e099110082072257c0b99b0688f78a0201898d7

data/lib/gemconfig.rb

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

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

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
 require_relative "../../../../requests"
-require_relative "types/create_points_boosts_request_boosts_item"
+require_relative "../../../types/list_points_boosts_response"
+require "json"
+require_relative "../../../types/create_points_boosts_request"
 require_relative "../../../types/create_points_boosts_response"
 require_relative "../../../types/delete_points_boosts_response"
+require_relative "../../../types/patch_points_boosts_request"
+require_relative "../../../types/patch_points_boosts_response"
+require_relative "../../../types/admin_points_boost"
 require "async"
 
 module TrophyApiClient
@@ -19,16 +24,55 @@ module TrophyApiClient
           @request_client = request_client
         end
 
-        # Create points boosts for multiple users.
+        # List points boosts for a system.
         #
-        # @param system_key [String] The key of the points system to create boosts for.
-        # @param boosts [Array<Hash>] Array of boosts to create. Maximum 100 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 system_id [String] The UUID of the points system.
+        # @param limit [Integer] Maximum number of results to return (1-100, default 10).
+        # @param skip [Integer] Number of results to skip for pagination (default 0).
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [TrophyApiClient::LIST_POINTS_BOOSTS_RESPONSE]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.list(
+        #    system_id: "550e8400-e29b-41d4-a716-446655440000",
+        #    limit: 1,
+        #    skip: 1
+        #  )
+        def list(system_id:, limit: nil, skip: 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 || {}),
+              "limit": limit,
+              "skip": skip
+            }.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/#{system_id}/boosts"
+          end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do |item|
+            item = item.to_json
+            TrophyApiClient::AdminPointsBoost.from_json(json_object: item)
+          end
+        end
+
+        # Create points boosts.
+        #
+        # @param system_id [String] The UUID of the points system.
+        # @param request [TrophyApiClient::CREATE_POINTS_BOOSTS_REQUEST]
         # @param request_options [TrophyApiClient::RequestOptions]
         # @return [TrophyApiClient::CreatePointsBoostsResponse]
         # @example
@@ -37,8 +81,8 @@ module TrophyApiClient
         #    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)
+        #  api.admin.points.boosts.create(system_id: "550e8400-e29b-41d4-a716-446655440000", request: [{ user_id: "user-123", name: "Double XP Weekend", start: "2024-01-01", end_: "2024-01-03", multiplier: 2 }])
+        def create(system_id:, 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?
             req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
@@ -50,18 +94,16 @@ module TrophyApiClient
             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"
+            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: admin,
+                                               request_options: request_options)}/points/#{system_id}/boosts"
           end
           TrophyApiClient::CreatePointsBoostsResponse.from_json(json_object: response.body)
         end
 
         # Delete multiple points boosts by ID.
         #
+        # @param system_id [String] The UUID of the points system.
         # @param ids [String] A list of up to 100 boost IDs.
         # @param request_options [TrophyApiClient::RequestOptions]
         # @return [TrophyApiClient::DeletePointsBoostsResponse]
@@ -72,7 +114,7 @@ module TrophyApiClient
         #    api_key: "YOUR_API_KEY"
         #  )
         #  api.admin.points.boosts.delete
-        def delete(ids: nil, request_options: nil)
+        def delete(system_id:, 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?
@@ -85,10 +127,77 @@ module TrophyApiClient
             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"
+            req.url "#{@request_client.get_url(environment: admin,
+                                               request_options: request_options)}/points/#{system_id}/boosts"
           end
           TrophyApiClient::DeletePointsBoostsResponse.from_json(json_object: response.body)
         end
+
+        # Update multiple points boosts.
+        #
+        # @param system_id [String] The UUID of the points system.
+        # @param request [TrophyApiClient::PATCH_POINTS_BOOSTS_REQUEST]
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [TrophyApiClient::PatchPointsBoostsResponse]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.update(system_id: "550e8400-e29b-41d4-a716-446655440000", request: [{ id: "550e8400-e29b-41d4-a716-446655440000", name: "Updated Boost Name", multiplier: 3 }])
+        def update(system_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?
+            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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: admin,
+                                               request_options: request_options)}/points/#{system_id}/boosts"
+          end
+          TrophyApiClient::PatchPointsBoostsResponse.from_json(json_object: response.body)
+        end
+
+        # Get a single points boost by ID.
+        #
+        # @param system_id [String] The UUID of the points system.
+        # @param id [String] The UUID of the points boost.
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [TrophyApiClient::AdminPointsBoost]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.get(system_id: "550e8400-e29b-41d4-a716-446655440000", id: "660f9500-f30c-42e5-b827-557766550001")
+        def get(system_id:, 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: admin,
+                                               request_options: request_options)}/points/#{system_id}/boosts/#{id}"
+          end
+          TrophyApiClient::AdminPointsBoost.from_json(json_object: response.body)
+        end
       end
 
       class AsyncBoostsClient
@@ -101,16 +210,57 @@ module TrophyApiClient
           @request_client = request_client
         end
 
-        # Create points boosts for multiple users.
+        # List points boosts for a system.
+        #
+        # @param system_id [String] The UUID of the points system.
+        # @param limit [Integer] Maximum number of results to return (1-100, default 10).
+        # @param skip [Integer] Number of results to skip for pagination (default 0).
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [TrophyApiClient::LIST_POINTS_BOOSTS_RESPONSE]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.list(
+        #    system_id: "550e8400-e29b-41d4-a716-446655440000",
+        #    limit: 1,
+        #    skip: 1
+        #  )
+        def list(system_id:, limit: nil, skip: 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 || {}),
+                "limit": limit,
+                "skip": skip
+              }.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/#{system_id}/boosts"
+            end
+            parsed_json = JSON.parse(response.body)
+            parsed_json&.map do |item|
+              item = item.to_json
+              TrophyApiClient::AdminPointsBoost.from_json(json_object: item)
+            end
+          end
+        end
+
+        # Create points boosts.
         #
-        # @param system_key [String] The key of the points system to create boosts for.
-        # @param boosts [Array<Hash>] Array of boosts to create. Maximum 100 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 system_id [String] The UUID of the points system.
+        # @param request [TrophyApiClient::CREATE_POINTS_BOOSTS_REQUEST]
         # @param request_options [TrophyApiClient::RequestOptions]
         # @return [TrophyApiClient::CreatePointsBoostsResponse]
         # @example
@@ -119,8 +269,8 @@ module TrophyApiClient
         #    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)
+        #  api.admin.points.boosts.create(system_id: "550e8400-e29b-41d4-a716-446655440000", request: [{ user_id: "user-123", name: "Double XP Weekend", start: "2024-01-01", end_: "2024-01-03", multiplier: 2 }])
+        def create(system_id:, request:, 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?
@@ -133,12 +283,9 @@ module TrophyApiClient
               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"
+              req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+              req.url "#{@request_client.get_url(environment: admin,
+                                                 request_options: request_options)}/points/#{system_id}/boosts"
             end
             TrophyApiClient::CreatePointsBoostsResponse.from_json(json_object: response.body)
           end
@@ -146,6 +293,7 @@ module TrophyApiClient
 
         # Delete multiple points boosts by ID.
         #
+        # @param system_id [String] The UUID of the points system.
         # @param ids [String] A list of up to 100 boost IDs.
         # @param request_options [TrophyApiClient::RequestOptions]
         # @return [TrophyApiClient::DeletePointsBoostsResponse]
@@ -156,7 +304,7 @@ module TrophyApiClient
         #    api_key: "YOUR_API_KEY"
         #  )
         #  api.admin.points.boosts.delete
-        def delete(ids: nil, request_options: nil)
+        def delete(system_id:, 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?
@@ -170,11 +318,82 @@ module TrophyApiClient
               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"
+              req.url "#{@request_client.get_url(environment: admin,
+                                                 request_options: request_options)}/points/#{system_id}/boosts"
             end
             TrophyApiClient::DeletePointsBoostsResponse.from_json(json_object: response.body)
           end
         end
+
+        # Update multiple points boosts.
+        #
+        # @param system_id [String] The UUID of the points system.
+        # @param request [TrophyApiClient::PATCH_POINTS_BOOSTS_REQUEST]
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [TrophyApiClient::PatchPointsBoostsResponse]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.update(system_id: "550e8400-e29b-41d4-a716-446655440000", request: [{ id: "550e8400-e29b-41d4-a716-446655440000", name: "Updated Boost Name", multiplier: 3 }])
+        def update(system_id:, request:, 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+              req.url "#{@request_client.get_url(environment: admin,
+                                                 request_options: request_options)}/points/#{system_id}/boosts"
+            end
+            TrophyApiClient::PatchPointsBoostsResponse.from_json(json_object: response.body)
+          end
+        end
+
+        # Get a single points boost by ID.
+        #
+        # @param system_id [String] The UUID of the points system.
+        # @param id [String] The UUID of the points boost.
+        # @param request_options [TrophyApiClient::RequestOptions]
+        # @return [TrophyApiClient::AdminPointsBoost]
+        # @example
+        #  api = TrophyApiClient::Client.new(
+        #    base_url: "https://api.example.com",
+        #    environment: TrophyApiClient::Environment::PRODUCTION,
+        #    api_key: "YOUR_API_KEY"
+        #  )
+        #  api.admin.points.boosts.get(system_id: "550e8400-e29b-41d4-a716-446655440000", id: "660f9500-f30c-42e5-b827-557766550001")
+        def get(system_id:, 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: admin,
+                                                 request_options: request_options)}/points/#{system_id}/boosts/#{id}"
+            end
+            TrophyApiClient::AdminPointsBoost.from_json(json_object: response.body)
+          end
+        end
       end
     end
   end

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

@@ -1,30 +1,51 @@
 # frozen_string_literal: true
 
 require_relative "../../../requests"
+require_relative "systems/client"
 require_relative "boosts/client"
+require_relative "levels/client"
+require_relative "triggers/client"
 
 module TrophyApiClient
   module Admin
     module Points
       class Client
+        # @return [TrophyApiClient::Admin::Points::SystemsClient]
+        attr_reader :systems
         # @return [TrophyApiClient::Admin::Points::BoostsClient]
         attr_reader :boosts
+        # @return [TrophyApiClient::Admin::Points::LevelsClient]
+        attr_reader :levels
+        # @return [TrophyApiClient::Admin::Points::TriggersClient]
+        attr_reader :triggers
 
         # @param request_client [TrophyApiClient::RequestClient]
         # @return [TrophyApiClient::Admin::Points::Client]
         def initialize(request_client:)
+          @systems = TrophyApiClient::Admin::Points::SystemsClient.new(request_client: request_client)
           @boosts = TrophyApiClient::Admin::Points::BoostsClient.new(request_client: request_client)
+          @levels = TrophyApiClient::Admin::Points::LevelsClient.new(request_client: request_client)
+          @triggers = TrophyApiClient::Admin::Points::TriggersClient.new(request_client: request_client)
         end
       end
 
       class AsyncClient
+        # @return [TrophyApiClient::Admin::Points::AsyncSystemsClient]
+        attr_reader :systems
         # @return [TrophyApiClient::Admin::Points::AsyncBoostsClient]
         attr_reader :boosts
+        # @return [TrophyApiClient::Admin::Points::AsyncLevelsClient]
+        attr_reader :levels
+        # @return [TrophyApiClient::Admin::Points::AsyncTriggersClient]
+        attr_reader :triggers
 
         # @param request_client [TrophyApiClient::AsyncRequestClient]
         # @return [TrophyApiClient::Admin::Points::AsyncClient]
         def initialize(request_client:)
+          @systems = TrophyApiClient::Admin::Points::AsyncSystemsClient.new(request_client: request_client)
           @boosts = TrophyApiClient::Admin::Points::AsyncBoostsClient.new(request_client: request_client)
+          @levels = TrophyApiClient::Admin::Points::AsyncLevelsClient.new(request_client: request_client)
+          @triggers = TrophyApiClient::Admin::Points::AsyncTriggersClient.new(request_client: request_client)
         end
       end
     end