trophy_api_client 1.14.0 → 1.27.0

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

data/lib/trophy/types/create_points_levels_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreatePointsLevelsRequest
+      # CreatePointsLevelsRequest 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_levels_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing created levels and any per-item issues.
+    class CreatePointsLevelsResponse < Internal::Types::Model
+      field :created, -> { Internal::Types::Array[Trophy::Types::AdminPointsLevel] }, 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_system_request_item.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A points system to create. Optionally include sub-entities.
+    class CreatePointsSystemRequestItem < 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 :badge, -> { Trophy::Types::CreatePointsSystemRequestItemBadge }, optional: true, nullable: false
+
+      field :max_points, -> { Integer }, optional: true, nullable: false, api_name: "maxPoints"
+
+      field :levels, -> { Internal::Types::Array[Trophy::Types::CreatePointsLevelRequestItem] }, optional: true, nullable: false
+
+      field :boosts, -> { Internal::Types::Array[Trophy::Types::CreatePointsBoostRequestItem] }, optional: true, nullable: false
+
+      field :triggers, -> { Internal::Types::Array[Trophy::Types::CreatePointsTriggerRequestItem] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_points_system_request_item_badge.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class CreatePointsSystemRequestItemBadge < Internal::Types::Model
+      field :url, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_points_systems_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreatePointsSystemsRequest
+      # CreatePointsSystemsRequest 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_systems_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing created points systems and any per-item issues.
+    class CreatePointsSystemsResponse < Internal::Types::Model
+      field :created, -> { Internal::Types::Array[Trophy::Types::CreatedAdminPointsSystem] }, 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_trigger_request_item.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A points trigger to create.
+    class CreatePointsTriggerRequestItem < Internal::Types::Model
+      field :type, -> { Trophy::Types::CreatePointsTriggerRequestItemType }, optional: false, nullable: false
+
+      field :points, -> { Integer }, optional: false, nullable: false
+
+      field :status, -> { Trophy::Types::CreatePointsTriggerRequestItemStatus }, optional: true, nullable: false
+
+      field :user_attributes, -> { Internal::Types::Array[Trophy::Types::CreatePointsTriggerRequestItemUserAttributesItem] }, optional: true, nullable: false, api_name: "userAttributes"
+
+      field :metric_id, -> { String }, optional: true, nullable: false, api_name: "metricId"
+
+      field :metric_threshold, -> { Integer }, optional: true, nullable: false, api_name: "metricThreshold"
+
+      field :event_attributes, -> { Internal::Types::Array[Trophy::Types::CreatePointsTriggerRequestItemEventAttributesItem] }, optional: true, nullable: false, api_name: "eventAttributes"
+
+      field :achievement_id, -> { String }, optional: true, nullable: false, api_name: "achievementId"
+
+      field :streak_length, -> { Integer }, optional: true, nullable: false, api_name: "streakLength"
+
+      field :time_unit, -> { Trophy::Types::CreatePointsTriggerRequestItemTimeUnit }, optional: true, nullable: false, api_name: "timeUnit"
+
+      field :time_interval, -> { Integer }, optional: true, nullable: false, api_name: "timeInterval"
+
+      field :block_if_out_of_points, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "blockIfOutOfPoints"
+    end
+  end
+end

data/lib/trophy/types/create_points_trigger_request_item_event_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class CreatePointsTriggerRequestItemEventAttributesItem < 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_trigger_request_item_status.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreatePointsTriggerRequestItemStatus
+      extend Trophy::Internal::Types::Enum
+
+      ACTIVE = "active"
+      INACTIVE = "inactive"
+    end
+  end
+end

data/lib/trophy/types/create_points_trigger_request_item_time_unit.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreatePointsTriggerRequestItemTimeUnit
+      extend Trophy::Internal::Types::Enum
+
+      HOURS = "hours"
+      DAYS = "days"
+    end
+  end
+end

data/lib/trophy/types/create_points_trigger_request_item_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreatePointsTriggerRequestItemType
+      extend Trophy::Internal::Types::Enum
+
+      METRIC = "metric"
+      ACHIEVEMENT = "achievement"
+      STREAK = "streak"
+      TIME = "time"
+      USER_CREATION = "user_creation"
+    end
+  end
+end

data/lib/trophy/types/create_points_trigger_request_item_user_attributes_item.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class CreatePointsTriggerRequestItemUserAttributesItem < 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_triggers_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreatePointsTriggersRequest
+      # CreatePointsTriggersRequest 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_triggers_response.rb

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

data/lib/trophy/types/create_streak_freezes_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing any issues encountered while creating streak freezes.
+    class CreateStreakFreezesResponse < Internal::Types::Model
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_streak_pauses_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing created streak pauses and any issues encountered.
+    class CreateStreakPausesResponse < Internal::Types::Model
+      field :created, -> { Internal::Types::Array[Trophy::Types::AdminStreakPause] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_tenant_request_item.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A tenant to create.
+    class CreateTenantRequestItem < Internal::Types::Model
+      field :customer_id, -> { String }, optional: false, nullable: false, api_name: "customerId"
+
+      field :name, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/create_tenants_request.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    module CreateTenantsRequest
+      # CreateTenantsRequest 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_tenants_response.rb

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

data/lib/trophy/types/created_admin_points_system.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A points system returned from the creation endpoint. Extends AdminPointsSystem with optional sub-entity arrays
+    # that are present when those sub-entities were included in the creation request.
+    class CreatedAdminPointsSystem < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :description, -> { String }, optional: false, nullable: false
+
+      field :status, -> { Trophy::Types::AdminPointsSystemStatus }, optional: false, nullable: false
+
+      field :badge, -> { Trophy::Types::AdminPointsSystemBadge }, optional: true, nullable: false
+
+      field :max_points, -> { Integer }, optional: true, nullable: false, api_name: "maxPoints"
+
+      field :levels, -> { Internal::Types::Array[Trophy::Types::AdminPointsLevel] }, optional: true, nullable: false
+
+      field :boosts, -> { Internal::Types::Array[Trophy::Types::AdminPointsBoost] }, optional: true, nullable: false
+
+      field :triggers, -> { Internal::Types::Array[Trophy::Types::AdminPointsTrigger] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/trophy/types/created_application_key.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A newly created application API key.
+    class CreatedApplicationKey < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :user_id, -> { String }, optional: false, nullable: false, api_name: "userId"
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :prefix, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/created_metric.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A successfully created metric returned from the create endpoint.
+    class CreatedMetric < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :name, -> { String }, optional: false, nullable: false
+
+      field :key, -> { String }, optional: false, nullable: false
+
+      field :unit_type, -> { Trophy::Types::CreatedMetricUnitType }, optional: false, nullable: false, api_name: "unitType"
+
+      field :units, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/created_metric_unit_type.rb

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

data/lib/trophy/types/delete_achievements_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing deleted achievements represented by ID and any per-item issues, including invalid or missing
+    # achievement IDs.
+    class DeleteAchievementsResponse < Internal::Types::Model
+      field :deleted, -> { Internal::Types::Array[Trophy::Types::DeletedResource] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/delete_application_keys_response.rb

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

data/lib/trophy/types/delete_attributes_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing deleted attributes represented by ID and any per-item issues, including invalid or missing
+    # attribute IDs.
+    class DeleteAttributesResponse < Internal::Types::Model
+      field :deleted, -> { Internal::Types::Array[Trophy::Types::DeletedResource] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/delete_leaderboards_response.rb

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

data/lib/trophy/types/delete_metrics_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing deleted metrics represented by ID and any per-item issues, including invalid or missing metric
+    # IDs.
+    class DeleteMetricsResponse < Internal::Types::Model
+      field :deleted, -> { Internal::Types::Array[Trophy::Types::DeletedResource] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/delete_points_boosts_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing the points boosts that were deleted and any per-item issues.
+    class DeletePointsBoostsResponse < Internal::Types::Model
+      field :deleted, -> { Internal::Types::Array[Trophy::Types::DeletedResource] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/delete_points_levels_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing the points levels that were deleted and any per-item issues.
+    class DeletePointsLevelsResponse < Internal::Types::Model
+      field :deleted, -> { Internal::Types::Array[Trophy::Types::DeletedResource] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/delete_points_systems_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing deleted points system IDs and any per-item issues.
+    class DeletePointsSystemsResponse < Internal::Types::Model
+      field :deleted, -> { Internal::Types::Array[Trophy::Types::DeletedResource] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/delete_points_triggers_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing the points triggers that were deleted and any per-item issues.
+    class DeletePointsTriggersResponse < Internal::Types::Model
+      field :deleted, -> { Internal::Types::Array[Trophy::Types::DeletedResource] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/delete_streak_pauses_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing deleted streak pauses and any issues encountered.
+    class DeleteStreakPausesResponse < Internal::Types::Model
+      field :deleted, -> { Internal::Types::Array[Trophy::Types::DeletedResource] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/delete_tenants_response.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # Response containing deleted tenant IDs and any issues.
+    class DeleteTenantsResponse < Internal::Types::Model
+      field :deleted, -> { Internal::Types::Array[Trophy::Types::DeletedResource] }, optional: false, nullable: false
+
+      field :issues, -> { Internal::Types::Array[Trophy::Types::AdminIssue] }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/deleted_resource.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    # A deleted resource represented by ID.
+    class DeletedResource < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/error_body.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class ErrorBody < Internal::Types::Model
+      field :error, -> { String }, optional: false, nullable: false
+    end
+  end
+end

data/lib/trophy/types/event_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Trophy
+  module Types
+    class EventResponse < Internal::Types::Model
+      field :event_id, -> { String }, optional: false, nullable: false, api_name: "eventId"
+
+      field :metric_id, -> { String }, optional: false, nullable: false, api_name: "metricId"
+
+      field :total, -> { Integer }, optional: false, nullable: false
+
+      field :achievements, -> { Internal::Types::Array[Trophy::Types::UserAchievementResponse] }, optional: false, nullable: false
+
+      field :current_streak, -> { Trophy::Types::MetricEventStreakResponse }, optional: false, nullable: false, api_name: "currentStreak"
+
+      field :points, -> { Internal::Types::Hash[String, Trophy::Types::MetricEventPointsResponse] }, optional: false, nullable: false
+
+      field :leaderboards, -> { Internal::Types::Hash[String, Trophy::Types::MetricEventLeaderboardResponse] }, optional: false, nullable: false
+
+      field :idempotency_key, -> { String }, optional: true, nullable: false, api_name: "idempotencyKey"
+
+      field :idempotent_replayed, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "idempotentReplayed"
+    end
+  end
+end