trophy_api_client 1.5.0 → 1.7.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.
+      #
+      # @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 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 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.
+      #
+      # @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 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 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/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/admin_leaderboard.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require_relative "admin_leaderboard_status"
+require_relative "admin_leaderboard_rank_by"
+require_relative "admin_leaderboard_run_unit"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A leaderboard returned from the admin leaderboards endpoints.
+  class AdminLeaderboard
+    # @return [String] The UUID of the leaderboard.
+    attr_reader :id
+    # @return [String] The leaderboard name.
+    attr_reader :name
+    # @return [String] The leaderboard key.
+    attr_reader :key
+    # @return [String] The leaderboard description.
+    attr_reader :description
+    # @return [TrophyApiClient::AdminLeaderboardStatus] The current user-facing status of the leaderboard.
+    attr_reader :status
+    # @return [TrophyApiClient::AdminLeaderboardRankBy] What the leaderboard ranks by.
+    attr_reader :rank_by
+    # @return [String] The metric ID used when `rankBy` is `metric`.
+    attr_reader :metric_id
+    # @return [String] The points system ID used when `rankBy` is `points`.
+    attr_reader :points_system_id
+    # @return [Integer] The maximum number of participants.
+    attr_reader :max_participants
+    # @return [String] The leaderboard start date in YYYY-MM-DD format.
+    attr_reader :start
+    # @return [String] The optional leaderboard end date in YYYY-MM-DD format.
+    attr_reader :end_
+    # @return [Array<String>] The UUIDs of the user attributes used for ranking breakdowns.
+    attr_reader :breakdown_attributes
+    # @return [TrophyApiClient::AdminLeaderboardRunUnit] The recurrence unit when the leaderboard repeats.
+    attr_reader :run_unit
+    # @return [Integer] The number of recurrence units between leaderboard runs.
+    attr_reader :run_interval
+    # @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 leaderboard.
+    # @param name [String] The leaderboard name.
+    # @param key [String] The leaderboard key.
+    # @param description [String] The leaderboard description.
+    # @param status [TrophyApiClient::AdminLeaderboardStatus] The current user-facing status of the leaderboard.
+    # @param rank_by [TrophyApiClient::AdminLeaderboardRankBy] What the leaderboard ranks by.
+    # @param metric_id [String] The metric ID used when `rankBy` is `metric`.
+    # @param points_system_id [String] The points system ID used when `rankBy` is `points`.
+    # @param max_participants [Integer] The maximum number of participants.
+    # @param start [String] The leaderboard start date in YYYY-MM-DD format.
+    # @param end_ [String] The optional leaderboard end date in YYYY-MM-DD format.
+    # @param breakdown_attributes [Array<String>] The UUIDs of the user attributes used for ranking breakdowns.
+    # @param run_unit [TrophyApiClient::AdminLeaderboardRunUnit] The recurrence unit when the leaderboard repeats.
+    # @param run_interval [Integer] The number of recurrence units between leaderboard runs.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AdminLeaderboard]
+    def initialize(id:, name:, key:, status:, rank_by:, max_participants:, start:, breakdown_attributes:,
+                   description: OMIT, metric_id: OMIT, points_system_id: OMIT, end_: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
+      @id = id
+      @name = name
+      @key = key
+      @description = description if description != OMIT
+      @status = status
+      @rank_by = rank_by
+      @metric_id = metric_id if metric_id != OMIT
+      @points_system_id = points_system_id if points_system_id != OMIT
+      @max_participants = max_participants
+      @start = start
+      @end_ = end_ if end_ != OMIT
+      @breakdown_attributes = breakdown_attributes
+      @run_unit = run_unit if run_unit != OMIT
+      @run_interval = run_interval if run_interval != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "name": name,
+        "key": key,
+        "description": description,
+        "status": status,
+        "rankBy": rank_by,
+        "metricId": metric_id,
+        "pointsSystemId": points_system_id,
+        "maxParticipants": max_participants,
+        "start": start,
+        "end": end_,
+        "breakdownAttributes": breakdown_attributes,
+        "runUnit": run_unit,
+        "runInterval": run_interval
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of AdminLeaderboard
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AdminLeaderboard]
+    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"]
+      description = parsed_json["description"]
+      status = parsed_json["status"]
+      rank_by = parsed_json["rankBy"]
+      metric_id = parsed_json["metricId"]
+      points_system_id = parsed_json["pointsSystemId"]
+      max_participants = parsed_json["maxParticipants"]
+      start = parsed_json["start"]
+      end_ = parsed_json["end"]
+      breakdown_attributes = parsed_json["breakdownAttributes"]
+      run_unit = parsed_json["runUnit"]
+      run_interval = parsed_json["runInterval"]
+      new(
+        id: id,
+        name: name,
+        key: key,
+        description: description,
+        status: status,
+        rank_by: rank_by,
+        metric_id: metric_id,
+        points_system_id: points_system_id,
+        max_participants: max_participants,
+        start: start,
+        end_: end_,
+        breakdown_attributes: breakdown_attributes,
+        run_unit: run_unit,
+        run_interval: run_interval,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AdminLeaderboard 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.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
+      obj.status.is_a?(TrophyApiClient::AdminLeaderboardStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+      obj.rank_by.is_a?(TrophyApiClient::AdminLeaderboardRankBy) != false || raise("Passed value for field obj.rank_by is not the expected type, validation failed.")
+      obj.metric_id&.is_a?(String) != false || raise("Passed value for field obj.metric_id is not the expected type, validation failed.")
+      obj.points_system_id&.is_a?(String) != false || raise("Passed value for field obj.points_system_id is not the expected type, validation failed.")
+      obj.max_participants.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
+      obj.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
+      obj.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
+      obj.breakdown_attributes.is_a?(Array) != false || raise("Passed value for field obj.breakdown_attributes is not the expected type, validation failed.")
+      obj.run_unit&.is_a?(TrophyApiClient::AdminLeaderboardRunUnit) != false || raise("Passed value for field obj.run_unit is not the expected type, validation failed.")
+      obj.run_interval&.is_a?(Integer) != false || raise("Passed value for field obj.run_interval is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/admin_leaderboard_rank_by.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # What the leaderboard ranks by.
+  class AdminLeaderboardRankBy
+    METRIC = "metric"
+    STREAK = "streak"
+    POINTS = "points"
+  end
+end

data/lib/trophy_api_client/types/admin_leaderboard_run_unit.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The recurrence unit when the leaderboard repeats.
+  class AdminLeaderboardRunUnit
+    DAY = "day"
+    MONTH = "month"
+    YEAR = "year"
+  end
+end

data/lib/trophy_api_client/types/admin_leaderboard_status.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  # The current user-facing status of the leaderboard.
+  class AdminLeaderboardStatus
+    INACTIVE = "inactive"
+    ACTIVE = "active"
+    SCHEDULED = "scheduled"
+    FINISHED = "finished"
+  end
+end