trophy_api_client 1.7.0 → 1.9.1

data/lib/trophy_api_client/types/create_points_boosts_response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "created_points_boost"
+require_relative "admin_points_boost"
 require_relative "admin_issue"
 require "ostruct"
 require "json"
@@ -9,7 +9,7 @@ module TrophyApiClient
   # Response containing created boosts and any issues encountered while creating
   #  points boosts.
   class CreatePointsBoostsResponse
-    # @return [Array<TrophyApiClient::CreatedPointsBoost>] Array of successfully created boosts.
+    # @return [Array<TrophyApiClient::AdminPointsBoost>] Array of successfully created boosts.
     attr_reader :created
     # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during boost creation.
     attr_reader :issues
@@ -21,7 +21,7 @@ module TrophyApiClient
 
     OMIT = Object.new
 
-    # @param created [Array<TrophyApiClient::CreatedPointsBoost>] Array of successfully created boosts.
+    # @param created [Array<TrophyApiClient::AdminPointsBoost>] Array of successfully created boosts.
     # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during boost creation.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::CreatePointsBoostsResponse]
@@ -41,7 +41,7 @@ module TrophyApiClient
       parsed_json = JSON.parse(json_object)
       created = parsed_json["created"]&.map do |item|
         item = item.to_json
-        TrophyApiClient::CreatedPointsBoost.from_json(json_object: item)
+        TrophyApiClient::AdminPointsBoost.from_json(json_object: item)
       end
       issues = parsed_json["issues"]&.map do |item|
         item = item.to_json

data/lib/trophy_api_client/types/create_points_level_request_item.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative "create_points_level_request_item_badge"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A points level to create.
+  class CreatePointsLevelRequestItem
+    # @return [String] The name of the level.
+    attr_reader :name
+    # @return [String] A unique key for the level. Only alphanumeric characters, hyphens, and
+    #  underscores are permitted.
+    attr_reader :key
+    # @return [Integer] The threshold points value for the level.
+    attr_reader :points
+    # @return [String] An optional description of the level.
+    attr_reader :description
+    # @return [TrophyApiClient::CreatePointsLevelRequestItemBadge] An optional badge for the level.
+    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 name [String] The name of the level.
+    # @param key [String] A unique key for the level. Only alphanumeric characters, hyphens, and
+    #  underscores are permitted.
+    # @param points [Integer] The threshold points value for the level.
+    # @param description [String] An optional description of the level.
+    # @param badge [TrophyApiClient::CreatePointsLevelRequestItemBadge] An optional badge for the level.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::CreatePointsLevelRequestItem]
+    def initialize(name:, key:, points:, description: OMIT, badge: OMIT, additional_properties: nil)
+      @name = name
+      @key = key
+      @points = points
+      @description = description if description != OMIT
+      @badge = badge if badge != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "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 CreatePointsLevelRequestItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CreatePointsLevelRequestItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      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::CreatePointsLevelRequestItemBadge.from_json(json_object: badge)
+      end
+      new(
+        name: name,
+        key: key,
+        points: points,
+        description: description,
+        badge: badge,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreatePointsLevelRequestItem 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.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::CreatePointsLevelRequestItemBadge.validate_raw(obj: obj.badge)
+    end
+  end
+end

data/lib/trophy_api_client/types/create_points_level_request_item_badge.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # An optional badge for the level.
+  class CreatePointsLevelRequestItemBadge
+    # @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::CreatePointsLevelRequestItemBadge]
+    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 CreatePointsLevelRequestItemBadge
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CreatePointsLevelRequestItemBadge]
+    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 CreatePointsLevelRequestItemBadge 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/create_points_levels_request.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "create_points_level_request_item"
+
+module TrophyApiClient
+  CREATE_POINTS_LEVELS_REQUEST = Array
+end

