trophy_api_client 1.5.0 → 1.7.0

data/lib/trophy_api_client/types/created_metric.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative "created_metric_unit_type"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A successfully created metric returned from the create endpoint.
+  class CreatedMetric
+    # @return [String] The UUID of the created metric.
+    attr_reader :id
+    # @return [String] The metric name.
+    attr_reader :name
+    # @return [String] The metric key.
+    attr_reader :key
+    # @return [TrophyApiClient::CreatedMetricUnitType] The metric unit type.
+    attr_reader :unit_type
+    # @return [String] The stored units value for the metric.
+    attr_reader :units
+    # @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 created metric.
+    # @param name [String] The metric name.
+    # @param key [String] The metric key.
+    # @param unit_type [TrophyApiClient::CreatedMetricUnitType] The metric unit type.
+    # @param units [String] The stored units value for the metric.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::CreatedMetric]
+    def initialize(id:, name:, key:, unit_type:, units:, additional_properties: nil)
+      @id = id
+      @name = name
+      @key = key
+      @unit_type = unit_type
+      @units = units
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "name": name, "key": key, "unitType": unit_type, "units": units }
+    end
+
+    # Deserialize a JSON object to an instance of CreatedMetric
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CreatedMetric]
+    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"]
+      key = parsed_json["key"]
+      unit_type = parsed_json["unitType"]
+      units = parsed_json["units"]
+      new(
+        id: id,
+        name: name,
+        key: key,
+        unit_type: unit_type,
+        units: units,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreatedMetric 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.")
+      obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
+      obj.unit_type.is_a?(TrophyApiClient::CreatedMetricUnitType) != false || raise("Passed value for field obj.unit_type is not the expected type, validation failed.")
+      obj.units.is_a?(String) != false || raise("Passed value for field obj.units is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/created_metric_unit_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The metric unit type.
+  class CreatedMetricUnitType
+    NUMBER = "number"
+    CURRENCY = "currency"
+  end
+end

data/lib/trophy_api_client/types/delete_attributes_response.rb

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

data/lib/trophy_api_client/types/delete_leaderboards_response.rb

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

data/lib/trophy_api_client/types/delete_metrics_response.rb

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

data/lib/trophy_api_client/types/delete_points_boosts_response.rb

@@ -10,7 +10,7 @@ module TrophyApiClient
   class DeletePointsBoostsResponse
     # @return [Array<TrophyApiClient::DeletedResource>] Array of deleted points boosts represented by ID.
     attr_reader :deleted
-    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during boost archival.
+    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during boost deletion.
     attr_reader :issues
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -21,7 +21,7 @@ module TrophyApiClient
     OMIT = Object.new
 
     # @param deleted [Array<TrophyApiClient::DeletedResource>] Array of deleted points boosts represented by ID.
-    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during boost archival.
+    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during boost deletion.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::DeletePointsBoostsResponse]
     def initialize(deleted:, issues:, additional_properties: nil)

data/lib/trophy_api_client/types/list_attributes_response.rb

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

data/lib/trophy_api_client/types/list_leaderboards_response.rb

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

data/lib/trophy_api_client/types/list_metrics_response.rb

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

data/lib/trophy_api_client/types/metric_response.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "metric_status"
 require_relative "user_achievement_response"
 require "ostruct"
 require "json"
@@ -13,8 +12,6 @@ module TrophyApiClient
     attr_reader :key
     # @return [String] The name of the metric.
     attr_reader :name
-    # @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::UserAchievementResponse>] A list of the metric's achievements and the user's progress towards each.
@@ -30,27 +27,18 @@ module TrophyApiClient
     # @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 status [TrophyApiClient::MetricStatus] The status of the metric.
     # @param current [Float] The user's current total for the metric.
     # @param achievements [Array<TrophyApiClient::UserAchievementResponse>] A list of the metric's achievements and the user's progress towards each.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::MetricResponse]
-    def initialize(id:, key:, name:, status:, current:, achievements:, additional_properties: nil)
+    def initialize(id:, key:, name:, current:, achievements:, additional_properties: nil)
       @id = id
       @key = key
       @name = name
-      @status = status
       @current = current
       @achievements = achievements
       @additional_properties = additional_properties
-      @_field_set = {
-        "id": id,
-        "key": key,
-        "name": name,
-        "status": status,
-        "current": current,
-        "achievements": achievements
-      }
+      @_field_set = { "id": id, "key": key, "name": name, "current": current, "achievements": achievements }
     end
 
     # Deserialize a JSON object to an instance of MetricResponse
@@ -63,7 +51,6 @@ module TrophyApiClient
       id = parsed_json["id"]
       key = parsed_json["key"]
       name = parsed_json["name"]
-      status = parsed_json["status"]
       current = parsed_json["current"]
       achievements = parsed_json["achievements"]&.map do |item|
         item = item.to_json
@@ -73,7 +60,6 @@ module TrophyApiClient
         id: id,
         key: key,
         name: name,
-        status: status,
         current: current,
         achievements: achievements,
         additional_properties: struct
@@ -97,7 +83,6 @@ module TrophyApiClient
       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.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.")
     end

data/lib/trophy_api_client/types/update_attribute_request_item.rb

@@ -0,0 +1,69 @@
+# 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

@@ -0,0 +1,7 @@
+# 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

@@ -0,0 +1,75 @@
+# 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