trophy_api_client 1.0.42 → 1.1.0

data/lib/trophy_api_client/types/archive_points_boosts_response.rb

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

data/lib/trophy_api_client/types/create_points_boosts_response.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "created_points_boost"
+require_relative "bulk_insert_issue"
+require "ostruct"
+require "json"
+
+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.
+    attr_reader :created
+    # @return [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during boost 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::CreatedPointsBoost>] Array of successfully created boosts.
+    # @param issues [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during boost creation.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::CreatePointsBoostsResponse]
+    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 CreatePointsBoostsResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CreatePointsBoostsResponse]
+    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::CreatedPointsBoost.from_json(json_object: item)
+      end
+      issues = parsed_json["issues"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::BulkInsertIssue.from_json(json_object: item)
+      end
+      new(
+        created: created,
+        issues: issues,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreatePointsBoostsResponse 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/created_points_boost.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require_relative "created_points_boost_status"
+require_relative "created_points_boost_rounding"
+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.
+    attr_reader :id
+    # @return [String] The name of the boost.
+    attr_reader :name
+    # @return [TrophyApiClient::CreatedPointsBoostStatus] The status of the boost.
+    attr_reader :status
+    # @return [String] The start date (YYYY-MM-DD).
+    attr_reader :start
+    # @return [String] The end date (YYYY-MM-DD) or null if no end date.
+    attr_reader :end_
+    # @return [Float] The points multiplier.
+    attr_reader :multiplier
+    # @return [TrophyApiClient::CreatedPointsBoostRounding] How boosted points are rounded.
+    attr_reader :rounding
+    # @return [String] The customer ID of the user the boost was created for.
+    attr_reader :user_id
+    # @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 created boost.
+    # @param name [String] The name of the boost.
+    # @param status [TrophyApiClient::CreatedPointsBoostStatus] 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 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)
+      @id = id
+      @name = name
+      @status = status
+      @start = start
+      @end_ = end_ if end_ != OMIT
+      @multiplier = multiplier
+      @rounding = rounding
+      @user_id = user_id
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "name": name,
+        "status": status,
+        "start": start,
+        "end": end_,
+        "multiplier": multiplier,
+        "rounding": rounding,
+        "userId": user_id
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of CreatedPointsBoost
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CreatedPointsBoost]
+    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"]
+      status = parsed_json["status"]
+      start = parsed_json["start"]
+      end_ = parsed_json["end"]
+      multiplier = parsed_json["multiplier"]
+      rounding = parsed_json["rounding"]
+      user_id = parsed_json["userId"]
+      new(
+        id: id,
+        name: name,
+        status: status,
+        start: start,
+        end_: end_,
+        multiplier: multiplier,
+        rounding: rounding,
+        user_id: user_id,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreatedPointsBoost 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.status.is_a?(TrophyApiClient::CreatedPointsBoostStatus) != 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.")
+    end
+  end
+end

data/lib/trophy_api_client/types/created_points_boost_rounding.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # How boosted points are rounded.
+  class CreatedPointsBoostRounding
+    DOWN = "down"
+    UP = "up"
+    NEAREST = "nearest"
+  end
+end

data/lib/trophy_api_client/types/created_points_boost_status.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The status of the boost.
+  class CreatedPointsBoostStatus
+    ACTIVE = "active"
+    SCHEDULED = "scheduled"
+    FINISHED = "finished"
+  end
+end

data/lib/trophy_api_client/types/metric_event_points_response.rb

@@ -5,9 +5,8 @@ require "ostruct"
 require "json"
 
 module TrophyApiClient
+  # Points system response for metric events.
   class MetricEventPointsResponse
-    # @return [Integer] The points added by this event.
-    attr_reader :added
     # @return [String] The ID of the points system
     attr_reader :id
     # @return [String] The key of the points system
@@ -22,6 +21,8 @@ module TrophyApiClient
     attr_reader :max_points
     # @return [Integer] The user's total points
     attr_reader :total
+    # @return [Integer] The points added by this event.
+    attr_reader :added
     # @return [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
     attr_reader :awards
     # @return [OpenStruct] Additional properties unmapped to the current class definition
@@ -32,7 +33,6 @@ module TrophyApiClient
 
     OMIT = Object.new
 
-    # @param added [Integer] The points added by this event.
     # @param id [String] The ID of the points system
     # @param key [String] The key of the points system
     # @param name [String] The name of the points system
@@ -40,12 +40,12 @@ module TrophyApiClient
     # @param badge_url [String] The URL of the badge image for the points system
     # @param max_points [Float] The maximum number of points a user can be awarded in this points system
     # @param total [Integer] The user's total points
+    # @param added [Integer] The points added by this event.
     # @param awards [Array<TrophyApiClient::PointsAward>] Array of trigger awards that added points.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::MetricEventPointsResponse]
-    def initialize(added:, id:, key:, name:, total:, awards:, description: OMIT, badge_url: OMIT, max_points: OMIT,
+    def initialize(id:, key:, name:, total:, added:, awards:, description: OMIT, badge_url: OMIT, max_points: OMIT,
                    additional_properties: nil)
-      @added = added
       @id = id
       @key = key
       @name = name
@@ -53,10 +53,10 @@ module TrophyApiClient
       @badge_url = badge_url if badge_url != OMIT
       @max_points = max_points if max_points != OMIT
       @total = total
+      @added = added
       @awards = awards
       @additional_properties = additional_properties
       @_field_set = {
-        "added": added,
         "id": id,
         "key": key,
         "name": name,
@@ -64,6 +64,7 @@ module TrophyApiClient
         "badgeUrl": badge_url,
         "maxPoints": max_points,
         "total": total,
+        "added": added,
         "awards": awards
       }.reject do |_k, v|
         v == OMIT
@@ -77,7 +78,6 @@ module TrophyApiClient
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      added = parsed_json["added"]
       id = parsed_json["id"]
       key = parsed_json["key"]
       name = parsed_json["name"]
@@ -85,12 +85,12 @@ module TrophyApiClient
       badge_url = parsed_json["badgeUrl"]
       max_points = parsed_json["maxPoints"]
       total = parsed_json["total"]
+      added = parsed_json["added"]
       awards = parsed_json["awards"]&.map do |item|
         item = item.to_json
         TrophyApiClient::PointsAward.from_json(json_object: item)
       end
       new(
-        added: added,
         id: id,
         key: key,
         name: name,
@@ -98,6 +98,7 @@ module TrophyApiClient
         badge_url: badge_url,
         max_points: max_points,
         total: total,
+        added: added,
         awards: awards,
         additional_properties: struct
       )
@@ -117,7 +118,6 @@ module TrophyApiClient
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.added.is_a?(Integer) != false || raise("Passed value for field obj.added is not the expected type, validation failed.")
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
@@ -125,6 +125,7 @@ module TrophyApiClient
       obj.badge_url&.is_a?(String) != false || raise("Passed value for field obj.badge_url is not the expected type, validation failed.")
       obj.max_points&.is_a?(Float) != false || raise("Passed value for field obj.max_points is not the expected type, validation failed.")
       obj.total.is_a?(Integer) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
+      obj.added.is_a?(Integer) != false || raise("Passed value for field obj.added is not the expected type, validation failed.")
       obj.awards.is_a?(Array) != false || raise("Passed value for field obj.awards is not the expected type, validation failed.")
     end
   end

data/lib/trophy_api_client/types/points_award.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "points_trigger"
+require_relative "points_boost"
 require "ostruct"
 require "json"
 
@@ -16,6 +17,8 @@ module TrophyApiClient
     attr_reader :total
     # @return [TrophyApiClient::PointsTrigger]
     attr_reader :trigger
+    # @return [Array<TrophyApiClient::PointsBoost>] Array of points boosts that applied to this award.
+    attr_reader :boosts
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -29,21 +32,25 @@ module TrophyApiClient
     # @param date [String] The date these points were awarded, in ISO 8601 format.
     # @param total [Integer] The user's total points after this award occurred.
     # @param trigger [TrophyApiClient::PointsTrigger]
+    # @param boosts [Array<TrophyApiClient::PointsBoost>] Array of points boosts that applied to this award.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::PointsAward]
-    def initialize(id: OMIT, awarded: OMIT, date: OMIT, total: OMIT, trigger: OMIT, additional_properties: nil)
+    def initialize(id: OMIT, awarded: OMIT, date: OMIT, total: OMIT, trigger: OMIT, boosts: OMIT,
+                   additional_properties: nil)
       @id = id if id != OMIT
       @awarded = awarded if awarded != OMIT
       @date = date if date != OMIT
       @total = total if total != OMIT
       @trigger = trigger if trigger != OMIT
+      @boosts = boosts if boosts != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "id": id,
         "awarded": awarded,
         "date": date,
         "total": total,
-        "trigger": trigger
+        "trigger": trigger,
+        "boosts": boosts
       }.reject do |_k, v|
         v == OMIT
       end
@@ -66,12 +73,17 @@ module TrophyApiClient
         trigger = parsed_json["trigger"].to_json
         trigger = TrophyApiClient::PointsTrigger.from_json(json_object: trigger)
       end
+      boosts = parsed_json["boosts"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::PointsBoost.from_json(json_object: item)
+      end
       new(
         id: id,
         awarded: awarded,
         date: date,
         total: total,
         trigger: trigger,
+        boosts: boosts,
         additional_properties: struct
       )
     end
@@ -95,6 +107,7 @@ module TrophyApiClient
       obj.date&.is_a?(String) != false || raise("Passed value for field obj.date is not the expected type, validation failed.")
       obj.total&.is_a?(Integer) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
       obj.trigger.nil? || TrophyApiClient::PointsTrigger.validate_raw(obj: obj.trigger)
+      obj.boosts&.is_a?(Array) != false || raise("Passed value for field obj.boosts is not the expected type, validation failed.")
     end
   end
 end

data/lib/trophy_api_client/types/points_boost.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require_relative "points_boost_status"
+require_relative "points_boost_rounding"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class PointsBoost
+    # @return [String] The ID of the points boost
+    attr_reader :id
+    # @return [String] The name of the points boost
+    attr_reader :name
+    # @return [TrophyApiClient::PointsBoostStatus] The status of the points boost
+    attr_reader :status
+    # @return [String] The start date of the points boost
+    attr_reader :start
+    # @return [String] The end date of the points boost
+    attr_reader :end_
+    # @return [Float] The multiplier of the points boost
+    attr_reader :multiplier
+    # @return [TrophyApiClient::PointsBoostRounding] The rounding method of the points boost
+    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 id [String] The ID of the points boost
+    # @param name [String] The name of the points boost
+    # @param status [TrophyApiClient::PointsBoostStatus] The status of the points boost
+    # @param start [String] The start date of the points boost
+    # @param end_ [String] The end date of the points boost
+    # @param multiplier [Float] The multiplier of the points boost
+    # @param rounding [TrophyApiClient::PointsBoostRounding] The rounding method of the points boost
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::PointsBoost]
+    def initialize(id:, name:, status:, start:, multiplier:, rounding:, end_: OMIT, additional_properties: nil)
+      @id = id
+      @name = name
+      @status = status
+      @start = start
+      @end_ = end_ if end_ != OMIT
+      @multiplier = multiplier
+      @rounding = rounding
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "name": name,
+        "status": status,
+        "start": start,
+        "end": end_,
+        "multiplier": multiplier,
+        "rounding": rounding
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of PointsBoost
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::PointsBoost]
+    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"]
+      status = parsed_json["status"]
+      start = parsed_json["start"]
+      end_ = parsed_json["end"]
+      multiplier = parsed_json["multiplier"]
+      rounding = parsed_json["rounding"]
+      new(
+        id: id,
+        name: name,
+        status: status,
+        start: start,
+        end_: end_,
+        multiplier: multiplier,
+        rounding: rounding,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of PointsBoost 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.status.is_a?(TrophyApiClient::PointsBoostStatus) != 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::PointsBoostRounding) != false || raise("Passed value for field obj.rounding is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/points_boost_rounding.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The rounding method of the points boost
+  class PointsBoostRounding
+    DOWN = "down"
+    UP = "up"
+    NEAREST = "nearest"
+  end
+end

data/lib/trophy_api_client/types/points_boost_status.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The status of the points boost
+  class PointsBoostStatus
+    ACTIVE = "active"
+    SCHEDULED = "scheduled"
+    FINISHED = "finished"
+  end
+end