CitraClient.Schemas.AlertSubscriptionCreate (citra_client v0.3.0)

View Source

Schema for alert subscription creation

Fields

  • :alert_type — AlertType (see OpenAPI spec) (API key: alertType) — Type of alerts to receive
  • :maneuver_status_filter — ManeuverStatusFilter (see OpenAPI spec) (API key: maneuverStatusFilter) — Filter by maneuver status (unverified, verified, or all)
  • :satellite_event_type_filter — list of SatelliteEventType (see OpenAPI spec) (API key: satelliteEventTypeFilter) — Filter by satellite event types (for SATELLITE_EVENT alerts). Null means all event types.
  • :satellite_group_id — UUID String.t() (API key: satelliteGroupId) — Target satellite group ID (if target_type is satellite_group)
  • :satellite_id — UUID String.t() (API key: satelliteId) — Target satellite ID (if target_type is satellite)
  • :target_type — SubscriptionTargetType (see OpenAPI spec) (API key: targetType) — Type of target (satellite or satellite_group)
  • :user_group_ids — list of UUID String.t() (API key: userGroupIds) — Filter by provider user group IDs (for NEW_UCT alerts). Null/empty means all providers.

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.AlertSubscriptionCreate{
  alert_type: map() | String.t() | nil,
  maneuver_status_filter: map() | String.t() | nil,
  satellite_event_type_filter: [map() | String.t() | nil],
  satellite_group_id: String.t() | nil,
  satellite_id: String.t() | nil,
  target_type: map() | String.t() | nil,
  user_group_ids: [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.