CitraClient.Schemas.GlobeSatellite (citra_client v0.3.0)

View Source

Struct generated from the GlobeSatellite schema.

Fields

  • :country_codeString.t() (API key: countryCode)
  • :country_isoString.t() (API key: countryIso)
  • :country_nameString.t() (API key: countryName)
  • :eccentricitynumber()
  • :missionMission (see OpenAPI spec)
  • :norad_cat_idinteger() (API key: noradCatId)
  • :satellite_id — UUID String.t() (API key: satelliteId)
  • :satellite_nameString.t() (API key: satelliteName)
  • :satellite_typeSatelliteType (see OpenAPI spec) (API key: satelliteType)
  • :secondary_missionMission (see OpenAPI spec) (API key: secondaryMission)
  • :sectorSector (see OpenAPI spec)
  • :semi_major_axisnumber() (API key: semiMajorAxis)
  • :tle — list of any()

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

t()

@type t() :: %CitraClient.Schemas.GlobeSatellite{
  country_code: String.t() | nil,
  country_iso: String.t() | nil,
  country_name: String.t() | nil,
  eccentricity: number() | nil,
  mission: map() | String.t() | nil,
  norad_cat_id: integer() | nil,
  satellite_id: String.t() | nil,
  satellite_name: String.t() | nil,
  satellite_type: map() | String.t() | nil,
  secondary_mission: map() | String.t() | nil,
  sector: map() | String.t() | nil,
  semi_major_axis: number() | nil,
  tle: [any()]
}

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.