trophy_api_client 1.14.0 → 1.26.1

data/lib/trophy/types/batch_events_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response returned when a batch of metric events is accepted.
+    class BatchEventsResponse < Internal::Types::Model
+      field :accepted, -> { Integer }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/batch_metric_event.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A metric event submitted as part of a batch. Same shape as a single metric event, with the metric key included in
+    # the body.
+    class BatchMetricEvent < Internal::Types::Model
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :user, -> { Trophy::Types::BatchMetricEventUser }, optional: false, nullable: false
+
+      field :value, -> { Integer }, optional: false, nullable: false
+
+      field :attributes, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
+
+      field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "idempotencyKey"
+    end
+  end
+end

data/lib/trophy/types/batch_metric_event_user.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # The user that triggered a batch metric event.
+    class BatchMetricEventUser < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :email, -> { String }, optional: true, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :tz, -> { String }, optional: true, nullable: false
+
+      field :device_tokens, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "deviceTokens"
+
+      field :subscribe_to_emails, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "subscribeToEmails"
+
+      field :attributes, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/bulk_streak_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module BulkStreakResponse
+      # BulkStreakResponse is an alias for Array
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/trophy/types/bulk_streak_response_item.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class BulkStreakResponseItem < Internal::Types::Model
+      field :user_id, -> { String }, optional: false, nullable: false, api_name: "userId"
+
+      field :streak_length, -> { Integer }, optional: false, nullable: false, api_name: "streakLength"
+
+      field :extended, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_achievement_request_item.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An achievement to create. Trigger-specific fields are required based on `trigger`. `status` defaults to
+    # `inactive`.
+    class CreateAchievementRequestItem < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :trigger, -> { Trophy::Types::CreateAchievementRequestItemTrigger }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :status, -> { Trophy::Types::CreateAchievementRequestItemStatus }, optional: true, nullable: false
+
+      field :badge, -> { Trophy::Types::CreateAchievementRequestItemBadge }, optional: true, nullable: false
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::CreateAchievementRequestItemUserAttributesItem] }, optional: true, nullable: false, api_name: "userAttributes"
+
+      field :key, -> { String }, optional: true, nullable: false
+
+      field :metric_id, -> { String }, optional: true, nullable: false, api_name: "metricId"
+
+      field :metric_value, -> { Integer }, optional: true, nullable: false, api_name: "metricValue"
+
+      field :event_attributes, -> { Internal::Types::Array[Trophy::Types::CreateAchievementRequestItemEventAttributesItem] }, optional: true, nullable: false, api_name: "eventAttributes"
+
+      field :streak_length, -> { Integer }, optional: true, nullable: false, api_name: "streakLength"
+
+      field :anniversary_years, -> { Integer }, optional: true, nullable: false, api_name: "anniversaryYears"
+
+      field :achievement_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "achievementIds"
+    end
+  end
+end

data/lib/trophy/types/create_achievement_request_item_badge.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An optional badge for the achievement.
+    class CreateAchievementRequestItemBadge < Internal::Types::Model
+      field :url, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_achievement_request_item_event_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class CreateAchievementRequestItemEventAttributesItem < Internal::Types::Model
+      field :attribute_id, -> { String }, optional: false, nullable: false, api_name: "attributeId"
+
+      field :attribute_value, -> { String }, optional: false, nullable: false, api_name: "attributeValue"
+    end
+  end
+end

data/lib/trophy/types/create_achievement_request_item_status.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateAchievementRequestItemStatus
+      extend Trophy::Internal::Types::Enum
+
+      ACTIVE = "active"
+      INACTIVE = "inactive"
+      LOCKED = "locked"
+    end
+  end
+end

data/lib/trophy/types/create_achievement_request_item_trigger.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateAchievementRequestItemTrigger
+      extend Trophy::Internal::Types::Enum
+
+      METRIC = "metric"
+      STREAK = "streak"
+      API = "api"
+      ACHIEVEMENT = "achievement"
+      ANNIVERSARY = "anniversary"
+    end
+  end
+end

