galaxy-ruby 0.2.0

data/lib/galaxy-ruby/internal.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Internal
+    extend ScalarGalaxy::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap { _1.define_singleton_method(:inspect) { "#<#{ScalarGalaxy::Internal}::OMIT>" } }.freeze
+
+    define_sorbet_constant!(:AnyHash) { T.type_alias { T::Hash[Symbol, T.anything] } }
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, ScalarGalaxy::FilePart) }
+    end
+  end
+end

data/lib/galaxy-ruby/models/authentication_create_token_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Authentication#create_token
+    class AuthenticationCreateTokenParams < ScalarGalaxy::Models::Credentials
+      extend ScalarGalaxy::Internal::Type::RequestParameters::Converter
+      include ScalarGalaxy::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/galaxy-ruby/models/authentication_create_token_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Authentication#create_token
+    class AuthenticationCreateTokenResponse < ScalarGalaxy::Internal::Type::BaseModel
+      # @!attribute token
+      #
+      #   @return [String, nil]
+      optional :token, String
+
+      # @!method initialize(token: nil)
+      #   @param token [String]
+    end
+  end
+end

data/lib/galaxy-ruby/models/authentication_create_user_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Authentication#create_user
+    class AuthenticationCreateUserParams < ScalarGalaxy::Internal::Type::BaseModel
+      extend ScalarGalaxy::Internal::Type::RequestParameters::Converter
+      include ScalarGalaxy::Internal::Type::RequestParameters
+
+      # @!attribute email
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute password
+      #
+      #   @return [String]
+      required :password, String
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(email:, password:, name: nil, request_options: {})
+      #   @param email [String]
+      #   @param password [String]
+      #   @param name [String]
+      #   @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/galaxy-ruby/models/authentication_list_me_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Authentication#list_me
+    class AuthenticationListMeParams < ScalarGalaxy::Internal::Type::BaseModel
+      extend ScalarGalaxy::Internal::Type::RequestParameters::Converter
+      include ScalarGalaxy::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/galaxy-ruby/models/celestial_body.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # A celestial body which can be either a planet or a satellite
+    #
+    # @see ScalarGalaxy::Resources::CelestialBodies#create
+    module CelestialBody
+      extend ScalarGalaxy::Internal::Type::Union
+
+      discriminator :type
+
+      variant -> { ScalarGalaxy::Planet }
+
+      variant -> { ScalarGalaxy::CelestialBody::Satellite }
+
+      class Satellite < ScalarGalaxy::Internal::Type::BaseModel
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute diameter
+        #   Diameter in kilometers
+        #
+        #   @return [Float, nil]
+        optional :diameter, Float
+
+        # @!attribute orbit
+        #
+        #   @return [Object, nil]
+        optional :orbit, ScalarGalaxy::Internal::Type::Unknown
+
+        # @!attribute type
+        #
+        #   @return [Symbol, ScalarGalaxy::Models::CelestialBody::Satellite::Type, nil]
+        optional :type, enum: -> { ScalarGalaxy::CelestialBody::Satellite::Type }
+
+        response_only do
+          # @!attribute id
+          #
+          #   @return [Integer, nil]
+          optional :id, Integer
+        end
+
+        # @!method initialize(name:, id: nil, description: nil, diameter: nil, orbit: nil, type: nil)
+        #   @param name [String]
+        #
+        #   @param id [Integer]
+        #
+        #   @param description [String, nil]
+        #
+        #   @param diameter [Float] Diameter in kilometers
+        #
+        #   @param orbit [Object]
+        #
+        #   @param type [Symbol, ScalarGalaxy::Models::CelestialBody::Satellite::Type]
+
+        # @see ScalarGalaxy::Models::CelestialBody::Satellite#type
+        module Type
+          extend ScalarGalaxy::Internal::Type::Enum
+
+          MOON = :moon
+          ASTEROID = :asteroid
+          COMET = :comet
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @!method self.variants
+      #   @return [Array(ScalarGalaxy::Models::Planet, ScalarGalaxy::Models::CelestialBody::Satellite)]
+    end
+  end
+end

