CitraClient.Schemas.Satellite (citra_client v0.3.0)
View SourceStruct generated from the Satellite schema.
Fields
:aliases—SatelliteAliasList(see OpenAPI spec):altitude_display—String.t()(API key:altitudeDisplay) — Formatted altitude display from latest elset.:altitude_km—number()(API key:altitudeKm) — Altitude in kilometers from latest elset.:bus—String.t():country_code—String.t()(API key:countryCode):country_iso—String.t()(API key:countryIso) — ISO code for flag lookup from country_code.:country_name—String.t()(API key:countryName) — Decoded country name from country_code.:coverage_description—String.t()(API key:coverageDescription) — Coverage description from latest elset.:coverage_type—String.t()(API key:coverageType) — Coverage type (Polar, Equatorial, etc.) from latest elset.:creation_epoch—String.t()(API key:creationEpoch):decay_epoch—String.t()(API key:decayEpoch):depth_m—number()(API key:depthM):diameter_m—number()(API key:diameterM):elsets—ElsetList(see OpenAPI spec):headcount—integer():height_m—number()(API key:heightM):id—String.t():is_stable—boolean()(API key:isStable):launch_date_epoch—DateTime.t()(API key:launchDateEpoch) — Launch date from the satellite's origin event (if available).:launch_site_name—String.t()(API key:launchSiteName) — Decoded launch site name from site code.:maneuver_capability—ManeuverCapability(see OpenAPI spec) (API key:maneuverCapability):manufacturer—String.t():mass_kg—number()(API key:massKg):mission—Mission(see OpenAPI spec):name—String.t():norad_cat_id—integer()(API key:noradCatId):observed_rcs_max—number()(API key:observedRcsMax):observed_rcs_min—number()(API key:observedRcsMin):observed_rcs_updated_at—String.t()(API key:observedRcsUpdatedAt):observed_vmag_max—number()(API key:observedVmagMax):observed_vmag_min—number()(API key:observedVmagMin):observed_vmag_updated_at—String.t()(API key:observedVmagUpdatedAt):orbit_regime—String.t()(API key:orbitRegime) — Orbit regime (LEO, MEO, GEO, HEO) from latest elset.:orbit_regime_full_name—String.t()(API key:orbitRegimeFullName) — Full name of orbit regime from latest elset.:origin—SatelliteOriginEventReadList(see OpenAPI spec):origin_type—String.t()(API key:originType) — Origin type (Launch, Deployment, etc.) from the satellite's origin event.:owner—String.t():review_status—ReviewStatus(see OpenAPI spec) (API key:reviewStatus):rotation_period_sec—number()(API key:rotationPeriodSec):secondary_mission—Mission(see OpenAPI spec) (API key:secondaryMission):sector—Sector(see OpenAPI spec):shape—String.t():site—String.t():span_m—number()(API key:spanM):stability_calculated_at—String.t()(API key:stabilityCalculatedAt):transmissions—SatelliteTransmissionReadList(see OpenAPI spec):type—SatelliteType(see OpenAPI spec):user_group_id— UUIDString.t()(API key:userGroupId):user_id— UUIDString.t()(API key:userId):user_tier—UserTier(see OpenAPI spec) (API key:userTier):width_m—number()(API key:widthM)
Summary
Functions
Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.
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
@type t() :: %CitraClient.Schemas.Satellite{ aliases: map() | String.t() | nil, altitude_display: String.t() | nil, altitude_km: number() | nil, bus: String.t() | nil, country_code: String.t() | nil, country_iso: String.t() | nil, country_name: String.t() | nil, coverage_description: String.t() | nil, coverage_type: String.t() | nil, creation_epoch: String.t() | nil, decay_epoch: String.t() | nil, depth_m: number() | nil, diameter_m: number() | nil, elsets: map() | String.t() | nil, headcount: integer() | nil, height_m: number() | nil, id: String.t() | nil, is_stable: boolean() | nil, launch_date_epoch: DateTime.t() | nil, launch_site_name: String.t() | nil, maneuver_capability: map() | String.t() | nil, manufacturer: String.t() | nil, mass_kg: number() | nil, mission: map() | String.t() | nil, name: String.t() | nil, norad_cat_id: integer() | nil, observed_rcs_max: number() | nil, observed_rcs_min: number() | nil, observed_rcs_updated_at: String.t() | nil, observed_vmag_max: number() | nil, observed_vmag_min: number() | nil, observed_vmag_updated_at: String.t() | nil, orbit_regime: String.t() | nil, orbit_regime_full_name: String.t() | nil, origin: map() | String.t() | nil, origin_type: String.t() | nil, owner: String.t() | nil, review_status: map() | String.t() | nil, rotation_period_sec: number() | nil, secondary_mission: map() | String.t() | nil, sector: map() | String.t() | nil, shape: String.t() | nil, site: String.t() | nil, span_m: number() | nil, stability_calculated_at: String.t() | nil, transmissions: map() | String.t() | nil, type: map() | String.t() | nil, user_group_id: String.t() | nil, user_id: String.t() | nil, user_tier: map() | String.t() | nil, width_m: number() | nil }