Class: DemoApiScalarGalaxy::Resources::CelestialBodies

Inherits:

Object

• Object
• DemoApiScalarGalaxy::Resources::CelestialBodies

Defined in:

lib/amritk-galaxy-staging/resources/celestial_bodies.rb,
sig/amritk-galaxy-staging/resources/celestial_bodies.rbs

Overview

Celestial bodies are the planets and satellites in the Scalar Galaxy.

Instance Method Summary

• #create(celestial_body:, request_options: {}) ⇒ DemoApiScalarGalaxy::Models::Planet, DemoApiScalarGalaxy::Models::Satellite

  Create a celestial body.

• #initialize(client:) ⇒ CelestialBodies constructor private

  A new instance of CelestialBodies.

Constructor Details

#initialize(client:) ⇒ CelestialBodies

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of CelestialBodies.

Parameters:

• client (DemoApiScalarGalaxy::Client)
• client: (DemoApiScalarGalaxy::Client)

# File 'lib/amritk-galaxy-staging/resources/celestial_bodies.rb', line 31

def initialize(client:)
  @client = client
end

Instance Method Details

#create(celestial_body:, request_options: {}) ⇒ DemoApiScalarGalaxy::Models::Planet, DemoApiScalarGalaxy::Models::Satellite

Create a celestial body

Parameters:

• celestial_body (DemoApiScalarGalaxy::Models::Planet, DemoApiScalarGalaxy::Models::Satellite)
• request_options (DemoApiScalarGalaxy::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (DemoApiScalarGalaxy::Models::Planet, DemoApiScalarGalaxy::Models::Satellite)

See Also:

• Models::CelestialBodyCreateParams

# File 'lib/amritk-galaxy-staging/resources/celestial_bodies.rb', line 17

def create(params)
  parsed, options = DemoApiScalarGalaxy::CelestialBodyCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "celestial-bodies",
    body: parsed[:celestial_body],
    model: DemoApiScalarGalaxy::CelestialBody,
    options: options
  )
end