trophy_api_client 1.4.0 → 1.6.0

data/lib/trophy_api_client/admin/metrics/client.rb

@@ -0,0 +1,366 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../types/list_metrics_response"
+require "json"
+require_relative "../../types/create_metrics_request"
+require_relative "../../types/create_metrics_response"
+require_relative "../../types/delete_metrics_response"
+require_relative "../../types/update_metrics_request"
+require_relative "../../types/update_metrics_response"
+require_relative "../../types/created_metric"
+require "async"
+
+module TrophyApiClient
+  module Admin
+    class MetricsClient
+      # @return [TrophyApiClient::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [TrophyApiClient::RequestClient]
+      # @return [TrophyApiClient::Admin::MetricsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # List metrics.
+      #
+      # @param limit [Integer] Number of records to return.
+      # @param skip [Integer] Number of records to skip from the start of the list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::LIST_METRICS_RESPONSE]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.metrics.list(limit: 1, skip: 1)
+      def list(limit: nil, skip: nil, request_options: nil)
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "skip": skip }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/metrics"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::CreatedMetric.from_json(json_object: item)
+        end
+      end
+
+      # Create metrics in bulk.
+      #
+      # @param request [TrophyApiClient::CREATE_METRICS_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::CreateMetricsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.metrics.create(request: [{ name: "Invites Sent", key: "invites-sent" }, { name: "Revenue", key: "revenue", unit_type: CURRENCY, units: "USD" }])
+      def create(request:, request_options: nil)
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/metrics"
+        end
+        TrophyApiClient::CreateMetricsResponse.from_json(json_object: response.body)
+      end
+
+      # Delete metrics in bulk by ID.
+      #
+      # @param ids [String] Metric IDs to delete. Repeat the query param or provide a comma-separated list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::DeleteMetricsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.metrics.delete
+      def delete(ids: nil, request_options: nil)
+        response = @request_client.conn.delete do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "ids": ids }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/metrics"
+        end
+        TrophyApiClient::DeleteMetricsResponse.from_json(json_object: response.body)
+      end
+
+      # Update metrics in bulk by ID.
+      #
+      # @param request [TrophyApiClient::UPDATE_METRICS_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::UpdateMetricsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.metrics.update(request: [{ id: "550e8400-e29b-41d4-a716-446655440000", name: "Invites Completed", units: "invites" }, { id: "550e8400-e29b-41d4-a716-446655440001", unit_type: NUMBER, units: "dollars" }])
+      def update(request:, request_options: nil)
+        response = @request_client.conn.patch do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/metrics"
+        end
+        TrophyApiClient::UpdateMetricsResponse.from_json(json_object: response.body)
+      end
+
+      # Get a metric by ID.
+      #
+      # @param id [String] The UUID of the metric to retrieve.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::CreatedMetric]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.metrics.get(id: "550e8400-e29b-41d4-a716-446655440000")
+      def get(id:, request_options: nil)
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/metrics/#{id}"
+        end
+        TrophyApiClient::CreatedMetric.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncMetricsClient
+      # @return [TrophyApiClient::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [TrophyApiClient::AsyncRequestClient]
+      # @return [TrophyApiClient::Admin::AsyncMetricsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # List metrics.
+      #
+      # @param limit [Integer] Number of records to return.
+      # @param skip [Integer] Number of records to skip from the start of the list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::LIST_METRICS_RESPONSE]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.metrics.list(limit: 1, skip: 1)
+      def list(limit: nil, skip: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "limit": limit,
+              "skip": skip
+            }.compact
+            unless request_options.nil? || request_options&.additional_body_parameters.nil?
+              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/metrics"
+          end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do |item|
+            item = item.to_json
+            TrophyApiClient::CreatedMetric.from_json(json_object: item)
+          end
+        end
+      end
+
+      # Create metrics in bulk.
+      #
+      # @param request [TrophyApiClient::CREATE_METRICS_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::CreateMetricsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.metrics.create(request: [{ name: "Invites Sent", key: "invites-sent" }, { name: "Revenue", key: "revenue", unit_type: CURRENCY, units: "USD" }])
+      def create(request:, request_options: nil)
+        Async do
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/metrics"
+          end
+          TrophyApiClient::CreateMetricsResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Delete metrics in bulk by ID.
+      #
+      # @param ids [String] Metric IDs to delete. Repeat the query param or provide a comma-separated list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::DeleteMetricsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.metrics.delete
+      def delete(ids: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.delete do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.params = { **(request_options&.additional_query_parameters || {}), "ids": ids }.compact
+            unless request_options.nil? || request_options&.additional_body_parameters.nil?
+              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/metrics"
+          end
+          TrophyApiClient::DeleteMetricsResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Update metrics in bulk by ID.
+      #
+      # @param request [TrophyApiClient::UPDATE_METRICS_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::UpdateMetricsResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.metrics.update(request: [{ id: "550e8400-e29b-41d4-a716-446655440000", name: "Invites Completed", units: "invites" }, { id: "550e8400-e29b-41d4-a716-446655440001", unit_type: NUMBER, units: "dollars" }])
+      def update(request:, request_options: nil)
+        Async do
+          response = @request_client.conn.patch do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/metrics"
+          end
+          TrophyApiClient::UpdateMetricsResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Get a metric by ID.
+      #
+      # @param id [String] The UUID of the metric to retrieve.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::CreatedMetric]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.metrics.get(id: "550e8400-e29b-41d4-a716-446655440000")
+      def get(id:, request_options: nil)
+        Async do
+          response = @request_client.conn.get do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            unless request_options.nil? || request_options&.additional_body_parameters.nil?
+              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/metrics/#{id}"
+          end
+          TrophyApiClient::CreatedMetric.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/trophy_api_client/admin/points/boosts/client.rb

@@ -60,7 +60,7 @@ module TrophyApiClient
           TrophyApiClient::CreatePointsBoostsResponse.from_json(json_object: response.body)
         end
 
-        # Archive multiple points boosts by ID.
+        # Delete multiple points boosts by ID.
         #
         # @param ids [String] A list of up to 100 boost IDs.
         # @param request_options [TrophyApiClient::RequestOptions]
@@ -71,8 +71,8 @@ module TrophyApiClient
         #    environment: TrophyApiClient::Environment::PRODUCTION,
         #    api_key: "YOUR_API_KEY"
         #  )
-        #  api.admin.points.boosts.batch_archive
-        def batch_archive(ids: nil, request_options: nil)
+        #  api.admin.points.boosts.delete
+        def delete(ids: nil, request_options: nil)
           response = @request_client.conn.delete do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
@@ -89,39 +89,6 @@ module TrophyApiClient
           end
           TrophyApiClient::DeletePointsBoostsResponse.from_json(json_object: response.body)
         end
-
-        # Archive a points boost by ID.
-        #
-        # @param id [String] The UUID of the points boost to archive
-        # @param request_options [TrophyApiClient::RequestOptions]
-        # @return [TrophyApiClient::DeletePointsBoostsResponse]
-        # @example
-        #  api = TrophyApiClient::Client.new(
-        #    base_url: "https://api.example.com",
-        #    environment: TrophyApiClient::Environment::PRODUCTION,
-        #    api_key: "YOUR_API_KEY"
-        #  )
-        #  api.admin.points.boosts.archive(id: "id")
-        def archive(id:, request_options: nil)
-          response = @request_client.conn.delete do |req|
-            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-            req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
-            req.headers = {
-          **(req.headers || {}),
-          **@request_client.get_headers,
-          **(request_options&.additional_headers || {})
-            }.compact
-            unless request_options.nil? || request_options&.additional_query_parameters.nil?
-              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-            end
-            unless request_options.nil? || request_options&.additional_body_parameters.nil?
-              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-            end
-            req.url "#{@request_client.get_url(environment: admin,
-                                               request_options: request_options)}/points/boosts/#{id}"
-          end
-          TrophyApiClient::DeletePointsBoostsResponse.from_json(json_object: response.body)
-        end
       end
 
       class AsyncBoostsClient
