trophy_api_client 1.4.0 → 1.6.0

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

data/lib/trophy_api_client/types/update_metric_request_item.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "update_metric_request_item_unit_type"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A metric update object. `id` is required; `name`, `unitType`, and `units` are
+  #  optional. `key` cannot be changed through this endpoint.
+  class UpdateMetricRequestItem
+    # @return [String] The UUID of the metric to update.
+    attr_reader :id
+    # @return [String] The updated metric name.
+    attr_reader :name
+    # @return [TrophyApiClient::UpdateMetricRequestItemUnitType] The updated metric unit type.
+    attr_reader :unit_type
+    # @return [String] The updated units value. For `unitType: currency`, this must be a supported
+    #  `MetricCurrency` code such as `USD`.
+    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 metric to update.
+    # @param name [String] The updated metric name.
+    # @param unit_type [TrophyApiClient::UpdateMetricRequestItemUnitType] The updated metric unit type.
+    # @param units [String] The updated units value. For `unitType: currency`, this must be a supported
+    #  `MetricCurrency` code such as `USD`.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::UpdateMetricRequestItem]
+    def initialize(id:, name: OMIT, unit_type: OMIT, units: OMIT, additional_properties: nil)
+      @id = id
+      @name = name if name != OMIT
+      @unit_type = unit_type if unit_type != OMIT
+      @units = units if units != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "name": name, "unitType": unit_type, "units": units }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of UpdateMetricRequestItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::UpdateMetricRequestItem]
+    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"]
+      unit_type = parsed_json["unitType"]
+      units = parsed_json["units"]
+      new(
+        id: id,
+        name: name,
+        unit_type: unit_type,
+        units: units,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdateMetricRequestItem 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.unit_type&.is_a?(TrophyApiClient::UpdateMetricRequestItemUnitType) != 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/update_metric_request_item_unit_type.rb

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

data/lib/trophy_api_client/types/update_metrics_request.rb

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

data/lib/trophy_api_client/types/update_metrics_response.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "created_metric"
+require_relative "admin_issue"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Response containing updated metrics and any per-item issues identified by metric
+  #  ID.
+  class UpdateMetricsResponse
+    # @return [Array<TrophyApiClient::CreatedMetric>] Array of successfully updated metrics.
+    attr_reader :updated
+    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during metric 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::CreatedMetric>] Array of successfully updated metrics.
+    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during metric update.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::UpdateMetricsResponse]
+    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 UpdateMetricsResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::UpdateMetricsResponse]
+    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::CreatedMetric.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 UpdateMetricsResponse 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

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.4.0"
+  VERSION = "1.6.0"
 end

data/lib/types_export.rb

@@ -26,7 +26,6 @@ require_relative "trophy_api_client/types/webhooks_leaderboard_started_payload"
 require_relative "trophy_api_client/types/webhooks_leaderboard_changed_payload"
 require_relative "trophy_api_client/types/webhooks_leaderboard_finished_payload"
 require_relative "trophy_api_client/types/webhooks_leaderboard_rank_changed_payload"
-require_relative "trophy_api_client/types/metric_status"
 require_relative "trophy_api_client/types/streak_frequency"
 require_relative "trophy_api_client/types/base_streak_response"
 require_relative "trophy_api_client/types/bulk_streak_response_item"
@@ -90,6 +89,29 @@ require_relative "trophy_api_client/types/user_leaderboard_response"
 require_relative "trophy_api_client/types/user_leaderboard_response_with_history"
 require_relative "trophy_api_client/types/webhook_user_leaderboard_response"
 require_relative "trophy_api_client/types/create_streak_freezes_response"
+require_relative "trophy_api_client/types/create_attribute_request_item"
+require_relative "trophy_api_client/types/create_attributes_request"
+require_relative "trophy_api_client/types/create_attribute_request_item_type"
+require_relative "trophy_api_client/types/admin_attribute_type"
+require_relative "trophy_api_client/types/admin_attribute"
+require_relative "trophy_api_client/types/create_attributes_response"
+require_relative "trophy_api_client/types/update_attribute_request_item"
+require_relative "trophy_api_client/types/update_attributes_request"
+require_relative "trophy_api_client/types/update_attributes_response"
+require_relative "trophy_api_client/types/delete_attributes_response"
+require_relative "trophy_api_client/types/list_attributes_response"
+require_relative "trophy_api_client/types/create_metric_request_item"
+require_relative "trophy_api_client/types/create_metrics_request"
+require_relative "trophy_api_client/types/create_metric_request_item_unit_type"
+require_relative "trophy_api_client/types/created_metric_unit_type"
+require_relative "trophy_api_client/types/created_metric"
+require_relative "trophy_api_client/types/create_metrics_response"
+require_relative "trophy_api_client/types/update_metric_request_item"
+require_relative "trophy_api_client/types/update_metrics_request"
+require_relative "trophy_api_client/types/update_metric_request_item_unit_type"
+require_relative "trophy_api_client/types/update_metrics_response"
+require_relative "trophy_api_client/types/delete_metrics_response"
+require_relative "trophy_api_client/types/list_metrics_response"
 require_relative "trophy_api_client/types/created_points_boost_status"
 require_relative "trophy_api_client/types/created_points_boost_rounding"
 require_relative "trophy_api_client/types/created_points_boost"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -100,7 +100,9 @@ files:
 - lib/requests.rb
 - lib/trophy_api_client.rb
 - lib/trophy_api_client/achievements/client.rb
