CitraClient.Schemas.Alert (citra_client v0.3.0)

View Source

Complete alert schema for responses

Fields

  • :alert_type — AlertType (see OpenAPI spec) (API key: alertType)
  • :creation_epoch — DateTime.t() (API key: creationEpoch)
  • :event_epoch — DateTime.t() (API key: eventEpoch)
  • :id — UUID String.t()
  • :is_read — boolean() (API key: isRead)
  • :maneuver_id — UUID String.t() (API key: maneuverId)
  • :maneuver_status — ManeuverStatus (see OpenAPI spec) (API key: maneuverStatus)
  • :message — String.t()
  • :read_epoch — DateTime.t() (API key: readEpoch)
  • :satellite_event_id — UUID String.t() (API key: satelliteEventId)
  • :satellite_event_type — SatelliteEventType (see OpenAPI spec) (API key: satelliteEventType)
  • :satellite_id — UUID String.t() (API key: satelliteId)
  • :satellite_name — String.t() (API key: satelliteName)
  • :subscription_id — UUID String.t() (API key: subscriptionId)
  • :title — String.t()
  • :user_group_id — UUID String.t() (API key: userGroupId)
  • :user_id — UUID String.t() (API key: userId)

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.Alert{
  alert_type: map() | String.t() | nil,
  creation_epoch: DateTime.t() | nil,
  event_epoch: DateTime.t() | nil,
  id: String.t() | nil,
  is_read: boolean() | nil,
  maneuver_id: String.t() | nil,
  maneuver_status: map() | String.t() | nil,
  message: String.t() | nil,
  read_epoch: DateTime.t() | nil,
  satellite_event_id: String.t() | nil,
  satellite_event_type: map() | String.t() | nil,
  satellite_id: String.t() | nil,
  satellite_name: String.t() | nil,
  subscription_id: String.t() | nil,
  title: String.t() | nil,
  user_group_id: String.t() | nil,
  user_id: 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.