trophy_api_client 0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0149173e6a70fddabed85fea62764af9c90d07a0b0144a83a3ad83db1daae650'
+  data.tar.gz: 3757f76091036303ec8a5dae7461e966e790d1c224dab0ed46e013a0620d30a8
+SHA512:
+  metadata.gz: 5eb33c6cc42390b5ca8a795c2ca76dccf4e28835be36809d5097e3b0b2a175d1e54fdb00708b715656007c60155f572e3d5910b6a74d845c8fce017681fc8e77
+  data.tar.gz: 62a486aeff9d35fabec254359d6abef0b4da11a53ba4c91d5a257b079acd589cea899227bbc4aa8b493b09f918672f8cace09522be77deb94ef08ab4e1abe847

data/lib/environment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  class Environment
+    DEFAULT = "https://app.trophy.so/api"
+  end
+end

data/lib/gemconfig.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TrophyApiClient
+  module Gemconfig
+    VERSION = ""
+    AUTHORS = [""].freeze
+    EMAIL = ""
+    SUMMARY = ""
+    DESCRIPTION = ""
+    HOMEPAGE = "https://github.com/REPO/URL"
+    SOURCE_CODE_URI = "https://github.com/REPO/URL"
+    CHANGELOG_URI = "https://github.com/REPO/URL/blob/master/CHANGELOG.md"
+  end
+end

data/lib/requests.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+require_relative "environment"
+require "faraday"
+require "faraday/retry"
+require "async/http/faraday"
+
+module TrophyApiClient
+  class RequestClient
+    # @return [Faraday]
+    attr_reader :conn
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [String]
+    attr_reader :default_environment
+
+    # @param base_url [String]
+    # @param environment [TrophyApiClient::Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [TrophyApiClient::RequestClient]
+    def initialize(api_key:, base_url: nil, environment: TrophyApiClient::Environment::DEFAULT, max_retries: nil,
+                   timeout_in_seconds: nil)
+      @default_environment = environment
+      @base_url = environment || base_url
+      @api_key = api_key
+      @conn = Faraday.new do |faraday|
+        faraday.request :json
+        faraday.response :raise_error, include_request: true
+        faraday.request :retry, { max: max_retries } unless max_retries.nil?
+        faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
+      end
+    end
+
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [String]
+    def get_url(request_options: nil)
+      request_options&.base_url || @default_environment || @base_url
+    end
+
+    # @return [Hash{String => String}]
+    def get_headers
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "trophy_api_client" }
+      headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
+      headers
+    end
+  end
+
+  class AsyncRequestClient
+    # @return [Faraday]
+    attr_reader :conn
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [String]
+    attr_reader :default_environment
+
+    # @param base_url [String]
+    # @param environment [TrophyApiClient::Environment]
+    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
+    # @param timeout_in_seconds [Long]
+    # @param api_key [String]
+    # @return [TrophyApiClient::AsyncRequestClient]
+    def initialize(api_key:, base_url: nil, environment: TrophyApiClient::Environment::DEFAULT, max_retries: nil,
+                   timeout_in_seconds: nil)
+      @default_environment = environment
+      @base_url = environment || base_url
+      @api_key = api_key
+      @conn = Faraday.new do |faraday|
+        faraday.request :json
+        faraday.response :raise_error, include_request: true
+        faraday.adapter :async_http
+        faraday.request :retry, { max: max_retries } unless max_retries.nil?
+        faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
+      end
+    end
+
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [String]
+    def get_url(request_options: nil)
+      request_options&.base_url || @default_environment || @base_url
+    end
+
+    # @return [Hash{String => String}]
+    def get_headers
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "trophy_api_client" }
+      headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
+      headers
+    end
+  end
+
+  # Additional options for request-specific configuration when calling APIs via the
+  #  SDK.
+  class RequestOptions
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [Hash{String => Object}]
+    attr_reader :additional_headers
+    # @return [Hash{String => Object}]
+    attr_reader :additional_query_parameters
+    # @return [Hash{String => Object}]
+    attr_reader :additional_body_parameters
+    # @return [Long]
+    attr_reader :timeout_in_seconds
+
+    # @param base_url [String]
+    # @param api_key [String]
+    # @param additional_headers [Hash{String => Object}]
+    # @param additional_query_parameters [Hash{String => Object}]
+    # @param additional_body_parameters [Hash{String => Object}]
+    # @param timeout_in_seconds [Long]
+    # @return [TrophyApiClient::RequestOptions]
+    def initialize(base_url: nil, api_key: nil, additional_headers: nil, additional_query_parameters: nil,
+                   additional_body_parameters: nil, timeout_in_seconds: nil)
+      @base_url = base_url
+      @api_key = api_key
+      @additional_headers = additional_headers
+      @additional_query_parameters = additional_query_parameters
+      @additional_body_parameters = additional_body_parameters
+      @timeout_in_seconds = timeout_in_seconds
+    end
+  end
+
+  # Additional options for request-specific configuration when calling APIs via the
+  #  SDK.
+  class IdempotencyRequestOptions
+    # @return [String]
+    attr_reader :base_url
+    # @return [String]
+    attr_reader :api_key
+    # @return [Hash{String => Object}]
+    attr_reader :additional_headers
+    # @return [Hash{String => Object}]
+    attr_reader :additional_query_parameters
+    # @return [Hash{String => Object}]
+    attr_reader :additional_body_parameters
+    # @return [Long]
+    attr_reader :timeout_in_seconds
+
+    # @param base_url [String]
+    # @param api_key [String]
+    # @param additional_headers [Hash{String => Object}]
+    # @param additional_query_parameters [Hash{String => Object}]
+    # @param additional_body_parameters [Hash{String => Object}]
+    # @param timeout_in_seconds [Long]
+    # @return [TrophyApiClient::IdempotencyRequestOptions]
+    def initialize(base_url: nil, api_key: nil, additional_headers: nil, additional_query_parameters: nil,
+                   additional_body_parameters: nil, timeout_in_seconds: nil)
+      @base_url = base_url
+      @api_key = api_key
+      @additional_headers = additional_headers
+      @additional_query_parameters = additional_query_parameters
+      @additional_body_parameters = additional_body_parameters
+      @timeout_in_seconds = timeout_in_seconds
+    end
+  end
+end

