trophy_api_client 1.0.27 → 1.0.28

data/lib/trophy_api_client/types/base_streak_response.rb

@@ -18,6 +18,18 @@ module TrophyApiClient
     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]
@@ -32,16 +44,28 @@ module TrophyApiClient
     # @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::BaseStreakResponse]
     def initialize(length:, frequency:, started: OMIT, period_start: OMIT, period_end: OMIT, expires: OMIT,
-                   additional_properties: nil)
+                   freezes: OMIT, max_freezes: OMIT, freeze_auto_earn_interval: OMIT, freeze_auto_earn_amount: OMIT, additional_properties: nil)
       @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 = {
         "length": length,
@@ -49,7 +73,11 @@ module TrophyApiClient
         "started": started,
         "periodStart": period_start,
         "periodEnd": period_end,
-        "expires": expires
+        "expires": expires,
+        "freezes": freezes,
+        "maxFreezes": max_freezes,
+        "freezeAutoEarnInterval": freeze_auto_earn_interval,
+        "freezeAutoEarnAmount": freeze_auto_earn_amount
       }.reject do |_k, v|
         v == OMIT
       end
@@ -68,6 +96,10 @@ module TrophyApiClient
       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(
         length: length,
         frequency: frequency,
@@ -75,6 +107,10 @@ module TrophyApiClient
         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
@@ -99,6 +135,10 @@ module TrophyApiClient
       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/bulk_insert_issue.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "bulk_insert_issue_level"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # An issue encountered while bulk inserting data.
+  class BulkInsertIssue
+    # @return [String] The ID of the user the issue relates to.
+    attr_reader :user_id
+    # @return [TrophyApiClient::BulkInsertIssueLevel] The severity level of the issue.
+    attr_reader :level
+    # @return [String] A human-readable description of the issue.
+    attr_reader :reason
+    # @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 user_id [String] The ID of the user the issue relates to.
+    # @param level [TrophyApiClient::BulkInsertIssueLevel] The severity level of the issue.
+    # @param reason [String] A human-readable description of the issue.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::BulkInsertIssue]
+    def initialize(user_id:, level:, reason:, additional_properties: nil)
+      @user_id = user_id
+      @level = level
+      @reason = reason
+      @additional_properties = additional_properties
+      @_field_set = { "userId": user_id, "level": level, "reason": reason }
+    end
+
+    # Deserialize a JSON object to an instance of BulkInsertIssue
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::BulkInsertIssue]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      user_id = parsed_json["userId"]
+      level = parsed_json["level"]
+      reason = parsed_json["reason"]
+      new(
+        user_id: user_id,
+        level: level,
+        reason: reason,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of BulkInsertIssue 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.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
+      obj.level.is_a?(TrophyApiClient::BulkInsertIssueLevel) != false || raise("Passed value for field obj.level is not the expected type, validation failed.")
+      obj.reason.is_a?(String) != false || raise("Passed value for field obj.reason is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/bulk_insert_issue_level.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The severity level of the issue.
+  class BulkInsertIssueLevel
+    ERROR = "error"
+    WARNING = "warning"
+  end
+end

data/lib/trophy_api_client/types/create_streak_freezes_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative "bulk_insert_issue"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Response containing any issues encountered while creating streak freezes.
+  class CreateStreakFreezesResponse
+    # @return [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during freeze 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 issues [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during freeze creation.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::CreateStreakFreezesResponse]
+    def initialize(issues:, additional_properties: nil)
+      @issues = issues
+      @additional_properties = additional_properties
+      @_field_set = { "issues": issues }
+    end
+
+    # Deserialize a JSON object to an instance of CreateStreakFreezesResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CreateStreakFreezesResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      issues = parsed_json["issues"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::BulkInsertIssue.from_json(json_object: item)
+      end
+      new(issues: issues, additional_properties: struct)
+    end
+
+    # Serialize an instance of CreateStreakFreezesResponse 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.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/metric_event_streak_response.rb

@@ -21,6 +21,18 @@ module TrophyApiClient
     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]
@@ -36,10 +48,18 @@ module TrophyApiClient
     # @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::MetricEventStreakResponse]
     def initialize(length:, frequency:, extended: OMIT, started: OMIT, period_start: OMIT, period_end: OMIT,
-                   expires: OMIT, additional_properties: nil)
+                   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
       @length = length
       @frequency = frequency
@@ -47,6 +67,10 @@ module TrophyApiClient
       @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,
@@ -55,7 +79,11 @@ module TrophyApiClient
         "started": started,
         "periodStart": period_start,
         "periodEnd": period_end,
-        "expires": expires
+        "expires": expires,
+        "freezes": freezes,
+        "maxFreezes": max_freezes,
+        "freezeAutoEarnInterval": freeze_auto_earn_interval,
+        "freezeAutoEarnAmount": freeze_auto_earn_amount
       }.reject do |_k, v|
         v == OMIT
       end
@@ -75,6 +103,10 @@ module TrophyApiClient
       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,
         length: length,
@@ -83,6 +115,10 @@ module TrophyApiClient
         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
@@ -108,6 +144,10 @@ module TrophyApiClient
       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.rb

@@ -25,6 +25,18 @@ module TrophyApiClient
     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]
@@ -42,10 +54,18 @@ module TrophyApiClient
     # @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(length:, frequency:, streak_history: OMIT, rank: OMIT, started: OMIT, period_start: OMIT,
-                   period_end: OMIT, expires: OMIT, additional_properties: nil)
+                   period_end: OMIT, expires: OMIT, freezes: OMIT, max_freezes: OMIT, freeze_auto_earn_interval: OMIT, freeze_auto_earn_amount: OMIT, additional_properties: nil)
       @streak_history = streak_history if streak_history != OMIT
       @rank = rank if rank != OMIT
       @length = length
@@ -54,6 +74,10 @@ module TrophyApiClient
       @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 = {
         "streakHistory": streak_history,
@@ -63,7 +87,11 @@ module TrophyApiClient
         "started": started,
         "periodStart": period_start,
         "periodEnd": period_end,
-        "expires": expires
+        "expires": expires,
+        "freezes": freezes,
+        "maxFreezes": max_freezes,
+        "freezeAutoEarnInterval": freeze_auto_earn_interval,
+        "freezeAutoEarnAmount": freeze_auto_earn_amount
       }.reject do |_k, v|
         v == OMIT
       end
@@ -87,6 +115,10 @@ module TrophyApiClient
       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(
         streak_history: streak_history,
         rank: rank,
@@ -96,6 +128,10 @@ module TrophyApiClient
         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
@@ -122,6 +158,10 @@ module TrophyApiClient
       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

@@ -12,6 +12,9 @@ module TrophyApiClient
     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]
@@ -23,14 +26,24 @@ module TrophyApiClient
     # @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:, additional_properties: nil)
+    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 }
+      @_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
@@ -43,10 +56,12 @@ module TrophyApiClient
       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
@@ -68,6 +83,7 @@ module TrophyApiClient
       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