CitraClient.Schemas.Maneuver (citra_client v0.3.0)

View Source

Complete maneuver schema for responses

Fields

  • :creation_epoch — DateTime.t() (API key: creationEpoch)
  • :cross_track_magnitude — number() (API key: crossTrackMagnitude)
  • :epoch — DateTime.t()
  • :id — UUID String.t()
  • :in_track_magnitude — number() (API key: inTrackMagnitude)
  • :magnitude — number()
  • :radial_magnitude — number() (API key: radialMagnitude)
  • :satellite_id — UUID String.t() (API key: satelliteId)
  • :satellite_name — String.t() (API key: satelliteName)
  • :status — ManeuverStatus (see OpenAPI spec)
  • :update_epoch — DateTime.t() (API key: updateEpoch)

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.Maneuver{
  creation_epoch: DateTime.t() | nil,
  cross_track_magnitude: number() | nil,
  epoch: DateTime.t() | nil,
  id: String.t() | nil,
  in_track_magnitude: number() | nil,
  magnitude: number() | nil,
  radial_magnitude: number() | nil,
  satellite_id: String.t() | nil,
  satellite_name: String.t() | nil,
  status: map() | String.t() | nil,
  update_epoch: DateTime.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.