data/lib/galaxy-ruby/models/celestial_body_create_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::CelestialBodies#create
+    class CelestialBodyCreateParams < ScalarGalaxy::Internal::Type::BaseModel
+      extend ScalarGalaxy::Internal::Type::RequestParameters::Converter
+      include ScalarGalaxy::Internal::Type::RequestParameters
+
+      # @!attribute celestial_body
+      #
+      #   @return [ScalarGalaxy::Models::Planet, ScalarGalaxy::Models::CelestialBody::Satellite]
+      required :celestial_body, union: -> { ScalarGalaxy::CelestialBody }
+
+      # @!method initialize(celestial_body:, request_options: {})
+      #   @param celestial_body [ScalarGalaxy::Models::Planet, ScalarGalaxy::Models::CelestialBody::Satellite]
+      #   @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/galaxy-ruby/models/credentials.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    class Credentials < ScalarGalaxy::Internal::Type::BaseModel
+      # @!attribute email
+      #
+      #   @return [String]
+      required :email, String
+
+      request_only do
+        # @!attribute password
+        #
+        #   @return [String]
+        required :password, String
+      end
+
+      # @!method initialize(email:, password:)
+      #   Credentials to authenticate a user
+      #
+      #   @param email [String]
+      #   @param password [String]
+    end
+  end
+end