data/lib/trophy/types/create_achievement_request_item_user_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class CreateAchievementRequestItemUserAttributesItem < Internal::Types::Model
+      field :attribute_id, -> { String }, optional: false, nullable: false, api_name: "attributeId"
+
+      field :attribute_value, -> { String }, optional: false, nullable: false, api_name: "attributeValue"
+    end
+  end
+end

data/lib/trophy/types/create_achievements_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateAchievementsRequest
+      # CreateAchievementsRequest is an alias for Array
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/trophy/types/create_achievements_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing created achievements and any per-item issues.
+    class CreateAchievementsResponse < Internal::Types::Model
+      field :created, -> { Internal::Types::Array[Trophy::Types::AdminAchievement] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_application_key_request_item.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A user to create an application API key for.
+    class CreateApplicationKeyRequestItem < Internal::Types::Model
+      field :user_id, -> { String }, optional: false, nullable: false, api_name: "userId"
+    end
+  end
+end

data/lib/trophy/types/create_application_keys_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateApplicationKeysRequest
+      # CreateApplicationKeysRequest is an alias for Array
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/trophy/types/create_application_keys_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing created application API keys and any issues.
+    class CreateApplicationKeysResponse < Internal::Types::Model
+      field :created, -> { Internal::Types::Array[Trophy::Types::CreatedApplicationKey] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_attribute_request_item.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An attribute to create.
+    class CreateAttributeRequestItem < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :type, -> { Trophy::Types::CreateAttributeRequestItemType }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_attribute_request_item_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateAttributeRequestItemType
+      extend Trophy::Internal::Types::Enum
+
+      USER = "user"
+      EVENT = "event"
+    end
+  end
+end

data/lib/trophy/types/create_attributes_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateAttributesRequest
+      # CreateAttributesRequest is an alias for Array
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/trophy/types/create_attributes_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing created attributes and any per-item issues.
+    class CreateAttributesResponse < Internal::Types::Model
+      field :created, -> { Internal::Types::Array[Trophy::Types::AdminAttribute] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_leaderboard_request_item.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A leaderboard to create.
+    class CreateLeaderboardRequestItem < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :status, -> { Trophy::Types::CreateLeaderboardRequestItemStatus }, optional: true, nullable: false
+
+      field :rank_by, -> { Trophy::Types::CreateLeaderboardRequestItemRankBy }, optional: false, nullable: false, api_name: "rankBy"
+
+      field :metric_id, -> { String }, optional: true, nullable: false, api_name: "metricId"
+
+      field :points_system_id, -> { String }, optional: true, nullable: false, api_name: "pointsSystemId"
+
+      field :max_participants, -> { Integer }, optional: true, nullable: false, api_name: "maxParticipants"
+
+      field :start, -> { String }, optional: true, nullable: false
+
+      field :end_, -> { String }, optional: true, nullable: false, api_name: "end"
+
+      field :start_time, -> { String }, optional: true, nullable: false, api_name: "startTime"
+
+      field :end_time, -> { String }, optional: true, nullable: false, api_name: "endTime"
+
+      field :breakdown_attributes, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "breakdownAttributes"
+
+      field :run_unit, -> { Trophy::Types::CreateLeaderboardRequestItemRunUnit }, optional: true, nullable: false, api_name: "runUnit"
+
+      field :run_interval, -> { Integer }, optional: true, nullable: false, api_name: "runInterval"
+    end
+  end
+end

data/lib/trophy/types/create_leaderboard_request_item_rank_by.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateLeaderboardRequestItemRankBy
+      extend Trophy::Internal::Types::Enum
+
+      METRIC = "metric"
+      STREAK = "streak"
+      POINTS = "points"
+    end
+  end
+end

data/lib/trophy/types/create_leaderboard_request_item_run_unit.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateLeaderboardRequestItemRunUnit
+      extend Trophy::Internal::Types::Enum
+
+      DAY = "day"
+      MONTH = "month"
+      YEAR = "year"
+    end
+  end
+end

data/lib/trophy/types/create_leaderboard_request_item_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateLeaderboardRequestItemStatus
+      extend Trophy::Internal::Types::Enum
+
+      INACTIVE = "inactive"
+      ACTIVE = "active"
+      SCHEDULED = "scheduled"
+      FINISHED = "finished"
+    end
+  end
+end

data/lib/trophy/types/create_leaderboards_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateLeaderboardsRequest
+      # CreateLeaderboardsRequest is an alias for Array
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/trophy/types/create_leaderboards_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing created leaderboards and any per-item issues.
+    class CreateLeaderboardsResponse < Internal::Types::Model
+      field :created, -> { Internal::Types::Array[Trophy::Types::AdminLeaderboard] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_metric_request_item.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A metric to create.
+    class CreateMetricRequestItem < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :unit_type, -> { Trophy::Types::CreateMetricRequestItemUnitType }, optional: true, nullable: false, api_name: "unitType"
+
+      field :units, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_metric_request_item_unit_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateMetricRequestItemUnitType
+      extend Trophy::Internal::Types::Enum
+
+      NUMBER = "number"
+      CURRENCY = "currency"
+    end
+  end
+end

data/lib/trophy/types/create_metrics_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateMetricsRequest
+      # CreateMetricsRequest is an alias for Array
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/trophy/types/create_metrics_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing created metrics and any per-item issues.
+    class CreateMetricsResponse < Internal::Types::Model
+      field :created, -> { Internal::Types::Array[Trophy::Types::CreatedMetric] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_points_boost_request_item.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A points boost to create. May optionally target a specific user via `userId` or filter by user attributes via
+    # `userAttributes`. These two fields are mutually exclusive.
+    class CreatePointsBoostRequestItem < Internal::Types::Model
+      field :user_id, -> { String }, optional: true, nullable: false, api_name: "userId"
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :start, -> { String }, optional: false, nullable: false
+
+      field :end_, -> { String }, optional: true, nullable: false, api_name: "end"
+
+      field :multiplier, -> { Integer }, optional: false, nullable: false
+
+      field :rounding, -> { Trophy::Types::CreatePointsBoostRequestItemRounding }, optional: true, nullable: false
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::CreatePointsBoostRequestItemUserAttributesItem] }, optional: true, nullable: false, api_name: "userAttributes"
+    end
+  end
+end

data/lib/trophy/types/create_points_boost_request_item_rounding.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreatePointsBoostRequestItemRounding
+      extend Trophy::Internal::Types::Enum
+
+      DOWN = "down"
+      UP = "up"
+      NEAREST = "nearest"
+    end
+  end
+end

data/lib/trophy/types/create_points_boost_request_item_user_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class CreatePointsBoostRequestItemUserAttributesItem < Internal::Types::Model
+      field :attribute_id, -> { String }, optional: false, nullable: false, api_name: "attributeId"
+
+      field :attribute_value, -> { String }, optional: false, nullable: false, api_name: "attributeValue"
+    end
+  end
+end

data/lib/trophy/types/create_points_boosts_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreatePointsBoostsRequest
+      # CreatePointsBoostsRequest is an alias for Array
+
+      # @option str [String]
+      #
+      # @return [untyped]
+      def self.load(str)
+        ::JSON.parse(str)
+      end
+
+      # @option value [untyped]
+      #
+      # @return [String]
+      def self.dump(value)
+        ::JSON.generate(value)
+      end
+    end
+  end
+end

data/lib/trophy/types/create_points_boosts_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing created boosts and any issues encountered while creating points boosts.
+    class CreatePointsBoostsResponse < Internal::Types::Model
+      field :created, -> { Internal::Types::Array[Trophy::Types::AdminPointsBoost] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_points_level_request_item.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A points level to create.
+    class CreatePointsLevelRequestItem < Internal::Types::Model
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :points, -> { Integer }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: true, nullable: false
+
+      field :badge, -> { Trophy::Types::CreatePointsLevelRequestItemBadge }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_points_level_request_item_badge.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # An optional badge for the level.
+    class CreatePointsLevelRequestItemBadge < Internal::Types::Model
+      field :url, -> { String }, optional: false, nullable: false
+    end
+  end
+end