data/lib/trophy_api_client/types/create_points_levels_response.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "admin_points_level"
+require_relative "admin_issue"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Response containing created levels and any per-item issues.
+  class CreatePointsLevelsResponse
+    # @return [Array<TrophyApiClient::AdminPointsLevel>] Array of successfully created levels.
+    attr_reader :created
+    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during level creation.
+    attr_reader :issues
+    # @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 created [Array<TrophyApiClient::AdminPointsLevel>] Array of successfully created levels.
+    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during level creation.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::CreatePointsLevelsResponse]
+    def initialize(created:, issues:, additional_properties: nil)
+      @created = created
+      @issues = issues
+      @additional_properties = additional_properties
+      @_field_set = { "created": created, "issues": issues }
+    end
+
+    # Deserialize a JSON object to an instance of CreatePointsLevelsResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CreatePointsLevelsResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      created = parsed_json["created"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AdminPointsLevel.from_json(json_object: item)
+      end
+      issues = parsed_json["issues"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AdminIssue.from_json(json_object: item)
+      end
+      new(
+        created: created,
+        issues: issues,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreatePointsLevelsResponse 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.created.is_a?(Array) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+      obj.issues.is_a?(Array) != false || raise("Passed value for field obj.issues is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/create_points_system_request_item.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require_relative "create_points_system_request_item_badge"
+require_relative "create_points_level_request_item"
+require_relative "create_points_boost_request_item"
+require_relative "create_points_trigger_request_item"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A points system to create. Optionally include sub-entities.
+  class CreatePointsSystemRequestItem
+    # @return [String] The points system name.
+    attr_reader :name
+    # @return [String] The points system key. Only alphanumeric characters, hyphens, and underscores
+    #  are permitted.
+    attr_reader :key
+    # @return [String] A short description of the points system.
+    attr_reader :description
+    # @return [TrophyApiClient::CreatePointsSystemRequestItemBadge] An optional badge for the points system.
+    attr_reader :badge
+    # @return [Integer] Optional maximum points a user can earn.
+    attr_reader :max_points
+    # @return [Array<TrophyApiClient::CreatePointsLevelRequestItem>] Optional array of levels to create alongside the system.
+    attr_reader :levels
+    # @return [Array<TrophyApiClient::CreatePointsBoostRequestItem>] Optional array of boosts to create alongside the system.
+    attr_reader :boosts
+    # @return [Array<TrophyApiClient::CreatePointsTriggerRequestItem>] Optional array of triggers to create alongside the system.
+    attr_reader :triggers
+    # @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 name [String] The points system name.
+    # @param key [String] The points system key. Only alphanumeric characters, hyphens, and underscores
+    #  are permitted.
+    # @param description [String] A short description of the points system.
+    # @param badge [TrophyApiClient::CreatePointsSystemRequestItemBadge] An optional badge for the points system.
+    # @param max_points [Integer] Optional maximum points a user can earn.
+    # @param levels [Array<TrophyApiClient::CreatePointsLevelRequestItem>] Optional array of levels to create alongside the system.
+    # @param boosts [Array<TrophyApiClient::CreatePointsBoostRequestItem>] Optional array of boosts to create alongside the system.
+    # @param triggers [Array<TrophyApiClient::CreatePointsTriggerRequestItem>] Optional array of triggers to create alongside the system.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::CreatePointsSystemRequestItem]
+    def initialize(name:, key:, description: OMIT, badge: OMIT, max_points: OMIT, levels: OMIT, boosts: OMIT,
+                   triggers: OMIT, additional_properties: nil)
+      @name = name
+      @key = key
+      @description = description if description != OMIT
+      @badge = badge if badge != OMIT
+      @max_points = max_points if max_points != OMIT
+      @levels = levels if levels != OMIT
+      @boosts = boosts if boosts != OMIT
+      @triggers = triggers if triggers != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "name": name,
+        "key": key,
+        "description": description,
+        "badge": badge,
+        "maxPoints": max_points,
+        "levels": levels,
+        "boosts": boosts,
+        "triggers": triggers
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreatePointsSystemRequestItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CreatePointsSystemRequestItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      key = parsed_json["key"]
+      description = parsed_json["description"]
+      if parsed_json["badge"].nil?
+        badge = nil
+      else
+        badge = parsed_json["badge"].to_json
+        badge = TrophyApiClient::CreatePointsSystemRequestItemBadge.from_json(json_object: badge)
+      end
+      max_points = parsed_json["maxPoints"]
+      levels = parsed_json["levels"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::CreatePointsLevelRequestItem.from_json(json_object: item)
+      end
+      boosts = parsed_json["boosts"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::CreatePointsBoostRequestItem.from_json(json_object: item)
+      end
+      triggers = parsed_json["triggers"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::CreatePointsTriggerRequestItem.from_json(json_object: item)
+      end
+      new(
+        name: name,
+        key: key,
+        description: description,
+        badge: badge,
+        max_points: max_points,
+        levels: levels,
+        boosts: boosts,
+        triggers: triggers,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreatePointsSystemRequestItem 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.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.badge.nil? || TrophyApiClient::CreatePointsSystemRequestItemBadge.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.")
+      obj.levels&.is_a?(Array) != false || raise("Passed value for field obj.levels is not the expected type, validation failed.")
+      obj.boosts&.is_a?(Array) != false || raise("Passed value for field obj.boosts is not the expected type, validation failed.")
+      obj.triggers&.is_a?(Array) != false || raise("Passed value for field obj.triggers is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/create_points_system_request_item_badge.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class CreatePointsSystemRequestItemBadge
+    # @return [String] Badge image URL.
+    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] Badge image URL.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::CreatePointsSystemRequestItemBadge]
+    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 CreatePointsSystemRequestItemBadge
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CreatePointsSystemRequestItemBadge]
+    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 CreatePointsSystemRequestItemBadge 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/create_points_systems_request.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "create_points_system_request_item"
+
+module TrophyApiClient
+  CREATE_POINTS_SYSTEMS_REQUEST = Array
+end

data/lib/trophy_api_client/types/create_points_systems_response.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "created_admin_points_system"
+require_relative "admin_issue"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Response containing created points systems and any per-item issues.
+  class CreatePointsSystemsResponse
+    # @return [Array<TrophyApiClient::CreatedAdminPointsSystem>] Array of successfully created points systems.
+    attr_reader :created
+    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during creation.
+    attr_reader :issues
+    # @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 created [Array<TrophyApiClient::CreatedAdminPointsSystem>] Array of successfully created points systems.
+    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during creation.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::CreatePointsSystemsResponse]
+    def initialize(created:, issues:, additional_properties: nil)
+      @created = created
+      @issues = issues
+      @additional_properties = additional_properties
+      @_field_set = { "created": created, "issues": issues }
+    end
+
+    # Deserialize a JSON object to an instance of CreatePointsSystemsResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CreatePointsSystemsResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      created = parsed_json["created"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::CreatedAdminPointsSystem.from_json(json_object: item)
+      end
+      issues = parsed_json["issues"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AdminIssue.from_json(json_object: item)
+      end
+      new(
+        created: created,
+        issues: issues,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreatePointsSystemsResponse 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.created.is_a?(Array) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+      obj.issues.is_a?(Array) != false || raise("Passed value for field obj.issues is not the expected type, validation failed.")
+    end
+  end
+end