trophy_api_client 1.0.9 → 1.0.11

data/lib/trophy_api_client/types/points_award.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "points_trigger"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class PointsAward
+    # @return [String] The ID of the trigger award
+    attr_reader :id
+    # @return [Float] The points awarded by this trigger
+    attr_reader :awarded
+    # @return [TrophyApiClient::PointsTrigger]
+    attr_reader :trigger
+    # @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 trigger award
+    # @param awarded [Float] The points awarded by this trigger
+    # @param trigger [TrophyApiClient::PointsTrigger]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::PointsAward]
+    def initialize(id: OMIT, awarded: OMIT, trigger: OMIT, additional_properties: nil)
+      @id = id if id != OMIT
+      @awarded = awarded if awarded != OMIT
+      @trigger = trigger if trigger != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "awarded": awarded, "trigger": trigger }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of PointsAward
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::PointsAward]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      awarded = parsed_json["awarded"]
+      if parsed_json["trigger"].nil?
+        trigger = nil
+      else
+        trigger = parsed_json["trigger"].to_json
+        trigger = TrophyApiClient::PointsTrigger.from_json(json_object: trigger)
+      end
+      new(
+        id: id,
+        awarded: awarded,
+        trigger: trigger,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of PointsAward 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.awarded&.is_a?(Float) != false || raise("Passed value for field obj.awarded is not the expected type, validation failed.")
+      obj.trigger.nil? || TrophyApiClient::PointsTrigger.validate_raw(obj: obj.trigger)
+    end
+  end
+end

data/lib/trophy_api_client/types/points_range.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class PointsRange
+    # @return [Float] The start of the points range. Inclusive.
+    attr_reader :from
+    # @return [Float] The end of the points range. Inclusive.
+    attr_reader :to
+    # @return [Float] The number of users in this points range.
+    attr_reader :users
+    # @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 from [Float] The start of the points range. Inclusive.
+    # @param to [Float] The end of the points range. Inclusive.
+    # @param users [Float] The number of users in this points range.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::PointsRange]
+    def initialize(from: OMIT, to: OMIT, users: OMIT, additional_properties: nil)
+      @from = from if from != OMIT
+      @to = to if to != OMIT
+      @users = users if users != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "from": from, "to": to, "users": users }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of PointsRange
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::PointsRange]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      from = parsed_json["from"]
+      to = parsed_json["to"]
+      users = parsed_json["users"]
+      new(
+        from: from,
+        to: to,
+        users: users,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of PointsRange 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.from&.is_a?(Float) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
+      obj.to&.is_a?(Float) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
+      obj.users&.is_a?(Float) != false || raise("Passed value for field obj.users is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/points_summary_response.rb

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

data/lib/trophy_api_client/types/points_trigger.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require_relative "points_trigger_type"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class PointsTrigger
+    # @return [String] The ID of the trigger
+    attr_reader :id
+    # @return [TrophyApiClient::PointsTriggerType] The type of trigger
+    attr_reader :type
+    # @return [Float] The points awarded by this trigger.
+    attr_reader :points
+    # @return [String] If the trigger has type 'metric', the name of the metric
+    attr_reader :metric_name
+    # @return [Float] If the trigger has type 'metric', the threshold of the metric that triggers the
+    #  points
+    attr_reader :metric_threshold
+    # @return [Float] If the trigger has type 'streak', the threshold of the streak that triggers the
+    #  points
+    attr_reader :streak_length_threshold
+    # @return [String] If the trigger has type 'achievement', the name of the achievement
+    attr_reader :achievement_name
+    # @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 trigger
+    # @param type [TrophyApiClient::PointsTriggerType] The type of trigger
+    # @param points [Float] The points awarded by this trigger.
+    # @param metric_name [String] If the trigger has type 'metric', the name of the metric
+    # @param metric_threshold [Float] If the trigger has type 'metric', the threshold of the metric that triggers the
+    #  points
+    # @param streak_length_threshold [Float] If the trigger has type 'streak', the threshold of the streak that triggers the
+    #  points
+    # @param achievement_name [String] If the trigger has type 'achievement', the name of the achievement
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::PointsTrigger]
+    def initialize(id: OMIT, type: OMIT, points: OMIT, metric_name: OMIT, metric_threshold: OMIT,
+                   streak_length_threshold: OMIT, achievement_name: OMIT, additional_properties: nil)
+      @id = id if id != OMIT
+      @type = type if type != OMIT
+      @points = points if points != OMIT
+      @metric_name = metric_name if metric_name != OMIT
+      @metric_threshold = metric_threshold if metric_threshold != OMIT
+      @streak_length_threshold = streak_length_threshold if streak_length_threshold != OMIT
+      @achievement_name = achievement_name if achievement_name != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "type": type,
+        "points": points,
+        "metricName": metric_name,
+        "metricThreshold": metric_threshold,
+        "streakLengthThreshold": streak_length_threshold,
+        "achievementName": achievement_name
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of PointsTrigger
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::PointsTrigger]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      type = parsed_json["type"]
+      points = parsed_json["points"]
+      metric_name = parsed_json["metricName"]
+      metric_threshold = parsed_json["metricThreshold"]
+      streak_length_threshold = parsed_json["streakLengthThreshold"]
+      achievement_name = parsed_json["achievementName"]
+      new(
+        id: id,
+        type: type,
+        points: points,
+        metric_name: metric_name,
+        metric_threshold: metric_threshold,
+        streak_length_threshold: streak_length_threshold,
+        achievement_name: achievement_name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of PointsTrigger 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.type&.is_a?(TrophyApiClient::PointsTriggerType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      obj.points&.is_a?(Float) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+      obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
+      obj.metric_threshold&.is_a?(Float) != false || raise("Passed value for field obj.metric_threshold is not the expected type, validation failed.")
+      obj.streak_length_threshold&.is_a?(Float) != false || raise("Passed value for field obj.streak_length_threshold is not the expected type, validation failed.")
+      obj.achievement_name&.is_a?(String) != false || raise("Passed value for field obj.achievement_name is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/points_trigger_response.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require_relative "points_trigger_response_type"
+require_relative "points_trigger_response_status"
+require "date"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class PointsTriggerResponse
+    # @return [String] The unique ID of the trigger.
+    attr_reader :id
+    # @return [TrophyApiClient::PointsTriggerResponseType] The type of trigger.
+    attr_reader :type
+    # @return [Float] The points awarded by this trigger.
+    attr_reader :points
+    # @return [TrophyApiClient::PointsTriggerResponseStatus] The status of the trigger.
+    attr_reader :status
+    # @return [String] The unique ID of the achievement associated with this trigger, if the trigger is
+    #  an achievement.
+    attr_reader :achievement_id
+    # @return [String] The unique ID of the metric associated with this trigger, if the trigger is a
+    #  metric.
+    attr_reader :metric_id
+    # @return [Float] The amount that a user must increase the metric to earn the points, if the
+    #  trigger is a metric.
+    attr_reader :metric_threshold
+    # @return [Float] The number of consecutive streak periods that a user must complete to earn the
+    #  points, if the trigger is a streak.
+    attr_reader :streak_length_threshold
+    # @return [String] The name of the metric associated with this trigger, if the trigger is a metric.
+    attr_reader :metric_name
+    # @return [String] The name of the achievement associated with this trigger, if the trigger is an
+    #  achievement.
+    attr_reader :achievement_name
+    # @return [DateTime] The date and time the trigger was created, in ISO 8601 format.
+    attr_reader :created
+    # @return [DateTime] The date and time the trigger was last updated, in ISO 8601 format.
+    attr_reader :updated
+    # @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 unique ID of the trigger.
+    # @param type [TrophyApiClient::PointsTriggerResponseType] The type of trigger.
+    # @param points [Float] The points awarded by this trigger.
+    # @param status [TrophyApiClient::PointsTriggerResponseStatus] The status of the trigger.
+    # @param achievement_id [String] The unique ID of the achievement associated with this trigger, if the trigger is
+    #  an achievement.
+    # @param metric_id [String] The unique ID of the metric associated with this trigger, if the trigger is a
+    #  metric.
+    # @param metric_threshold [Float] The amount that a user must increase the metric to earn the points, if the
+    #  trigger is a metric.
+    # @param streak_length_threshold [Float] The number of consecutive streak periods that a user must complete to earn the
+    #  points, if the trigger is a streak.
+    # @param metric_name [String] The name of the metric associated with this trigger, if the trigger is a metric.
+    # @param achievement_name [String] The name of the achievement associated with this trigger, if the trigger is an
+    #  achievement.
+    # @param created [DateTime] The date and time the trigger was created, in ISO 8601 format.
+    # @param updated [DateTime] The date and time the trigger was last updated, in ISO 8601 format.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::PointsTriggerResponse]
+    def initialize(id: OMIT, type: OMIT, points: OMIT, status: OMIT, achievement_id: OMIT, metric_id: OMIT,
+                   metric_threshold: OMIT, streak_length_threshold: OMIT, metric_name: OMIT, achievement_name: OMIT, created: OMIT, updated: OMIT, additional_properties: nil)
+      @id = id if id != OMIT
+      @type = type if type != OMIT
+      @points = points if points != OMIT
+      @status = status if status != OMIT
+      @achievement_id = achievement_id if achievement_id != OMIT
+      @metric_id = metric_id if metric_id != OMIT
+      @metric_threshold = metric_threshold if metric_threshold != OMIT
+      @streak_length_threshold = streak_length_threshold if streak_length_threshold != OMIT
+      @metric_name = metric_name if metric_name != OMIT
+      @achievement_name = achievement_name if achievement_name != OMIT
+      @created = created if created != OMIT
+      @updated = updated if updated != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "type": type,
+        "points": points,
+        "status": status,
+        "achievementId": achievement_id,
+        "metricId": metric_id,
+        "metricThreshold": metric_threshold,
+        "streakLengthThreshold": streak_length_threshold,
+        "metricName": metric_name,
+        "achievementName": achievement_name,
+        "created": created,
+        "updated": updated
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of PointsTriggerResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::PointsTriggerResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      type = parsed_json["type"]
+      points = parsed_json["points"]
+      status = parsed_json["status"]
+      achievement_id = parsed_json["achievementId"]
+      metric_id = parsed_json["metricId"]
+      metric_threshold = parsed_json["metricThreshold"]
+      streak_length_threshold = parsed_json["streakLengthThreshold"]
+      metric_name = parsed_json["metricName"]
+      achievement_name = parsed_json["achievementName"]
+      created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
+      updated = (DateTime.parse(parsed_json["updated"]) unless parsed_json["updated"].nil?)
+      new(
+        id: id,
+        type: type,
+        points: points,
+        status: status,
+        achievement_id: achievement_id,
+        metric_id: metric_id,
+        metric_threshold: metric_threshold,
+        streak_length_threshold: streak_length_threshold,
+        metric_name: metric_name,
+        achievement_name: achievement_name,
+        created: created,
+        updated: updated,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of PointsTriggerResponse 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.type&.is_a?(TrophyApiClient::PointsTriggerResponseType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+      obj.points&.is_a?(Float) != false || raise("Passed value for field obj.points is not the expected type, validation failed.")
+      obj.status&.is_a?(TrophyApiClient::PointsTriggerResponseStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.achievement_id&.is_a?(String) != false || raise("Passed value for field obj.achievement_id is not the expected type, validation failed.")
+      obj.metric_id&.is_a?(String) != false || raise("Passed value for field obj.metric_id is not the expected type, validation failed.")
+      obj.metric_threshold&.is_a?(Float) != false || raise("Passed value for field obj.metric_threshold is not the expected type, validation failed.")
+      obj.streak_length_threshold&.is_a?(Float) != false || raise("Passed value for field obj.streak_length_threshold is not the expected type, validation failed.")
+      obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_name is not the expected type, validation failed.")
+      obj.achievement_name&.is_a?(String) != false || raise("Passed value for field obj.achievement_name is not the expected type, validation failed.")
+      obj.created&.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+      obj.updated&.is_a?(DateTime) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/points_trigger_response_status.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The status of the trigger.
+  class PointsTriggerResponseStatus
+    ACTIVE = "active"
+    ARCHIVED = "archived"
+  end
+end

data/lib/trophy_api_client/types/points_trigger_response_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The type of trigger.
+  class PointsTriggerResponseType
+    METRIC = "metric"
+    ACHIEVEMENT = "achievement"
+    STREAK = "streak"
+  end
+end

data/lib/trophy_api_client/types/points_trigger_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The type of trigger
+  class PointsTriggerType
+    METRIC = "metric"
+    ACHIEVEMENT = "achievement"
+    STREAK = "streak"
+  end
+end