@@ -177,7 +144,7 @@ module TrophyApiClient
           end
         end
 
-        # Archive multiple points boosts by ID.
+        # Delete multiple points boosts by ID.
         #
         # @param ids [String] A list of up to 100 boost IDs.
         # @param request_options [TrophyApiClient::RequestOptions]
@@ -188,8 +155,8 @@ module TrophyApiClient
         #    environment: TrophyApiClient::Environment::PRODUCTION,
         #    api_key: "YOUR_API_KEY"
         #  )
-        #  api.admin.points.boosts.batch_archive
-        def batch_archive(ids: nil, request_options: nil)
+        #  api.admin.points.boosts.delete
+        def delete(ids: nil, request_options: nil)
           Async do
             response = @request_client.conn.delete do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -208,41 +175,6 @@ module TrophyApiClient
             TrophyApiClient::DeletePointsBoostsResponse.from_json(json_object: response.body)
           end
         end
-
-        # Archive a points boost by ID.
-        #
-        # @param id [String] The UUID of the points boost to archive
-        # @param request_options [TrophyApiClient::RequestOptions]
-        # @return [TrophyApiClient::DeletePointsBoostsResponse]
-        # @example
-        #  api = TrophyApiClient::Client.new(
-        #    base_url: "https://api.example.com",
-        #    environment: TrophyApiClient::Environment::PRODUCTION,
-        #    api_key: "YOUR_API_KEY"
-        #  )
-        #  api.admin.points.boosts.archive(id: "id")
-        def archive(id:, request_options: nil)
-          Async do
-            response = @request_client.conn.delete do |req|
-              req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-              req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
-              req.headers = {
-            **(req.headers || {}),
-            **@request_client.get_headers,
-            **(request_options&.additional_headers || {})
-              }.compact
-              unless request_options.nil? || request_options&.additional_query_parameters.nil?
-                req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-              end
-              unless request_options.nil? || request_options&.additional_body_parameters.nil?
-                req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-              end
-              req.url "#{@request_client.get_url(environment: admin,
-                                                 request_options: request_options)}/points/boosts/#{id}"
-            end
-            TrophyApiClient::DeletePointsBoostsResponse.from_json(json_object: response.body)
-          end
-        end
       end
     end
   end

