trophy_api_client 1.6.0 → 1.8.0

data/lib/trophy_api_client/types/{created_points_boost.rb → admin_points_boost.rb}

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
-require_relative "created_points_boost_status"
-require_relative "created_points_boost_rounding"
+require_relative "admin_points_boost_status"
+require_relative "admin_points_boost_rounding"
+require_relative "admin_points_boost_user_attributes_item"
 require "ostruct"
 require "json"
 
 module TrophyApiClient
-  # A successfully created points boost returned from the create endpoint.
-  class CreatedPointsBoost
-    # @return [String] The UUID of the created boost.
+  # A points boost as returned from admin endpoints.
+  class AdminPointsBoost
+    # @return [String] The UUID of the boost.
     attr_reader :id
     # @return [String] The name of the boost.
     attr_reader :name
-    # @return [TrophyApiClient::CreatedPointsBoostStatus] The status of the boost.
+    # @return [TrophyApiClient::AdminPointsBoostStatus] The status of the boost.
     attr_reader :status
     # @return [String] The start date (YYYY-MM-DD).
     attr_reader :start
@@ -20,10 +21,14 @@ module TrophyApiClient
     attr_reader :end_
     # @return [Float] The points multiplier.
     attr_reader :multiplier
-    # @return [TrophyApiClient::CreatedPointsBoostRounding] How boosted points are rounded.
+    # @return [TrophyApiClient::AdminPointsBoostRounding] How boosted points are rounded.
     attr_reader :rounding
-    # @return [String] The customer ID of the user the boost was created for.
+    # @return [String] The customer ID of the user the boost was created for, or null for
+    #  global/attribute-filtered boosts.
     attr_reader :user_id
+    # @return [Array<TrophyApiClient::AdminPointsBoostUserAttributesItem>] User attribute filters applied to the boost. Only present for non-user-specific
+    #  boosts (i.e. when `userId` is null). Empty array if no filters are set.
+    attr_reader :user_attributes
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -32,18 +37,21 @@ module TrophyApiClient
 
     OMIT = Object.new
 
-    # @param id [String] The UUID of the created boost.
+    # @param id [String] The UUID of the boost.
     # @param name [String] The name of the boost.
-    # @param status [TrophyApiClient::CreatedPointsBoostStatus] The status of the boost.
+    # @param status [TrophyApiClient::AdminPointsBoostStatus] The status of the boost.
     # @param start [String] The start date (YYYY-MM-DD).
     # @param end_ [String] The end date (YYYY-MM-DD) or null if no end date.
     # @param multiplier [Float] The points multiplier.
-    # @param rounding [TrophyApiClient::CreatedPointsBoostRounding] How boosted points are rounded.
-    # @param user_id [String] The customer ID of the user the boost was created for.
+    # @param rounding [TrophyApiClient::AdminPointsBoostRounding] How boosted points are rounded.
+    # @param user_id [String] The customer ID of the user the boost was created for, or null for
+    #  global/attribute-filtered boosts.
+    # @param user_attributes [Array<TrophyApiClient::AdminPointsBoostUserAttributesItem>] User attribute filters applied to the boost. Only present for non-user-specific
+    #  boosts (i.e. when `userId` is null). Empty array if no filters are set.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::CreatedPointsBoost]
-    def initialize(id:, name:, status:, start:, multiplier:, rounding:, user_id:, end_: OMIT,
-                   additional_properties: nil)
+    # @return [TrophyApiClient::AdminPointsBoost]
+    def initialize(id:, name:, status:, start:, multiplier:, rounding:, end_: OMIT, user_id: OMIT,
+                   user_attributes: OMIT, additional_properties: nil)
       @id = id
       @name = name
       @status = status
@@ -51,7 +59,8 @@ module TrophyApiClient
       @end_ = end_ if end_ != OMIT
       @multiplier = multiplier
       @rounding = rounding
-      @user_id = user_id
+      @user_id = user_id if user_id != OMIT
+      @user_attributes = user_attributes if user_attributes != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "id": id,
@@ -61,16 +70,17 @@ module TrophyApiClient
         "end": end_,
         "multiplier": multiplier,
         "rounding": rounding,
-        "userId": user_id
+        "userId": user_id,
+        "userAttributes": user_attributes
       }.reject do |_k, v|
         v == OMIT
       end
     end
 
-    # Deserialize a JSON object to an instance of CreatedPointsBoost
+    # Deserialize a JSON object to an instance of AdminPointsBoost
     #
     # @param json_object [String]
-    # @return [TrophyApiClient::CreatedPointsBoost]
+    # @return [TrophyApiClient::AdminPointsBoost]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
@@ -82,6 +92,10 @@ module TrophyApiClient
       multiplier = parsed_json["multiplier"]
       rounding = parsed_json["rounding"]
       user_id = parsed_json["userId"]