data/lib/trophy_api_client/achievements/client.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/event_request_user"
+require_relative "../types/achievement_completion_response"
+require "async"
+
+module TrophyApiClient
+  class AchievementsClient
+    # @return [TrophyApiClient::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::RequestClient]
+    # @return [TrophyApiClient::AchievementsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Mark an achievement as completed for a user.
+    #
+    # @param key [String] Unique reference of the achievement as set when created.
+    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::EventRequestUser, as a Hash
+    #   * :id (String)
+    #   * :email (String)
+    #   * :name (String)
+    #   * :tz (String)
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::AchievementCompletionResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.achievements.complete(key: "finish-onboarding", user: { id: "18", email: "jk.rowling@harrypotter.com", tz: "Europe/London" })
+    def complete(key:, user:, 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_options&.additional_body_parameters || {}), user: user }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/achievements/#{key}/complete"
+      end
+      TrophyApiClient::AchievementCompletionResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncAchievementsClient
+    # @return [TrophyApiClient::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::AsyncRequestClient]
+    # @return [TrophyApiClient::AsyncAchievementsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Mark an achievement as completed for a user.
+    #
+    # @param key [String] Unique reference of the achievement as set when created.
+    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::EventRequestUser, as a Hash
+    #   * :id (String)
+    #   * :email (String)
+    #   * :name (String)
+    #   * :tz (String)
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::AchievementCompletionResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.achievements.complete(key: "finish-onboarding", user: { id: "18", email: "jk.rowling@harrypotter.com", tz: "Europe/London" })
+    def complete(key:, user:, 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_options&.additional_body_parameters || {}), user: user }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/achievements/#{key}/complete"
+        end
+        TrophyApiClient::AchievementCompletionResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/trophy_api_client/metrics/client.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/event_request_user"
+require_relative "../types/event_response"
+require "async"
+
+module TrophyApiClient
+  class MetricsClient
+    # @return [TrophyApiClient::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::RequestClient]
+    # @return [TrophyApiClient::MetricsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Increment or decrement the value of a metric for a user.
+    #
+    # @param key [String] Unique reference of the metric as set when created.
+    # @param user [Hash] The user that triggered the event.Request of type TrophyApiClient::EventRequestUser, as a Hash
+    #   * :id (String)
+    #   * :email (String)
+    #   * :name (String)
+    #   * :tz (String)
+    # @param value [Float] The value to add to the user's current total for the given metric.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::EventResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.metrics.event(
+    #    key: "words-written",
+    #    user: { id: "18", email: "jk.rowling@harrypotter.com", tz: "Europe/London" },
+    #    value: 750
+    #  )
+    def event(key:, user:, value:, 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_options&.additional_body_parameters || {}), user: user, value: value }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/metrics/#{key}/event"
+      end
+      TrophyApiClient::EventResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncMetricsClient
+    # @return [TrophyApiClient::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [TrophyApiClient::AsyncRequestClient]
+    # @return [TrophyApiClient::AsyncMetricsClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Increment or decrement the value of a metric for a user.
+    #
+    # @param key [String] Unique reference of the metric as set when created.
+    # @param user [Hash] The user that triggered the event.Request of type TrophyApiClient::EventRequestUser, as a Hash
+    #   * :id (String)
+    #   * :email (String)
+    #   * :name (String)
+    #   * :tz (String)
+    # @param value [Float] The value to add to the user's current total for the given metric.
+    # @param request_options [TrophyApiClient::RequestOptions]
+    # @return [TrophyApiClient::EventResponse]
+    # @example
+    #  api = TrophyApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: TrophyApiClient::Environment::DEFAULT,
+    #    api_key: "YOUR_API_KEY"
+    #  )
+    #  api.metrics.event(
+    #    key: "words-written",
+    #    user: { id: "18", email: "jk.rowling@harrypotter.com", tz: "Europe/London" },
+    #    value: 750
+    #  )
+    def event(key:, user:, value:, 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_options&.additional_body_parameters || {}), user: user, value: value }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/metrics/#{key}/event"
+        end
+        TrophyApiClient::EventResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/trophy_api_client/types/achievement_completion_response.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "achievement_response"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class AchievementCompletionResponse
+    # @return [String] The unique ID of the completion.
+    attr_reader :completion_id
+    # @return [TrophyApiClient::AchievementResponse]
+    attr_reader :achievement
+    # @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 completion_id [String] The unique ID of the completion.
+    # @param achievement [TrophyApiClient::AchievementResponse]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AchievementCompletionResponse]
+    def initialize(completion_id:, achievement:, additional_properties: nil)
+      @completion_id = completion_id
+      @achievement = achievement
+      @additional_properties = additional_properties
+      @_field_set = { "completionId": completion_id, "achievement": achievement }
+    end
+
+    # Deserialize a JSON object to an instance of AchievementCompletionResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AchievementCompletionResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      completion_id = parsed_json["completionId"]
+      if parsed_json["achievement"].nil?
+        achievement = nil
+      else
+        achievement = parsed_json["achievement"].to_json
+        achievement = TrophyApiClient::AchievementResponse.from_json(json_object: achievement)
+      end
+      new(
+        completion_id: completion_id,
+        achievement: achievement,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AchievementCompletionResponse 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.completion_id.is_a?(String) != false || raise("Passed value for field obj.completion_id is not the expected type, validation failed.")
+      TrophyApiClient::AchievementResponse.validate_raw(obj: obj.achievement)
+    end
+  end
+end

data/lib/trophy_api_client/types/achievement_response.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class AchievementResponse
+    # @return [String] The unique ID of the achievement.
+    attr_reader :id
+    # @return [String] The name of this achievement.
+    attr_reader :name
+    # @return [String] The URL of the badge image for the achievement, if one has been uploaded.
+    attr_reader :badge_url
+    # @return [String] The ID of the metric associated with this achievement, if any.
+    attr_reader :metric_id
+    # @return [Float] The value of the metric required to complete the achievement, if this
+    #  achievement is associated with a metric.
+    attr_reader :metric_value
+    # @return [String] The name of the metric associated with this achievement, if any.
+    attr_reader :metric_name
+    # @return [String] The key used to reference this achievement in the API.
+    attr_reader :key
+    # @return [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    attr_reader :achieved_at
+    # @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 unique ID of the achievement.
+    # @param name [String] The name of this achievement.
+    # @param badge_url [String] The URL of the badge image for the achievement, if one has been uploaded.
+    # @param metric_id [String] The ID of the metric associated with this achievement, if any.
+    # @param metric_value [Float] The value of the metric required to complete the achievement, if this
+    #  achievement is associated with a metric.
+    # @param metric_name [String] The name of the metric associated with this achievement, if any.
+    # @param key [String] The key used to reference this achievement in the API.
+    # @param achieved_at [DateTime] The date and time the achievement was completed, in ISO 8601 format.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AchievementResponse]
+    def initialize(id:, name: OMIT, badge_url: OMIT, metric_id: OMIT, metric_value: OMIT, metric_name: OMIT, key: OMIT,
+                   achieved_at: OMIT, additional_properties: nil)
+      @id = id
+      @name = name if name != OMIT
+      @badge_url = badge_url if badge_url != OMIT
+      @metric_id = metric_id if metric_id != OMIT
+      @metric_value = metric_value if metric_value != OMIT
+      @metric_name = metric_name if metric_name != OMIT
+      @key = key if key != OMIT
+      @achieved_at = achieved_at if achieved_at != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "id": id,
+        "name": name,
+        "badgeUrl": badge_url,
+        "metricId": metric_id,
+        "metricValue": metric_value,
+        "metricName": metric_name,
+        "key": key,
+        "achievedAt": achieved_at
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of AchievementResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AchievementResponse]
+    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"]
+      badge_url = parsed_json["badgeUrl"]
+      metric_id = parsed_json["metricId"]
+      metric_value = parsed_json["metricValue"]
+      metric_name = parsed_json["metricName"]
+      key = parsed_json["key"]
+      achieved_at = (DateTime.parse(parsed_json["achievedAt"]) unless parsed_json["achievedAt"].nil?)
+      new(
+        id: id,
+        name: name,
+        badge_url: badge_url,
+        metric_id: metric_id,
+        metric_value: metric_value,
+        metric_name: metric_name,
+        key: key,
+        achieved_at: achieved_at,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AchievementResponse 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.badge_url&.is_a?(String) != false || raise("Passed value for field obj.badge_url 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.metric_value&.is_a?(Float) != false || raise("Passed value for field obj.metric_value is not the expected type, validation failed.")
+      obj.metric_name&.is_a?(String) != false || raise("Passed value for field obj.metric_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.achieved_at&.is_a?(DateTime) != false || raise("Passed value for field obj.achieved_at is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/error_body.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  class ErrorBody
+    # @return [String]
+    attr_reader :error
+    # @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 error [String]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::ErrorBody]
+    def initialize(error:, additional_properties: nil)
+      @error = error
+      @additional_properties = additional_properties
+      @_field_set = { "error": error }
+    end
+
+    # Deserialize a JSON object to an instance of ErrorBody
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::ErrorBody]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      error = parsed_json["error"]
+      new(error: error, additional_properties: struct)
+    end
+
+    # Serialize an instance of ErrorBody 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.error.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
+    end
+  end
+end