CitraClient.Schemas.ManeuverCreate (citra_client v0.3.0)

View Source

Schema for maneuver creation

Fields

  • :cross_track_magnitude — number() (API key: crossTrackMagnitude) — Cross-track component of maneuver
  • :epoch — DateTime.t() — When the maneuver occurred
  • :in_track_magnitude — number() (API key: inTrackMagnitude) — In-track component of maneuver
  • :magnitude — number() — Total maneuver magnitude
  • :radial_magnitude — number() (API key: radialMagnitude) — Radial component of maneuver
  • :satellite_id — UUID String.t() (API key: satelliteId) — Satellite that performed the maneuver
  • :status — ManeuverStatus (see OpenAPI spec) — Initial status of the maneuver

Summary

Types

t()

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.

Types

t()

@type t() :: %CitraClient.Schemas.ManeuverCreate{
  cross_track_magnitude: number() | nil,
  epoch: DateTime.t() | nil,
  in_track_magnitude: number() | nil,
  magnitude: number() | nil,
  radial_magnitude: number() | nil,
  satellite_id: String.t() | nil,
  status: map() | String.t() | nil
}

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.