+      user_attributes = parsed_json["userAttributes"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AdminPointsBoostUserAttributesItem.from_json(json_object: item)
+      end
       new(
         id: id,
         name: name,
@@ -91,11 +105,12 @@ module TrophyApiClient
         multiplier: multiplier,
         rounding: rounding,
         user_id: user_id,
+        user_attributes: user_attributes,
         additional_properties: struct
       )
     end
 
-    # Serialize an instance of CreatedPointsBoost to a JSON object
+    # Serialize an instance of AdminPointsBoost to a JSON object
     #
     # @return [String]
     def to_json(*_args)
@@ -111,12 +126,13 @@ module TrophyApiClient
     def self.validate_raw(obj:)
       obj.id.is_a?(String) != false || raise("Passed value for field obj.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.status.is_a?(TrophyApiClient::CreatedPointsBoostStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.status.is_a?(TrophyApiClient::AdminPointsBoostStatus) != false || raise("Passed value for field obj.status 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::CreatedPointsBoostRounding) != false || raise("Passed value for field obj.rounding is not the expected type, validation failed.")
-      obj.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
+      obj.rounding.is_a?(TrophyApiClient::AdminPointsBoostRounding) != false || raise("Passed value for field obj.rounding is not the expected type, validation failed.")
+      obj.user_id&.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
+      obj.user_attributes&.is_a?(Array) != false || raise("Passed value for field obj.user_attributes is not the expected type, validation failed.")
     end
   end
 end

data/lib/trophy_api_client/types/{created_points_boost_rounding.rb → admin_points_boost_rounding.rb}

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   # How boosted points are rounded.
-  class CreatedPointsBoostRounding
+  class AdminPointsBoostRounding
     DOWN = "down"
     UP = "up"
     NEAREST = "nearest"

data/lib/trophy_api_client/types/{created_points_boost_status.rb → admin_points_boost_status.rb}

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   # The status of the boost.
-  class CreatedPointsBoostStatus
+  class AdminPointsBoostStatus
     ACTIVE = "active"
     SCHEDULED = "scheduled"
     FINISHED = "finished"

data/lib/trophy_api_client/types/admin_points_boost_user_attributes_item.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class AdminPointsBoostUserAttributesItem
+    # @return [String] The UUID of the user attribute.
+    attr_reader :attribute_id
+    # @return [String] The matched attribute value.
+    attr_reader :attribute_value
+    # @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 attribute_id [String] The UUID of the user attribute.
+    # @param attribute_value [String] The matched attribute value.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AdminPointsBoostUserAttributesItem]
+    def initialize(attribute_id:, attribute_value:, additional_properties: nil)
+      @attribute_id = attribute_id
+      @attribute_value = attribute_value
+      @additional_properties = additional_properties
+      @_field_set = { "attributeId": attribute_id, "attributeValue": attribute_value }
+    end
+
+    # Deserialize a JSON object to an instance of AdminPointsBoostUserAttributesItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AdminPointsBoostUserAttributesItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      attribute_id = parsed_json["attributeId"]
+      attribute_value = parsed_json["attributeValue"]
+      new(
+        attribute_id: attribute_id,
+        attribute_value: attribute_value,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AdminPointsBoostUserAttributesItem 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.attribute_id.is_a?(String) != false || raise("Passed value for field obj.attribute_id is not the expected type, validation failed.")
+      obj.attribute_value.is_a?(String) != false || raise("Passed value for field obj.attribute_value is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/admin_points_level.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative "admin_points_level_badge"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A points level as returned from admin endpoints.
+  class AdminPointsLevel
+    # @return [String] The UUID of the level.
+    attr_reader :id
+    # @return [String] The name of the level.
+    attr_reader :name
+    # @return [String] The level key.
+    attr_reader :key
+    # @return [Integer] The threshold points value for the level.
+    attr_reader :points
+    # @return [String] The level description.
+    attr_reader :description
+    # @return [TrophyApiClient::AdminPointsLevelBadge] The badge for the level, or null if no badge is set.
+    attr_reader :badge
+    # @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 id [String] The UUID of the level.
+    # @param name [String] The name of the level.
+    # @param key [String] The level key.
+    # @param points [Integer] The threshold points value for the level.
+    # @param description [String] The level description.
+    # @param badge [TrophyApiClient::AdminPointsLevelBadge] The badge for the level, or null if no badge is set.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AdminPointsLevel]
+    def initialize(id:, name:, key:, points:, description:, badge: OMIT, additional_properties: nil)
+      @id = id
+      @name = name
+      @key = key
+      @points = points
+      @description = description
+      @badge = badge if badge != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "name": name,
+        "key": key,
+        "points": points,
+        "description": description,
+        "badge": badge
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of AdminPointsLevel
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AdminPointsLevel]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      name = parsed_json["name"]
+      key = parsed_json["key"]
+      points = parsed_json["points"]
+      description = parsed_json["description"]
+      if parsed_json["badge"].nil?
+        badge = nil
+      else
+        badge = parsed_json["badge"].to_json
+        badge = TrophyApiClient::AdminPointsLevelBadge.from_json(json_object: badge)
+      end
+      new(
+        id: id,
+        name: name,
+        key: key,
+        points: points,
+        description: description,
+        badge: badge,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AdminPointsLevel 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.id.is_a?(String) != false || raise("Passed value for field obj.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.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
+      obj.points.is_a?(Integer) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+      obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.badge.nil? || TrophyApiClient::AdminPointsLevelBadge.validate_raw(obj: obj.badge)
+    end
+  end
+end

data/lib/trophy_api_client/types/admin_points_level_badge.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class AdminPointsLevelBadge
+    # @return [String] The URL of the badge image.
+    attr_reader :url
+    # @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 url [String] The URL of the badge image.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AdminPointsLevelBadge]
+    def initialize(url:, additional_properties: nil)
+      @url = url
+      @additional_properties = additional_properties
+      @_field_set = { "url": url }
+    end
+
+    # Deserialize a JSON object to an instance of AdminPointsLevelBadge
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AdminPointsLevelBadge]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      url = parsed_json["url"]
+      new(url: url, additional_properties: struct)
+    end
+
+    # Serialize an instance of AdminPointsLevelBadge 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.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/admin_points_system.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require_relative "admin_points_system_status"
+require_relative "admin_points_system_badge"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A points system returned from the admin points systems endpoints.
+  class AdminPointsSystem
+    # @return [String] The UUID of the points system.
+    attr_reader :id
+    # @return [String] The points system name.
+    attr_reader :name
+    # @return [String] The points system key.
+    attr_reader :key
+    # @return [String] The points system description.
+    attr_reader :description
+    # @return [TrophyApiClient::AdminPointsSystemStatus] The points system status.
+    attr_reader :status
+    # @return [TrophyApiClient::AdminPointsSystemBadge] The badge for the points system.
+    attr_reader :badge
+    # @return [Integer] The maximum points a user can earn.
+    attr_reader :max_points
+    # @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 id [String] The UUID of the points system.
+    # @param name [String] The points system name.
+    # @param key [String] The points system key.
+    # @param description [String] The points system description.
+    # @param status [TrophyApiClient::AdminPointsSystemStatus] The points system status.
+    # @param badge [TrophyApiClient::AdminPointsSystemBadge] The badge for the points system.
+    # @param max_points [Integer] The maximum points a user can earn.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AdminPointsSystem]
+    def initialize(id:, name:, key:, description:, status:, badge: OMIT, max_points: OMIT, additional_properties: nil)
+      @id = id
+      @name = name
+      @key = key
+      @description = description
+      @status = status
+      @badge = badge if badge != OMIT
+      @max_points = max_points if max_points != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "name": name,
+        "key": key,
+        "description": description,
+        "status": status,
+        "badge": badge,
+        "maxPoints": max_points
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of AdminPointsSystem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AdminPointsSystem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      name = parsed_json["name"]
+      key = parsed_json["key"]
+      description = parsed_json["description"]
+      status = parsed_json["status"]
+      if parsed_json["badge"].nil?
+        badge = nil
+      else
+        badge = parsed_json["badge"].to_json
+        badge = TrophyApiClient::AdminPointsSystemBadge.from_json(json_object: badge)
+      end
+      max_points = parsed_json["maxPoints"]
+      new(
+        id: id,
+        name: name,
+        key: key,
+        description: description,
+        status: status,
+        badge: badge,
+        max_points: max_points,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AdminPointsSystem 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.id.is_a?(String) != false || raise("Passed value for field obj.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.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
+      obj.description.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.status.is_a?(TrophyApiClient::AdminPointsSystemStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.badge.nil? || TrophyApiClient::AdminPointsSystemBadge.validate_raw(obj: obj.badge)
+      obj.max_points&.is_a?(Integer) != false || raise("Passed value for field obj.max_points is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/admin_points_system_badge.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class AdminPointsSystemBadge
+    # @return [String]
+    attr_reader :url
+    # @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 url [String]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AdminPointsSystemBadge]
+    def initialize(url:, additional_properties: nil)
+      @url = url
+      @additional_properties = additional_properties
+      @_field_set = { "url": url }
+    end
+
+    # Deserialize a JSON object to an instance of AdminPointsSystemBadge
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AdminPointsSystemBadge]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      url = parsed_json["url"]
+      new(url: url, additional_properties: struct)
+    end
+
+    # Serialize an instance of AdminPointsSystemBadge 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.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/admin_points_system_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The points system status.
+  class AdminPointsSystemStatus
+    ACTIVE = "active"
+    ARCHIVED = "archived"
+  end
+end