+- lib/trophy_api_client/admin/attributes/client.rb
 - lib/trophy_api_client/admin/client.rb
+- lib/trophy_api_client/admin/metrics/client.rb
 - lib/trophy_api_client/admin/points/boosts/client.rb
 - lib/trophy_api_client/admin/points/boosts/types/create_points_boosts_request_boosts_item.rb
 - lib/trophy_api_client/admin/points/boosts/types/create_points_boosts_request_boosts_item_rounding.rb
@@ -123,16 +125,30 @@ files:
 - lib/trophy_api_client/types/achievement_response_trigger.rb
 - lib/trophy_api_client/types/achievement_response_user_attributes_item.rb
 - lib/trophy_api_client/types/achievement_with_stats_response.rb
+- lib/trophy_api_client/types/admin_attribute.rb
+- lib/trophy_api_client/types/admin_attribute_type.rb
 - lib/trophy_api_client/types/admin_issue.rb
 - lib/trophy_api_client/types/admin_issue_severity.rb
 - lib/trophy_api_client/types/base_streak_response.rb
 - lib/trophy_api_client/types/bulk_streak_response.rb
 - lib/trophy_api_client/types/bulk_streak_response_item.rb
+- lib/trophy_api_client/types/create_attribute_request_item.rb
+- lib/trophy_api_client/types/create_attribute_request_item_type.rb
+- lib/trophy_api_client/types/create_attributes_request.rb
+- lib/trophy_api_client/types/create_attributes_response.rb
+- lib/trophy_api_client/types/create_metric_request_item.rb
+- lib/trophy_api_client/types/create_metric_request_item_unit_type.rb
+- lib/trophy_api_client/types/create_metrics_request.rb
+- lib/trophy_api_client/types/create_metrics_response.rb
 - lib/trophy_api_client/types/create_points_boosts_response.rb
 - lib/trophy_api_client/types/create_streak_freezes_response.rb
+- lib/trophy_api_client/types/created_metric.rb
+- lib/trophy_api_client/types/created_metric_unit_type.rb
 - lib/trophy_api_client/types/created_points_boost.rb
 - lib/trophy_api_client/types/created_points_boost_rounding.rb
 - lib/trophy_api_client/types/created_points_boost_status.rb
+- lib/trophy_api_client/types/delete_attributes_response.rb
+- lib/trophy_api_client/types/delete_metrics_response.rb
 - lib/trophy_api_client/types/delete_points_boosts_response.rb
 - lib/trophy_api_client/types/deleted_resource.rb
 - lib/trophy_api_client/types/error_body.rb
@@ -145,12 +161,13 @@ files:
 - lib/trophy_api_client/types/leaderboard_response_run_unit.rb
 - lib/trophy_api_client/types/leaderboard_response_with_rankings.rb
 - lib/trophy_api_client/types/leaderboard_response_with_rankings_status.rb
+- lib/trophy_api_client/types/list_attributes_response.rb
+- lib/trophy_api_client/types/list_metrics_response.rb
 - lib/trophy_api_client/types/metric_event_leaderboard_response.rb
 - lib/trophy_api_client/types/metric_event_leaderboard_response_breakdown_attribute_values_item.rb
 - lib/trophy_api_client/types/metric_event_points_response.rb
 - lib/trophy_api_client/types/metric_event_streak_response.rb
 - lib/trophy_api_client/types/metric_response.rb
-- lib/trophy_api_client/types/metric_status.rb
 - lib/trophy_api_client/types/notification_channel.rb
 - lib/trophy_api_client/types/notification_preferences.rb
 - lib/trophy_api_client/types/notification_type.rb
@@ -180,6 +197,13 @@ files:
 - lib/trophy_api_client/types/streak_ranking_user.rb
 - lib/trophy_api_client/types/streak_response.rb
 - lib/trophy_api_client/types/streak_response_streak_history_item.rb
+- lib/trophy_api_client/types/update_attribute_request_item.rb
+- lib/trophy_api_client/types/update_attributes_request.rb
+- lib/trophy_api_client/types/update_attributes_response.rb
+- lib/trophy_api_client/types/update_metric_request_item.rb
+- lib/trophy_api_client/types/update_metric_request_item_unit_type.rb
+- lib/trophy_api_client/types/update_metrics_request.rb
+- lib/trophy_api_client/types/update_metrics_response.rb
 - lib/trophy_api_client/types/updated_user.rb
 - lib/trophy_api_client/types/upserted_user.rb
 - lib/trophy_api_client/types/user.rb

data/lib/trophy_api_client/types/metric_status.rb

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