trophy_api_client 0

data/lib/trophy_api_client/types/event_request_user.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # The user that triggered the event.
+  class EventRequestUser
+    # @return [String] The ID of the user in your database. Must be a string.
+    attr_reader :id
+    # @return [String] The user's email address.
+    attr_reader :email
+    # @return [String] The name to refer to the user by in emails.
+    attr_reader :name
+    # @return [String] The user's timezone (used for email scheduling).
+    attr_reader :tz
+    # @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 user in your database. Must be a string.
+    # @param email [String] The user's email address.
+    # @param name [String] The name to refer to the user by in emails.
+    # @param tz [String] The user's timezone (used for email scheduling).
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::EventRequestUser]
+    def initialize(id:, email: OMIT, name: OMIT, tz: OMIT, additional_properties: nil)
+      @id = id
+      @email = email if email != OMIT
+      @name = name if name != OMIT
+      @tz = tz if tz != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "email": email, "name": name, "tz": tz }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of EventRequestUser
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::EventRequestUser]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      email = parsed_json["email"]
+      name = parsed_json["name"]
+      tz = parsed_json["tz"]
+      new(
+        id: id,
+        email: email,
+        name: name,
+        tz: tz,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of EventRequestUser 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.email&.is_a?(String) != false || raise("Passed value for field obj.email 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.tz&.is_a?(String) != false || raise("Passed value for field obj.tz is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/event_response.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative "event_response_metrics_item"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class EventResponse
+    # @return [String] The unique ID of the event.
+    attr_reader :event_id
+    # @return [String] The unique ID of the metric that was updated.
+    attr_reader :metric_id
+    # @return [Float] The user's new total progress against the metric.
+    attr_reader :total
+    # @return [Array<TrophyApiClient::EventResponseMetricsItem>] Changes to achievements as a result of this event.
+    attr_reader :achievements
+    # @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 event_id [String] The unique ID of the event.
+    # @param metric_id [String] The unique ID of the metric that was updated.
+    # @param total [Float] The user's new total progress against the metric.
+    # @param achievements [Array<TrophyApiClient::EventResponseMetricsItem>] Changes to achievements as a result of this event.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::EventResponse]
+    def initialize(event_id:, metric_id:, total:, achievements: OMIT, additional_properties: nil)
+      @event_id = event_id
+      @metric_id = metric_id
+      @total = total
+      @achievements = achievements if achievements != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "eventId": event_id,
+        "metricId": metric_id,
+        "total": total,
+        "achievements": achievements
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of EventResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::EventResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      event_id = parsed_json["eventId"]
+      metric_id = parsed_json["metricId"]
+      total = parsed_json["total"]
+      achievements = parsed_json["achievements"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::EventResponseMetricsItem.from_json(json_object: item)
+      end
+      new(
+        event_id: event_id,
+        metric_id: metric_id,
+        total: total,
+        achievements: achievements,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of EventResponse 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.event_id.is_a?(String) != false || raise("Passed value for field obj.event_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.total.is_a?(Float) != false || raise("Passed value for field obj.total is not the expected type, validation failed.")
+      obj.achievements&.is_a?(Array) != false || raise("Passed value for field obj.achievements is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/event_response_metrics_item.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "achievement_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class EventResponseMetricsItem
+    # @return [String] The ID of the metric.
+    attr_reader :metric_id
+    # @return [Array<TrophyApiClient::AchievementResponse>] A list of any new achievements that the user has now completed as a result of
+    #  this event being submitted.
+    attr_reader :completed
+    # @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 metric_id [String] The ID of the metric.
+    # @param completed [Array<TrophyApiClient::AchievementResponse>] A list of any new achievements that the user has now completed as a result of
+    #  this event being submitted.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::EventResponseMetricsItem]
+    def initialize(metric_id: OMIT, completed: OMIT, additional_properties: nil)
+      @metric_id = metric_id if metric_id != OMIT
+      @completed = completed if completed != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "metricId": metric_id, "completed": completed }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of EventResponseMetricsItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::EventResponseMetricsItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      metric_id = parsed_json["metricId"]
+      completed = parsed_json["completed"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AchievementResponse.from_json(json_object: item)
+      end
+      new(
+        metric_id: metric_id,
+        completed: completed,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of EventResponseMetricsItem 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.metric_id&.is_a?(String) != false || raise("Passed value for field obj.metric_id is not the expected type, validation failed.")
+      obj.completed&.is_a?(Array) != false || raise("Passed value for field obj.completed is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/metric_response.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require_relative "streak_frequency"
+require_relative "metric_status"
+require_relative "achievement_response"
+require_relative "streak_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class MetricResponse
+    # @return [String] The unique ID of the metric.
+    attr_reader :id
+    # @return [String] The unique key of the metric.
+    attr_reader :key
+    # @return [String] The name of the metric.
+    attr_reader :name
+    # @return [String] The emoji to represent the metric.
+    attr_reader :emoji
+    # @return [TrophyApiClient::StreakFrequency] The frequency of the streak.
+    attr_reader :streak_frequency
+    # @return [TrophyApiClient::MetricStatus] The status of the metric.
+    attr_reader :status
+    # @return [Float] The user's current total for the metric.
+    attr_reader :current
+    # @return [Array<TrophyApiClient::AchievementResponse>] A list of the metric's achievements and the user's progress towards each.
+    attr_reader :achievements
+    # @return [TrophyApiClient::StreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    attr_reader :streak
+    # @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 metric.
+    # @param key [String] The unique key of the metric.
+    # @param name [String] The name of the metric.
+    # @param emoji [String] The emoji to represent the metric.
+    # @param streak_frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
+    # @param status [TrophyApiClient::MetricStatus] The status of the metric.
+    # @param current [Float] The user's current total for the metric.
+    # @param achievements [Array<TrophyApiClient::AchievementResponse>] A list of the metric's achievements and the user's progress towards each.
+    # @param streak [TrophyApiClient::StreakResponse] The user's current streak for the metric, if the metric has streaks enabled.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::MetricResponse]
+    def initialize(id:, key:, name:, emoji:, streak_frequency:, status:, current:, achievements:, streak: OMIT,
+                   additional_properties: nil)
+      @id = id
+      @key = key
+      @name = name
+      @emoji = emoji
+      @streak_frequency = streak_frequency
+      @status = status
+      @current = current
+      @achievements = achievements
+      @streak = streak if streak != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "key": key,
+        "name": name,
+        "emoji": emoji,
+        "streakFrequency": streak_frequency,
+        "status": status,
+        "current": current,
+        "achievements": achievements,
+        "streak": streak
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of MetricResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::MetricResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      key = parsed_json["key"]
+      name = parsed_json["name"]
+      emoji = parsed_json["emoji"]
+      streak_frequency = parsed_json["streakFrequency"]
+      status = parsed_json["status"]
+      current = parsed_json["current"]
+      achievements = parsed_json["achievements"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AchievementResponse.from_json(json_object: item)
+      end
+      if parsed_json["streak"].nil?
+        streak = nil
+      else
+        streak = parsed_json["streak"].to_json
+        streak = TrophyApiClient::StreakResponse.from_json(json_object: streak)
+      end
+      new(
+        id: id,
+        key: key,
+        name: name,
+        emoji: emoji,
+        streak_frequency: streak_frequency,
+        status: status,
+        current: current,
+        achievements: achievements,
+        streak: streak,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of MetricResponse 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.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.")
+      obj.emoji.is_a?(String) != false || raise("Passed value for field obj.emoji is not the expected type, validation failed.")
+      obj.streak_frequency.is_a?(TrophyApiClient::StreakFrequency) != false || raise("Passed value for field obj.streak_frequency is not the expected type, validation failed.")
+      obj.status.is_a?(TrophyApiClient::MetricStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.current.is_a?(Float) != false || raise("Passed value for field obj.current is not the expected type, validation failed.")
+      obj.achievements.is_a?(Array) != false || raise("Passed value for field obj.achievements is not the expected type, validation failed.")
+      obj.streak.nil? || TrophyApiClient::StreakResponse.validate_raw(obj: obj.streak)
+    end
+  end
+end

data/lib/trophy_api_client/types/metric_status.rb

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

data/lib/trophy_api_client/types/streak_frequency.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  class StreakFrequency
+    DAILY = "daily"
+    WEEKLY = "weekly"
+    MONTHLY = "monthly"
+    YEARLY = "yearly"
+  end
+end

data/lib/trophy_api_client/types/streak_response.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "streak_frequency"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class StreakResponse
+    # @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 [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 length [Integer] The length of the user's current streak.
+    # @param frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::StreakResponse]
+    def initialize(length:, frequency:, additional_properties: nil)
+      @length = length
+      @frequency = frequency
+      @additional_properties = additional_properties
+      @_field_set = { "length": length, "frequency": frequency }
+    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)
+      length = parsed_json["length"]
+      frequency = parsed_json["frequency"]
+      new(
+        length: length,
+        frequency: frequency,
+        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.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.")
+    end
+  end
+end