Complete reference of every operation, grouped by resource. See the README for usage and configuration.
import com.scalar.galaxy.client.GalaxyClient;
import com.scalar.galaxy.client.okhttp.GalaxyOkHttpClient;
GalaxyClient client =
GalaxyOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();Everything about planets
It's easy to say you know them all, but do you really? Retrieve all the planets and check whether you missed one.
| Direction | Type |
|---|---|
| Request | PlanetListAllDataParams |
| Response | PlanetListAllDataResponse |
import com.scalar.galaxy.client.GalaxyClient;
import com.scalar.galaxy.client.okhttp.GalaxyOkHttpClient;
import com.scalar.galaxy.models.planets.PlanetListAllDataParams;
GalaxyClient client =
GalaxyOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();
PlanetListAllDataParams params =
PlanetListAllDataParams.builder().limit(10L).offset(0L).build();
var planet = client.planets().listAllData(params);
System.out.println(planet);Time to play god and create a new planet. What do you think? Ah, don't think too much. What could go wrong anyway?
| Direction | Type |
|---|---|
| Request | PlanetCreateParams |
| Response | Planet |
import com.scalar.galaxy.client.GalaxyClient;
import com.scalar.galaxy.client.okhttp.GalaxyOkHttpClient;
import com.scalar.galaxy.models.planets.Planet;
import com.scalar.galaxy.models.planets.PlanetCreateParams;
GalaxyClient client =
GalaxyOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();
PlanetCreateParams params =
PlanetCreateParams.builder().planet(Planet.builder().name("Mars").build()).build();
var planet = client.planets().create(params);
System.out.println(planet);You'll better learn a little bit more about the planets. It might come in handy once space travel is available for everyone.
| Direction | Type |
|---|---|
| Request | PlanetRetrieveParams |
| Response | Planet |
import com.scalar.galaxy.client.GalaxyClient;
import com.scalar.galaxy.client.okhttp.GalaxyOkHttpClient;
import com.scalar.galaxy.models.planets.PlanetRetrieveParams;
GalaxyClient client =
GalaxyOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();
PlanetRetrieveParams params = PlanetRetrieveParams.builder().planetId(1L).build();
var planet = client.planets().retrieve(params);
System.out.println(planet);Sometimes you make mistakes, that's fine. No worries, you can update all planets.
| Direction | Type |
|---|---|
| Request | PlanetUpdateParams |
| Response | Planet |
import com.scalar.galaxy.client.GalaxyClient;
import com.scalar.galaxy.client.okhttp.GalaxyOkHttpClient;
import com.scalar.galaxy.models.planets.Planet;
import com.scalar.galaxy.models.planets.PlanetUpdateParams;
GalaxyClient client =
GalaxyOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();
PlanetUpdateParams params =
PlanetUpdateParams.builder()
.planetId(1L)
.planet(Planet.builder().name("Mars").build())
.build();
var planet = client.planets().update(params);
System.out.println(planet);This endpoint was used to delete planets. Unfortunately, that caused a lot of trouble for planets with life. So, this endpoint is now deprecated and should not be used anymore.
| Direction | Type |
|---|---|
| Request | PlanetDeleteParams |
import com.scalar.galaxy.client.GalaxyClient;
import com.scalar.galaxy.client.okhttp.GalaxyOkHttpClient;
import com.scalar.galaxy.models.planets.PlanetDeleteParams;
GalaxyClient client =
GalaxyOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();
PlanetDeleteParams params = PlanetDeleteParams.builder().planetId(1L).build();
client.planets().delete(params);Got a crazy good photo of a planet? Share it with the world!
| Direction | Type |
|---|---|
| Request | PlanetDelteImageParams |
| Response | PlanetDelteImageResponse |
import com.scalar.galaxy.client.GalaxyClient;
import com.scalar.galaxy.client.okhttp.GalaxyOkHttpClient;
import com.scalar.galaxy.models.planets.PlanetDelteImageParams;
GalaxyClient client =
GalaxyOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();
PlanetDelteImageParams params = PlanetDelteImageParams.builder().planetId(1L).build();
var planet = client.planets().delteImage(params);
System.out.println(planet);Celestial bodies are the planets and satellites in the Scalar Galaxy.
Stars, moons, comets, the occasional rogue asteroid — if it glows or drifts through the void, you can add it here.
| Direction | Type |
|---|---|
| Request | CelestialBodyCreateParams |
| Response | CelestialBody |
import com.scalar.galaxy.client.GalaxyClient;
import com.scalar.galaxy.client.okhttp.GalaxyOkHttpClient;
import com.scalar.galaxy.models.celestialbodies.CelestialBody;
import com.scalar.galaxy.models.celestialbodies.CelestialBodyCreateParams;
import com.scalar.galaxy.models.planets.Planet;
GalaxyClient client =
GalaxyOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();
CelestialBodyCreateParams params =
CelestialBodyCreateParams.builder()
.celestialBody(CelestialBody.ofPlanet(Planet.builder().name("Mars").build()))
.build();
var celestialBody = client.celestialBodies().create(params);
System.out.println(celestialBody);Some endpoints are public, but some require authentication. We provide all the required endpoints to create an account and authorize yourself.
Time to create a user account, eh?
| Direction | Type |
|---|---|
| Request | AuthenticationCreateUserParams |
| Response | User |
import com.scalar.galaxy.client.GalaxyClient;
import com.scalar.galaxy.client.okhttp.GalaxyOkHttpClient;
import com.scalar.galaxy.models.authentication.AuthenticationCreateUserParams;
GalaxyClient client =
GalaxyOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();
AuthenticationCreateUserParams params =
AuthenticationCreateUserParams.builder()
.name("Marc")
.email("marc@scalar.com")
.password("i-love-scalar")
.build();
var authentication = client.authentication().createUser(params);
System.out.println(authentication);Yeah, this is the boring security stuff. Just get your super secret token and move on.
| Direction | Type |
|---|---|
| Request | AuthenticationCreateTokenParams |
| Response | AuthenticationCreateTokenResponse |
import com.scalar.galaxy.client.GalaxyClient;
import com.scalar.galaxy.client.okhttp.GalaxyOkHttpClient;
import com.scalar.galaxy.models.authentication.AuthenticationCreateTokenParams;
import com.scalar.galaxy.models.authentication.Credentials;
GalaxyClient client =
GalaxyOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();
AuthenticationCreateTokenParams params =
AuthenticationCreateTokenParams.builder()
.credentials(
Credentials.builder().email("marc@scalar.com").password("i-love-scalar").build())
.build();
var authentication = client.authentication().createToken(params);
System.out.println(authentication);Find yourself they say. That's what you can do here.
| Direction | Type |
|---|---|
| Request | AuthenticationListMeParams |
| Response | User |
import com.scalar.galaxy.client.GalaxyClient;
import com.scalar.galaxy.client.okhttp.GalaxyOkHttpClient;
GalaxyClient client =
GalaxyOkHttpClient.builder().bearerAuth(System.getenv("BEARER_AUTH")).build();
var authentication = client.authentication().listMe();
System.out.println(authentication);