CitraClient.Schemas.AlertSubscription (citra_client v0.3.0)

View Source

Complete alert subscription schema for responses

Fields

  • :alert_type — AlertType (see OpenAPI spec) (API key: alertType)
  • :creation_epoch — DateTime.t() (API key: creationEpoch)
  • :id — UUID String.t()
  • :is_active — boolean() (API key: isActive)
  • :maneuver_status_filter — ManeuverStatusFilter (see OpenAPI spec) (API key: maneuverStatusFilter)
  • :satellite_event_type_filter — list of SatelliteEventType (see OpenAPI spec) (API key: satelliteEventTypeFilter)
  • :satellite_group_id — UUID String.t() (API key: satelliteGroupId)
  • :satellite_group_title — String.t() (API key: satelliteGroupTitle)
  • :satellite_id — UUID String.t() (API key: satelliteId)
  • :satellite_name — String.t() (API key: satelliteName)
  • :target_type — SubscriptionTargetType (see OpenAPI spec) (API key: targetType)
  • :update_epoch — DateTime.t() (API key: updateEpoch)
  • :user_group_ids — list of UUID String.t() (API key: userGroupIds)
  • :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.AlertSubscription{
  alert_type: map() | String.t() | nil,
  creation_epoch: DateTime.t() | nil,
  id: String.t() | nil,
  is_active: boolean() | nil,
  maneuver_status_filter: map() | String.t() | nil,
  satellite_event_type_filter: [map() | String.t() | nil],
  satellite_group_id: String.t() | nil,
  satellite_group_title: String.t() | nil,
  satellite_id: String.t() | nil,
  satellite_name: String.t() | nil,
  target_type: map() | String.t() | nil,
  update_epoch: DateTime.t() | nil,
  user_group_ids: [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.