trophy_api_client 1.13.0 → 1.26.1

data/lib/trophy_api_client/types/streak_metric_preference.rb

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

data/lib/trophy_api_client/types/streak_preferences.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "streak_evaluation_mode_preference"
-require_relative "streak_metric_preference"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # Per-user streak configuration. Requires streak customization to be enabled in
-  #  dashboard settings.
-  class StreakPreferences
-    # @return [TrophyApiClient::StreakEvaluationModePreference]
-    attr_reader :evaluation_mode
-    # @return [Array<TrophyApiClient::StreakMetricPreference>] Metrics and thresholds that count toward this user's streak.
-    attr_reader :metrics
-    # @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 evaluation_mode [TrophyApiClient::StreakEvaluationModePreference]
-    # @param metrics [Array<TrophyApiClient::StreakMetricPreference>] Metrics and thresholds that count toward this user's streak.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::StreakPreferences]
-    def initialize(evaluation_mode: OMIT, metrics: OMIT, additional_properties: nil)
-      @evaluation_mode = evaluation_mode if evaluation_mode != OMIT
-      @metrics = metrics if metrics != OMIT
-      @additional_properties = additional_properties
-      @_field_set = { "evaluationMode": evaluation_mode, "metrics": metrics }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of StreakPreferences
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::StreakPreferences]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      evaluation_mode = parsed_json["evaluationMode"]
-      metrics = parsed_json["metrics"]&.map do |item|
-        item = item.to_json
-        TrophyApiClient::StreakMetricPreference.from_json(json_object: item)
-      end
-      new(
-        evaluation_mode: evaluation_mode,
-        metrics: metrics,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of StreakPreferences 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.evaluation_mode&.is_a?(TrophyApiClient::StreakEvaluationModePreference) != false || raise("Passed value for field obj.evaluation_mode is not the expected type, validation failed.")
-      obj.metrics&.is_a?(Array) != false || raise("Passed value for field obj.metrics is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/streak_response.rb

@@ -1,170 +0,0 @@
-# frozen_string_literal: true
-
-require "date"
-require_relative "streak_response_streak_history_item"
-require_relative "streak_frequency"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # An object representing the user's streak.
-  class StreakResponse
-    # @return [DateTime] The timestamp the streak was most recently extended. Null if the streak is not
-    #  active.
-    attr_reader :extended
-    # @return [Array<TrophyApiClient::StreakResponseStreakHistoryItem>] A list of the user's past streak periods up through the current period. Each
-    #  period includes the start and end dates and the length of the streak.
-    attr_reader :streak_history
-    # @return [Integer] The length of the user's current streak.
-    attr_reader :length
-    # @return [TrophyApiClient::StreakFrequency] The frequency of the streak.
-    attr_reader :frequency
-    # @return [String] The date the streak started.
-    attr_reader :started
-    # @return [String] The start date of the current streak period.
-    attr_reader :period_start
-    # @return [String] The end date of the current streak period.
-    attr_reader :period_end
-    # @return [String] The date the streak will expire if the user does not increment a metric.
-    attr_reader :expires
-    # @return [Integer] The number of available streak freezes. Only present if the organization has
-    #  enabled streak freezes.
-    attr_reader :freezes
-    # @return [Integer] The maximum number of streak freezes a user can have. Only present if the
-    #  organization has enabled streak freezes.
-    attr_reader :max_freezes
-    # @return [Integer] The interval at which the user will earn streak freezes, in days. Only present
-    #  if the organization has enabled streak freeze auto-earn.
-    attr_reader :freeze_auto_earn_interval
-    # @return [Integer] The amount of streak freezes the user will earn per interval. Only present if
-    #  the organization has enabled streak freeze auto-earn.
-    attr_reader :freeze_auto_earn_amount
-    # @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 extended [DateTime] The timestamp the streak was most recently extended. Null if the streak is not
-    #  active.
-    # @param streak_history [Array<TrophyApiClient::StreakResponseStreakHistoryItem>] A list of the user's past streak periods up through the current period. Each
-    #  period includes the start and end dates and the length of the streak.
-    # @param length [Integer] The length of the user's current streak.
-    # @param frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
-    # @param started [String] The date the streak started.
-    # @param period_start [String] The start date of the current streak period.
-    # @param period_end [String] The end date of the current streak period.
-    # @param expires [String] The date the streak will expire if the user does not increment a metric.
-    # @param freezes [Integer] The number of available streak freezes. Only present if the organization has
-    #  enabled streak freezes.
-    # @param max_freezes [Integer] The maximum number of streak freezes a user can have. Only present if the
-    #  organization has enabled streak freezes.
-    # @param freeze_auto_earn_interval [Integer] The interval at which the user will earn streak freezes, in days. Only present
-    #  if the organization has enabled streak freeze auto-earn.
-    # @param freeze_auto_earn_amount [Integer] The amount of streak freezes the user will earn per interval. Only present if
-    #  the organization has enabled streak freeze auto-earn.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::StreakResponse]
-    def initialize(streak_history:, length:, frequency:, extended: OMIT, started: OMIT, period_start: OMIT,
-                   period_end: OMIT, expires: OMIT, freezes: OMIT, max_freezes: OMIT, freeze_auto_earn_interval: OMIT, freeze_auto_earn_amount: OMIT, additional_properties: nil)
-      @extended = extended if extended != OMIT
-      @streak_history = streak_history
-      @length = length
-      @frequency = frequency
-      @started = started if started != OMIT
-      @period_start = period_start if period_start != OMIT
-      @period_end = period_end if period_end != OMIT
-      @expires = expires if expires != OMIT
-      @freezes = freezes if freezes != OMIT
-      @max_freezes = max_freezes if max_freezes != OMIT
-      @freeze_auto_earn_interval = freeze_auto_earn_interval if freeze_auto_earn_interval != OMIT
-      @freeze_auto_earn_amount = freeze_auto_earn_amount if freeze_auto_earn_amount != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "extended": extended,
-        "streakHistory": streak_history,
-        "length": length,
-        "frequency": frequency,
-        "started": started,
-        "periodStart": period_start,
-        "periodEnd": period_end,
-        "expires": expires,
-        "freezes": freezes,
-        "maxFreezes": max_freezes,
-        "freezeAutoEarnInterval": freeze_auto_earn_interval,
-        "freezeAutoEarnAmount": freeze_auto_earn_amount
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of StreakResponse
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::StreakResponse]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      extended = (DateTime.parse(parsed_json["extended"]) unless parsed_json["extended"].nil?)
-      streak_history = parsed_json["streakHistory"]&.map do |item|
-        item = item.to_json
-        TrophyApiClient::StreakResponseStreakHistoryItem.from_json(json_object: item)
-      end
-      length = parsed_json["length"]
-      frequency = parsed_json["frequency"]
-      started = parsed_json["started"]
-      period_start = parsed_json["periodStart"]
-      period_end = parsed_json["periodEnd"]
-      expires = parsed_json["expires"]
-      freezes = parsed_json["freezes"]
-      max_freezes = parsed_json["maxFreezes"]
-      freeze_auto_earn_interval = parsed_json["freezeAutoEarnInterval"]
-      freeze_auto_earn_amount = parsed_json["freezeAutoEarnAmount"]
-      new(
-        extended: extended,
-        streak_history: streak_history,
-        length: length,
-        frequency: frequency,
-        started: started,
-        period_start: period_start,
-        period_end: period_end,
-        expires: expires,
-        freezes: freezes,
-        max_freezes: max_freezes,
-        freeze_auto_earn_interval: freeze_auto_earn_interval,
-        freeze_auto_earn_amount: freeze_auto_earn_amount,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of StreakResponse 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.extended&.is_a?(DateTime) != false || raise("Passed value for field obj.extended is not the expected type, validation failed.")
-      obj.streak_history.is_a?(Array) != false || raise("Passed value for field obj.streak_history is not the expected type, validation failed.")
-      obj.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
-      obj.frequency.is_a?(TrophyApiClient::StreakFrequency) != false || raise("Passed value for field obj.frequency is not the expected type, validation failed.")
-      obj.started&.is_a?(String) != false || raise("Passed value for field obj.started is not the expected type, validation failed.")
-      obj.period_start&.is_a?(String) != false || raise("Passed value for field obj.period_start is not the expected type, validation failed.")
-      obj.period_end&.is_a?(String) != false || raise("Passed value for field obj.period_end is not the expected type, validation failed.")
-      obj.expires&.is_a?(String) != false || raise("Passed value for field obj.expires is not the expected type, validation failed.")
-      obj.freezes&.is_a?(Integer) != false || raise("Passed value for field obj.freezes is not the expected type, validation failed.")
-      obj.max_freezes&.is_a?(Integer) != false || raise("Passed value for field obj.max_freezes is not the expected type, validation failed.")
-      obj.freeze_auto_earn_interval&.is_a?(Integer) != false || raise("Passed value for field obj.freeze_auto_earn_interval is not the expected type, validation failed.")
-      obj.freeze_auto_earn_amount&.is_a?(Integer) != false || raise("Passed value for field obj.freeze_auto_earn_amount is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/streak_response_streak_history_item.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # An object representing a past streak period.
-  class StreakResponseStreakHistoryItem
-    # @return [String] The date this streak period started.
-    attr_reader :period_start
-    # @return [String] The date this streak period ended.
-    attr_reader :period_end
-    # @return [Integer] The length of the user's streak during this period.
-    attr_reader :length
-    # @return [Boolean] Whether the user used a streak freeze during this period. Only present if the
-    #  organization has enabled streak freezes.
-    attr_reader :used_freeze
-    # @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 period_start [String] The date this streak period started.
-    # @param period_end [String] The date this streak period ended.
-    # @param length [Integer] The length of the user's streak during this period.
-    # @param used_freeze [Boolean] Whether the user used a streak freeze during this period. Only present if the
-    #  organization has enabled streak freezes.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::StreakResponseStreakHistoryItem]
-    def initialize(period_start:, period_end:, length:, used_freeze: OMIT, additional_properties: nil)
-      @period_start = period_start
-      @period_end = period_end
-      @length = length
-      @used_freeze = used_freeze if used_freeze != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "periodStart": period_start,
-        "periodEnd": period_end,
-        "length": length,
-        "usedFreeze": used_freeze
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of StreakResponseStreakHistoryItem
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::StreakResponseStreakHistoryItem]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      period_start = parsed_json["periodStart"]
-      period_end = parsed_json["periodEnd"]
-      length = parsed_json["length"]
-      used_freeze = parsed_json["usedFreeze"]
-      new(
-        period_start: period_start,
-        period_end: period_end,
-        length: length,
-        used_freeze: used_freeze,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of StreakResponseStreakHistoryItem 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.period_start.is_a?(String) != false || raise("Passed value for field obj.period_start is not the expected type, validation failed.")
-      obj.period_end.is_a?(String) != false || raise("Passed value for field obj.period_end is not the expected type, validation failed.")
-      obj.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
-      obj.used_freeze&.is_a?(Boolean) != false || raise("Passed value for field obj.used_freeze is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/update_attribute_request_item.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # An attribute update object. `id` is required and `name` is optional. `key` and
-  #  `type` cannot be changed through this endpoint.
-  class UpdateAttributeRequestItem
-    # @return [String] The UUID of the attribute to update.
-    attr_reader :id
-    # @return [String] The updated attribute name.
-    attr_reader :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 UUID of the attribute to update.
-    # @param name [String] The updated attribute name.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::UpdateAttributeRequestItem]
-    def initialize(id:, name: OMIT, additional_properties: nil)
-      @id = id
-      @name = name if name != OMIT
-      @additional_properties = additional_properties
-      @_field_set = { "id": id, "name": name }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of UpdateAttributeRequestItem
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::UpdateAttributeRequestItem]
-    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"]
-      new(
-        id: id,
-        name: name,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of UpdateAttributeRequestItem 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.")
-    end
-  end
-end

data/lib/trophy_api_client/types/update_attributes_request.rb

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

data/lib/trophy_api_client/types/update_attributes_response.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "admin_attribute"
-require_relative "admin_issue"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # Response containing updated attributes and any per-item issues identified by
-  #  attribute ID.
-  class UpdateAttributesResponse
-    # @return [Array<TrophyApiClient::AdminAttribute>] Array of successfully updated attributes.
-    attr_reader :updated
-    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during attribute update.
-    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 updated [Array<TrophyApiClient::AdminAttribute>] Array of successfully updated attributes.
-    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during attribute update.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::UpdateAttributesResponse]
-    def initialize(updated:, issues:, additional_properties: nil)
-      @updated = updated
-      @issues = issues
-      @additional_properties = additional_properties
-      @_field_set = { "updated": updated, "issues": issues }
-    end
-
-    # Deserialize a JSON object to an instance of UpdateAttributesResponse
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::UpdateAttributesResponse]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      updated = parsed_json["updated"]&.map do |item|
-        item = item.to_json
-        TrophyApiClient::AdminAttribute.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(
-        updated: updated,
-        issues: issues,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of UpdateAttributesResponse 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.updated.is_a?(Array) != false || raise("Passed value for field obj.updated 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