data/lib/trophy_api_client/types/admin_attribute.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "admin_attribute_type"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # An attribute returned from the admin attributes endpoints.
+  class AdminAttribute
+    # @return [String] The UUID of the attribute.
+    attr_reader :id
+    # @return [String] The attribute name.
+    attr_reader :name
+    # @return [String] The attribute key.
+    attr_reader :key
+    # @return [TrophyApiClient::AdminAttributeType] The attribute type.
+    attr_reader :type
+    # @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.
+    # @param name [String] The attribute name.
+    # @param key [String] The attribute key.
+    # @param type [TrophyApiClient::AdminAttributeType] The attribute type.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AdminAttribute]
+    def initialize(id:, name:, key:, type:, additional_properties: nil)
+      @id = id
+      @name = name
+      @key = key
+      @type = type
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "name": name, "key": key, "type": type }
+    end
+
+    # Deserialize a JSON object to an instance of AdminAttribute
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AdminAttribute]
+    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"]
+      type = parsed_json["type"]
+      new(
+        id: id,
+        name: name,
+        key: key,
+        type: type,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AdminAttribute 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.type.is_a?(TrophyApiClient::AdminAttributeType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/admin_attribute_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The attribute type.
+  class AdminAttributeType
+    USER = "user"
+    EVENT = "event"
+  end
+end

data/lib/trophy_api_client/types/create_attribute_request_item.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative "create_attribute_request_item_type"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # An attribute to create.
+  class CreateAttributeRequestItem
+    # @return [String] The attribute name.
+    attr_reader :name
+    # @return [String] The attribute key. Only alphanumeric characters, hyphens, and underscores are
+    #  permitted.
+    attr_reader :key
+    # @return [TrophyApiClient::CreateAttributeRequestItemType] The attribute type.
+    attr_reader :type
+    # @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 name [String] The attribute name.
+    # @param key [String] The attribute key. Only alphanumeric characters, hyphens, and underscores are
+    #  permitted.
+    # @param type [TrophyApiClient::CreateAttributeRequestItemType] The attribute type.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::CreateAttributeRequestItem]
+    def initialize(name:, key:, type:, additional_properties: nil)
+      @name = name
+      @key = key
+      @type = type
+      @additional_properties = additional_properties
+      @_field_set = { "name": name, "key": key, "type": type }
+    end
+
+    # Deserialize a JSON object to an instance of CreateAttributeRequestItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::CreateAttributeRequestItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      key = parsed_json["key"]
+      type = parsed_json["type"]
+      new(
+        name: name,
+        key: key,
+        type: type,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of CreateAttributeRequestItem 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.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.type.is_a?(TrophyApiClient::CreateAttributeRequestItemType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/create_attribute_request_item_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The attribute type.
+  class CreateAttributeRequestItemType
+    USER = "user"
+    EVENT = "event"
+  end
+end

data/lib/trophy_api_client/types/create_attributes_request.rb

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