data/lib/galaxy-ruby/models/new_planet_webhook_event.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    class NewPlanetWebhookEvent < ScalarGalaxy::Internal::Type::BaseModel
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute atmosphere
+      #   Atmospheric composition
+      #
+      #   @return [Array<ScalarGalaxy::Models::NewPlanetWebhookEvent::Atmosphere>, nil]
+      optional :atmosphere,
+               -> { ScalarGalaxy::Internal::Type::ArrayOf[ScalarGalaxy::NewPlanetWebhookEvent::Atmosphere] }
+
+      # @!attribute creator
+      #   A user
+      #
+      #   @return [ScalarGalaxy::Models::User, nil]
+      optional :creator, -> { ScalarGalaxy::User }
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute discovered_at
+      #
+      #   @return [Time, nil]
+      optional :discovered_at, Time, api_name: :discoveredAt
+
+      # @!attribute failure_callback_url
+      #   URL which gets invoked upon a failed operation
+      #
+      #   @return [String, nil]
+      optional :failure_callback_url, String, api_name: :failureCallbackUrl
+
+      # @!attribute habitability_index
+      #   A score from 0 to 1 indicating potential habitability
+      #
+      #   @return [Float, nil]
+      optional :habitability_index, Float, api_name: :habitabilityIndex
+
+      # @!attribute image
+      #
+      #   @return [String, nil]
+      optional :image, String, nil?: true
+
+      # @!attribute physical_properties
+      #
+      #   @return [ScalarGalaxy::Models::NewPlanetWebhookEvent::PhysicalProperties, nil]
+      optional :physical_properties,
+               -> { ScalarGalaxy::NewPlanetWebhookEvent::PhysicalProperties },
+               api_name: :physicalProperties
+
+      # @!attribute satellites
+      #
+      #   @return [Array<Object>, nil]
+      optional :satellites, ScalarGalaxy::Internal::Type::ArrayOf[ScalarGalaxy::Internal::Type::Unknown]
+
+      # @!attribute success_callback_url
+      #   URL which gets invoked upon a successful operation
+      #
+      #   @return [String, nil]
+      optional :success_callback_url, String, api_name: :successCallbackUrl
+
+      # @!attribute tags
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ScalarGalaxy::Internal::Type::ArrayOf[String]
+
+      # @!attribute type
+      #
+      #   @return [Symbol, ScalarGalaxy::Models::NewPlanetWebhookEvent::Type, nil]
+      optional :type, enum: -> { ScalarGalaxy::NewPlanetWebhookEvent::Type }
+
+      response_only do
+        # @!attribute id
+        #
+        #   @return [Integer]
+        required :id, Integer
+
+        # @!attribute last_updated
+        #
+        #   @return [Time, nil]
+        optional :last_updated, Time, api_name: :lastUpdated
+      end
+
+      # @!method initialize(id:, name:, atmosphere: nil, creator: nil, description: nil, discovered_at: nil, failure_callback_url: nil, habitability_index: nil, image: nil, last_updated: nil, physical_properties: nil, satellites: nil, success_callback_url: nil, tags: nil, type: nil)
+      #   @param id [Integer]
+      #
+      #   @param name [String]
+      #
+      #   @param atmosphere [Array<ScalarGalaxy::Models::NewPlanetWebhookEvent::Atmosphere>] Atmospheric composition
+      #
+      #   @param creator [ScalarGalaxy::Models::User] A user
+      #
+      #   @param description [String, nil]
+      #
+      #   @param discovered_at [Time]
+      #
+      #   @param failure_callback_url [String] URL which gets invoked upon a failed operation
+      #
+      #   @param habitability_index [Float] A score from 0 to 1 indicating potential habitability
+      #
+      #   @param image [String, nil]
+      #
+      #   @param last_updated [Time]
+      #
+      #   @param physical_properties [ScalarGalaxy::Models::NewPlanetWebhookEvent::PhysicalProperties]
+      #
+      #   @param satellites [Array<Object>]
+      #
+      #   @param success_callback_url [String] URL which gets invoked upon a successful operation
+      #
+      #   @param tags [Array<String>]
+      #
+      #   @param type [Symbol, ScalarGalaxy::Models::NewPlanetWebhookEvent::Type]
+
+      class Atmosphere < ScalarGalaxy::Internal::Type::BaseModel
+        # @!attribute compound
+        #
+        #   @return [String, nil]
+        optional :compound, String
+
+        # @!attribute percentage
+        #
+        #   @return [Float, nil]
+        optional :percentage, Float
+
+        # @!method initialize(compound: nil, percentage: nil)
+        #   @param compound [String]
+        #   @param percentage [Float]
+      end
+
+      # @see ScalarGalaxy::Models::NewPlanetWebhookEvent#physical_properties
+      class PhysicalProperties < ScalarGalaxy::Internal::Type::BaseModel
+        # @!attribute gravity
+        #   Surface gravity in Earth g
+        #
+        #   @return [Float, nil]
+        optional :gravity, Float
+
+        # @!attribute mass
+        #   Mass in Earth masses (must be greater than 0)
+        #
+        #   @return [Float, nil]
+        optional :mass, Float
+
+        # @!attribute radius
+        #   Radius in Earth radii (must be greater than 0)
+        #
+        #   @return [Float, nil]
+        optional :radius, Float
+
+        # @!attribute temperature
+        #
+        #   @return [ScalarGalaxy::Models::NewPlanetWebhookEvent::PhysicalProperties::Temperature, nil]
+        optional :temperature, -> { ScalarGalaxy::NewPlanetWebhookEvent::PhysicalProperties::Temperature }
+
+        # @!method initialize(gravity: nil, mass: nil, radius: nil, temperature: nil)
+        #   @param gravity [Float] Surface gravity in Earth g
+        #
+        #   @param mass [Float] Mass in Earth masses (must be greater than 0)
+        #
+        #   @param radius [Float] Radius in Earth radii (must be greater than 0)
+        #
+        #   @param temperature [ScalarGalaxy::Models::NewPlanetWebhookEvent::PhysicalProperties::Temperature]
+
+        # @see ScalarGalaxy::Models::NewPlanetWebhookEvent::PhysicalProperties#temperature
+        class Temperature < ScalarGalaxy::Internal::Type::BaseModel
+          # @!attribute average
+          #   Average temperature in Kelvin
+          #
+          #   @return [Float, nil]
+          optional :average, Float
+
+          # @!attribute max
+          #   Maximum temperature in Kelvin
+          #
+          #   @return [Float, nil]
+          optional :max, Float
+
+          # @!attribute min
+          #   Minimum temperature in Kelvin
+          #
+          #   @return [Float, nil]
+          optional :min, Float
+
+          # @!method initialize(average: nil, max: nil, min: nil)
+          #   @param average [Float] Average temperature in Kelvin
+          #
+          #   @param max [Float] Maximum temperature in Kelvin
+          #
+          #   @param min [Float] Minimum temperature in Kelvin
+        end
+      end
+
+      # @see ScalarGalaxy::Models::NewPlanetWebhookEvent#type
+      module Type
+        extend ScalarGalaxy::Internal::Type::Enum
+
+        TERRESTRIAL = :terrestrial
+        GAS_GIANT = :gas_giant
+        ICE_GIANT = :ice_giant
+        DWARF = :dwarf
+        SUPER_EARTH = :super_earth
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/galaxy-ruby/models/planet.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Planets#create
+    class Planet < ScalarGalaxy::Internal::Type::BaseModel
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute atmosphere
+      #   Atmospheric composition
+      #
+      #   @return [Array<ScalarGalaxy::Models::Planet::Atmosphere>, nil]
+      optional :atmosphere, -> { ScalarGalaxy::Internal::Type::ArrayOf[ScalarGalaxy::Planet::Atmosphere] }
+
+      # @!attribute creator
+      #   A user
+      #
+      #   @return [ScalarGalaxy::Models::User, nil]
+      optional :creator, -> { ScalarGalaxy::User }
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute discovered_at
+      #
+      #   @return [Time, nil]
+      optional :discovered_at, Time, api_name: :discoveredAt
+
+      # @!attribute failure_callback_url
+      #   URL which gets invoked upon a failed operation
+      #
+      #   @return [String, nil]
+      optional :failure_callback_url, String, api_name: :failureCallbackUrl
+
+      # @!attribute habitability_index
+      #   A score from 0 to 1 indicating potential habitability
+      #
+      #   @return [Float, nil]
+      optional :habitability_index, Float, api_name: :habitabilityIndex
+
+      # @!attribute image
+      #
+      #   @return [String, nil]
+      optional :image, String, nil?: true
+
+      # @!attribute physical_properties
+      #
+      #   @return [ScalarGalaxy::Models::Planet::PhysicalProperties, nil]
+      optional :physical_properties,
+               -> { ScalarGalaxy::Planet::PhysicalProperties },
+               api_name: :physicalProperties
+
+      # @!attribute satellites
+      #
+      #   @return [Array<Object>, nil]
+      optional :satellites, ScalarGalaxy::Internal::Type::ArrayOf[ScalarGalaxy::Internal::Type::Unknown]
+
+      # @!attribute success_callback_url
+      #   URL which gets invoked upon a successful operation
+      #
+      #   @return [String, nil]
+      optional :success_callback_url, String, api_name: :successCallbackUrl
+
+      # @!attribute tags
+      #
+      #   @return [Array<String>, nil]
+      optional :tags, ScalarGalaxy::Internal::Type::ArrayOf[String]
+
+      # @!attribute type
+      #
+      #   @return [Symbol, ScalarGalaxy::Models::Planet::Type, nil]
+      optional :type, enum: -> { ScalarGalaxy::Planet::Type }
+
+      response_only do
+        # @!attribute id
+        #
+        #   @return [Integer]
+        required :id, Integer
+
+        # @!attribute last_updated
+        #
+        #   @return [Time, nil]
+        optional :last_updated, Time, api_name: :lastUpdated
+      end
+
+      # @!method initialize(id:, name:, atmosphere: nil, creator: nil, description: nil, discovered_at: nil, failure_callback_url: nil, habitability_index: nil, image: nil, last_updated: nil, physical_properties: nil, satellites: nil, success_callback_url: nil, tags: nil, type: nil)
+      #   A planet in the Scalar Galaxy
+      #
+      #   @param id [Integer]
+      #
+      #   @param name [String]
+      #
+      #   @param atmosphere [Array<ScalarGalaxy::Models::Planet::Atmosphere>] Atmospheric composition
+      #
+      #   @param creator [ScalarGalaxy::Models::User] A user
+      #
+      #   @param description [String, nil]
+      #
+      #   @param discovered_at [Time]
+      #
+      #   @param failure_callback_url [String] URL which gets invoked upon a failed operation
+      #
+      #   @param habitability_index [Float] A score from 0 to 1 indicating potential habitability
+      #
+      #   @param image [String, nil]
+      #
+      #   @param last_updated [Time]
+      #
+      #   @param physical_properties [ScalarGalaxy::Models::Planet::PhysicalProperties]
+      #
+      #   @param satellites [Array<Object>]
+      #
+      #   @param success_callback_url [String] URL which gets invoked upon a successful operation
+      #
+      #   @param tags [Array<String>]
+      #
+      #   @param type [Symbol, ScalarGalaxy::Models::Planet::Type]
+
+      class Atmosphere < ScalarGalaxy::Internal::Type::BaseModel
+        # @!attribute compound
+        #
+        #   @return [String, nil]
+        optional :compound, String
+
+        # @!attribute percentage
+        #
+        #   @return [Float, nil]
+        optional :percentage, Float
+
+        # @!method initialize(compound: nil, percentage: nil)
+        #   @param compound [String]
+        #   @param percentage [Float]
+      end
+
+      # @see ScalarGalaxy::Models::Planet#physical_properties
+      class PhysicalProperties < ScalarGalaxy::Internal::Type::BaseModel
+        # @!attribute gravity
+        #   Surface gravity in Earth g
+        #
+        #   @return [Float, nil]
+        optional :gravity, Float
+
+        # @!attribute mass
+        #   Mass in Earth masses (must be greater than 0)
+        #
+        #   @return [Float, nil]
+        optional :mass, Float
+
+        # @!attribute radius
+        #   Radius in Earth radii (must be greater than 0)
+        #
+        #   @return [Float, nil]
+        optional :radius, Float
+
+        # @!attribute temperature
+        #
+        #   @return [ScalarGalaxy::Models::Planet::PhysicalProperties::Temperature, nil]
+        optional :temperature, -> { ScalarGalaxy::Planet::PhysicalProperties::Temperature }
+
+        # @!method initialize(gravity: nil, mass: nil, radius: nil, temperature: nil)
+        #   @param gravity [Float] Surface gravity in Earth g
+        #
+        #   @param mass [Float] Mass in Earth masses (must be greater than 0)
+        #
+        #   @param radius [Float] Radius in Earth radii (must be greater than 0)
+        #
+        #   @param temperature [ScalarGalaxy::Models::Planet::PhysicalProperties::Temperature]
+
+        # @see ScalarGalaxy::Models::Planet::PhysicalProperties#temperature
+        class Temperature < ScalarGalaxy::Internal::Type::BaseModel
+          # @!attribute average
+          #   Average temperature in Kelvin
+          #
+          #   @return [Float, nil]
+          optional :average, Float
+
+          # @!attribute max
+          #   Maximum temperature in Kelvin
+          #
+          #   @return [Float, nil]
+          optional :max, Float
+
+          # @!attribute min
+          #   Minimum temperature in Kelvin
+          #
+          #   @return [Float, nil]
+          optional :min, Float
+
+          # @!method initialize(average: nil, max: nil, min: nil)
+          #   @param average [Float] Average temperature in Kelvin
+          #
+          #   @param max [Float] Maximum temperature in Kelvin
+          #
+          #   @param min [Float] Minimum temperature in Kelvin
+        end
+      end
+
+      # @see ScalarGalaxy::Models::Planet#type
+      module Type
+        extend ScalarGalaxy::Internal::Type::Enum
+
+        TERRESTRIAL = :terrestrial
+        GAS_GIANT = :gas_giant
+        ICE_GIANT = :ice_giant
+        DWARF = :dwarf
+        SUPER_EARTH = :super_earth
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/galaxy-ruby/models/planet_create_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Planets#create
+    class PlanetCreateParams < ScalarGalaxy::Models::Planet
+      extend ScalarGalaxy::Internal::Type::RequestParameters::Converter
+      include ScalarGalaxy::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/galaxy-ruby/models/planet_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ScalarGalaxy
+  module Models
+    # @see ScalarGalaxy::Resources::Planets#delete
+    class PlanetDeleteParams < ScalarGalaxy::Internal::Type::BaseModel
+      extend ScalarGalaxy::Internal::Type::RequestParameters::Converter
+      include ScalarGalaxy::Internal::Type::RequestParameters
+
+      # @!attribute planet_id
+      #
+      #   @return [Integer]
+      required :planet_id, Integer
+
+      # @!method initialize(planet_id:, request_options: {})
+      #   @param planet_id [Integer]
+      #   @param request_options [ScalarGalaxy::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end