udl-sdk 0.1.0a9__py3-none-any.whl → 0.1.0a11__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (413) hide show
  1. {udl_sdk-0.1.0a9.dist-info → udl_sdk-0.1.0a11.dist-info}/METADATA +39 -46
  2. {udl_sdk-0.1.0a9.dist-info → udl_sdk-0.1.0a11.dist-info}/RECORD +413 -263
  3. unifieddatalibrary/__init__.py +2 -1
  4. unifieddatalibrary/_base_client.py +44 -2
  5. unifieddatalibrary/_client.py +6 -2
  6. unifieddatalibrary/_models.py +2 -0
  7. unifieddatalibrary/_types.py +2 -0
  8. unifieddatalibrary/_version.py +1 -1
  9. unifieddatalibrary/resources/air_events.py +5 -6
  10. unifieddatalibrary/resources/air_load_plans.py +5 -6
  11. unifieddatalibrary/resources/air_operations/air_tasking_orders.py +5 -6
  12. unifieddatalibrary/resources/air_transport_missions/air_transport_missions.py +5 -6
  13. unifieddatalibrary/resources/aircraft.py +5 -6
  14. unifieddatalibrary/resources/aircraft_sorties.py +5 -6
  15. unifieddatalibrary/resources/aircraft_status_remarks.py +5 -6
  16. unifieddatalibrary/resources/aircraft_statuses/aircraft_statuses.py +5 -6
  17. unifieddatalibrary/resources/airfield_slot_consumptions.py +5 -6
  18. unifieddatalibrary/resources/airfield_slots.py +5 -6
  19. unifieddatalibrary/resources/airfield_status/airfield_status.py +5 -6
  20. unifieddatalibrary/resources/airfields.py +5 -6
  21. unifieddatalibrary/resources/airspace_control_orders.py +5 -6
  22. unifieddatalibrary/resources/ais/ais.py +5 -6
  23. unifieddatalibrary/resources/analytic_imagery.py +5 -6
  24. unifieddatalibrary/resources/antennas.py +5 -6
  25. unifieddatalibrary/resources/attitude_data.py +6 -7
  26. unifieddatalibrary/resources/attitude_sets/attitude_sets.py +5 -6
  27. unifieddatalibrary/resources/aviation_risk_management.py +5 -6
  28. unifieddatalibrary/resources/batteries.py +5 -6
  29. unifieddatalibrary/resources/beam.py +5 -6
  30. unifieddatalibrary/resources/beam_contours.py +5 -6
  31. unifieddatalibrary/resources/buses.py +5 -6
  32. unifieddatalibrary/resources/channels.py +5 -6
  33. unifieddatalibrary/resources/collect_requests/collect_requests.py +5 -6
  34. unifieddatalibrary/resources/collect_responses/collect_responses.py +5 -6
  35. unifieddatalibrary/resources/comm.py +5 -6
  36. unifieddatalibrary/resources/conjunctions/conjunctions.py +5 -6
  37. unifieddatalibrary/resources/countries.py +5 -6
  38. unifieddatalibrary/resources/crew.py +5 -6
  39. unifieddatalibrary/resources/diff_of_arrival/diff_of_arrival.py +5 -6
  40. unifieddatalibrary/resources/diplomatic_clearance/country.py +21 -22
  41. unifieddatalibrary/resources/diplomatic_clearance/diplomatic_clearance.py +5 -6
  42. unifieddatalibrary/resources/drift_history.py +6 -7
  43. unifieddatalibrary/resources/dropzone.py +5 -6
  44. unifieddatalibrary/resources/effect_requests/effect_requests.py +5 -6
  45. unifieddatalibrary/resources/effect_responses/effect_responses.py +5 -6
  46. unifieddatalibrary/resources/elsets/elsets.py +10 -12
  47. unifieddatalibrary/resources/emitter_geolocation.py +5 -6
  48. unifieddatalibrary/resources/engines.py +5 -6
  49. unifieddatalibrary/resources/entities.py +13 -10
  50. unifieddatalibrary/resources/eop/eop.py +5 -6
  51. unifieddatalibrary/resources/ephemeris/ephemeris.py +7 -8
  52. unifieddatalibrary/resources/ephemeris_sets/ephemeris_sets.py +7 -8
  53. unifieddatalibrary/resources/equipment.py +5 -6
  54. unifieddatalibrary/resources/equipment_remarks.py +5 -6
  55. unifieddatalibrary/resources/evac/evac.py +5 -6
  56. unifieddatalibrary/resources/event_evolution/event_evolution.py +5 -6
  57. unifieddatalibrary/resources/feature_assessment/feature_assessment.py +5 -6
  58. unifieddatalibrary/resources/flightplan.py +5 -6
  59. unifieddatalibrary/resources/geo_status/geo_status.py +5 -6
  60. unifieddatalibrary/resources/global_atmospheric_model/global_atmospheric_model.py +7 -8
  61. unifieddatalibrary/resources/gnss_observationset/gnss_observationset.py +5 -6
  62. unifieddatalibrary/resources/gnss_rawif.py +5 -6
  63. unifieddatalibrary/resources/ground_imagery/ground_imagery.py +5 -6
  64. unifieddatalibrary/resources/h3_geo/h3_geo.py +5 -6
  65. unifieddatalibrary/resources/h3_geo_hex_cell.py +6 -7
  66. unifieddatalibrary/resources/hazard/hazard.py +5 -6
  67. unifieddatalibrary/resources/ion_oobservation.py +5 -6
  68. unifieddatalibrary/resources/ir.py +5 -6
  69. unifieddatalibrary/resources/isr_collections/isr_collections.py +5 -6
  70. unifieddatalibrary/resources/item.py +5 -6
  71. unifieddatalibrary/resources/item_trackings/item_trackings.py +5 -6
  72. unifieddatalibrary/resources/launch_detection.py +5 -6
  73. unifieddatalibrary/resources/launch_event/launch_event.py +5 -6
  74. unifieddatalibrary/resources/launch_site.py +5 -6
  75. unifieddatalibrary/resources/launch_vehicle.py +5 -6
  76. unifieddatalibrary/resources/link_status/datalink.py +5 -6
  77. unifieddatalibrary/resources/link_status/link_status.py +5 -6
  78. unifieddatalibrary/resources/location.py +5 -6
  79. unifieddatalibrary/resources/logistics_support/logistics_support.py +5 -6
  80. unifieddatalibrary/resources/maneuvers/maneuvers.py +5 -6
  81. unifieddatalibrary/resources/manifold.py +5 -6
  82. unifieddatalibrary/resources/manifoldelset.py +5 -6
  83. unifieddatalibrary/resources/missile_tracks/missile_tracks.py +5 -6
  84. unifieddatalibrary/resources/mission_assignment/mission_assignment.py +5 -6
  85. unifieddatalibrary/resources/mti/mti.py +5 -6
  86. unifieddatalibrary/resources/navigation.py +5 -6
  87. unifieddatalibrary/resources/navigational_obstruction.py +5 -6
  88. unifieddatalibrary/resources/notification/notification.py +5 -6
  89. unifieddatalibrary/resources/object_of_interest.py +5 -6
  90. unifieddatalibrary/resources/observations/ecpsdr.py +5 -6
  91. unifieddatalibrary/resources/observations/eo_observations/eo_observations.py +5 -6
  92. unifieddatalibrary/resources/observations/monoradar/monoradar.py +5 -6
  93. unifieddatalibrary/resources/observations/passive_radar_observation/passive_radar_observation.py +5 -6
  94. unifieddatalibrary/resources/observations/radarobservation/radarobservation.py +5 -6
  95. unifieddatalibrary/resources/observations/rf_observation/rf_observation.py +5 -6
  96. unifieddatalibrary/resources/onboardnavigation/onboardnavigation.py +5 -6
  97. unifieddatalibrary/resources/onorbit/onorbit.py +5 -6
  98. unifieddatalibrary/resources/onorbitevent.py +5 -6
  99. unifieddatalibrary/resources/onorbitlist.py +5 -6
  100. unifieddatalibrary/resources/onorbitthrusterstatus/onorbitthrusterstatus.py +5 -6
  101. unifieddatalibrary/resources/operatingunit.py +5 -6
  102. unifieddatalibrary/resources/operatingunitremark.py +5 -6
  103. unifieddatalibrary/resources/orbitdetermination/orbitdetermination.py +5 -6
  104. unifieddatalibrary/resources/orbittrack/orbittrack.py +5 -6
  105. unifieddatalibrary/resources/organization.py +5 -6
  106. unifieddatalibrary/resources/personnelrecovery/personnelrecovery.py +5 -6
  107. unifieddatalibrary/resources/poi.py +5 -6
  108. unifieddatalibrary/resources/port.py +5 -6
  109. unifieddatalibrary/resources/rf_band.py +5 -6
  110. unifieddatalibrary/resources/rf_band_type.py +5 -6
  111. unifieddatalibrary/resources/rf_emitter.py +5 -6
  112. unifieddatalibrary/resources/rf_emitter_details.py +5 -6
  113. unifieddatalibrary/resources/route_stats.py +5 -6
  114. unifieddatalibrary/resources/sar_observation/sar_observation.py +5 -6
  115. unifieddatalibrary/resources/scientific.py +5 -6
  116. unifieddatalibrary/resources/scs/folders.py +8 -0
  117. unifieddatalibrary/resources/scs/paths.py +16 -0
  118. unifieddatalibrary/resources/scs/scs.py +16 -0
  119. unifieddatalibrary/resources/scs/v2.py +64 -4
  120. unifieddatalibrary/resources/sensor/calibration/calibration.py +117 -112
  121. unifieddatalibrary/resources/sensor/sensor.py +5 -6
  122. unifieddatalibrary/resources/sensor_maintenance/sensor_maintenance.py +5 -6
  123. unifieddatalibrary/resources/sensor_observation_type.py +6 -7
  124. unifieddatalibrary/resources/sensor_plan/sensor_plan.py +5 -6
  125. unifieddatalibrary/resources/sensor_type.py +6 -7
  126. unifieddatalibrary/resources/sera_data_comm_details.py +5 -6
  127. unifieddatalibrary/resources/sera_data_early_warning.py +5 -6
  128. unifieddatalibrary/resources/sera_data_navigation.py +5 -6
  129. unifieddatalibrary/resources/seradata_optical_payload.py +5 -6
  130. unifieddatalibrary/resources/seradata_radar_payload.py +5 -6
  131. unifieddatalibrary/resources/seradata_sigint_payload.py +5 -6
  132. unifieddatalibrary/resources/seradata_spacecraft_details.py +5 -6
  133. unifieddatalibrary/resources/sgi/sgi.py +5 -6
  134. unifieddatalibrary/resources/sigact/sigact.py +5 -6
  135. unifieddatalibrary/resources/site/operations.py +5 -6
  136. unifieddatalibrary/resources/site/site.py +5 -6
  137. unifieddatalibrary/resources/site_remark.py +5 -6
  138. unifieddatalibrary/resources/site_status/site_status.py +5 -6
  139. unifieddatalibrary/resources/sky_imagery/sky_imagery.py +5 -6
  140. unifieddatalibrary/resources/soi_observation_set/soi_observation_set.py +5 -6
  141. unifieddatalibrary/resources/solar_array.py +5 -6
  142. unifieddatalibrary/resources/sortie_ppr/sortie_ppr.py +5 -6
  143. unifieddatalibrary/resources/space_env_observation/space_env_observation.py +5 -6
  144. unifieddatalibrary/resources/stage.py +5 -6
  145. unifieddatalibrary/resources/star_catalog/star_catalog.py +5 -6
  146. unifieddatalibrary/resources/state_vector/state_vector.py +7 -8
  147. unifieddatalibrary/resources/status.py +5 -6
  148. unifieddatalibrary/resources/substatus.py +5 -6
  149. unifieddatalibrary/resources/supporting_data/query_help.py +6 -7
  150. unifieddatalibrary/resources/surface.py +5 -6
  151. unifieddatalibrary/resources/surface_obstruction.py +5 -6
  152. unifieddatalibrary/resources/swir/swir.py +5 -6
  153. unifieddatalibrary/resources/tai_utc/tai_utc.py +5 -6
  154. unifieddatalibrary/resources/track/track.py +5 -6
  155. unifieddatalibrary/resources/track_details/track_details.py +5 -6
  156. unifieddatalibrary/resources/track_route/track_route.py +5 -6
  157. unifieddatalibrary/resources/transponder.py +5 -6
  158. unifieddatalibrary/resources/vessel.py +5 -6
  159. unifieddatalibrary/resources/video/video.py +5 -6
  160. unifieddatalibrary/resources/weather_data/weather_data.py +5 -6
  161. unifieddatalibrary/resources/weather_report/weather_report.py +5 -6
  162. unifieddatalibrary/types/__init__.py +200 -0
  163. unifieddatalibrary/types/ai_queryhelp_response.py +63 -0
  164. unifieddatalibrary/types/air_event_queryhelp_response.py +63 -0
  165. unifieddatalibrary/types/air_load_plan_queryhelp_response.py +63 -0
  166. unifieddatalibrary/types/air_operations/__init__.py +1 -0
  167. unifieddatalibrary/types/air_operations/air_tasking_order_query_help_response.py +63 -0
  168. unifieddatalibrary/types/air_operations/diplomatic_clearance_unvalidated_publish_params.py +4 -4
  169. unifieddatalibrary/types/air_operations/diplomaticclearance_abridged.py +4 -4
  170. unifieddatalibrary/types/air_operations/diplomaticclearance_full.py +4 -4
  171. unifieddatalibrary/types/air_transport_mission_queryhelp_response.py +63 -0
  172. unifieddatalibrary/types/aircraft_queryhelp_response.py +63 -0
  173. unifieddatalibrary/types/aircraft_sorty_queryhelp_response.py +63 -0
  174. unifieddatalibrary/types/aircraft_status_queryhelp_response.py +63 -0
  175. unifieddatalibrary/types/aircraft_status_remark_queryhelp_response.py +63 -0
  176. unifieddatalibrary/types/airfield_queryhelp_response.py +63 -0
  177. unifieddatalibrary/types/airfield_slot_consumption_queryhelp_response.py +63 -0
  178. unifieddatalibrary/types/airfield_slot_queryhelp_response.py +63 -0
  179. unifieddatalibrary/types/airfield_status_queryhelp_response.py +63 -0
  180. unifieddatalibrary/types/airspace_control_order_query_help_response.py +63 -0
  181. unifieddatalibrary/types/analytic_imagery_full.py +272 -1
  182. unifieddatalibrary/types/analytic_imagery_history_response.py +2 -2
  183. unifieddatalibrary/types/analytic_imagery_queryhelp_response.py +63 -0
  184. unifieddatalibrary/types/analytic_imagery_tuple_response.py +2 -2
  185. unifieddatalibrary/types/antenna_queryhelp_response.py +63 -0
  186. unifieddatalibrary/types/attitude_data_query_help_response.py +63 -0
  187. unifieddatalibrary/types/attitude_set_query_help_response.py +63 -0
  188. unifieddatalibrary/types/aviation_risk_management_query_help_response.py +63 -0
  189. unifieddatalibrary/types/battery_queryhelp_response.py +63 -0
  190. unifieddatalibrary/types/beam_contour_query_help_response.py +63 -0
  191. unifieddatalibrary/types/beam_query_help_response.py +63 -0
  192. unifieddatalibrary/types/bus_query_help_response.py +63 -0
  193. unifieddatalibrary/types/channel_queryhelp_response.py +63 -0
  194. unifieddatalibrary/types/collect_request_abridged.py +3 -1
  195. unifieddatalibrary/types/collect_request_create_bulk_params.py +3 -1
  196. unifieddatalibrary/types/collect_request_create_params.py +3 -1
  197. unifieddatalibrary/types/collect_request_query_help_response.py +63 -0
  198. unifieddatalibrary/types/collect_request_unvalidated_publish_params.py +3 -1
  199. unifieddatalibrary/types/collect_response_query_help_response.py +63 -0
  200. unifieddatalibrary/types/comm_queryhelp_response.py +63 -0
  201. unifieddatalibrary/types/conjunction_abridged.py +6 -2
  202. unifieddatalibrary/types/conjunction_create_bulk_params.py +6 -2
  203. unifieddatalibrary/types/conjunction_create_udl_params.py +6 -2
  204. unifieddatalibrary/types/conjunction_full.py +6 -2
  205. unifieddatalibrary/types/conjunction_queryhelp_response.py +63 -0
  206. unifieddatalibrary/types/conjunction_unvalidated_publish_params.py +6 -2
  207. unifieddatalibrary/types/country_queryhelp_response.py +63 -0
  208. unifieddatalibrary/types/crew_queryhelp_response.py +63 -0
  209. unifieddatalibrary/types/diff_of_arrival_queryhelp_response.py +63 -0
  210. unifieddatalibrary/types/diplomatic_clearance/__init__.py +1 -0
  211. unifieddatalibrary/types/diplomatic_clearance/country_create_bulk_params.py +4 -4
  212. unifieddatalibrary/types/diplomatic_clearance/country_create_params.py +4 -4
  213. unifieddatalibrary/types/diplomatic_clearance/country_list_response.py +4 -4
  214. unifieddatalibrary/types/diplomatic_clearance/country_query_help_response.py +63 -0
  215. unifieddatalibrary/types/diplomatic_clearance/country_retrieve_response.py +4 -4
  216. unifieddatalibrary/types/diplomatic_clearance/country_tuple_response.py +4 -4
  217. unifieddatalibrary/types/diplomatic_clearance/country_unvalidated_publish_params.py +4 -4
  218. unifieddatalibrary/types/diplomatic_clearance/country_update_params.py +4 -4
  219. unifieddatalibrary/types/diplomatic_clearance_create_bulk_params.py +4 -4
  220. unifieddatalibrary/types/diplomatic_clearance_create_params.py +4 -4
  221. unifieddatalibrary/types/diplomatic_clearance_queryhelp_response.py +63 -0
  222. unifieddatalibrary/types/diplomatic_clearance_update_params.py +4 -4
  223. unifieddatalibrary/types/drift_history_queryhelp_response.py +63 -0
  224. unifieddatalibrary/types/dropzone_query_help_response.py +63 -0
  225. unifieddatalibrary/types/effect_request_query_help_response.py +63 -0
  226. unifieddatalibrary/types/effect_response_query_help_response.py +63 -0
  227. unifieddatalibrary/types/elset_query_current_elset_help_response.py +63 -0
  228. unifieddatalibrary/types/elset_queryhelp_response.py +63 -0
  229. unifieddatalibrary/types/emitter_geolocation_query_help_response.py +63 -0
  230. unifieddatalibrary/types/engine_queryhelp_response.py +63 -0
  231. unifieddatalibrary/types/entity_abridged.py +13 -2
  232. unifieddatalibrary/types/entity_create_params.py +2 -1
  233. unifieddatalibrary/types/entity_full.py +13 -2
  234. unifieddatalibrary/types/entity_get_all_types_response.py +4 -3875
  235. unifieddatalibrary/types/entity_ingest_param.py +2 -1
  236. unifieddatalibrary/types/entity_query_help_response.py +63 -0
  237. unifieddatalibrary/types/entity_update_params.py +2 -1
  238. unifieddatalibrary/types/eop_queryhelp_response.py +63 -0
  239. unifieddatalibrary/types/ephemeris_queryhelp_response.py +63 -0
  240. unifieddatalibrary/types/ephemeris_set.py +3 -1
  241. unifieddatalibrary/types/ephemeris_set_abridged.py +3 -1
  242. unifieddatalibrary/types/ephemeris_set_create_params.py +3 -1
  243. unifieddatalibrary/types/ephemeris_set_queryhelp_response.py +63 -0
  244. unifieddatalibrary/types/ephemeris_unvalidated_publish_params.py +3 -1
  245. unifieddatalibrary/types/equipment_query_help_response.py +63 -0
  246. unifieddatalibrary/types/equipment_remark_query_help_response.py +63 -0
  247. unifieddatalibrary/types/evac_query_help_response.py +63 -0
  248. unifieddatalibrary/types/event_evolution_queryhelp_response.py +63 -0
  249. unifieddatalibrary/types/feature_assessment_query_help_response.py +63 -0
  250. unifieddatalibrary/types/flightplan_queryhelp_response.py +63 -0
  251. unifieddatalibrary/types/geo_status_queryhelp_response.py +63 -0
  252. unifieddatalibrary/types/global_atmospheric_model_query_help_response.py +63 -0
  253. unifieddatalibrary/types/gnss_observationset_queryhelp_response.py +63 -0
  254. unifieddatalibrary/types/gnss_rawif_queryhelp_response.py +63 -0
  255. unifieddatalibrary/types/ground_imagery_queryhelp_response.py +63 -0
  256. unifieddatalibrary/types/h3_geo_hex_cell_queryhelp_response.py +63 -0
  257. unifieddatalibrary/types/h3_geo_queryhelp_response.py +63 -0
  258. unifieddatalibrary/types/hazard_queryhelp_response.py +63 -0
  259. unifieddatalibrary/types/ion_oobservation_queryhelp_response.py +63 -0
  260. unifieddatalibrary/types/ir_queryhelp_response.py +63 -0
  261. unifieddatalibrary/types/isr_collection_queryhelp_response.py +63 -0
  262. unifieddatalibrary/types/item_queryhelp_response.py +63 -0
  263. unifieddatalibrary/types/item_tracking_queryhelp_response.py +63 -0
  264. unifieddatalibrary/types/launch_detection_queryhelp_response.py +63 -0
  265. unifieddatalibrary/types/launch_event_queryhelp_response.py +63 -0
  266. unifieddatalibrary/types/launch_site_queryhelp_response.py +63 -0
  267. unifieddatalibrary/types/launch_vehicle_queryhelp_response.py +63 -0
  268. unifieddatalibrary/types/link_status/__init__.py +1 -0
  269. unifieddatalibrary/types/link_status/datalink_queryhelp_response.py +63 -0
  270. unifieddatalibrary/types/link_status_queryhelp_response.py +63 -0
  271. unifieddatalibrary/types/location_queryhelp_response.py +63 -0
  272. unifieddatalibrary/types/logistics_support_queryhelp_response.py +63 -0
  273. unifieddatalibrary/types/maneuver_create_bulk_params.py +6 -2
  274. unifieddatalibrary/types/maneuver_create_params.py +6 -2
  275. unifieddatalibrary/types/maneuver_get_response.py +6 -2
  276. unifieddatalibrary/types/maneuver_list_response.py +6 -2
  277. unifieddatalibrary/types/maneuver_queryhelp_response.py +63 -0
  278. unifieddatalibrary/types/maneuver_tuple_response.py +6 -2
  279. unifieddatalibrary/types/maneuver_unvalidated_publish_params.py +6 -2
  280. unifieddatalibrary/types/maneuvers/history_list_response.py +6 -2
  281. unifieddatalibrary/types/manifold_queryhelp_response.py +63 -0
  282. unifieddatalibrary/types/manifoldelset_queryhelp_response.py +63 -0
  283. unifieddatalibrary/types/missile_track_create_bulk_params.py +6 -4
  284. unifieddatalibrary/types/missile_track_list_response.py +6 -4
  285. unifieddatalibrary/types/missile_track_queryhelp_response.py +63 -0
  286. unifieddatalibrary/types/missile_track_tuple_response.py +6 -4
  287. unifieddatalibrary/types/missile_track_unvalidated_publish_params.py +6 -4
  288. unifieddatalibrary/types/missile_tracks/history_query_response.py +6 -4
  289. unifieddatalibrary/types/mission_assignment_queryhelp_response.py +63 -0
  290. unifieddatalibrary/types/mti_queryhelp_response.py +63 -0
  291. unifieddatalibrary/types/navigation_queryhelp_response.py +63 -0
  292. unifieddatalibrary/types/navigational_obstruction_queryhelp_response.py +63 -0
  293. unifieddatalibrary/types/notification_queryhelp_response.py +63 -0
  294. unifieddatalibrary/types/object_of_interest_queryhelp_response.py +63 -0
  295. unifieddatalibrary/types/observations/__init__.py +8 -0
  296. unifieddatalibrary/types/observations/ecpsdr_query_help_response.py +63 -0
  297. unifieddatalibrary/types/observations/eo_observation_queryhelp_response.py +63 -0
  298. unifieddatalibrary/types/observations/monoradar_queryhelp_response.py +63 -0
  299. unifieddatalibrary/types/observations/passive_radar_observation_queryhelp_response.py +63 -0
  300. unifieddatalibrary/types/observations/radarobservation_queryhelp_response.py +63 -0
  301. unifieddatalibrary/types/observations/rf_observation_queryhelp_response.py +63 -0
  302. unifieddatalibrary/types/onboardnavigation_queryhelp_response.py +63 -0
  303. unifieddatalibrary/types/onorbit_queryhelp_response.py +63 -0
  304. unifieddatalibrary/types/onorbitevent_queryhelp_response.py +63 -0
  305. unifieddatalibrary/types/onorbitlist_queryhelp_response.py +63 -0
  306. unifieddatalibrary/types/onorbitthrusterstatus_queryhelp_response.py +63 -0
  307. unifieddatalibrary/types/operatingunit_queryhelp_response.py +63 -0
  308. unifieddatalibrary/types/operatingunitremark_queryhelp_response.py +63 -0
  309. unifieddatalibrary/types/orbitdetermination/history_list_response.py +3 -1
  310. unifieddatalibrary/types/orbitdetermination_create_bulk_params.py +3 -1
  311. unifieddatalibrary/types/orbitdetermination_create_params.py +3 -1
  312. unifieddatalibrary/types/orbitdetermination_get_response.py +3 -1
  313. unifieddatalibrary/types/orbitdetermination_list_response.py +3 -1
  314. unifieddatalibrary/types/orbitdetermination_queryhelp_response.py +63 -0
  315. unifieddatalibrary/types/orbitdetermination_tuple_response.py +3 -1
  316. unifieddatalibrary/types/orbitdetermination_unvalidated_publish_params.py +3 -1
  317. unifieddatalibrary/types/orbittrack_queryhelp_response.py +63 -0
  318. unifieddatalibrary/types/organization_queryhelp_response.py +63 -0
  319. unifieddatalibrary/types/personnelrecovery_queryhelp_response.py +63 -0
  320. unifieddatalibrary/types/poi_queryhelp_response.py +63 -0
  321. unifieddatalibrary/types/port_queryhelp_response.py +63 -0
  322. unifieddatalibrary/types/rf_band_queryhelp_response.py +63 -0
  323. unifieddatalibrary/types/rf_band_type_queryhelp_response.py +63 -0
  324. unifieddatalibrary/types/rf_emitter_detail_queryhelp_response.py +63 -0
  325. unifieddatalibrary/types/rf_emitter_queryhelp_response.py +63 -0
  326. unifieddatalibrary/types/route_stat_query_help_response.py +63 -0
  327. unifieddatalibrary/types/sar_observation_queryhelp_response.py +63 -0
  328. unifieddatalibrary/types/sc_file_upload_params.py +6 -0
  329. unifieddatalibrary/types/scientific_queryhelp_response.py +63 -0
  330. unifieddatalibrary/types/scs/folder_create_params.py +3 -0
  331. unifieddatalibrary/types/scs/folder_update_params.py +2 -0
  332. unifieddatalibrary/types/scs/path_create_params.py +6 -0
  333. unifieddatalibrary/types/scs/scs_entity.py +2 -0
  334. unifieddatalibrary/types/scs/v2_file_upload_params.py +6 -0
  335. unifieddatalibrary/types/scs/v2_folder_create_params.py +5 -0
  336. unifieddatalibrary/types/scs/v2_update_params.py +5 -0
  337. unifieddatalibrary/types/sensor/__init__.py +1 -0
  338. unifieddatalibrary/types/sensor/calibration/history_query_response.py +64 -53
  339. unifieddatalibrary/types/sensor/calibration_create_bulk_params.py +64 -53
  340. unifieddatalibrary/types/sensor/calibration_create_params.py +64 -53
  341. unifieddatalibrary/types/sensor/calibration_query_help_response.py +63 -0
  342. unifieddatalibrary/types/sensor/calibration_query_response.py +64 -53
  343. unifieddatalibrary/types/sensor/calibration_retrieve_response.py +64 -53
  344. unifieddatalibrary/types/sensor/calibration_tuple_response.py +64 -53
  345. unifieddatalibrary/types/sensor/calibration_unvalidated_publish_params.py +64 -53
  346. unifieddatalibrary/types/sensor_create_params.py +349 -4
  347. unifieddatalibrary/types/sensor_get_response.py +362 -5
  348. unifieddatalibrary/types/sensor_list_response.py +362 -5
  349. unifieddatalibrary/types/sensor_maintenance_queryhelp_response.py +63 -0
  350. unifieddatalibrary/types/sensor_observation_type_queryhelp_response.py +63 -0
  351. unifieddatalibrary/types/sensor_plan/history_retrieve_response.py +3 -1
  352. unifieddatalibrary/types/sensor_plan_create_params.py +3 -1
  353. unifieddatalibrary/types/sensor_plan_get_response.py +3 -1
  354. unifieddatalibrary/types/sensor_plan_queryhelp_response.py +63 -0
  355. unifieddatalibrary/types/sensor_plan_tuple_response.py +3 -1
  356. unifieddatalibrary/types/sensor_plan_unvalidated_publish_params.py +3 -1
  357. unifieddatalibrary/types/sensor_plan_update_params.py +3 -1
  358. unifieddatalibrary/types/sensor_queryhelp_response.py +63 -0
  359. unifieddatalibrary/types/sensor_tuple_response.py +362 -5
  360. unifieddatalibrary/types/sensor_type_queryhelp_response.py +63 -0
  361. unifieddatalibrary/types/sensor_update_params.py +349 -4
  362. unifieddatalibrary/types/sera_data_comm_detail_queryhelp_response.py +63 -0
  363. unifieddatalibrary/types/sera_data_early_warning_queryhelp_response.py +63 -0
  364. unifieddatalibrary/types/sera_data_navigation_queryhelp_response.py +63 -0
  365. unifieddatalibrary/types/seradata_optical_payload_queryhelp_response.py +63 -0
  366. unifieddatalibrary/types/seradata_radar_payload_queryhelp_response.py +63 -0
  367. unifieddatalibrary/types/seradata_sigint_payload_queryhelp_response.py +63 -0
  368. unifieddatalibrary/types/seradata_spacecraft_detail_queryhelp_response.py +63 -0
  369. unifieddatalibrary/types/sgi_queryhelp_response.py +63 -0
  370. unifieddatalibrary/types/shared/collect_request_full.py +3 -1
  371. unifieddatalibrary/types/shared/file_data.py +2 -0
  372. unifieddatalibrary/types/shared/onorbit_full.py +13 -2
  373. unifieddatalibrary/types/shared_params/file_data.py +2 -0
  374. unifieddatalibrary/types/sigact_queryhelp_response.py +63 -0
  375. unifieddatalibrary/types/site/__init__.py +1 -0
  376. unifieddatalibrary/types/site/operation_query_help_response.py +63 -0
  377. unifieddatalibrary/types/site_queryhelp_response.py +63 -0
  378. unifieddatalibrary/types/site_remark_queryhelp_response.py +63 -0
  379. unifieddatalibrary/types/site_status_queryhelp_response.py +63 -0
  380. unifieddatalibrary/types/sky_imagery_queryhelp_response.py +63 -0
  381. unifieddatalibrary/types/soi_observation_set_queryhelp_response.py +63 -0
  382. unifieddatalibrary/types/solar_array_queryhelp_response.py +63 -0
  383. unifieddatalibrary/types/sortie_ppr_queryhelp_response.py +63 -0
  384. unifieddatalibrary/types/space_env_observation_queryhelp_response.py +63 -0
  385. unifieddatalibrary/types/stage_queryhelp_response.py +63 -0
  386. unifieddatalibrary/types/star_catalog_queryhelp_response.py +63 -0
  387. unifieddatalibrary/types/state_vector_abridged.py +3 -1
  388. unifieddatalibrary/types/state_vector_create_params.py +3 -1
  389. unifieddatalibrary/types/state_vector_full.py +3 -1
  390. unifieddatalibrary/types/state_vector_ingest_param.py +3 -1
  391. unifieddatalibrary/types/state_vector_queryhelp_response.py +63 -0
  392. unifieddatalibrary/types/status_queryhelp_response.py +63 -0
  393. unifieddatalibrary/types/substatus_queryhelp_response.py +63 -0
  394. unifieddatalibrary/types/supporting_data/__init__.py +1 -0
  395. unifieddatalibrary/types/supporting_data/query_help_retrieve_response.py +63 -0
  396. unifieddatalibrary/types/surface_obstruction_queryhelp_response.py +63 -0
  397. unifieddatalibrary/types/surface_queryhelp_response.py +63 -0
  398. unifieddatalibrary/types/swir_queryhelp_response.py +63 -0
  399. unifieddatalibrary/types/tai_utc_queryhelp_response.py +63 -0
  400. unifieddatalibrary/types/track/track_full.py +26 -0
  401. unifieddatalibrary/types/track_create_bulk_params.py +26 -0
  402. unifieddatalibrary/types/track_detail_queryhelp_response.py +63 -0
  403. unifieddatalibrary/types/track_list_response.py +26 -0
  404. unifieddatalibrary/types/track_queryhelp_response.py +63 -0
  405. unifieddatalibrary/types/track_route_queryhelp_response.py +63 -0
  406. unifieddatalibrary/types/track_unvalidated_publish_params.py +26 -0
  407. unifieddatalibrary/types/transponder_queryhelp_response.py +63 -0
  408. unifieddatalibrary/types/vessel_queryhelp_response.py +63 -0
  409. unifieddatalibrary/types/video_queryhelp_response.py +63 -0
  410. unifieddatalibrary/types/weather_data_queryhelp_response.py +63 -0
  411. unifieddatalibrary/types/weather_report_queryhelp_response.py +63 -0
  412. {udl_sdk-0.1.0a9.dist-info → udl_sdk-0.1.0a11.dist-info}/WHEEL +0 -0
  413. {udl_sdk-0.1.0a9.dist-info → udl_sdk-0.1.0a11.dist-info}/licenses/LICENSE +0 -0
@@ -1,3879 +1,8 @@
1
1
  # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
- from typing import List, Optional
4
- from datetime import date, datetime
5
- from typing_extensions import Literal, TypeAlias
3
+ from typing import List
4
+ from typing_extensions import TypeAlias
6
5
 
7
- from pydantic import Field as FieldInfo
6
+ __all__ = ["EntityGetAllTypesResponse"]
8
7
 
9
- from .._models import BaseModel
10
-
11
- __all__ = [
12
- "EntityGetAllTypesResponse",
13
- "EntityGetAllTypesResponseItem",
14
- "EntityGetAllTypesResponseItemLocation",
15
- "EntityGetAllTypesResponseItemOnOrbit",
16
- "EntityGetAllTypesResponseItemOnOrbitAntenna",
17
- "EntityGetAllTypesResponseItemOnOrbitAntennaAntenna",
18
- "EntityGetAllTypesResponseItemOnOrbitAntennaAntennaAntennaDetail",
19
- "EntityGetAllTypesResponseItemOnOrbitAntennaAntennaAntennaDetailManufacturerOrg",
20
- "EntityGetAllTypesResponseItemOnOrbitAntennaAntennaAntennaDetailManufacturerOrgOrganizationDetail",
21
- "EntityGetAllTypesResponseItemOnOrbitBattery",
22
- "EntityGetAllTypesResponseItemOnOrbitBatteryBattery",
23
- "EntityGetAllTypesResponseItemOnOrbitBatteryBatteryBatteryDetail",
24
- "EntityGetAllTypesResponseItemOnOrbitBatteryBatteryBatteryDetailManufacturerOrg",
25
- "EntityGetAllTypesResponseItemOnOrbitBatteryBatteryBatteryDetailManufacturerOrgOrganizationDetail",
26
- "EntityGetAllTypesResponseItemOnOrbitOnorbitDetail",
27
- "EntityGetAllTypesResponseItemOnOrbitSolarArray",
28
- "EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArray",
29
- "EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArraySolarArrayDetail",
30
- "EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArraySolarArrayDetailManufacturerOrg",
31
- "EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArraySolarArrayDetailManufacturerOrgOrganizationDetail",
32
- "EntityGetAllTypesResponseItemOnOrbitThruster",
33
- "EntityGetAllTypesResponseItemOnOrbitThrusterEngine",
34
- "EntityGetAllTypesResponseItemOnOrbitThrusterEngineEngineDetail",
35
- "EntityGetAllTypesResponseItemOperatingUnit",
36
- "EntityGetAllTypesResponseItemOperatingUnitLocation",
37
- "EntityGetAllTypesResponseItemOperatingUnitOperatingUnitRemark",
38
- "EntityGetAllTypesResponseItemOperatingUnitOrganization",
39
- "EntityGetAllTypesResponseItemOperatingUnitOrganizationOrganizationDetail",
40
- "EntityGetAllTypesResponseItemRfBand",
41
- "EntityGetAllTypesResponseItemStatusCollection",
42
- "EntityGetAllTypesResponseItemStatusCollectionSubStatusCollection",
43
- ]
44
-
45
-
46
- class EntityGetAllTypesResponseItemLocation(BaseModel):
47
- classification_marking: str = FieldInfo(alias="classificationMarking")
48
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
49
-
50
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
51
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
52
-
53
- EXERCISE: Data pertaining to a government or military exercise. The data
54
- may include both real and simulated data.
55
-
56
- REAL: Data collected or produced that pertains to real-world objects,
57
- events, and analysis.
58
-
59
- SIMULATED: Synthetic data generated by a model to mimic real-world
60
- datasets.
61
-
62
- TEST: Specific datasets used to evaluate compliance with specifications and
63
- requirements, and for validating technical, functional, and performance
64
- characteristics.
65
- """
66
-
67
- name: str
68
- """Location name."""
69
-
70
- source: str
71
- """Source of the data."""
72
-
73
- altitude: Optional[float] = None
74
- """Altitude of the location, in kilometers."""
75
-
76
- country_code: Optional[str] = FieldInfo(alias="countryCode", default=None)
77
- """The country code.
78
-
79
- This value is typically the ISO 3166 Alpha-2 two-character country code, however
80
- it can also represent various consortiums that do not appear in the ISO
81
- document. The code must correspond to an existing country in the UDL’s country
82
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
83
- or alternate code values that exist for the specified country code.
84
- """
85
-
86
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
87
- """Time the row was created in the database, auto-populated by the system."""
88
-
89
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
90
- """
91
- Application user who created the row in the database, auto-populated by the
92
- system.
93
- """
94
-
95
- id_location: Optional[str] = FieldInfo(alias="idLocation", default=None)
96
- """Unique identifier of the location, auto-generated by the system."""
97
-
98
- lat: Optional[float] = None
99
- """WGS84 latitude of the location, in degrees.
100
-
101
- -90 to 90 degrees (negative values south of equator).
102
- """
103
-
104
- lon: Optional[float] = None
105
- """WGS84 longitude of the location, in degrees.
106
-
107
- -180 to 180 degrees (negative values west of Prime Meridian).
108
- """
109
-
110
- origin: Optional[str] = None
111
- """
112
- Originating system or organization which produced the data, if different from
113
- the source. The origin may be different than the source if the source was a
114
- mediating system which forwarded the data on behalf of the origin system. If
115
- null, the source may be assumed to be the origin.
116
- """
117
-
118
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
119
- """
120
- The originating source network on which this record was created, auto-populated
121
- by the system.
122
- """
123
-
124
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
125
- """Time the row was last updated in the database, auto-populated by the system."""
126
-
127
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
128
- """
129
- Application user who updated the row in the database, auto-populated by the
130
- system.
131
- """
132
-
133
-
134
- class EntityGetAllTypesResponseItemOnOrbitAntennaAntennaAntennaDetailManufacturerOrgOrganizationDetail(BaseModel):
135
- classification_marking: str = FieldInfo(alias="classificationMarking")
136
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
137
-
138
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
139
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
140
-
141
- EXERCISE: Data pertaining to a government or military exercise. The data
142
- may include both real and simulated data.
143
-
144
- REAL: Data collected or produced that pertains to real-world objects,
145
- events, and analysis.
146
-
147
- SIMULATED: Synthetic data generated by a model to mimic real-world
148
- datasets.
149
-
150
- TEST: Specific datasets used to evaluate compliance with specifications and
151
- requirements, and for validating technical, functional, and performance
152
- characteristics.
153
- """
154
-
155
- id_organization: str = FieldInfo(alias="idOrganization")
156
- """Unique identifier of the parent organization."""
157
-
158
- name: str
159
- """Organization details name."""
160
-
161
- source: str
162
- """Source of the data."""
163
-
164
- id: Optional[str] = None
165
- """Unique identifier of the record, auto-generated by the system."""
166
-
167
- address1: Optional[str] = None
168
- """Street number of the organization."""
169
-
170
- address2: Optional[str] = None
171
- """
172
- Field for additional organization address information such as PO Box and unit
173
- number.
174
- """
175
-
176
- address3: Optional[str] = None
177
- """Contains the third line of address information for an organization."""
178
-
179
- broker: Optional[str] = None
180
- """Designated broker for this organization."""
181
-
182
- ceo: Optional[str] = None
183
- """For organizations of type CORPORATION, the name of the Chief Executive Officer."""
184
-
185
- cfo: Optional[str] = None
186
- """For organizations of type CORPORATION, the name of the Chief Financial Officer."""
187
-
188
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
189
- """Time the row was created in the database, auto-populated by the system."""
190
-
191
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
192
- """
193
- Application user who created the row in the database, auto-populated by the
194
- system.
195
- """
196
-
197
- cto: Optional[str] = None
198
- """
199
- For organizations of type CORPORATION, the name of the Chief Technology Officer.
200
- """
201
-
202
- description: Optional[str] = None
203
- """Organization description."""
204
-
205
- ebitda: Optional[float] = None
206
- """
207
- For organizations of type CORPORATION, the company EBITDA value as of
208
- financialYearEndDate in US Dollars.
209
- """
210
-
211
- email: Optional[str] = None
212
- """Listed contact email address for the organization."""
213
-
214
- financial_notes: Optional[str] = FieldInfo(alias="financialNotes", default=None)
215
- """For organizations of type CORPORATION, notes on company financials."""
216
-
217
- financial_year_end_date: Optional[datetime] = FieldInfo(alias="financialYearEndDate", default=None)
218
- """
219
- For organizations of type CORPORATION, the effective financial year end date for
220
- revenue, EBITDA, and profit values.
221
- """
222
-
223
- fleet_plan_notes: Optional[str] = FieldInfo(alias="fleetPlanNotes", default=None)
224
- """Satellite fleet planning notes for this organization."""
225
-
226
- former_org_id: Optional[str] = FieldInfo(alias="formerOrgId", default=None)
227
- """
228
- Former organization ID (if this organization previously existed as another
229
- organization).
230
- """
231
-
232
- ftes: Optional[int] = None
233
- """Total number of FTEs in this organization."""
234
-
235
- geo_admin_level1: Optional[str] = FieldInfo(alias="geoAdminLevel1", default=None)
236
- """Administrative boundaries of the first sub-national level.
237
-
238
- Level 1 is simply the largest demarcation under whatever demarcation criteria
239
- has been determined by the governing body. For example, this may be a state or
240
- province.
241
- """
242
-
243
- geo_admin_level2: Optional[str] = FieldInfo(alias="geoAdminLevel2", default=None)
244
- """Administrative boundaries of the second sub-national level.
245
-
246
- Level 2 is simply the second largest demarcation under whatever demarcation
247
- criteria has been determined by the governing body. For example, this may be a
248
- county or district.
249
- """
250
-
251
- geo_admin_level3: Optional[str] = FieldInfo(alias="geoAdminLevel3", default=None)
252
- """Administrative boundaries of the third sub-national level.
253
-
254
- Level 3 is simply the third largest demarcation under whatever demarcation
255
- criteria has been determined by the governing body. For example, this may be a
256
- city or township.
257
- """
258
-
259
- mass_ranking: Optional[int] = FieldInfo(alias="massRanking", default=None)
260
- """Mass ranking for this organization."""
261
-
262
- origin: Optional[str] = None
263
- """
264
- Originating system or organization which produced the data, if different from
265
- the source. The origin may be different than the source if the source was a
266
- mediating system which forwarded the data on behalf of the origin system. If
267
- null, the source may be assumed to be the origin.
268
- """
269
-
270
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
271
- """
272
- The originating source network on which this record was created, auto-populated
273
- by the system.
274
- """
275
-
276
- parent_org_id: Optional[str] = FieldInfo(alias="parentOrgId", default=None)
277
- """Parent organization ID of this organization if it is a child organization."""
278
-
279
- postal_code: Optional[str] = FieldInfo(alias="postalCode", default=None)
280
- """
281
- A postal code, such as PIN or ZIP Code, is a series of letters or digits or both
282
- included in the postal address of the organization.
283
- """
284
-
285
- profit: Optional[float] = None
286
- """
287
- For organizations of type CORPORATION, total annual profit as of
288
- financialYearEndDate in US Dollars.
289
- """
290
-
291
- revenue: Optional[float] = None
292
- """
293
- For organizations of type CORPORATION, total annual revenue as of
294
- financialYearEndDate in US Dollars.
295
- """
296
-
297
- revenue_ranking: Optional[int] = FieldInfo(alias="revenueRanking", default=None)
298
- """Revenue ranking for this organization."""
299
-
300
- risk_manager: Optional[str] = FieldInfo(alias="riskManager", default=None)
301
- """The name of the risk manager for the organization."""
302
-
303
- services_notes: Optional[str] = FieldInfo(alias="servicesNotes", default=None)
304
- """Notes on the services provided by the organization."""
305
-
306
- tags: Optional[List[str]] = None
307
- """
308
- Optional array of provider/source specific tags for this data, where each
309
- element is no longer than 32 characters, used for implementing data owner
310
- conditional access controls to restrict access to the data. Should be left null
311
- by data providers unless conditional access controls are coordinated with the
312
- UDL team.
313
- """
314
-
315
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
316
- """Time the row was last updated in the database, auto-populated by the system."""
317
-
318
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
319
- """
320
- Application user who updated the row in the database, auto-populated by the
321
- system.
322
- """
323
-
324
-
325
- class EntityGetAllTypesResponseItemOnOrbitAntennaAntennaAntennaDetailManufacturerOrg(BaseModel):
326
- classification_marking: str = FieldInfo(alias="classificationMarking")
327
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
328
-
329
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
330
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
331
-
332
- EXERCISE: Data pertaining to a government or military exercise. The data
333
- may include both real and simulated data.
334
-
335
- REAL: Data collected or produced that pertains to real-world objects,
336
- events, and analysis.
337
-
338
- SIMULATED: Synthetic data generated by a model to mimic real-world
339
- datasets.
340
-
341
- TEST: Specific datasets used to evaluate compliance with specifications and
342
- requirements, and for validating technical, functional, and performance
343
- characteristics.
344
- """
345
-
346
- name: str
347
- """Organization name."""
348
-
349
- source: str
350
- """Source of the data."""
351
-
352
- type: str
353
- """Type of organization (e.g. GOVERNMENT, CORPORATION, CONSORTIUM, ACADEMIC)."""
354
-
355
- id: Optional[str] = None
356
- """Unique identifier of the record, auto-generated by the system."""
357
-
358
- active: Optional[bool] = None
359
- """Boolean indicating if this organization is currently active."""
360
-
361
- category: Optional[str] = None
362
- """Subtype or category of the organization (e.g.
363
-
364
- Private company, stock market quoted company, subsidiary, goverment
365
- department/agency, etc).
366
- """
367
-
368
- country_code: Optional[str] = FieldInfo(alias="countryCode", default=None)
369
- """Country of the physical location of the organization.
370
-
371
- This value is typically the ISO 3166 Alpha-2 two-character country code.
372
- However, it can also represent various consortiums that do not appear in the ISO
373
- document. The code must correspond to an existing country in the UDL’s country
374
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
375
- or alternate code values that exist for the specified country code.
376
- """
377
-
378
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
379
- """Time the row was created in the database, auto-populated by the system."""
380
-
381
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
382
- """
383
- Application user who created the row in the database, auto-populated by the
384
- system.
385
- """
386
-
387
- description: Optional[str] = None
388
- """Organization description."""
389
-
390
- external_id: Optional[str] = FieldInfo(alias="externalId", default=None)
391
- """Optional externally provided identifier for this row."""
392
-
393
- nationality: Optional[str] = None
394
- """Country of registration or ownership of the organization.
395
-
396
- This value is typically the ISO 3166 Alpha-2 two-character country code, however
397
- it can also represent various consortiums that do not appear in the ISO
398
- document. The code must correspond to an existing country in the UDL’s country
399
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
400
- or alternate code values that exist for the specified country code.
401
- """
402
-
403
- organization_details: Optional[
404
- List[EntityGetAllTypesResponseItemOnOrbitAntennaAntennaAntennaDetailManufacturerOrgOrganizationDetail]
405
- ] = FieldInfo(alias="organizationDetails", default=None)
406
- """
407
- Read-only collection of additional OrganizationDetails by various sources for
408
- this organization, ignored on create/update. These details must be created
409
- separately via the /udl/organizationdetails operations.
410
- """
411
-
412
- origin: Optional[str] = None
413
- """
414
- Originating system or organization which produced the data, if different from
415
- the source. The origin may be different than the source if the source was a
416
- mediating system which forwarded the data on behalf of the origin system. If
417
- null, the source may be assumed to be the origin.
418
- """
419
-
420
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
421
- """
422
- The originating source network on which this record was created, auto-populated
423
- by the system.
424
- """
425
-
426
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
427
- """Time the row was last updated in the database, auto-populated by the system."""
428
-
429
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
430
- """
431
- Application user who updated the row in the database, auto-populated by the
432
- system.
433
- """
434
-
435
-
436
- class EntityGetAllTypesResponseItemOnOrbitAntennaAntennaAntennaDetail(BaseModel):
437
- classification_marking: str = FieldInfo(alias="classificationMarking")
438
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
439
-
440
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
441
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
442
-
443
- EXERCISE: Data pertaining to a government or military exercise. The data
444
- may include both real and simulated data.
445
-
446
- REAL: Data collected or produced that pertains to real-world objects,
447
- events, and analysis.
448
-
449
- SIMULATED: Synthetic data generated by a model to mimic real-world
450
- datasets.
451
-
452
- TEST: Specific datasets used to evaluate compliance with specifications and
453
- requirements, and for validating technical, functional, and performance
454
- characteristics.
455
- """
456
-
457
- id_antenna: str = FieldInfo(alias="idAntenna")
458
- """Unique identifier of the parent Antenna."""
459
-
460
- source: str
461
- """Source of the data."""
462
-
463
- id: Optional[str] = None
464
- """Unique identifier of the record, auto-generated by the system."""
465
-
466
- beam_forming: Optional[bool] = FieldInfo(alias="beamForming", default=None)
467
- """Boolean indicating if this is a beam forming antenna."""
468
-
469
- beamwidth: Optional[float] = None
470
- """
471
- Array of angles between the half-power (-3 dB) points of the main lobe of the
472
- antenna, in degrees.
473
- """
474
-
475
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
476
- """Time the row was created in the database, auto-populated by the system."""
477
-
478
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
479
- """
480
- Application user who created the row in the database, auto-populated by the
481
- system.
482
- """
483
-
484
- description: Optional[str] = None
485
- """Antenna description."""
486
-
487
- diameter: Optional[float] = None
488
- """Antenna diameter in meters."""
489
-
490
- end_frequency: Optional[float] = FieldInfo(alias="endFrequency", default=None)
491
- """Antenna end of frequency range in Mhz."""
492
-
493
- gain: Optional[float] = None
494
- """Antenna maximum gain in dBi."""
495
-
496
- gain_tolerance: Optional[float] = FieldInfo(alias="gainTolerance", default=None)
497
- """Antenna gain tolerance in dB."""
498
-
499
- manufacturer_org: Optional[EntityGetAllTypesResponseItemOnOrbitAntennaAntennaAntennaDetailManufacturerOrg] = (
500
- FieldInfo(alias="manufacturerOrg", default=None)
501
- )
502
- """An organization such as a corporation, manufacturer, consortium, government,
503
- etc.
504
-
505
- An organization may have parent and child organizations as well as link to a
506
- former organization if this org previously existed as another organization.
507
- """
508
-
509
- manufacturer_org_id: Optional[str] = FieldInfo(alias="manufacturerOrgId", default=None)
510
- """ID of the organization that manufactures the antenna."""
511
-
512
- mode: Optional[Literal["TX", "RX"]] = None
513
- """Antenna mode (e.g. TX,RX)."""
514
-
515
- origin: Optional[str] = None
516
- """
517
- Originating system or organization which produced the data, if different from
518
- the source. The origin may be different than the source if the source was a
519
- mediating system which forwarded the data on behalf of the origin system. If
520
- null, the source may be assumed to be the origin.
521
- """
522
-
523
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
524
- """
525
- The originating source network on which this record was created, auto-populated
526
- by the system.
527
- """
528
-
529
- polarization: Optional[float] = None
530
- """Antenna polarization in degrees."""
531
-
532
- position: Optional[str] = None
533
- """Antenna position (e.g. Top, Nadir, Side)."""
534
-
535
- size: Optional[List[float]] = None
536
- """
537
- Array with 1-2 values specifying the length and width (for rectangular) and just
538
- length for dipole antennas in meters.
539
- """
540
-
541
- start_frequency: Optional[float] = FieldInfo(alias="startFrequency", default=None)
542
- """Antenna start of frequency range in Mhz."""
543
-
544
- steerable: Optional[bool] = None
545
- """Boolean indicating if this antenna is steerable."""
546
-
547
- tags: Optional[List[str]] = None
548
- """
549
- Optional array of provider/source specific tags for this data, where each
550
- element is no longer than 32 characters, used for implementing data owner
551
- conditional access controls to restrict access to the data. Should be left null
552
- by data providers unless conditional access controls are coordinated with the
553
- UDL team.
554
- """
555
-
556
- type: Optional[str] = None
557
- """Type of antenna (e.g.
558
-
559
- Reflector, Double Reflector, Shaped Reflector, Horn, Parabolic, etc.).
560
- """
561
-
562
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
563
- """Time the row was last updated in the database, auto-populated by the system."""
564
-
565
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
566
- """
567
- Application user who updated the row in the database, auto-populated by the
568
- system.
569
- """
570
-
571
-
572
- class EntityGetAllTypesResponseItemOnOrbitAntennaAntenna(BaseModel):
573
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
574
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
575
-
576
- EXERCISE: Data pertaining to a government or military exercise. The data
577
- may include both real and simulated data.
578
-
579
- REAL: Data collected or produced that pertains to real-world objects,
580
- events, and analysis.
581
-
582
- SIMULATED: Synthetic data generated by a model to mimic real-world
583
- datasets.
584
-
585
- TEST: Specific datasets used to evaluate compliance with specifications and
586
- requirements, and for validating technical, functional, and performance
587
- characteristics.
588
- """
589
-
590
- name: str
591
- """Antenna name."""
592
-
593
- source: str
594
- """Source of the data."""
595
-
596
- id: Optional[str] = None
597
- """Unique identifier of the record, auto-generated by the system."""
598
-
599
- antenna_details: Optional[List[EntityGetAllTypesResponseItemOnOrbitAntennaAntennaAntennaDetail]] = FieldInfo(
600
- alias="antennaDetails", default=None
601
- )
602
- """
603
- Read-only collection of additional AntennaDetails by various sources for this
604
- organization, ignored on create/update. These details must be created separately
605
- via the /udl/antennadetails operations.
606
- """
607
-
608
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
609
- """Time the row was created in the database, auto-populated by the system."""
610
-
611
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
612
- """
613
- Application user who created the row in the database, auto-populated by the
614
- system.
615
- """
616
-
617
- origin: Optional[str] = None
618
- """
619
- Originating system or organization which produced the data, if different from
620
- the source. The origin may be different than the source if the source was a
621
- mediating system which forwarded the data on behalf of the origin system. If
622
- null, the source may be assumed to be the origin.
623
- """
624
-
625
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
626
- """
627
- The originating source network on which this record was created, auto-populated
628
- by the system.
629
- """
630
-
631
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
632
- """Time the row was last updated in the database, auto-populated by the system."""
633
-
634
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
635
- """
636
- Application user who updated the row in the database, auto-populated by the
637
- system.
638
- """
639
-
640
-
641
- class EntityGetAllTypesResponseItemOnOrbitAntenna(BaseModel):
642
- classification_marking: str = FieldInfo(alias="classificationMarking")
643
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
644
-
645
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
646
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
647
-
648
- EXERCISE: Data pertaining to a government or military exercise. The data
649
- may include both real and simulated data.
650
-
651
- REAL: Data collected or produced that pertains to real-world objects,
652
- events, and analysis.
653
-
654
- SIMULATED: Synthetic data generated by a model to mimic real-world
655
- datasets.
656
-
657
- TEST: Specific datasets used to evaluate compliance with specifications and
658
- requirements, and for validating technical, functional, and performance
659
- characteristics.
660
- """
661
-
662
- id_antenna: str = FieldInfo(alias="idAntenna")
663
- """ID of the antenna."""
664
-
665
- id_on_orbit: str = FieldInfo(alias="idOnOrbit")
666
- """ID of the on-orbit object."""
667
-
668
- source: str
669
- """Source of the data."""
670
-
671
- id: Optional[str] = None
672
- """Unique identifier of the record, auto-generated by the system."""
673
-
674
- antenna: Optional[EntityGetAllTypesResponseItemOnOrbitAntennaAntenna] = None
675
- """
676
- Model representation of information on on-orbit/spacecraft communication
677
- antennas. A spacecraft may have multiple antennas and each antenna can have
678
- multiple 'details' records compiled by different sources.
679
- """
680
-
681
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
682
- """Time the row was created in the database, auto-populated by the system."""
683
-
684
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
685
- """
686
- Application user who created the row in the database, auto-populated by the
687
- system.
688
- """
689
-
690
- origin: Optional[str] = None
691
- """
692
- Originating system or organization which produced the data, if different from
693
- the source. The origin may be different than the source if the source was a
694
- mediating system which forwarded the data on behalf of the origin system. If
695
- null, the source may be assumed to be the origin.
696
- """
697
-
698
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
699
- """
700
- The originating source network on which this record was created, auto-populated
701
- by the system.
702
- """
703
-
704
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
705
- """Time the row was last updated in the database, auto-populated by the system."""
706
-
707
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
708
- """
709
- Application user who updated the row in the database, auto-populated by the
710
- system.
711
- """
712
-
713
-
714
- class EntityGetAllTypesResponseItemOnOrbitBatteryBatteryBatteryDetailManufacturerOrgOrganizationDetail(BaseModel):
715
- classification_marking: str = FieldInfo(alias="classificationMarking")
716
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
717
-
718
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
719
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
720
-
721
- EXERCISE: Data pertaining to a government or military exercise. The data
722
- may include both real and simulated data.
723
-
724
- REAL: Data collected or produced that pertains to real-world objects,
725
- events, and analysis.
726
-
727
- SIMULATED: Synthetic data generated by a model to mimic real-world
728
- datasets.
729
-
730
- TEST: Specific datasets used to evaluate compliance with specifications and
731
- requirements, and for validating technical, functional, and performance
732
- characteristics.
733
- """
734
-
735
- id_organization: str = FieldInfo(alias="idOrganization")
736
- """Unique identifier of the parent organization."""
737
-
738
- name: str
739
- """Organization details name."""
740
-
741
- source: str
742
- """Source of the data."""
743
-
744
- id: Optional[str] = None
745
- """Unique identifier of the record, auto-generated by the system."""
746
-
747
- address1: Optional[str] = None
748
- """Street number of the organization."""
749
-
750
- address2: Optional[str] = None
751
- """
752
- Field for additional organization address information such as PO Box and unit
753
- number.
754
- """
755
-
756
- address3: Optional[str] = None
757
- """Contains the third line of address information for an organization."""
758
-
759
- broker: Optional[str] = None
760
- """Designated broker for this organization."""
761
-
762
- ceo: Optional[str] = None
763
- """For organizations of type CORPORATION, the name of the Chief Executive Officer."""
764
-
765
- cfo: Optional[str] = None
766
- """For organizations of type CORPORATION, the name of the Chief Financial Officer."""
767
-
768
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
769
- """Time the row was created in the database, auto-populated by the system."""
770
-
771
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
772
- """
773
- Application user who created the row in the database, auto-populated by the
774
- system.
775
- """
776
-
777
- cto: Optional[str] = None
778
- """
779
- For organizations of type CORPORATION, the name of the Chief Technology Officer.
780
- """
781
-
782
- description: Optional[str] = None
783
- """Organization description."""
784
-
785
- ebitda: Optional[float] = None
786
- """
787
- For organizations of type CORPORATION, the company EBITDA value as of
788
- financialYearEndDate in US Dollars.
789
- """
790
-
791
- email: Optional[str] = None
792
- """Listed contact email address for the organization."""
793
-
794
- financial_notes: Optional[str] = FieldInfo(alias="financialNotes", default=None)
795
- """For organizations of type CORPORATION, notes on company financials."""
796
-
797
- financial_year_end_date: Optional[datetime] = FieldInfo(alias="financialYearEndDate", default=None)
798
- """
799
- For organizations of type CORPORATION, the effective financial year end date for
800
- revenue, EBITDA, and profit values.
801
- """
802
-
803
- fleet_plan_notes: Optional[str] = FieldInfo(alias="fleetPlanNotes", default=None)
804
- """Satellite fleet planning notes for this organization."""
805
-
806
- former_org_id: Optional[str] = FieldInfo(alias="formerOrgId", default=None)
807
- """
808
- Former organization ID (if this organization previously existed as another
809
- organization).
810
- """
811
-
812
- ftes: Optional[int] = None
813
- """Total number of FTEs in this organization."""
814
-
815
- geo_admin_level1: Optional[str] = FieldInfo(alias="geoAdminLevel1", default=None)
816
- """Administrative boundaries of the first sub-national level.
817
-
818
- Level 1 is simply the largest demarcation under whatever demarcation criteria
819
- has been determined by the governing body. For example, this may be a state or
820
- province.
821
- """
822
-
823
- geo_admin_level2: Optional[str] = FieldInfo(alias="geoAdminLevel2", default=None)
824
- """Administrative boundaries of the second sub-national level.
825
-
826
- Level 2 is simply the second largest demarcation under whatever demarcation
827
- criteria has been determined by the governing body. For example, this may be a
828
- county or district.
829
- """
830
-
831
- geo_admin_level3: Optional[str] = FieldInfo(alias="geoAdminLevel3", default=None)
832
- """Administrative boundaries of the third sub-national level.
833
-
834
- Level 3 is simply the third largest demarcation under whatever demarcation
835
- criteria has been determined by the governing body. For example, this may be a
836
- city or township.
837
- """
838
-
839
- mass_ranking: Optional[int] = FieldInfo(alias="massRanking", default=None)
840
- """Mass ranking for this organization."""
841
-
842
- origin: Optional[str] = None
843
- """
844
- Originating system or organization which produced the data, if different from
845
- the source. The origin may be different than the source if the source was a
846
- mediating system which forwarded the data on behalf of the origin system. If
847
- null, the source may be assumed to be the origin.
848
- """
849
-
850
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
851
- """
852
- The originating source network on which this record was created, auto-populated
853
- by the system.
854
- """
855
-
856
- parent_org_id: Optional[str] = FieldInfo(alias="parentOrgId", default=None)
857
- """Parent organization ID of this organization if it is a child organization."""
858
-
859
- postal_code: Optional[str] = FieldInfo(alias="postalCode", default=None)
860
- """
861
- A postal code, such as PIN or ZIP Code, is a series of letters or digits or both
862
- included in the postal address of the organization.
863
- """
864
-
865
- profit: Optional[float] = None
866
- """
867
- For organizations of type CORPORATION, total annual profit as of
868
- financialYearEndDate in US Dollars.
869
- """
870
-
871
- revenue: Optional[float] = None
872
- """
873
- For organizations of type CORPORATION, total annual revenue as of
874
- financialYearEndDate in US Dollars.
875
- """
876
-
877
- revenue_ranking: Optional[int] = FieldInfo(alias="revenueRanking", default=None)
878
- """Revenue ranking for this organization."""
879
-
880
- risk_manager: Optional[str] = FieldInfo(alias="riskManager", default=None)
881
- """The name of the risk manager for the organization."""
882
-
883
- services_notes: Optional[str] = FieldInfo(alias="servicesNotes", default=None)
884
- """Notes on the services provided by the organization."""
885
-
886
- tags: Optional[List[str]] = None
887
- """
888
- Optional array of provider/source specific tags for this data, where each
889
- element is no longer than 32 characters, used for implementing data owner
890
- conditional access controls to restrict access to the data. Should be left null
891
- by data providers unless conditional access controls are coordinated with the
892
- UDL team.
893
- """
894
-
895
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
896
- """Time the row was last updated in the database, auto-populated by the system."""
897
-
898
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
899
- """
900
- Application user who updated the row in the database, auto-populated by the
901
- system.
902
- """
903
-
904
-
905
- class EntityGetAllTypesResponseItemOnOrbitBatteryBatteryBatteryDetailManufacturerOrg(BaseModel):
906
- classification_marking: str = FieldInfo(alias="classificationMarking")
907
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
908
-
909
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
910
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
911
-
912
- EXERCISE: Data pertaining to a government or military exercise. The data
913
- may include both real and simulated data.
914
-
915
- REAL: Data collected or produced that pertains to real-world objects,
916
- events, and analysis.
917
-
918
- SIMULATED: Synthetic data generated by a model to mimic real-world
919
- datasets.
920
-
921
- TEST: Specific datasets used to evaluate compliance with specifications and
922
- requirements, and for validating technical, functional, and performance
923
- characteristics.
924
- """
925
-
926
- name: str
927
- """Organization name."""
928
-
929
- source: str
930
- """Source of the data."""
931
-
932
- type: str
933
- """Type of organization (e.g. GOVERNMENT, CORPORATION, CONSORTIUM, ACADEMIC)."""
934
-
935
- id: Optional[str] = None
936
- """Unique identifier of the record, auto-generated by the system."""
937
-
938
- active: Optional[bool] = None
939
- """Boolean indicating if this organization is currently active."""
940
-
941
- category: Optional[str] = None
942
- """Subtype or category of the organization (e.g.
943
-
944
- Private company, stock market quoted company, subsidiary, goverment
945
- department/agency, etc).
946
- """
947
-
948
- country_code: Optional[str] = FieldInfo(alias="countryCode", default=None)
949
- """Country of the physical location of the organization.
950
-
951
- This value is typically the ISO 3166 Alpha-2 two-character country code.
952
- However, it can also represent various consortiums that do not appear in the ISO
953
- document. The code must correspond to an existing country in the UDL’s country
954
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
955
- or alternate code values that exist for the specified country code.
956
- """
957
-
958
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
959
- """Time the row was created in the database, auto-populated by the system."""
960
-
961
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
962
- """
963
- Application user who created the row in the database, auto-populated by the
964
- system.
965
- """
966
-
967
- description: Optional[str] = None
968
- """Organization description."""
969
-
970
- external_id: Optional[str] = FieldInfo(alias="externalId", default=None)
971
- """Optional externally provided identifier for this row."""
972
-
973
- nationality: Optional[str] = None
974
- """Country of registration or ownership of the organization.
975
-
976
- This value is typically the ISO 3166 Alpha-2 two-character country code, however
977
- it can also represent various consortiums that do not appear in the ISO
978
- document. The code must correspond to an existing country in the UDL’s country
979
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
980
- or alternate code values that exist for the specified country code.
981
- """
982
-
983
- organization_details: Optional[
984
- List[EntityGetAllTypesResponseItemOnOrbitBatteryBatteryBatteryDetailManufacturerOrgOrganizationDetail]
985
- ] = FieldInfo(alias="organizationDetails", default=None)
986
- """
987
- Read-only collection of additional OrganizationDetails by various sources for
988
- this organization, ignored on create/update. These details must be created
989
- separately via the /udl/organizationdetails operations.
990
- """
991
-
992
- origin: Optional[str] = None
993
- """
994
- Originating system or organization which produced the data, if different from
995
- the source. The origin may be different than the source if the source was a
996
- mediating system which forwarded the data on behalf of the origin system. If
997
- null, the source may be assumed to be the origin.
998
- """
999
-
1000
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
1001
- """
1002
- The originating source network on which this record was created, auto-populated
1003
- by the system.
1004
- """
1005
-
1006
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
1007
- """Time the row was last updated in the database, auto-populated by the system."""
1008
-
1009
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
1010
- """
1011
- Application user who updated the row in the database, auto-populated by the
1012
- system.
1013
- """
1014
-
1015
-
1016
- class EntityGetAllTypesResponseItemOnOrbitBatteryBatteryBatteryDetail(BaseModel):
1017
- classification_marking: str = FieldInfo(alias="classificationMarking")
1018
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
1019
-
1020
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
1021
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
1022
-
1023
- EXERCISE: Data pertaining to a government or military exercise. The data
1024
- may include both real and simulated data.
1025
-
1026
- REAL: Data collected or produced that pertains to real-world objects,
1027
- events, and analysis.
1028
-
1029
- SIMULATED: Synthetic data generated by a model to mimic real-world
1030
- datasets.
1031
-
1032
- TEST: Specific datasets used to evaluate compliance with specifications and
1033
- requirements, and for validating technical, functional, and performance
1034
- characteristics.
1035
- """
1036
-
1037
- id_battery: str = FieldInfo(alias="idBattery")
1038
- """Identifier of the parent battery type record."""
1039
-
1040
- source: str
1041
- """Source of the data."""
1042
-
1043
- id: Optional[str] = None
1044
- """Unique identifier of the record, auto-generated by the system."""
1045
-
1046
- capacity: Optional[float] = None
1047
- """Battery capacity in Ah."""
1048
-
1049
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
1050
- """Time the row was created in the database, auto-populated by the system."""
1051
-
1052
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
1053
- """
1054
- Application user who created the row in the database, auto-populated by the
1055
- system.
1056
- """
1057
-
1058
- description: Optional[str] = None
1059
- """Battery description/notes."""
1060
-
1061
- discharge_depth: Optional[float] = FieldInfo(alias="dischargeDepth", default=None)
1062
- """Depth of discharge as a percentage/fraction."""
1063
-
1064
- manufacturer_org: Optional[EntityGetAllTypesResponseItemOnOrbitBatteryBatteryBatteryDetailManufacturerOrg] = (
1065
- FieldInfo(alias="manufacturerOrg", default=None)
1066
- )
1067
- """An organization such as a corporation, manufacturer, consortium, government,
1068
- etc.
1069
-
1070
- An organization may have parent and child organizations as well as link to a
1071
- former organization if this org previously existed as another organization.
1072
- """
1073
-
1074
- manufacturer_org_id: Optional[str] = FieldInfo(alias="manufacturerOrgId", default=None)
1075
- """ID of the organization that manufactures the battery."""
1076
-
1077
- model: Optional[str] = None
1078
- """Battery model number or name."""
1079
-
1080
- origin: Optional[str] = None
1081
- """
1082
- Originating system or organization which produced the data, if different from
1083
- the source. The origin may be different than the source if the source was a
1084
- mediating system which forwarded the data on behalf of the origin system. If
1085
- null, the source may be assumed to be the origin.
1086
- """
1087
-
1088
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
1089
- """
1090
- The originating source network on which this record was created, auto-populated
1091
- by the system.
1092
- """
1093
-
1094
- tags: Optional[List[str]] = None
1095
- """
1096
- Optional array of provider/source specific tags for this data, where each
1097
- element is no longer than 32 characters, used for implementing data owner
1098
- conditional access controls to restrict access to the data. Should be left null
1099
- by data providers unless conditional access controls are coordinated with the
1100
- UDL team.
1101
- """
1102
-
1103
- technology: Optional[str] = None
1104
- """Type of battery technology (e.g. Ni-Cd, Ni-H2, Li-ion, etc.)."""
1105
-
1106
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
1107
- """Time the row was last updated in the database, auto-populated by the system."""
1108
-
1109
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
1110
- """
1111
- Application user who updated the row in the database, auto-populated by the
1112
- system.
1113
- """
1114
-
1115
-
1116
- class EntityGetAllTypesResponseItemOnOrbitBatteryBattery(BaseModel):
1117
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
1118
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
1119
-
1120
- EXERCISE: Data pertaining to a government or military exercise. The data
1121
- may include both real and simulated data.
1122
-
1123
- REAL: Data collected or produced that pertains to real-world objects,
1124
- events, and analysis.
1125
-
1126
- SIMULATED: Synthetic data generated by a model to mimic real-world
1127
- datasets.
1128
-
1129
- TEST: Specific datasets used to evaluate compliance with specifications and
1130
- requirements, and for validating technical, functional, and performance
1131
- characteristics.
1132
- """
1133
-
1134
- name: str
1135
- """Battery name."""
1136
-
1137
- source: str
1138
- """Source of the data."""
1139
-
1140
- id: Optional[str] = None
1141
- """Unique identifier of the record, auto-generated by the system."""
1142
-
1143
- battery_details: Optional[List[EntityGetAllTypesResponseItemOnOrbitBatteryBatteryBatteryDetail]] = FieldInfo(
1144
- alias="batteryDetails", default=None
1145
- )
1146
- """
1147
- Read-only collection of additional BatteryDetails by various sources for this
1148
- organization, ignored on create/update. These details must be created separately
1149
- via the /udl/batterydetails operations.
1150
- """
1151
-
1152
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
1153
- """Time the row was created in the database, auto-populated by the system."""
1154
-
1155
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
1156
- """
1157
- Application user who created the row in the database, auto-populated by the
1158
- system.
1159
- """
1160
-
1161
- origin: Optional[str] = None
1162
- """
1163
- Originating system or organization which produced the data, if different from
1164
- the source. The origin may be different than the source if the source was a
1165
- mediating system which forwarded the data on behalf of the origin system. If
1166
- null, the source may be assumed to be the origin.
1167
- """
1168
-
1169
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
1170
- """
1171
- The originating source network on which this record was created, auto-populated
1172
- by the system.
1173
- """
1174
-
1175
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
1176
- """Time the row was last updated in the database, auto-populated by the system."""
1177
-
1178
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
1179
- """
1180
- Application user who updated the row in the database, auto-populated by the
1181
- system.
1182
- """
1183
-
1184
-
1185
- class EntityGetAllTypesResponseItemOnOrbitBattery(BaseModel):
1186
- classification_marking: str = FieldInfo(alias="classificationMarking")
1187
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
1188
-
1189
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
1190
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
1191
-
1192
- EXERCISE: Data pertaining to a government or military exercise. The data
1193
- may include both real and simulated data.
1194
-
1195
- REAL: Data collected or produced that pertains to real-world objects,
1196
- events, and analysis.
1197
-
1198
- SIMULATED: Synthetic data generated by a model to mimic real-world
1199
- datasets.
1200
-
1201
- TEST: Specific datasets used to evaluate compliance with specifications and
1202
- requirements, and for validating technical, functional, and performance
1203
- characteristics.
1204
- """
1205
-
1206
- id_battery: str = FieldInfo(alias="idBattery")
1207
- """ID of the battery."""
1208
-
1209
- id_on_orbit: str = FieldInfo(alias="idOnOrbit")
1210
- """ID of the on-orbit object."""
1211
-
1212
- source: str
1213
- """Source of the data."""
1214
-
1215
- id: Optional[str] = None
1216
- """Unique identifier of the record, auto-generated by the system."""
1217
-
1218
- battery: Optional[EntityGetAllTypesResponseItemOnOrbitBatteryBattery] = None
1219
- """Model representation of specific spacecraft battery types."""
1220
-
1221
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
1222
- """Time the row was created in the database, auto-populated by the system."""
1223
-
1224
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
1225
- """
1226
- Application user who created the row in the database, auto-populated by the
1227
- system.
1228
- """
1229
-
1230
- origin: Optional[str] = None
1231
- """
1232
- Originating system or organization which produced the data, if different from
1233
- the source. The origin may be different than the source if the source was a
1234
- mediating system which forwarded the data on behalf of the origin system. If
1235
- null, the source may be assumed to be the origin.
1236
- """
1237
-
1238
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
1239
- """
1240
- The originating source network on which this record was created, auto-populated
1241
- by the system.
1242
- """
1243
-
1244
- quantity: Optional[int] = None
1245
- """The number of batteries on the spacecraft of the type identified by idBattery."""
1246
-
1247
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
1248
- """Time the row was last updated in the database, auto-populated by the system."""
1249
-
1250
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
1251
- """
1252
- Application user who updated the row in the database, auto-populated by the
1253
- system.
1254
- """
1255
-
1256
-
1257
- class EntityGetAllTypesResponseItemOnOrbitOnorbitDetail(BaseModel):
1258
- classification_marking: str = FieldInfo(alias="classificationMarking")
1259
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
1260
-
1261
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
1262
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
1263
-
1264
- EXERCISE: Data pertaining to a government or military exercise. The data
1265
- may include both real and simulated data.
1266
-
1267
- REAL: Data collected or produced that pertains to real-world objects,
1268
- events, and analysis.
1269
-
1270
- SIMULATED: Synthetic data generated by a model to mimic real-world
1271
- datasets.
1272
-
1273
- TEST: Specific datasets used to evaluate compliance with specifications and
1274
- requirements, and for validating technical, functional, and performance
1275
- characteristics.
1276
- """
1277
-
1278
- id_on_orbit: str = FieldInfo(alias="idOnOrbit")
1279
- """UUID of the parent Onorbit record."""
1280
-
1281
- source: str
1282
- """Source of the data."""
1283
-
1284
- id: Optional[str] = None
1285
- """Unique identifier of the record, auto-generated by the system."""
1286
-
1287
- additional_mass: Optional[float] = FieldInfo(alias="additionalMass", default=None)
1288
- """Mass of fuel and disposables at launch time in kilograms."""
1289
-
1290
- adept_radius: Optional[float] = FieldInfo(alias="adeptRadius", default=None)
1291
- """
1292
- The radius used for long-term debris environment projection analyses that is not
1293
- as conservative as COLA Radius, in meters.
1294
- """
1295
-
1296
- bol_delta_v: Optional[float] = FieldInfo(alias="bolDeltaV", default=None)
1297
- """The total beginning of life delta V of the spacecraft, in meters per second."""
1298
-
1299
- bol_fuel_mass: Optional[float] = FieldInfo(alias="bolFuelMass", default=None)
1300
- """Spacecraft beginning of life fuel mass, in orbit, in kilograms."""
1301
-
1302
- bus_cross_section: Optional[float] = FieldInfo(alias="busCrossSection", default=None)
1303
- """Average cross sectional area of the bus in meters squared."""
1304
-
1305
- bus_type: Optional[str] = FieldInfo(alias="busType", default=None)
1306
- """Type of the bus on the spacecraft."""
1307
-
1308
- cola_radius: Optional[float] = FieldInfo(alias="colaRadius", default=None)
1309
- """
1310
- Maximum dimension of the box circumscribing the spacecraft (d = sqrt(a*a + b*b +
1311
- c\\**c) where a is the tip-to-tip dimension, b and c are perpendicular to that.)
1312
- in meters.
1313
- """
1314
-
1315
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
1316
- """Time the row was created in the database, auto-populated by the system."""
1317
-
1318
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
1319
- """
1320
- Application user who created the row in the database, auto-populated by the
1321
- system.
1322
- """
1323
-
1324
- cross_section: Optional[float] = FieldInfo(alias="crossSection", default=None)
1325
- """Average cross sectional area in meters squared."""
1326
-
1327
- current_mass: Optional[float] = FieldInfo(alias="currentMass", default=None)
1328
- """The estimated total current mass of the spacecraft, in kilograms."""
1329
-
1330
- delta_v_unc: Optional[float] = FieldInfo(alias="deltaVUnc", default=None)
1331
- """The 1-sigma uncertainty of the total spacecraft delta V, in meters per second."""
1332
-
1333
- dep_est_masses: Optional[List[float]] = FieldInfo(alias="depEstMasses", default=None)
1334
- """Array of the estimated mass of each deployable object, in kilograms.
1335
-
1336
- Must contain the same number of elements as the value of numDeployable.
1337
- """
1338
-
1339
- dep_mass_uncs: Optional[List[float]] = FieldInfo(alias="depMassUncs", default=None)
1340
- """
1341
- Array of the 1-sigma uncertainty of the mass for each deployable object, in
1342
- kilograms. Must contain the same number of elements as the value of
1343
- numDeployable.
1344
- """
1345
-
1346
- dep_names: Optional[List[str]] = FieldInfo(alias="depNames", default=None)
1347
- """Array of satellite deployable objects.
1348
-
1349
- Must contain the same number of elements as the value of numDeployable.
1350
- """
1351
-
1352
- drift_rate: Optional[float] = FieldInfo(alias="driftRate", default=None)
1353
- """GEO drift rate, if applicable in degrees per day."""
1354
-
1355
- dry_mass: Optional[float] = FieldInfo(alias="dryMass", default=None)
1356
- """Spacecraft dry mass (without fuel or disposables) in kilograms."""
1357
-
1358
- est_delta_v_duration: Optional[float] = FieldInfo(alias="estDeltaVDuration", default=None)
1359
- """Estimated maximum burn duration for the object, in seconds."""
1360
-
1361
- fuel_remaining: Optional[float] = FieldInfo(alias="fuelRemaining", default=None)
1362
- """Estimated remaining fuel for the object in kilograms."""
1363
-
1364
- geo_slot: Optional[float] = FieldInfo(alias="geoSlot", default=None)
1365
- """GEO slot if applicable, in degrees.
1366
-
1367
- -180 (West of Prime Meridian) to 180 degrees (East of Prime Meridian). Prime
1368
- Meridian is 0.
1369
- """
1370
-
1371
- last_ob_source: Optional[str] = FieldInfo(alias="lastObSource", default=None)
1372
- """The name of the source who last provided an observation for this idOnOrbit."""
1373
-
1374
- last_ob_time: Optional[datetime] = FieldInfo(alias="lastObTime", default=None)
1375
- """
1376
- Time of last reported observation for this object in ISO 8601 UTC with
1377
- microsecond precision.
1378
- """
1379
-
1380
- launch_mass: Optional[float] = FieldInfo(alias="launchMass", default=None)
1381
- """Nominal mass of spacecraft and fuel at launch time, in kilograms."""
1382
-
1383
- launch_mass_max: Optional[float] = FieldInfo(alias="launchMassMax", default=None)
1384
- """Maximum (estimated) mass of spacecraft and fuel at launch time, in kilograms."""
1385
-
1386
- launch_mass_min: Optional[float] = FieldInfo(alias="launchMassMin", default=None)
1387
- """Minimum (estimated) mass of spacecraft and fuel at launch time, in kilograms."""
1388
-
1389
- maneuverable: Optional[bool] = None
1390
- """Boolean indicating whether a spacecraft is maneuverable.
1391
-
1392
- Note that a spacecraft may have propulsion capability but may not be
1393
- maneuverable due to lack of fuel, anomalous condition, or other operational
1394
- constraints.
1395
- """
1396
-
1397
- max_delta_v: Optional[float] = FieldInfo(alias="maxDeltaV", default=None)
1398
- """Maximum delta V available for this on-orbit spacecraft, in meters per second."""
1399
-
1400
- max_radius: Optional[float] = FieldInfo(alias="maxRadius", default=None)
1401
- """
1402
- Maximum dimension across the spacecraft (e.g., tip-to-tip across the solar panel
1403
- arrays) in meters.
1404
- """
1405
-
1406
- mission_types: Optional[List[str]] = FieldInfo(alias="missionTypes", default=None)
1407
- """Array of the type of missions the spacecraft performs.
1408
-
1409
- Must contain the same number of elements as the value of numMission.
1410
- """
1411
-
1412
- num_deployable: Optional[int] = FieldInfo(alias="numDeployable", default=None)
1413
- """The number of sub-satellites or deployable objects on the spacecraft."""
1414
-
1415
- num_mission: Optional[int] = FieldInfo(alias="numMission", default=None)
1416
- """The number of distinct missions the spacecraft performs."""
1417
-
1418
- origin: Optional[str] = None
1419
- """
1420
- Originating system or organization which produced the data, if different from
1421
- the source. The origin may be different than the source if the source was a
1422
- mediating system which forwarded the data on behalf of the origin system. If
1423
- null, the source may be assumed to be the origin.
1424
- """
1425
-
1426
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
1427
- """
1428
- The originating source network on which this record was created, auto-populated
1429
- by the system.
1430
- """
1431
-
1432
- rcs: Optional[float] = None
1433
- """Current/latest radar cross section in meters squared."""
1434
-
1435
- rcs_max: Optional[float] = FieldInfo(alias="rcsMax", default=None)
1436
- """Maximum radar cross section in meters squared."""
1437
-
1438
- rcs_mean: Optional[float] = FieldInfo(alias="rcsMean", default=None)
1439
- """Mean radar cross section in meters squared."""
1440
-
1441
- rcs_min: Optional[float] = FieldInfo(alias="rcsMin", default=None)
1442
- """Minimum radar cross section in meters squared."""
1443
-
1444
- ref_source: Optional[str] = FieldInfo(alias="refSource", default=None)
1445
- """
1446
- The reference source, sources, or URL from which the data in this record was
1447
- obtained.
1448
- """
1449
-
1450
- solar_array_area: Optional[float] = FieldInfo(alias="solarArrayArea", default=None)
1451
- """Spacecraft deployed area of solar array in meters squared."""
1452
-
1453
- total_mass_unc: Optional[float] = FieldInfo(alias="totalMassUnc", default=None)
1454
- """The 1-sigma uncertainty of the total spacecraft mass, in kilograms."""
1455
-
1456
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
1457
- """Time the row was last updated in the database, auto-populated by the system."""
1458
-
1459
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
1460
- """
1461
- Application user who updated the row in the database, auto-populated by the
1462
- system.
1463
- """
1464
-
1465
- vismag: Optional[float] = None
1466
- """Current/latest visual magnitude in M."""
1467
-
1468
- vismag_max: Optional[float] = FieldInfo(alias="vismagMax", default=None)
1469
- """Maximum visual magnitude in M."""
1470
-
1471
- vismag_mean: Optional[float] = FieldInfo(alias="vismagMean", default=None)
1472
- """Mean visual magnitude in M."""
1473
-
1474
- vismag_min: Optional[float] = FieldInfo(alias="vismagMin", default=None)
1475
- """Minimum visual magnitude in M."""
1476
-
1477
-
1478
- class EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArraySolarArrayDetailManufacturerOrgOrganizationDetail(
1479
- BaseModel
1480
- ):
1481
- classification_marking: str = FieldInfo(alias="classificationMarking")
1482
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
1483
-
1484
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
1485
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
1486
-
1487
- EXERCISE: Data pertaining to a government or military exercise. The data
1488
- may include both real and simulated data.
1489
-
1490
- REAL: Data collected or produced that pertains to real-world objects,
1491
- events, and analysis.
1492
-
1493
- SIMULATED: Synthetic data generated by a model to mimic real-world
1494
- datasets.
1495
-
1496
- TEST: Specific datasets used to evaluate compliance with specifications and
1497
- requirements, and for validating technical, functional, and performance
1498
- characteristics.
1499
- """
1500
-
1501
- id_organization: str = FieldInfo(alias="idOrganization")
1502
- """Unique identifier of the parent organization."""
1503
-
1504
- name: str
1505
- """Organization details name."""
1506
-
1507
- source: str
1508
- """Source of the data."""
1509
-
1510
- id: Optional[str] = None
1511
- """Unique identifier of the record, auto-generated by the system."""
1512
-
1513
- address1: Optional[str] = None
1514
- """Street number of the organization."""
1515
-
1516
- address2: Optional[str] = None
1517
- """
1518
- Field for additional organization address information such as PO Box and unit
1519
- number.
1520
- """
1521
-
1522
- address3: Optional[str] = None
1523
- """Contains the third line of address information for an organization."""
1524
-
1525
- broker: Optional[str] = None
1526
- """Designated broker for this organization."""
1527
-
1528
- ceo: Optional[str] = None
1529
- """For organizations of type CORPORATION, the name of the Chief Executive Officer."""
1530
-
1531
- cfo: Optional[str] = None
1532
- """For organizations of type CORPORATION, the name of the Chief Financial Officer."""
1533
-
1534
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
1535
- """Time the row was created in the database, auto-populated by the system."""
1536
-
1537
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
1538
- """
1539
- Application user who created the row in the database, auto-populated by the
1540
- system.
1541
- """
1542
-
1543
- cto: Optional[str] = None
1544
- """
1545
- For organizations of type CORPORATION, the name of the Chief Technology Officer.
1546
- """
1547
-
1548
- description: Optional[str] = None
1549
- """Organization description."""
1550
-
1551
- ebitda: Optional[float] = None
1552
- """
1553
- For organizations of type CORPORATION, the company EBITDA value as of
1554
- financialYearEndDate in US Dollars.
1555
- """
1556
-
1557
- email: Optional[str] = None
1558
- """Listed contact email address for the organization."""
1559
-
1560
- financial_notes: Optional[str] = FieldInfo(alias="financialNotes", default=None)
1561
- """For organizations of type CORPORATION, notes on company financials."""
1562
-
1563
- financial_year_end_date: Optional[datetime] = FieldInfo(alias="financialYearEndDate", default=None)
1564
- """
1565
- For organizations of type CORPORATION, the effective financial year end date for
1566
- revenue, EBITDA, and profit values.
1567
- """
1568
-
1569
- fleet_plan_notes: Optional[str] = FieldInfo(alias="fleetPlanNotes", default=None)
1570
- """Satellite fleet planning notes for this organization."""
1571
-
1572
- former_org_id: Optional[str] = FieldInfo(alias="formerOrgId", default=None)
1573
- """
1574
- Former organization ID (if this organization previously existed as another
1575
- organization).
1576
- """
1577
-
1578
- ftes: Optional[int] = None
1579
- """Total number of FTEs in this organization."""
1580
-
1581
- geo_admin_level1: Optional[str] = FieldInfo(alias="geoAdminLevel1", default=None)
1582
- """Administrative boundaries of the first sub-national level.
1583
-
1584
- Level 1 is simply the largest demarcation under whatever demarcation criteria
1585
- has been determined by the governing body. For example, this may be a state or
1586
- province.
1587
- """
1588
-
1589
- geo_admin_level2: Optional[str] = FieldInfo(alias="geoAdminLevel2", default=None)
1590
- """Administrative boundaries of the second sub-national level.
1591
-
1592
- Level 2 is simply the second largest demarcation under whatever demarcation
1593
- criteria has been determined by the governing body. For example, this may be a
1594
- county or district.
1595
- """
1596
-
1597
- geo_admin_level3: Optional[str] = FieldInfo(alias="geoAdminLevel3", default=None)
1598
- """Administrative boundaries of the third sub-national level.
1599
-
1600
- Level 3 is simply the third largest demarcation under whatever demarcation
1601
- criteria has been determined by the governing body. For example, this may be a
1602
- city or township.
1603
- """
1604
-
1605
- mass_ranking: Optional[int] = FieldInfo(alias="massRanking", default=None)
1606
- """Mass ranking for this organization."""
1607
-
1608
- origin: Optional[str] = None
1609
- """
1610
- Originating system or organization which produced the data, if different from
1611
- the source. The origin may be different than the source if the source was a
1612
- mediating system which forwarded the data on behalf of the origin system. If
1613
- null, the source may be assumed to be the origin.
1614
- """
1615
-
1616
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
1617
- """
1618
- The originating source network on which this record was created, auto-populated
1619
- by the system.
1620
- """
1621
-
1622
- parent_org_id: Optional[str] = FieldInfo(alias="parentOrgId", default=None)
1623
- """Parent organization ID of this organization if it is a child organization."""
1624
-
1625
- postal_code: Optional[str] = FieldInfo(alias="postalCode", default=None)
1626
- """
1627
- A postal code, such as PIN or ZIP Code, is a series of letters or digits or both
1628
- included in the postal address of the organization.
1629
- """
1630
-
1631
- profit: Optional[float] = None
1632
- """
1633
- For organizations of type CORPORATION, total annual profit as of
1634
- financialYearEndDate in US Dollars.
1635
- """
1636
-
1637
- revenue: Optional[float] = None
1638
- """
1639
- For organizations of type CORPORATION, total annual revenue as of
1640
- financialYearEndDate in US Dollars.
1641
- """
1642
-
1643
- revenue_ranking: Optional[int] = FieldInfo(alias="revenueRanking", default=None)
1644
- """Revenue ranking for this organization."""
1645
-
1646
- risk_manager: Optional[str] = FieldInfo(alias="riskManager", default=None)
1647
- """The name of the risk manager for the organization."""
1648
-
1649
- services_notes: Optional[str] = FieldInfo(alias="servicesNotes", default=None)
1650
- """Notes on the services provided by the organization."""
1651
-
1652
- tags: Optional[List[str]] = None
1653
- """
1654
- Optional array of provider/source specific tags for this data, where each
1655
- element is no longer than 32 characters, used for implementing data owner
1656
- conditional access controls to restrict access to the data. Should be left null
1657
- by data providers unless conditional access controls are coordinated with the
1658
- UDL team.
1659
- """
1660
-
1661
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
1662
- """Time the row was last updated in the database, auto-populated by the system."""
1663
-
1664
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
1665
- """
1666
- Application user who updated the row in the database, auto-populated by the
1667
- system.
1668
- """
1669
-
1670
-
1671
- class EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArraySolarArrayDetailManufacturerOrg(BaseModel):
1672
- classification_marking: str = FieldInfo(alias="classificationMarking")
1673
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
1674
-
1675
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
1676
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
1677
-
1678
- EXERCISE: Data pertaining to a government or military exercise. The data
1679
- may include both real and simulated data.
1680
-
1681
- REAL: Data collected or produced that pertains to real-world objects,
1682
- events, and analysis.
1683
-
1684
- SIMULATED: Synthetic data generated by a model to mimic real-world
1685
- datasets.
1686
-
1687
- TEST: Specific datasets used to evaluate compliance with specifications and
1688
- requirements, and for validating technical, functional, and performance
1689
- characteristics.
1690
- """
1691
-
1692
- name: str
1693
- """Organization name."""
1694
-
1695
- source: str
1696
- """Source of the data."""
1697
-
1698
- type: str
1699
- """Type of organization (e.g. GOVERNMENT, CORPORATION, CONSORTIUM, ACADEMIC)."""
1700
-
1701
- id: Optional[str] = None
1702
- """Unique identifier of the record, auto-generated by the system."""
1703
-
1704
- active: Optional[bool] = None
1705
- """Boolean indicating if this organization is currently active."""
1706
-
1707
- category: Optional[str] = None
1708
- """Subtype or category of the organization (e.g.
1709
-
1710
- Private company, stock market quoted company, subsidiary, goverment
1711
- department/agency, etc).
1712
- """
1713
-
1714
- country_code: Optional[str] = FieldInfo(alias="countryCode", default=None)
1715
- """Country of the physical location of the organization.
1716
-
1717
- This value is typically the ISO 3166 Alpha-2 two-character country code.
1718
- However, it can also represent various consortiums that do not appear in the ISO
1719
- document. The code must correspond to an existing country in the UDL’s country
1720
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
1721
- or alternate code values that exist for the specified country code.
1722
- """
1723
-
1724
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
1725
- """Time the row was created in the database, auto-populated by the system."""
1726
-
1727
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
1728
- """
1729
- Application user who created the row in the database, auto-populated by the
1730
- system.
1731
- """
1732
-
1733
- description: Optional[str] = None
1734
- """Organization description."""
1735
-
1736
- external_id: Optional[str] = FieldInfo(alias="externalId", default=None)
1737
- """Optional externally provided identifier for this row."""
1738
-
1739
- nationality: Optional[str] = None
1740
- """Country of registration or ownership of the organization.
1741
-
1742
- This value is typically the ISO 3166 Alpha-2 two-character country code, however
1743
- it can also represent various consortiums that do not appear in the ISO
1744
- document. The code must correspond to an existing country in the UDL’s country
1745
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
1746
- or alternate code values that exist for the specified country code.
1747
- """
1748
-
1749
- organization_details: Optional[
1750
- List[EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArraySolarArrayDetailManufacturerOrgOrganizationDetail]
1751
- ] = FieldInfo(alias="organizationDetails", default=None)
1752
- """
1753
- Read-only collection of additional OrganizationDetails by various sources for
1754
- this organization, ignored on create/update. These details must be created
1755
- separately via the /udl/organizationdetails operations.
1756
- """
1757
-
1758
- origin: Optional[str] = None
1759
- """
1760
- Originating system or organization which produced the data, if different from
1761
- the source. The origin may be different than the source if the source was a
1762
- mediating system which forwarded the data on behalf of the origin system. If
1763
- null, the source may be assumed to be the origin.
1764
- """
1765
-
1766
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
1767
- """
1768
- The originating source network on which this record was created, auto-populated
1769
- by the system.
1770
- """
1771
-
1772
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
1773
- """Time the row was last updated in the database, auto-populated by the system."""
1774
-
1775
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
1776
- """
1777
- Application user who updated the row in the database, auto-populated by the
1778
- system.
1779
- """
1780
-
1781
-
1782
- class EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArraySolarArrayDetail(BaseModel):
1783
- classification_marking: str = FieldInfo(alias="classificationMarking")
1784
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
1785
-
1786
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
1787
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
1788
-
1789
- EXERCISE: Data pertaining to a government or military exercise. The data
1790
- may include both real and simulated data.
1791
-
1792
- REAL: Data collected or produced that pertains to real-world objects,
1793
- events, and analysis.
1794
-
1795
- SIMULATED: Synthetic data generated by a model to mimic real-world
1796
- datasets.
1797
-
1798
- TEST: Specific datasets used to evaluate compliance with specifications and
1799
- requirements, and for validating technical, functional, and performance
1800
- characteristics.
1801
- """
1802
-
1803
- id_solar_array: str = FieldInfo(alias="idSolarArray")
1804
- """Unique identifier of the parent SolarArray."""
1805
-
1806
- source: str
1807
- """Source of the data."""
1808
-
1809
- id: Optional[str] = None
1810
- """Unique identifier of the record, auto-generated by the system."""
1811
-
1812
- area: Optional[float] = None
1813
- """Solar Array area in square meters."""
1814
-
1815
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
1816
- """Time the row was created in the database, auto-populated by the system."""
1817
-
1818
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
1819
- """
1820
- Application user who created the row in the database, auto-populated by the
1821
- system.
1822
- """
1823
-
1824
- description: Optional[str] = None
1825
- """Solar array description/notes."""
1826
-
1827
- junction_technology: Optional[str] = FieldInfo(alias="junctionTechnology", default=None)
1828
- """Solar array junction technology (e.g. Triple)."""
1829
-
1830
- manufacturer_org: Optional[
1831
- EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArraySolarArrayDetailManufacturerOrg
1832
- ] = FieldInfo(alias="manufacturerOrg", default=None)
1833
- """An organization such as a corporation, manufacturer, consortium, government,
1834
- etc.
1835
-
1836
- An organization may have parent and child organizations as well as link to a
1837
- former organization if this org previously existed as another organization.
1838
- """
1839
-
1840
- manufacturer_org_id: Optional[str] = FieldInfo(alias="manufacturerOrgId", default=None)
1841
- """Unique identifier of the organization that manufactures the solar array."""
1842
-
1843
- origin: Optional[str] = None
1844
- """
1845
- Originating system or organization which produced the data, if different from
1846
- the source. The origin may be different than the source if the source was a
1847
- mediating system which forwarded the data on behalf of the origin system. If
1848
- null, the source may be assumed to be the origin.
1849
- """
1850
-
1851
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
1852
- """
1853
- The originating source network on which this record was created, auto-populated
1854
- by the system.
1855
- """
1856
-
1857
- span: Optional[float] = None
1858
- """Solar Array span in meters."""
1859
-
1860
- tags: Optional[List[str]] = None
1861
- """
1862
- Optional array of provider/source specific tags for this data, where each
1863
- element is no longer than 32 characters, used for implementing data owner
1864
- conditional access controls to restrict access to the data. Should be left null
1865
- by data providers unless conditional access controls are coordinated with the
1866
- UDL team.
1867
- """
1868
-
1869
- technology: Optional[str] = None
1870
- """Solar array technology (e.g. Ga-As)."""
1871
-
1872
- type: Optional[str] = None
1873
- """Type of solar array (e.g. U Shaped)."""
1874
-
1875
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
1876
- """Time the row was last updated in the database, auto-populated by the system."""
1877
-
1878
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
1879
- """
1880
- Application user who updated the row in the database, auto-populated by the
1881
- system.
1882
- """
1883
-
1884
-
1885
- class EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArray(BaseModel):
1886
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
1887
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
1888
-
1889
- EXERCISE: Data pertaining to a government or military exercise. The data
1890
- may include both real and simulated data.
1891
-
1892
- REAL: Data collected or produced that pertains to real-world objects,
1893
- events, and analysis.
1894
-
1895
- SIMULATED: Synthetic data generated by a model to mimic real-world
1896
- datasets.
1897
-
1898
- TEST: Specific datasets used to evaluate compliance with specifications and
1899
- requirements, and for validating technical, functional, and performance
1900
- characteristics.
1901
- """
1902
-
1903
- name: str
1904
- """Solar Array name."""
1905
-
1906
- source: str
1907
- """Source of the data."""
1908
-
1909
- id: Optional[str] = None
1910
- """Unique identifier of the record, auto-generated by the system."""
1911
-
1912
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
1913
- """Time the row was created in the database, auto-populated by the system."""
1914
-
1915
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
1916
- """
1917
- Application user who created the row in the database, auto-populated by the
1918
- system.
1919
- """
1920
-
1921
- origin: Optional[str] = None
1922
- """
1923
- Originating system or organization which produced the data, if different from
1924
- the source. The origin may be different than the source if the source was a
1925
- mediating system which forwarded the data on behalf of the origin system. If
1926
- null, the source may be assumed to be the origin.
1927
- """
1928
-
1929
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
1930
- """
1931
- The originating source network on which this record was created, auto-populated
1932
- by the system.
1933
- """
1934
-
1935
- solar_array_details: Optional[List[EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArraySolarArrayDetail]] = (
1936
- FieldInfo(alias="solarArrayDetails", default=None)
1937
- )
1938
- """
1939
- Read-only collection of additional SolarArrayDetails by various sources for this
1940
- organization, ignored on create/update. These details must be created separately
1941
- via the /udl/solararraydetails operations.
1942
- """
1943
-
1944
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
1945
- """Time the row was last updated in the database, auto-populated by the system."""
1946
-
1947
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
1948
- """
1949
- Application user who updated the row in the database, auto-populated by the
1950
- system.
1951
- """
1952
-
1953
-
1954
- class EntityGetAllTypesResponseItemOnOrbitSolarArray(BaseModel):
1955
- classification_marking: str = FieldInfo(alias="classificationMarking")
1956
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
1957
-
1958
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
1959
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
1960
-
1961
- EXERCISE: Data pertaining to a government or military exercise. The data
1962
- may include both real and simulated data.
1963
-
1964
- REAL: Data collected or produced that pertains to real-world objects,
1965
- events, and analysis.
1966
-
1967
- SIMULATED: Synthetic data generated by a model to mimic real-world
1968
- datasets.
1969
-
1970
- TEST: Specific datasets used to evaluate compliance with specifications and
1971
- requirements, and for validating technical, functional, and performance
1972
- characteristics.
1973
- """
1974
-
1975
- id_on_orbit: str = FieldInfo(alias="idOnOrbit")
1976
- """ID of the on-orbit object."""
1977
-
1978
- id_solar_array: str = FieldInfo(alias="idSolarArray")
1979
- """ID of the SolarArray."""
1980
-
1981
- source: str
1982
- """Source of the data."""
1983
-
1984
- id: Optional[str] = None
1985
- """Unique identifier of the record, auto-generated by the system."""
1986
-
1987
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
1988
- """Time the row was created in the database, auto-populated by the system."""
1989
-
1990
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
1991
- """
1992
- Application user who created the row in the database, auto-populated by the
1993
- system.
1994
- """
1995
-
1996
- origin: Optional[str] = None
1997
- """
1998
- Originating system or organization which produced the data, if different from
1999
- the source. The origin may be different than the source if the source was a
2000
- mediating system which forwarded the data on behalf of the origin system. If
2001
- null, the source may be assumed to be the origin.
2002
- """
2003
-
2004
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
2005
- """
2006
- The originating source network on which this record was created, auto-populated
2007
- by the system.
2008
- """
2009
-
2010
- quantity: Optional[int] = None
2011
- """
2012
- The number of solar arrays on the spacecraft of the type identified by
2013
- idSolarArray.
2014
- """
2015
-
2016
- solar_array: Optional[EntityGetAllTypesResponseItemOnOrbitSolarArraySolarArray] = FieldInfo(
2017
- alias="solarArray", default=None
2018
- )
2019
- """Model representation of information on on-orbit/spacecraft solar arrays.
2020
-
2021
- A spacecraft may have multiple solar arrays and each solar array can have
2022
- multiple 'details' records compiled by different sources.
2023
- """
2024
-
2025
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
2026
- """Time the row was last updated in the database, auto-populated by the system."""
2027
-
2028
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
2029
- """
2030
- Application user who updated the row in the database, auto-populated by the
2031
- system.
2032
- """
2033
-
2034
-
2035
- class EntityGetAllTypesResponseItemOnOrbitThrusterEngineEngineDetail(BaseModel):
2036
- classification_marking: str = FieldInfo(alias="classificationMarking")
2037
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
2038
-
2039
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
2040
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
2041
-
2042
- EXERCISE: Data pertaining to a government or military exercise. The data
2043
- may include both real and simulated data.
2044
-
2045
- REAL: Data collected or produced that pertains to real-world objects,
2046
- events, and analysis.
2047
-
2048
- SIMULATED: Synthetic data generated by a model to mimic real-world
2049
- datasets.
2050
-
2051
- TEST: Specific datasets used to evaluate compliance with specifications and
2052
- requirements, and for validating technical, functional, and performance
2053
- characteristics.
2054
- """
2055
-
2056
- id_engine: str = FieldInfo(alias="idEngine")
2057
- """Identifier of the parent engine record."""
2058
-
2059
- source: str
2060
- """Source of the data."""
2061
-
2062
- id: Optional[str] = None
2063
- """Unique identifier of the record, auto-generated by the system."""
2064
-
2065
- burn_time: Optional[float] = FieldInfo(alias="burnTime", default=None)
2066
- """Launch engine maximum burn time in seconds."""
2067
-
2068
- chamber_pressure: Optional[float] = FieldInfo(alias="chamberPressure", default=None)
2069
- """Engine chamber pressure in bars."""
2070
-
2071
- characteristic_type: Optional[str] = FieldInfo(alias="characteristicType", default=None)
2072
- """Engine characteristic type (e.g.
2073
-
2074
- Electric, Mono-propellant, Bi-propellant, etc.).
2075
- """
2076
-
2077
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
2078
- """Time the row was created in the database, auto-populated by the system."""
2079
-
2080
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
2081
- """
2082
- Application user who created the row in the database, auto-populated by the
2083
- system.
2084
- """
2085
-
2086
- cycle_type: Optional[str] = FieldInfo(alias="cycleType", default=None)
2087
- """Engine cycle type (e.g.
2088
-
2089
- Electrostatic Ion, Pressure Fed, Hall, Catalytic Decomposition, etc.).
2090
- """
2091
-
2092
- family: Optional[str] = None
2093
- """Engine type or family."""
2094
-
2095
- manufacturer_org_id: Optional[str] = FieldInfo(alias="manufacturerOrgId", default=None)
2096
- """Organization ID of the engine manufacturer."""
2097
-
2098
- max_firings: Optional[int] = FieldInfo(alias="maxFirings", default=None)
2099
- """Engine maximum number of firings."""
2100
-
2101
- notes: Optional[str] = None
2102
- """Notes/Description of the engine."""
2103
-
2104
- nozzle_expansion_ratio: Optional[float] = FieldInfo(alias="nozzleExpansionRatio", default=None)
2105
- """Engine nozzle expansion ratio."""
2106
-
2107
- origin: Optional[str] = None
2108
- """
2109
- Originating system or organization which produced the data, if different from
2110
- the source. The origin may be different than the source if the source was a
2111
- mediating system which forwarded the data on behalf of the origin system. If
2112
- null, the source may be assumed to be the origin.
2113
- """
2114
-
2115
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
2116
- """
2117
- The originating source network on which this record was created, auto-populated
2118
- by the system.
2119
- """
2120
-
2121
- oxidizer: Optional[str] = None
2122
- """Oxidizer type (e.g. Nitrogen Tetroxide, Liquid Oxygen, etc)."""
2123
-
2124
- propellant: Optional[str] = None
2125
- """Propellant/fuel type of the engine (e.g.
2126
-
2127
- Liquid Hydrogen, Kerosene, Aerozine, etc).
2128
- """
2129
-
2130
- sea_level_thrust: Optional[float] = FieldInfo(alias="seaLevelThrust", default=None)
2131
- """Engine maximum thrust at sea level in Kilo-Newtons."""
2132
-
2133
- specific_impulse: Optional[float] = FieldInfo(alias="specificImpulse", default=None)
2134
- """Launch engine specific impulse in seconds."""
2135
-
2136
- tags: Optional[List[str]] = None
2137
- """
2138
- Optional array of provider/source specific tags for this data, where each
2139
- element is no longer than 32 characters, used for implementing data owner
2140
- conditional access controls to restrict access to the data. Should be left null
2141
- by data providers unless conditional access controls are coordinated with the
2142
- UDL team.
2143
- """
2144
-
2145
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
2146
- """Time the row was last updated in the database, auto-populated by the system."""
2147
-
2148
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
2149
- """
2150
- Application user who updated the row in the database, auto-populated by the
2151
- system.
2152
- """
2153
-
2154
- vacuum_thrust: Optional[float] = FieldInfo(alias="vacuumThrust", default=None)
2155
- """Engine maximum thrust in a vacuum in Kilo-Newtons."""
2156
-
2157
-
2158
- class EntityGetAllTypesResponseItemOnOrbitThrusterEngine(BaseModel):
2159
- classification_marking: str = FieldInfo(alias="classificationMarking")
2160
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
2161
-
2162
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
2163
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
2164
-
2165
- EXERCISE: Data pertaining to a government or military exercise. The data
2166
- may include both real and simulated data.
2167
-
2168
- REAL: Data collected or produced that pertains to real-world objects,
2169
- events, and analysis.
2170
-
2171
- SIMULATED: Synthetic data generated by a model to mimic real-world
2172
- datasets.
2173
-
2174
- TEST: Specific datasets used to evaluate compliance with specifications and
2175
- requirements, and for validating technical, functional, and performance
2176
- characteristics.
2177
- """
2178
-
2179
- name: str
2180
- """Engine name/variant."""
2181
-
2182
- source: str
2183
- """Source of the data."""
2184
-
2185
- id: Optional[str] = None
2186
- """Unique identifier of the record, auto-generated by the system."""
2187
-
2188
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
2189
- """Time the row was created in the database, auto-populated by the system."""
2190
-
2191
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
2192
- """
2193
- Application user who created the row in the database, auto-populated by the
2194
- system.
2195
- """
2196
-
2197
- engine_details: Optional[List[EntityGetAllTypesResponseItemOnOrbitThrusterEngineEngineDetail]] = FieldInfo(
2198
- alias="engineDetails", default=None
2199
- )
2200
- """
2201
- Read-only collection of additional EngineDetails by various sources for this
2202
- engine, ignored on create/update. These details must be created separately via
2203
- the /udl/enginedetails operations.
2204
- """
2205
-
2206
- origin: Optional[str] = None
2207
- """
2208
- Originating system or organization which produced the data, if different from
2209
- the source. The origin may be different than the source if the source was a
2210
- mediating system which forwarded the data on behalf of the origin system. If
2211
- null, the source may be assumed to be the origin.
2212
- """
2213
-
2214
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
2215
- """
2216
- The originating source network on which this record was created, auto-populated
2217
- by the system.
2218
- """
2219
-
2220
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
2221
- """Time the row was last updated in the database, auto-populated by the system."""
2222
-
2223
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
2224
- """
2225
- Application user who updated the row in the database, auto-populated by the
2226
- system.
2227
- """
2228
-
2229
-
2230
- class EntityGetAllTypesResponseItemOnOrbitThruster(BaseModel):
2231
- classification_marking: str = FieldInfo(alias="classificationMarking")
2232
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
2233
-
2234
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
2235
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
2236
-
2237
- EXERCISE: Data pertaining to a government or military exercise. The data
2238
- may include both real and simulated data.
2239
-
2240
- REAL: Data collected or produced that pertains to real-world objects,
2241
- events, and analysis.
2242
-
2243
- SIMULATED: Synthetic data generated by a model to mimic real-world
2244
- datasets.
2245
-
2246
- TEST: Specific datasets used to evaluate compliance with specifications and
2247
- requirements, and for validating technical, functional, and performance
2248
- characteristics.
2249
- """
2250
-
2251
- id_engine: str = FieldInfo(alias="idEngine")
2252
- """ID of the Engine."""
2253
-
2254
- id_on_orbit: str = FieldInfo(alias="idOnOrbit")
2255
- """ID of the on-orbit object."""
2256
-
2257
- source: str
2258
- """Source of the data."""
2259
-
2260
- id: Optional[str] = None
2261
- """Unique identifier of the record, auto-generated by the system."""
2262
-
2263
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
2264
- """Time the row was created in the database, auto-populated by the system."""
2265
-
2266
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
2267
- """
2268
- Application user who created the row in the database, auto-populated by the
2269
- system.
2270
- """
2271
-
2272
- engine: Optional[EntityGetAllTypesResponseItemOnOrbitThrusterEngine] = None
2273
- """Known launch vehicle engines and their performance characteristics and limits.
2274
-
2275
- A launch vehicle has 1 to many engines per stage.
2276
- """
2277
-
2278
- origin: Optional[str] = None
2279
- """
2280
- Originating system or organization which produced the data, if different from
2281
- the source. The origin may be different than the source if the source was a
2282
- mediating system which forwarded the data on behalf of the origin system. If
2283
- null, the source may be assumed to be the origin.
2284
- """
2285
-
2286
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
2287
- """
2288
- The originating source network on which this record was created, auto-populated
2289
- by the system.
2290
- """
2291
-
2292
- quantity: Optional[int] = None
2293
- """
2294
- The number of engines/thrusters on the spacecraft of the type identified by
2295
- idEngine.
2296
- """
2297
-
2298
- type: Optional[str] = None
2299
- """The type of thruster associated with this record (e.g.
2300
-
2301
- LAE, Hydrazine REA, etc.).
2302
- """
2303
-
2304
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
2305
- """Time the row was last updated in the database, auto-populated by the system."""
2306
-
2307
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
2308
- """
2309
- Application user who updated the row in the database, auto-populated by the
2310
- system.
2311
- """
2312
-
2313
-
2314
- class EntityGetAllTypesResponseItemOnOrbit(BaseModel):
2315
- classification_marking: str = FieldInfo(alias="classificationMarking")
2316
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
2317
-
2318
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
2319
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
2320
-
2321
- EXERCISE: Data pertaining to a government or military exercise. The data
2322
- may include both real and simulated data.
2323
-
2324
- REAL: Data collected or produced that pertains to real-world objects,
2325
- events, and analysis.
2326
-
2327
- SIMULATED: Synthetic data generated by a model to mimic real-world
2328
- datasets.
2329
-
2330
- TEST: Specific datasets used to evaluate compliance with specifications and
2331
- requirements, and for validating technical, functional, and performance
2332
- characteristics.
2333
- """
2334
-
2335
- sat_no: int = FieldInfo(alias="satNo")
2336
- """Satellite/Catalog number of the target on-orbit object."""
2337
-
2338
- source: str
2339
- """Source of the data."""
2340
-
2341
- alt_name: Optional[str] = FieldInfo(alias="altName", default=None)
2342
- """Alternate name of the on-orbit object."""
2343
-
2344
- antennas: Optional[List[EntityGetAllTypesResponseItemOnOrbitAntenna]] = None
2345
- """Read-only collection of antennas on this on-orbit object."""
2346
-
2347
- batteries: Optional[List[EntityGetAllTypesResponseItemOnOrbitBattery]] = None
2348
- """Read-only collection of batteries on this on-orbit object."""
2349
-
2350
- category: Optional[
2351
- Literal[
2352
- "Unknown",
2353
- "On-Orbit",
2354
- "Decayed",
2355
- "Cataloged Without State",
2356
- "Launch Nominal",
2357
- "Analyst Satellite",
2358
- "Cislunar",
2359
- "Lunar",
2360
- "Hyperbolic",
2361
- "Heliocentric",
2362
- "Interplanetary",
2363
- "Lagrangian",
2364
- "Docked",
2365
- ]
2366
- ] = None
2367
- """Category of the on-orbit object.
2368
-
2369
- (Unknown, On-Orbit, Decayed, Cataloged Without State, Launch Nominal, Analyst
2370
- Satellite, Cislunar, Lunar, Hyperbolic, Heliocentric, Interplanetary,
2371
- Lagrangian, Docked).
2372
- """
2373
-
2374
- common_name: Optional[str] = FieldInfo(alias="commonName", default=None)
2375
- """Common name of the on-orbit object."""
2376
-
2377
- constellation: Optional[str] = None
2378
- """Constellation to which this satellite belongs."""
2379
-
2380
- country_code: Optional[str] = FieldInfo(alias="countryCode", default=None)
2381
- """The country code.
2382
-
2383
- This value is typically the ISO 3166 Alpha-2 two-character country code, however
2384
- it can also represent various consortiums that do not appear in the ISO
2385
- document. The code must correspond to an existing country in the UDL’s country
2386
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
2387
- or alternate code values that exist for the specified country code.
2388
- """
2389
-
2390
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
2391
- """Time the row was created in the database, auto-populated by the system."""
2392
-
2393
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
2394
- """
2395
- Application user who created the row in the database, auto-populated by the
2396
- system.
2397
- """
2398
-
2399
- decay_date: Optional[datetime] = FieldInfo(alias="decayDate", default=None)
2400
- """Date of decay."""
2401
-
2402
- id_on_orbit: Optional[str] = FieldInfo(alias="idOnOrbit", default=None)
2403
- """
2404
- For the public catalog, the idOnOrbit is typically the satellite number as a
2405
- string, but may be a UUID for analyst or other unknown or untracked satellites,
2406
- auto-generated by the system.
2407
- """
2408
-
2409
- intl_des: Optional[str] = FieldInfo(alias="intlDes", default=None)
2410
- """
2411
- International Designator, typically of the format YYYYLLLAAA, where YYYY is the
2412
- launch year, LLL is the sequential launch number of that year, and AAA is an
2413
- optional launch piece designator for the launch.
2414
- """
2415
-
2416
- launch_date: Optional[date] = FieldInfo(alias="launchDate", default=None)
2417
- """Date of launch."""
2418
-
2419
- launch_site_id: Optional[str] = FieldInfo(alias="launchSiteId", default=None)
2420
- """Id of the associated launchSite entity."""
2421
-
2422
- lifetime_years: Optional[int] = FieldInfo(alias="lifetimeYears", default=None)
2423
- """Estimated lifetime of the on-orbit payload, if known."""
2424
-
2425
- mission_number: Optional[str] = FieldInfo(alias="missionNumber", default=None)
2426
- """Mission number of the on-orbit object."""
2427
-
2428
- object_type: Optional[Literal["ROCKET BODY", "DEBRIS", "PAYLOAD", "PLATFORM", "MANNED", "UNKNOWN"]] = FieldInfo(
2429
- alias="objectType", default=None
2430
- )
2431
- """
2432
- Type of on-orbit object: ROCKET BODY, DEBRIS, PAYLOAD, PLATFORM, MANNED,
2433
- UNKNOWN.
2434
- """
2435
-
2436
- onorbit_details: Optional[List[EntityGetAllTypesResponseItemOnOrbitOnorbitDetail]] = FieldInfo(
2437
- alias="onorbitDetails", default=None
2438
- )
2439
- """Read-only collection of details for this on-orbit object."""
2440
-
2441
- origin: Optional[str] = None
2442
- """
2443
- Originating system or organization which produced the data, if different from
2444
- the source. The origin may be different than the source if the source was a
2445
- mediating system which forwarded the data on behalf of the origin system. If
2446
- null, the source may be assumed to be the origin.
2447
- """
2448
-
2449
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
2450
- """
2451
- The originating source network on which this record was created, auto-populated
2452
- by the system.
2453
- """
2454
-
2455
- solar_arrays: Optional[List[EntityGetAllTypesResponseItemOnOrbitSolarArray]] = FieldInfo(
2456
- alias="solarArrays", default=None
2457
- )
2458
- """Read-only collection of solar arrays on this on-orbit object."""
2459
-
2460
- thrusters: Optional[List[EntityGetAllTypesResponseItemOnOrbitThruster]] = None
2461
- """Read-only collection of thrusters (engines) on this on-orbit object."""
2462
-
2463
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
2464
- """Time the row was last updated in the database, auto-populated by the system."""
2465
-
2466
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
2467
- """
2468
- Application user who updated the row in the database, auto-populated by the
2469
- system.
2470
- """
2471
-
2472
-
2473
- class EntityGetAllTypesResponseItemOperatingUnitLocation(BaseModel):
2474
- classification_marking: str = FieldInfo(alias="classificationMarking")
2475
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
2476
-
2477
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
2478
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
2479
-
2480
- EXERCISE: Data pertaining to a government or military exercise. The data
2481
- may include both real and simulated data.
2482
-
2483
- REAL: Data collected or produced that pertains to real-world objects,
2484
- events, and analysis.
2485
-
2486
- SIMULATED: Synthetic data generated by a model to mimic real-world
2487
- datasets.
2488
-
2489
- TEST: Specific datasets used to evaluate compliance with specifications and
2490
- requirements, and for validating technical, functional, and performance
2491
- characteristics.
2492
- """
2493
-
2494
- name: str
2495
- """Location name."""
2496
-
2497
- source: str
2498
- """Source of the data."""
2499
-
2500
- altitude: Optional[float] = None
2501
- """Altitude of the location, in kilometers."""
2502
-
2503
- country_code: Optional[str] = FieldInfo(alias="countryCode", default=None)
2504
- """The country code.
2505
-
2506
- This value is typically the ISO 3166 Alpha-2 two-character country code, however
2507
- it can also represent various consortiums that do not appear in the ISO
2508
- document. The code must correspond to an existing country in the UDL’s country
2509
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
2510
- or alternate code values that exist for the specified country code.
2511
- """
2512
-
2513
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
2514
- """Time the row was created in the database, auto-populated by the system."""
2515
-
2516
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
2517
- """
2518
- Application user who created the row in the database, auto-populated by the
2519
- system.
2520
- """
2521
-
2522
- id_location: Optional[str] = FieldInfo(alias="idLocation", default=None)
2523
- """Unique identifier of the location, auto-generated by the system."""
2524
-
2525
- lat: Optional[float] = None
2526
- """WGS84 latitude of the location, in degrees.
2527
-
2528
- -90 to 90 degrees (negative values south of equator).
2529
- """
2530
-
2531
- lon: Optional[float] = None
2532
- """WGS84 longitude of the location, in degrees.
2533
-
2534
- -180 to 180 degrees (negative values west of Prime Meridian).
2535
- """
2536
-
2537
- origin: Optional[str] = None
2538
- """
2539
- Originating system or organization which produced the data, if different from
2540
- the source. The origin may be different than the source if the source was a
2541
- mediating system which forwarded the data on behalf of the origin system. If
2542
- null, the source may be assumed to be the origin.
2543
- """
2544
-
2545
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
2546
- """
2547
- The originating source network on which this record was created, auto-populated
2548
- by the system.
2549
- """
2550
-
2551
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
2552
- """Time the row was last updated in the database, auto-populated by the system."""
2553
-
2554
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
2555
- """
2556
- Application user who updated the row in the database, auto-populated by the
2557
- system.
2558
- """
2559
-
2560
-
2561
- class EntityGetAllTypesResponseItemOperatingUnitOperatingUnitRemark(BaseModel):
2562
- classification_marking: str = FieldInfo(alias="classificationMarking")
2563
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
2564
-
2565
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
2566
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
2567
-
2568
- EXERCISE: Data pertaining to a government or military exercise. The data
2569
- may include both real and simulated data.
2570
-
2571
- REAL: Data collected or produced that pertains to real-world objects,
2572
- events, and analysis.
2573
-
2574
- SIMULATED: Synthetic data generated by a model to mimic real-world
2575
- datasets.
2576
-
2577
- TEST: Specific datasets used to evaluate compliance with specifications and
2578
- requirements, and for validating technical, functional, and performance
2579
- characteristics.
2580
- """
2581
-
2582
- id_operating_unit: str = FieldInfo(alias="idOperatingUnit")
2583
- """The ID of the operating unit to which this remark applies."""
2584
-
2585
- source: str
2586
- """Source of the data."""
2587
-
2588
- text: str
2589
- """The text of the remark."""
2590
-
2591
- id: Optional[str] = None
2592
- """Unique identifier of the record, auto-generated by the system."""
2593
-
2594
- alt_rmk_id: Optional[str] = FieldInfo(alias="altRmkId", default=None)
2595
- """Unique identifier of the unit remark record from the originating system."""
2596
-
2597
- code: Optional[str] = None
2598
- """The remark type identifier.
2599
-
2600
- For example, the Mobility Air Forces (MAF) remark code, defined in the Airfield
2601
- Suitability and Restriction Report (ASRR).
2602
- """
2603
-
2604
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
2605
- """Time the row was created in the database, auto-populated by the system."""
2606
-
2607
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
2608
- """
2609
- Application user who created the row in the database, auto-populated by the
2610
- system.
2611
- """
2612
-
2613
- name: Optional[str] = None
2614
- """The name of the remark."""
2615
-
2616
- origin: Optional[str] = None
2617
- """
2618
- Originating system or organization which produced the data, if different from
2619
- the source. The origin may be different than the source if the source was a
2620
- mediating system which forwarded the data on behalf of the origin system. If
2621
- null, the source may be assumed to be the origin.
2622
- """
2623
-
2624
- type: Optional[str] = None
2625
- """The remark type (e.g. Caution, Information, Misc, Restriction, etc.)."""
2626
-
2627
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
2628
- """Time the row was last updated in the database, auto-populated by the system."""
2629
-
2630
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
2631
- """
2632
- Application user who updated the row in the database, auto-populated by the
2633
- system.
2634
- """
2635
-
2636
-
2637
- class EntityGetAllTypesResponseItemOperatingUnitOrganizationOrganizationDetail(BaseModel):
2638
- classification_marking: str = FieldInfo(alias="classificationMarking")
2639
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
2640
-
2641
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
2642
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
2643
-
2644
- EXERCISE: Data pertaining to a government or military exercise. The data
2645
- may include both real and simulated data.
2646
-
2647
- REAL: Data collected or produced that pertains to real-world objects,
2648
- events, and analysis.
2649
-
2650
- SIMULATED: Synthetic data generated by a model to mimic real-world
2651
- datasets.
2652
-
2653
- TEST: Specific datasets used to evaluate compliance with specifications and
2654
- requirements, and for validating technical, functional, and performance
2655
- characteristics.
2656
- """
2657
-
2658
- id_organization: str = FieldInfo(alias="idOrganization")
2659
- """Unique identifier of the parent organization."""
2660
-
2661
- name: str
2662
- """Organization details name."""
2663
-
2664
- source: str
2665
- """Source of the data."""
2666
-
2667
- id: Optional[str] = None
2668
- """Unique identifier of the record, auto-generated by the system."""
2669
-
2670
- address1: Optional[str] = None
2671
- """Street number of the organization."""
2672
-
2673
- address2: Optional[str] = None
2674
- """
2675
- Field for additional organization address information such as PO Box and unit
2676
- number.
2677
- """
2678
-
2679
- address3: Optional[str] = None
2680
- """Contains the third line of address information for an organization."""
2681
-
2682
- broker: Optional[str] = None
2683
- """Designated broker for this organization."""
2684
-
2685
- ceo: Optional[str] = None
2686
- """For organizations of type CORPORATION, the name of the Chief Executive Officer."""
2687
-
2688
- cfo: Optional[str] = None
2689
- """For organizations of type CORPORATION, the name of the Chief Financial Officer."""
2690
-
2691
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
2692
- """Time the row was created in the database, auto-populated by the system."""
2693
-
2694
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
2695
- """
2696
- Application user who created the row in the database, auto-populated by the
2697
- system.
2698
- """
2699
-
2700
- cto: Optional[str] = None
2701
- """
2702
- For organizations of type CORPORATION, the name of the Chief Technology Officer.
2703
- """
2704
-
2705
- description: Optional[str] = None
2706
- """Organization description."""
2707
-
2708
- ebitda: Optional[float] = None
2709
- """
2710
- For organizations of type CORPORATION, the company EBITDA value as of
2711
- financialYearEndDate in US Dollars.
2712
- """
2713
-
2714
- email: Optional[str] = None
2715
- """Listed contact email address for the organization."""
2716
-
2717
- financial_notes: Optional[str] = FieldInfo(alias="financialNotes", default=None)
2718
- """For organizations of type CORPORATION, notes on company financials."""
2719
-
2720
- financial_year_end_date: Optional[datetime] = FieldInfo(alias="financialYearEndDate", default=None)
2721
- """
2722
- For organizations of type CORPORATION, the effective financial year end date for
2723
- revenue, EBITDA, and profit values.
2724
- """
2725
-
2726
- fleet_plan_notes: Optional[str] = FieldInfo(alias="fleetPlanNotes", default=None)
2727
- """Satellite fleet planning notes for this organization."""
2728
-
2729
- former_org_id: Optional[str] = FieldInfo(alias="formerOrgId", default=None)
2730
- """
2731
- Former organization ID (if this organization previously existed as another
2732
- organization).
2733
- """
2734
-
2735
- ftes: Optional[int] = None
2736
- """Total number of FTEs in this organization."""
2737
-
2738
- geo_admin_level1: Optional[str] = FieldInfo(alias="geoAdminLevel1", default=None)
2739
- """Administrative boundaries of the first sub-national level.
2740
-
2741
- Level 1 is simply the largest demarcation under whatever demarcation criteria
2742
- has been determined by the governing body. For example, this may be a state or
2743
- province.
2744
- """
2745
-
2746
- geo_admin_level2: Optional[str] = FieldInfo(alias="geoAdminLevel2", default=None)
2747
- """Administrative boundaries of the second sub-national level.
2748
-
2749
- Level 2 is simply the second largest demarcation under whatever demarcation
2750
- criteria has been determined by the governing body. For example, this may be a
2751
- county or district.
2752
- """
2753
-
2754
- geo_admin_level3: Optional[str] = FieldInfo(alias="geoAdminLevel3", default=None)
2755
- """Administrative boundaries of the third sub-national level.
2756
-
2757
- Level 3 is simply the third largest demarcation under whatever demarcation
2758
- criteria has been determined by the governing body. For example, this may be a
2759
- city or township.
2760
- """
2761
-
2762
- mass_ranking: Optional[int] = FieldInfo(alias="massRanking", default=None)
2763
- """Mass ranking for this organization."""
2764
-
2765
- origin: Optional[str] = None
2766
- """
2767
- Originating system or organization which produced the data, if different from
2768
- the source. The origin may be different than the source if the source was a
2769
- mediating system which forwarded the data on behalf of the origin system. If
2770
- null, the source may be assumed to be the origin.
2771
- """
2772
-
2773
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
2774
- """
2775
- The originating source network on which this record was created, auto-populated
2776
- by the system.
2777
- """
2778
-
2779
- parent_org_id: Optional[str] = FieldInfo(alias="parentOrgId", default=None)
2780
- """Parent organization ID of this organization if it is a child organization."""
2781
-
2782
- postal_code: Optional[str] = FieldInfo(alias="postalCode", default=None)
2783
- """
2784
- A postal code, such as PIN or ZIP Code, is a series of letters or digits or both
2785
- included in the postal address of the organization.
2786
- """
2787
-
2788
- profit: Optional[float] = None
2789
- """
2790
- For organizations of type CORPORATION, total annual profit as of
2791
- financialYearEndDate in US Dollars.
2792
- """
2793
-
2794
- revenue: Optional[float] = None
2795
- """
2796
- For organizations of type CORPORATION, total annual revenue as of
2797
- financialYearEndDate in US Dollars.
2798
- """
2799
-
2800
- revenue_ranking: Optional[int] = FieldInfo(alias="revenueRanking", default=None)
2801
- """Revenue ranking for this organization."""
2802
-
2803
- risk_manager: Optional[str] = FieldInfo(alias="riskManager", default=None)
2804
- """The name of the risk manager for the organization."""
2805
-
2806
- services_notes: Optional[str] = FieldInfo(alias="servicesNotes", default=None)
2807
- """Notes on the services provided by the organization."""
2808
-
2809
- tags: Optional[List[str]] = None
2810
- """
2811
- Optional array of provider/source specific tags for this data, where each
2812
- element is no longer than 32 characters, used for implementing data owner
2813
- conditional access controls to restrict access to the data. Should be left null
2814
- by data providers unless conditional access controls are coordinated with the
2815
- UDL team.
2816
- """
2817
-
2818
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
2819
- """Time the row was last updated in the database, auto-populated by the system."""
2820
-
2821
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
2822
- """
2823
- Application user who updated the row in the database, auto-populated by the
2824
- system.
2825
- """
2826
-
2827
-
2828
- class EntityGetAllTypesResponseItemOperatingUnitOrganization(BaseModel):
2829
- classification_marking: str = FieldInfo(alias="classificationMarking")
2830
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
2831
-
2832
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
2833
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
2834
-
2835
- EXERCISE: Data pertaining to a government or military exercise. The data
2836
- may include both real and simulated data.
2837
-
2838
- REAL: Data collected or produced that pertains to real-world objects,
2839
- events, and analysis.
2840
-
2841
- SIMULATED: Synthetic data generated by a model to mimic real-world
2842
- datasets.
2843
-
2844
- TEST: Specific datasets used to evaluate compliance with specifications and
2845
- requirements, and for validating technical, functional, and performance
2846
- characteristics.
2847
- """
2848
-
2849
- name: str
2850
- """Organization name."""
2851
-
2852
- source: str
2853
- """Source of the data."""
2854
-
2855
- type: str
2856
- """Type of organization (e.g. GOVERNMENT, CORPORATION, CONSORTIUM, ACADEMIC)."""
2857
-
2858
- id: Optional[str] = None
2859
- """Unique identifier of the record, auto-generated by the system."""
2860
-
2861
- active: Optional[bool] = None
2862
- """Boolean indicating if this organization is currently active."""
2863
-
2864
- category: Optional[str] = None
2865
- """Subtype or category of the organization (e.g.
2866
-
2867
- Private company, stock market quoted company, subsidiary, goverment
2868
- department/agency, etc).
2869
- """
2870
-
2871
- country_code: Optional[str] = FieldInfo(alias="countryCode", default=None)
2872
- """Country of the physical location of the organization.
2873
-
2874
- This value is typically the ISO 3166 Alpha-2 two-character country code.
2875
- However, it can also represent various consortiums that do not appear in the ISO
2876
- document. The code must correspond to an existing country in the UDL’s country
2877
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
2878
- or alternate code values that exist for the specified country code.
2879
- """
2880
-
2881
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
2882
- """Time the row was created in the database, auto-populated by the system."""
2883
-
2884
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
2885
- """
2886
- Application user who created the row in the database, auto-populated by the
2887
- system.
2888
- """
2889
-
2890
- description: Optional[str] = None
2891
- """Organization description."""
2892
-
2893
- external_id: Optional[str] = FieldInfo(alias="externalId", default=None)
2894
- """Optional externally provided identifier for this row."""
2895
-
2896
- nationality: Optional[str] = None
2897
- """Country of registration or ownership of the organization.
2898
-
2899
- This value is typically the ISO 3166 Alpha-2 two-character country code, however
2900
- it can also represent various consortiums that do not appear in the ISO
2901
- document. The code must correspond to an existing country in the UDL’s country
2902
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
2903
- or alternate code values that exist for the specified country code.
2904
- """
2905
-
2906
- organization_details: Optional[List[EntityGetAllTypesResponseItemOperatingUnitOrganizationOrganizationDetail]] = (
2907
- FieldInfo(alias="organizationDetails", default=None)
2908
- )
2909
- """
2910
- Read-only collection of additional OrganizationDetails by various sources for
2911
- this organization, ignored on create/update. These details must be created
2912
- separately via the /udl/organizationdetails operations.
2913
- """
2914
-
2915
- origin: Optional[str] = None
2916
- """
2917
- Originating system or organization which produced the data, if different from
2918
- the source. The origin may be different than the source if the source was a
2919
- mediating system which forwarded the data on behalf of the origin system. If
2920
- null, the source may be assumed to be the origin.
2921
- """
2922
-
2923
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
2924
- """
2925
- The originating source network on which this record was created, auto-populated
2926
- by the system.
2927
- """
2928
-
2929
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
2930
- """Time the row was last updated in the database, auto-populated by the system."""
2931
-
2932
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
2933
- """
2934
- Application user who updated the row in the database, auto-populated by the
2935
- system.
2936
- """
2937
-
2938
-
2939
- class EntityGetAllTypesResponseItemOperatingUnit(BaseModel):
2940
- classification_marking: str = FieldInfo(alias="classificationMarking")
2941
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
2942
-
2943
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
2944
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
2945
-
2946
- EXERCISE: Data pertaining to a government or military exercise. The data
2947
- may include both real and simulated data.
2948
-
2949
- REAL: Data collected or produced that pertains to real-world objects,
2950
- events, and analysis.
2951
-
2952
- SIMULATED: Synthetic data generated by a model to mimic real-world
2953
- datasets.
2954
-
2955
- TEST: Specific datasets used to evaluate compliance with specifications and
2956
- requirements, and for validating technical, functional, and performance
2957
- characteristics.
2958
- """
2959
-
2960
- name: str
2961
- """Name of the operating unit."""
2962
-
2963
- source: str
2964
- """Source of the data."""
2965
-
2966
- air_def_area: Optional[str] = FieldInfo(alias="airDefArea", default=None)
2967
- """
2968
- Air Defense District (ADD) or Air Defense Area (ADA) in which the geographic
2969
- coordinates reside.
2970
- """
2971
-
2972
- allegiance: Optional[str] = None
2973
- """
2974
- The DoD Standard country code designator for the country or political entity to
2975
- which the operating unit owes its allegiance. This field will be set to "OTHR"
2976
- if the source value does not match a UDL country code value (ISO-3166-ALPHA-2).
2977
- """
2978
-
2979
- alt_allegiance: Optional[str] = FieldInfo(alias="altAllegiance", default=None)
2980
- """
2981
- Specifies an alternate allegiance code if the data provider code is not part of
2982
- an official Country Code standard such as ISO-3166 or FIPS. This field will be
2983
- set to the value provided by the source and should be used for all Queries
2984
- specifying allegiance.
2985
- """
2986
-
2987
- alt_country_code: Optional[str] = FieldInfo(alias="altCountryCode", default=None)
2988
- """
2989
- Specifies an alternate country code if the data provider code is not part of an
2990
- official Country Code standard such as ISO-3166 or FIPS. This field will be set
2991
- to the value provided by the source and should be used for all Queries
2992
- specifying a Country Code.
2993
- """
2994
-
2995
- alt_operating_unit_id: Optional[str] = FieldInfo(alias="altOperatingUnitId", default=None)
2996
- """Unique identifier of the operating unit record from the originating system."""
2997
-
2998
- class_rating: Optional[str] = FieldInfo(alias="classRating", default=None)
2999
- """Indicates the importance of the operating unit to the OES or MIR system.
3000
-
3001
- This data element is restricted to update by DIA (DB-4). Valid values are: 0 -
3002
- Does not meet criteria above 1 - Primary importance to system 2 - Secondary
3003
- importance to system 3 - Tertiary importance to system O - Other. Explain in
3004
- Remarks.
3005
- """
3006
-
3007
- condition: Optional[str] = None
3008
- """The physical manner of being or state of existence of the operating unit.
3009
-
3010
- A physical condition that must be considered in the determining of a course of
3011
- action. The specific usage and enumerations contained in this field may be found
3012
- in the documentation provided in the referenceDoc field. If referenceDoc not
3013
- provided, users may consult the data provider.
3014
- """
3015
-
3016
- condition_avail: Optional[str] = FieldInfo(alias="conditionAvail", default=None)
3017
- """Availability of the operating unit relative to its condition.
3018
-
3019
- Indicates the reason the operating unit is not fully operational. The specific
3020
- usage and enumerations contained in this field may be found in the documentation
3021
- provided in the referenceDoc field. If referenceDoc not provided, users may
3022
- consult the data provider.
3023
- """
3024
-
3025
- coord: Optional[str] = None
3026
- """
3027
- Indicates any of the magnitudes that serve to define the position of a point by
3028
- reference to a fixed figure, system of lines, etc.
3029
-
3030
- Pos. 1-2. Latitude Degrees [00-90]
3031
-
3032
- Pos. 3-4. Latitude Minutes [00-59]
3033
-
3034
- Pos. 5-6. Latitude Seconds [00-59]
3035
-
3036
- Pos. 7-9. Latitude Thousandths Of Seconds [000-999]
3037
-
3038
- Pos. 10. Latitude Hemisphere [NS]
3039
-
3040
- Pos. 11-13. Longitude Degrees [00-180]
3041
-
3042
- Pos. 14-15. Longitude Minutes [00-59]
3043
-
3044
- Pos. 16-17. Longitude Seconds [00-59]
3045
-
3046
- Pos. 18-20. Longitude Thousandths Of Seconds [000-999]
3047
-
3048
- Pos. 21. Longitude Hemisphere [EW]
3049
-
3050
- Pos. 1-21. Unknown Latitude and Unknown Longitude [000000000U000000000U]
3051
- """
3052
-
3053
- coord_datum: Optional[str] = FieldInfo(alias="coordDatum", default=None)
3054
- """A mathematical model of the earth used to calculate coordinates on a map.
3055
-
3056
- US Forces use the World Geodetic System 1984 (WGS 84), but also use maps by
3057
- allied countries with local datums. The datum must be specified to ensure
3058
- accuracy of coordinates. The specific usage and enumerations contained in this
3059
- field may be found in the documentation provided in the referenceDoc field. If
3060
- referenceDoc not provided, users may consult the data provider.
3061
- """
3062
-
3063
- coord_deriv_acc: Optional[float] = FieldInfo(alias="coordDerivAcc", default=None)
3064
- """
3065
- Indicates the plus or minus error assessed against the method used to derive the
3066
- coordinate.
3067
- """
3068
-
3069
- country_code: Optional[str] = FieldInfo(alias="countryCode", default=None)
3070
- """
3071
- The DoD Standard country code designator for the country or political entity to
3072
- which the operating unit geographic coordinates reside . This field will be set
3073
- to "OTHR" if the source value does not match a UDL country code value
3074
- (ISO-3166-ALPHA-2).
3075
- """
3076
-
3077
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
3078
- """Time the row was created in the database, auto-populated by the system."""
3079
-
3080
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
3081
- """
3082
- Application user who created the row in the database, auto-populated by the
3083
- system.
3084
- """
3085
-
3086
- deploy_status: Optional[str] = FieldInfo(alias="deployStatus", default=None)
3087
- """A code describing the amount of operating unit participation in a deployment.
3088
-
3089
- The specific usage and enumerations contained in this field may be found in the
3090
- documentation provided in the referenceDoc field. If referenceDoc not provided,
3091
- users may consult the data provider.
3092
- """
3093
-
3094
- description: Optional[str] = None
3095
- """Description of the operating unit."""
3096
-
3097
- div_cat: Optional[str] = FieldInfo(alias="divCat", default=None)
3098
- """Combat status of a divisional or equivalent operating unit.
3099
-
3100
- Currently, this data element applies only to operating units of the Former
3101
- Soviet Union. The specific usage and enumerations contained in this field may be
3102
- found in the documentation provided in the referenceDoc field. If referenceDoc
3103
- not provided, users may consult the data provider.
3104
- """
3105
-
3106
- echelon: Optional[str] = None
3107
- """Organizational level of the operating unit.
3108
-
3109
- The specific usage and enumerations contained in this field may be found in the
3110
- documentation provided in the referenceDoc field. If referenceDoc not provided,
3111
- users may consult the data provider.
3112
- """
3113
-
3114
- echelon_tier: Optional[str] = FieldInfo(alias="echelonTier", default=None)
3115
- """Indicates the major group or level to which an echelon belongs.
3116
-
3117
- The specific usage and enumerations contained in this field may be found in the
3118
- documentation provided in the referenceDoc field. If referenceDoc not provided,
3119
- users may consult the data provider.
3120
- """
3121
-
3122
- elev_msl: Optional[float] = FieldInfo(alias="elevMsl", default=None)
3123
- """
3124
- Ground elevation of the geographic coordinates referenced to (above or below)
3125
- Mean Sea Level (MSL) vertical datum.
3126
- """
3127
-
3128
- elev_msl_conf_lvl: Optional[int] = FieldInfo(alias="elevMslConfLvl", default=None)
3129
- """
3130
- Indicates the confidence level expressed as a percent that a specific geometric
3131
- spatial element, ELEVATION_MSL linear accuracy, has been vertically positioned
3132
- to within a specified vertical accuracy.
3133
- """
3134
-
3135
- elev_msl_deriv_acc: Optional[float] = FieldInfo(alias="elevMslDerivAcc", default=None)
3136
- """
3137
- Indicates the plus or minus error assessed against the method used to derive the
3138
- elevation.
3139
- """
3140
-
3141
- eval: Optional[int] = None
3142
- """
3143
- The Intelligence Confidence Level or the Reliability/degree of confidence that
3144
- the analyst has assigned to the data within this record. The numerical range is
3145
- from 1 to 9 with 1 representing the highest confidence level.
3146
- """
3147
-
3148
- flag_flown: Optional[str] = FieldInfo(alias="flagFlown", default=None)
3149
- """The country code of the observed flag flown."""
3150
-
3151
- fleet_id: Optional[str] = FieldInfo(alias="fleetId", default=None)
3152
- """Naval fleet to which an operating unit is assigned.
3153
-
3154
- The specific usage and enumerations contained in this field may be found in the
3155
- documentation provided in the referenceDoc field. If referenceDoc not provided,
3156
- users may consult the data provider.
3157
- """
3158
-
3159
- force: Optional[str] = None
3160
- """
3161
- An aggregation of military units within a single service (i.e., ARMY, AIR FORCE,
3162
- etc.) which operates under a single authority to accomplish a common mission.
3163
- The specific usage and enumerations contained in this field may be found in the
3164
- documentation provided in the referenceDoc field. If referenceDoc not provided,
3165
- users may consult the data provider.
3166
- """
3167
-
3168
- force_name: Optional[str] = FieldInfo(alias="forceName", default=None)
3169
- """The specific name for a given force.
3170
-
3171
- For example, Force = ADF (Air Defense Force) and Force Name = Army Air Defense
3172
- Force.
3173
- """
3174
-
3175
- fpa: Optional[str] = None
3176
- """Functional Production Area (FPA) under the Shared Production Program (SPP).
3177
-
3178
- Producers are defined per country per FPA. The specific usage and enumerations
3179
- contained in this field may be found in the documentation provided in the
3180
- referenceDoc field. If referenceDoc not provided, users may consult the data
3181
- provider.
3182
- """
3183
-
3184
- funct_role: Optional[str] = FieldInfo(alias="functRole", default=None)
3185
- """
3186
- Principal combat-related role that an operating unit is organized, structured
3187
- and equipped to perform. Or, the specialized military or paramilitary branch in
3188
- which an individual serves, their specialization. The specific usage and
3189
- enumerations contained in this field may be found in the documentation provided
3190
- in the referenceDoc field. If referenceDoc not provided, users may consult the
3191
- data provider.
3192
- """
3193
-
3194
- geoidal_msl_sep: Optional[float] = FieldInfo(alias="geoidalMslSep", default=None)
3195
- """The distance between Mean Sea Level and a referenced ellipsoid."""
3196
-
3197
- id_contact: Optional[str] = FieldInfo(alias="idContact", default=None)
3198
- """Unique identifier of the contact for this operating unit."""
3199
-
3200
- ident: Optional[str] = None
3201
- """
3202
- Estimated identity of the Site (ASSUMED FRIEND, FRIEND, HOSTILE, FAKER, JOKER,
3203
- NEUTRAL, PENDING, SUSPECT, UNKNOWN):
3204
-
3205
- ASSUMED FRIEND: Track assumed to be a friend due to the object characteristics,
3206
- behavior, and/or origin.
3207
-
3208
- FRIEND: Track object supporting friendly forces and belonging to a declared
3209
- friendly nation or entity.
3210
-
3211
- HOSTILE: Track object belonging to an opposing nation, party, group, or entity
3212
- deemed to contribute to a threat to friendly forces or their mission due to its
3213
- behavior, characteristics, nationality, or origin.
3214
-
3215
- FAKER: Friendly track, object, or entity acting as an exercise hostile.
3216
-
3217
- JOKER: Friendly track, object, or entity acting as an exercise suspect.
3218
-
3219
- NEUTRAL: Track object whose characteristics, behavior, nationality, and/or
3220
- origin indicate that it is neither supporting nor opposing friendly forces or
3221
- their mission.
3222
-
3223
- PENDING: Track object which has not been evaluated.
3224
-
3225
- SUSPECT: Track object deemed potentially hostile due to the object
3226
- characteristics, behavior, nationality, and/or origin.
3227
-
3228
- UNKNOWN: Track object which has been evaluated and does not meet criteria for
3229
- any standard identity.
3230
- """
3231
-
3232
- id_location: Optional[str] = FieldInfo(alias="idLocation", default=None)
3233
- """Unique identifier of the location record for this operating unit."""
3234
-
3235
- id_operating_unit: Optional[str] = FieldInfo(alias="idOperatingUnit", default=None)
3236
- """Unique identifier of the record, auto-generated by the system."""
3237
-
3238
- id_organization: Optional[str] = FieldInfo(alias="idOrganization", default=None)
3239
- """Unique identifier of the organization record for this operating unit."""
3240
-
3241
- lat: Optional[float] = None
3242
- """WGS84 latitude of the location, in degrees.
3243
-
3244
- -90 to 90 degrees (negative values south of equator).
3245
- """
3246
-
3247
- location: Optional[EntityGetAllTypesResponseItemOperatingUnitLocation] = None
3248
- """
3249
- Model representation of a location, which is a specific fixed point on the earth
3250
- and is used to denote the locations of fixed sensors, operating units, etc.
3251
- """
3252
-
3253
- loc_name: Optional[str] = FieldInfo(alias="locName", default=None)
3254
- """Location name for the coordinates."""
3255
-
3256
- loc_reason: Optional[str] = FieldInfo(alias="locReason", default=None)
3257
- """Indicates the reason that the operating unit is at that location.
3258
-
3259
- The specific usage and enumerations contained in this field may be found in the
3260
- documentation provided in the referenceDoc field. If referenceDoc not provided,
3261
- users may consult the data provider.
3262
- """
3263
-
3264
- lon: Optional[float] = None
3265
- """WGS84 longitude of the location, in degrees.
3266
-
3267
- -180 to 180 degrees (negative values west of Prime Meridian).
3268
- """
3269
-
3270
- master_unit: Optional[bool] = FieldInfo(alias="masterUnit", default=None)
3271
- """
3272
- This field contains a value indicating whether the record is a master unit
3273
- record (True) or a detail record (False). Master records contain basic
3274
- information that does not change over time for each unit that has been selected
3275
- to be projected.
3276
- """
3277
-
3278
- mil_grid: Optional[str] = FieldInfo(alias="milGrid", default=None)
3279
- """
3280
- The Military Grid Reference System is the geocoordinate standard used by NATO
3281
- militaries for locating points on Earth. The MGRS is derived from the Universal
3282
- Transverse Mercator (UTM) grid system and the Universal Polar Stereographic
3283
- (UPS) grid system, but uses a different labeling convention. The MGRS is used as
3284
- geocode for the entire Earth. Example of an milgrid coordinate, or grid
3285
- reference, would be 4QFJ12345678, which consists of three parts: 4Q (grid zone
3286
- designator, GZD) FJ (the 100,000-meter square identifier) 12345678 (numerical
3287
- location; easting is 1234 and northing is 5678, in this case specifying a
3288
- location with 10 m resolution).
3289
- """
3290
-
3291
- mil_grid_sys: Optional[str] = FieldInfo(alias="milGridSys", default=None)
3292
- """Indicates the grid system used in the development of the milGrid coordinates.
3293
-
3294
- Values are:
3295
-
3296
- UPS - Universal Polar System
3297
-
3298
- UTM - Universal Transverse Mercator
3299
- """
3300
-
3301
- msn_primary: Optional[str] = FieldInfo(alias="msnPrimary", default=None)
3302
- """
3303
- Indicates the principal type of mission that an operating unit is organized and
3304
- equipped to perform. The specific usage and enumerations contained in this field
3305
- may be found in the documentation provided in the referenceDoc field. If
3306
- referenceDoc not provided, users may consult the data provider.
3307
- """
3308
-
3309
- msn_primary_specialty: Optional[str] = FieldInfo(alias="msnPrimarySpecialty", default=None)
3310
- """
3311
- Indicates the principal specialty type of mission that an operating unit is
3312
- organized and equipped to perform. The specific usage and enumerations contained
3313
- in this field may be found in the documentation provided in the referenceDoc
3314
- field. If referenceDoc not provided, users may consult the data provider.
3315
- """
3316
-
3317
- operating_unit_remarks: Optional[List[EntityGetAllTypesResponseItemOperatingUnitOperatingUnitRemark]] = FieldInfo(
3318
- alias="operatingUnitRemarks", default=None
3319
- )
3320
- """Remarks contain amplifying information for a specific service.
3321
-
3322
- The information may contain context and interpretations for consumer use.
3323
- """
3324
-
3325
- oper_status: Optional[str] = FieldInfo(alias="operStatus", default=None)
3326
- """
3327
- The Degree to which an operating unit is ready to perform the overall
3328
- operational mission(s) for which it was organized and equipped. The specific
3329
- usage and enumerations contained in this field may be found in the documentation
3330
- provided in the referenceDoc field. If referenceDoc not provided, users may
3331
- consult the data provider.
3332
- """
3333
-
3334
- organization: Optional[EntityGetAllTypesResponseItemOperatingUnitOrganization] = None
3335
- """An organization such as a corporation, manufacturer, consortium, government,
3336
- etc.
3337
-
3338
- An organization may have parent and child organizations as well as link to a
3339
- former organization if this org previously existed as another organization.
3340
- """
3341
-
3342
- origin: Optional[str] = None
3343
- """
3344
- Originating system or organization which produced the data, if different from
3345
- the source. The origin may be different than the source if the source was a
3346
- mediating system which forwarded the data on behalf of the origin system. If
3347
- null, the source may be assumed to be the origin.
3348
- """
3349
-
3350
- pol_subdiv: Optional[str] = FieldInfo(alias="polSubdiv", default=None)
3351
- """Political subdivision in which the geographic coordinates reside.
3352
-
3353
- The specific usage and enumerations contained in this field may be found in the
3354
- documentation provided in the referenceDoc field. If referenceDoc not provided,
3355
- users may consult the data provider.
3356
- """
3357
-
3358
- rec_status: Optional[str] = FieldInfo(alias="recStatus", default=None)
3359
- """
3360
- Validity and currency of the data in the record to be used in conjunction with
3361
- the other elements in the record as defined by SOPs. Values are: A - Active I -
3362
- Inactive K - Acknowledged L - Local Q - A nominated (NOM) or Data Change Request
3363
- (DCR) record R - Production reduced by CMD decision W - Working Record.
3364
- """
3365
-
3366
- reference_doc: Optional[str] = FieldInfo(alias="referenceDoc", default=None)
3367
- """
3368
- The reference documentiation that specifies the usage and enumerations contained
3369
- in this record. If referenceDoc not provided, users may consult the data
3370
- provider.
3371
- """
3372
-
3373
- res_prod: Optional[str] = FieldInfo(alias="resProd", default=None)
3374
- """
3375
- Responsible Producer - Organization that is responsible for the maintenance of
3376
- the record.
3377
- """
3378
-
3379
- review_date: Optional[date] = FieldInfo(alias="reviewDate", default=None)
3380
- """
3381
- Date on which the data in the record was last reviewed by the responsible
3382
- analyst for accuracy and currency. This date cannot be greater than the current
3383
- date.
3384
- """
3385
-
3386
- stylized_unit: Optional[bool] = FieldInfo(alias="stylizedUnit", default=None)
3387
- """
3388
- This field contains a value indicating whether the record is a stylized
3389
- operating unit record (True) or a regular operating unit record (False). A
3390
- stylized operating unit is a type of operating unit with one set of equipment
3391
- that can be assigned to one or more superiors. A stylized operating unit is
3392
- generally useful for lower echelon operating units where the number of operating
3393
- units and types of equipment are equal for multiple organizations. In lieu of
3394
- creating unique operating unit records for each operating unit, a template is
3395
- created for the operating unit and its equipment. This template enables the user
3396
- to assign the operating unit to multiple organizations.
3397
- """
3398
-
3399
- sym_code: Optional[str] = FieldInfo(alias="symCode", default=None)
3400
- """
3401
- A standard scheme for symbol coding enabling the transfer, display and use of
3402
- symbols and graphics among information systems, as per MIL-STD 2525B, and
3403
- supported by the element AFFILIATION.
3404
- """
3405
-
3406
- unit_identifier: Optional[str] = FieldInfo(alias="unitIdentifier", default=None)
3407
- """
3408
- An optional identifier for this operating unit that may be composed from items
3409
- such as the originating organization, allegiance, one-up number, etc.
3410
- """
3411
-
3412
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
3413
- """Time the row was last updated in the database, auto-populated by the system."""
3414
-
3415
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
3416
- """
3417
- Application user who updated the row in the database, auto-populated by the
3418
- system.
3419
- """
3420
-
3421
- utm: Optional[str] = None
3422
- """Universal Transverse Mercator (UTM) grid coordinates. Pos.
3423
-
3424
- 1-2, UTM Zone Column [01-60 Pos. 3, UTM Zone Row [C-HJ-NP-X] Pos. 4, UTM False
3425
- Easting [0-9] Pos. 5-9, UTM Meter Easting [0-9][0-9][0-9][0-9][0-9] Pos. 10-11,
3426
- UTM False Northing [0-9][0-9] Pos. 12-16, UTM Meter Northing
3427
- [0-9][0-9][0-9][0-9][0-9].
3428
- """
3429
-
3430
- wac: Optional[str] = None
3431
- """
3432
- World Aeronautical Chart identifier for the area in which a designated operating
3433
- unit is located.
3434
- """
3435
-
3436
-
3437
- class EntityGetAllTypesResponseItemRfBand(BaseModel):
3438
- classification_marking: str = FieldInfo(alias="classificationMarking")
3439
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
3440
-
3441
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
3442
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
3443
-
3444
- EXERCISE: Data pertaining to a government or military exercise. The data
3445
- may include both real and simulated data.
3446
-
3447
- REAL: Data collected or produced that pertains to real-world objects,
3448
- events, and analysis.
3449
-
3450
- SIMULATED: Synthetic data generated by a model to mimic real-world
3451
- datasets.
3452
-
3453
- TEST: Specific datasets used to evaluate compliance with specifications and
3454
- requirements, and for validating technical, functional, and performance
3455
- characteristics.
3456
- """
3457
-
3458
- id_entity: str = FieldInfo(alias="idEntity")
3459
- """Unique identifier of the parent Entity which uses this band."""
3460
-
3461
- name: str
3462
- """RF Band name."""
3463
-
3464
- source: str
3465
- """Source of the data."""
3466
-
3467
- id: Optional[str] = None
3468
- """Unique identifier of the record, auto-generated by the system."""
3469
-
3470
- band: Optional[str] = None
3471
- """Name of the band of this RF range (e.g.
3472
-
3473
- X,K,Ku,Ka,L,S,C,UHF,VHF,EHF,SHF,UNK,VLF,HF,E,Q,V,W). See RFBandType for more
3474
- details and descriptions of each band name.
3475
- """
3476
-
3477
- bandwidth: Optional[float] = None
3478
- """RF Band frequency range bandwidth in Mhz."""
3479
-
3480
- beamwidth: Optional[float] = None
3481
- """
3482
- Angle between the half-power (-3 dB) points of the main lobe of the antenna, in
3483
- degrees.
3484
- """
3485
-
3486
- center_freq: Optional[float] = FieldInfo(alias="centerFreq", default=None)
3487
- """Center frequency of RF frequency range, if applicable, in Mhz."""
3488
-
3489
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
3490
- """Time the row was created in the database, auto-populated by the system."""
3491
-
3492
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
3493
- """
3494
- Application user who created the row in the database, auto-populated by the
3495
- system.
3496
- """
3497
-
3498
- edge_gain: Optional[float] = FieldInfo(alias="edgeGain", default=None)
3499
- """RF Range edge gain, in dBi."""
3500
-
3501
- eirp: Optional[float] = None
3502
- """
3503
- EIRP is defined as the RMS power input in decibel watts required to a lossless
3504
- half-wave dipole antenna to give the same maximum power density far from the
3505
- antenna as the actual transmitter. It is equal to the power input to the
3506
- transmitter's antenna multiplied by the antenna gain relative to a half-wave
3507
- dipole. Effective radiated power and effective isotropic radiated power both
3508
- measure the amount of power a radio transmitter and antenna (or other source of
3509
- electromagnetic waves) radiates in a specific direction: in the direction of
3510
- maximum signal strength (the "main lobe") of its radiation pattern.
3511
- """
3512
-
3513
- erp: Optional[float] = None
3514
- """
3515
- Effective Radiated Power (ERP) is the total power in decibel watts radiated by
3516
- an actual antenna relative to a half-wave dipole rather than a theoretical
3517
- isotropic antenna. A half-wave dipole has a gain of 2.15 dB compared to an
3518
- isotropic antenna. EIRP(dB) = ERP (dB)+2.15 dB or EIRP (W) = 1.64\\**ERP(W).
3519
- Effective radiated power and effective isotropic radiated power both measure the
3520
- amount of power a radio transmitter and antenna (or other source of
3521
- electromagnetic waves) radiates in a specific direction: in the direction of
3522
- maximum signal strength (the "main lobe") of its radiation pattern.
3523
- """
3524
-
3525
- freq_max: Optional[float] = FieldInfo(alias="freqMax", default=None)
3526
- """End/maximum of transmit RF frequency range, if applicable, in Mhz."""
3527
-
3528
- freq_min: Optional[float] = FieldInfo(alias="freqMin", default=None)
3529
- """Start/minimum of transmit RF frequency range, if applicable, in Mhz."""
3530
-
3531
- mode: Optional[Literal["TX", "RX"]] = None
3532
- """RF Band mode (e.g. TX, RX)."""
3533
-
3534
- origin: Optional[str] = None
3535
- """
3536
- Originating system or organization which produced the data, if different from
3537
- the source. The origin may be different than the source if the source was a
3538
- mediating system which forwarded the data on behalf of the origin system. If
3539
- null, the source may be assumed to be the origin.
3540
- """
3541
-
3542
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
3543
- """
3544
- The originating source network on which this record was created, auto-populated
3545
- by the system.
3546
- """
3547
-
3548
- peak_gain: Optional[float] = FieldInfo(alias="peakGain", default=None)
3549
- """RF Range maximum gain, in dBi."""
3550
-
3551
- polarization: Optional[Literal["H", "V", "R", "L"]] = None
3552
- """Transponder polarization e.g.
3553
-
3554
- H - (Horizontally Polarized) Perpendicular to Earth's surface, V - (Vertically
3555
- Polarized) Parallel to Earth's surface, L - (Left Hand Circularly Polarized)
3556
- Rotating left relative to the Earth's surface, R - (Right Hand Circularly
3557
- Polarized) Rotating right relative to the Earth's surface.
3558
- """
3559
-
3560
- purpose: Optional[Literal["COMM", "TTC", "OPS", "OTHER"]] = None
3561
- """
3562
- Purpose or use of the RF Band -- COMM = communications, TTC =
3563
- Telemetry/Tracking/Control, OPS = Operations, OTHER = Other).
3564
- """
3565
-
3566
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
3567
- """Time the row was last updated in the database, auto-populated by the system."""
3568
-
3569
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
3570
- """
3571
- Application user who updated the row in the database, auto-populated by the
3572
- system.
3573
- """
3574
-
3575
-
3576
- class EntityGetAllTypesResponseItemStatusCollectionSubStatusCollection(BaseModel):
3577
- classification_marking: str = FieldInfo(alias="classificationMarking")
3578
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
3579
-
3580
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
3581
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
3582
-
3583
- EXERCISE: Data pertaining to a government or military exercise. The data
3584
- may include both real and simulated data.
3585
-
3586
- REAL: Data collected or produced that pertains to real-world objects,
3587
- events, and analysis.
3588
-
3589
- SIMULATED: Synthetic data generated by a model to mimic real-world
3590
- datasets.
3591
-
3592
- TEST: Specific datasets used to evaluate compliance with specifications and
3593
- requirements, and for validating technical, functional, and performance
3594
- characteristics.
3595
- """
3596
-
3597
- notes: str
3598
- """Descriptions and/or comments associated with the sub-status."""
3599
-
3600
- source: str
3601
- """Source of the data."""
3602
-
3603
- status: Literal["FMC", "NMC", "PMC", "UNK"]
3604
- """Status of the sub-system/capability, e.g. FMC, NMC, PMC, UNK."""
3605
-
3606
- status_id: str = FieldInfo(alias="statusId")
3607
- """Id of the parent status."""
3608
-
3609
- type: Literal["mwCap", "ssCap", "mdCap"]
3610
- """Parent entity's sub-system or capability status: mwCap, mdCap, ssCap, etc."""
3611
-
3612
- id: Optional[str] = None
3613
- """Unique identifier of the record, auto-generated by the system."""
3614
-
3615
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
3616
- """Time the row was created in the database, auto-populated by the system."""
3617
-
3618
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
3619
- """
3620
- Application user who created the row in the database, auto-populated by the
3621
- system.
3622
- """
3623
-
3624
- origin: Optional[str] = None
3625
- """
3626
- Originating system or organization which produced the data, if different from
3627
- the source. The origin may be different than the source if the source was a
3628
- mediating system which forwarded the data on behalf of the origin system. If
3629
- null, the source may be assumed to be the origin.
3630
- """
3631
-
3632
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
3633
- """
3634
- The originating source network on which this record was created, auto-populated
3635
- by the system.
3636
- """
3637
-
3638
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
3639
- """Time the row was updated in the database, auto-populated by the system."""
3640
-
3641
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
3642
- """
3643
- Application user who updated the row in the database, auto-populated by the
3644
- system.
3645
- """
3646
-
3647
-
3648
- class EntityGetAllTypesResponseItemStatusCollection(BaseModel):
3649
- classification_marking: str = FieldInfo(alias="classificationMarking")
3650
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
3651
-
3652
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
3653
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
3654
-
3655
- EXERCISE: Data pertaining to a government or military exercise. The data
3656
- may include both real and simulated data.
3657
-
3658
- REAL: Data collected or produced that pertains to real-world objects,
3659
- events, and analysis.
3660
-
3661
- SIMULATED: Synthetic data generated by a model to mimic real-world
3662
- datasets.
3663
-
3664
- TEST: Specific datasets used to evaluate compliance with specifications and
3665
- requirements, and for validating technical, functional, and performance
3666
- characteristics.
3667
- """
3668
-
3669
- id_entity: str = FieldInfo(alias="idEntity")
3670
- """Unique identifier of the parent entity."""
3671
-
3672
- source: str
3673
- """Source of the data."""
3674
-
3675
- id: Optional[str] = None
3676
- """Unique identifier of the record, auto-generated by the system."""
3677
-
3678
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
3679
- """Time the row was created in the database, auto-populated by the system."""
3680
-
3681
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
3682
- """
3683
- Application user who created the row in the database, auto-populated by the
3684
- system.
3685
- """
3686
-
3687
- declassification_date: Optional[datetime] = FieldInfo(alias="declassificationDate", default=None)
3688
- """The declassification date of this data, in ISO 8601 UTC format."""
3689
-
3690
- declassification_string: Optional[str] = FieldInfo(alias="declassificationString", default=None)
3691
- """Declassification string of this data."""
3692
-
3693
- derived_from: Optional[str] = FieldInfo(alias="derivedFrom", default=None)
3694
- """
3695
- The sources or SCG references from which the classification of this data is
3696
- derived.
3697
- """
3698
-
3699
- notes: Optional[str] = None
3700
- """Comments describing the status creation and or updates to an entity."""
3701
-
3702
- ops_cap: Optional[Literal["FMC", "NMC", "PMC", "UNK"]] = FieldInfo(alias="opsCap", default=None)
3703
- """Operation capability of the entity, if applicable (e.g. FMC, NMC, PMC, UNK)."""
3704
-
3705
- origin: Optional[str] = None
3706
- """
3707
- Originating system or organization which produced the data, if different from
3708
- the source. The origin may be different than the source if the source was a
3709
- mediating system which forwarded the data on behalf of the origin system. If
3710
- null, the source may be assumed to be the origin.
3711
- """
3712
-
3713
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
3714
- """
3715
- The originating source network on which this record was created, auto-populated
3716
- by the system.
3717
- """
3718
-
3719
- state: Optional[Literal["UNKNOWN", "DEAD", "ACTIVE", "RF ACTIVE", "STANDBY"]] = None
3720
- """Overall state of the entity, if applicable (e.g.
3721
-
3722
- UNKNOWN, DEAD, ACTIVE, RF ACTIVE, STANDBY).
3723
- """
3724
-
3725
- sub_status_collection: Optional[List[EntityGetAllTypesResponseItemStatusCollectionSubStatusCollection]] = FieldInfo(
3726
- alias="subStatusCollection", default=None
3727
- )
3728
-
3729
- sys_cap: Optional[Literal["FMC", "NMC", "PMC", "UNK"]] = FieldInfo(alias="sysCap", default=None)
3730
- """System capability of the entity, if applicable (e.g. FMC, NMC, PMC, UNK)."""
3731
-
3732
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
3733
- """Time the row was last updated in the database, auto-populated by the system."""
3734
-
3735
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
3736
- """
3737
- Application user who updated the row in the database, auto-populated by the
3738
- system.
3739
- """
3740
-
3741
-
3742
- class EntityGetAllTypesResponseItem(BaseModel):
3743
- classification_marking: str = FieldInfo(alias="classificationMarking")
3744
- """Classification marking of the data in IC/CAPCO Portion-marked format."""
3745
-
3746
- data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"] = FieldInfo(alias="dataMode")
3747
- """Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
3748
-
3749
- EXERCISE: Data pertaining to a government or military exercise. The data
3750
- may include both real and simulated data.
3751
-
3752
- REAL: Data collected or produced that pertains to real-world objects,
3753
- events, and analysis.
3754
-
3755
- SIMULATED: Synthetic data generated by a model to mimic real-world
3756
- datasets.
3757
-
3758
- TEST: Specific datasets used to evaluate compliance with specifications and
3759
- requirements, and for validating technical, functional, and performance
3760
- characteristics.
3761
- """
3762
-
3763
- name: str
3764
- """Unique entity name."""
3765
-
3766
- source: str
3767
- """Source of the data."""
3768
-
3769
- type: Literal[
3770
- "AIRCRAFT", "BUS", "COMM", "IR", "NAVIGATION", "ONORBIT", "RFEMITTER", "SCIENTIFIC", "SENSOR", "SITE", "VESSEL"
3771
- ]
3772
- """
3773
- The type of entity represented by this record (AIRCRAFT, BUS, COMM, IR,
3774
- NAVIGATION, ONORBIT, RFEMITTER, SCIENTIFIC, SENSOR, SITE, VESSEL).
3775
- """
3776
-
3777
- country_code: Optional[str] = FieldInfo(alias="countryCode", default=None)
3778
- """The country code.
3779
-
3780
- This value is typically the ISO 3166 Alpha-2 two-character country code, however
3781
- it can also represent various consortiums that do not appear in the ISO
3782
- document. The code must correspond to an existing country in the UDL’s country
3783
- API. Call udl/country/{code} to get any associated FIPS code, ISO Alpha-3 code,
3784
- or alternate code values that exist for the specified country code.
3785
- """
3786
-
3787
- created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
3788
- """Time the row was created in the database, auto-populated by the system."""
3789
-
3790
- created_by: Optional[str] = FieldInfo(alias="createdBy", default=None)
3791
- """
3792
- Application user who created the row in the database, auto-populated by the
3793
- system.
3794
- """
3795
-
3796
- id_entity: Optional[str] = FieldInfo(alias="idEntity", default=None)
3797
- """Unique identifier of the record."""
3798
-
3799
- id_location: Optional[str] = FieldInfo(alias="idLocation", default=None)
3800
- """Unique identifier of the entity location, if terrestrial/fixed."""
3801
-
3802
- id_on_orbit: Optional[str] = FieldInfo(alias="idOnOrbit", default=None)
3803
- """Onorbit identifier if this entity is part of an on-orbit object.
3804
-
3805
- For the public catalog, the idOnOrbit is typically the satellite number as a
3806
- string, but may be a UUID for analyst or other unknown or untracked satellites.
3807
- """
3808
-
3809
- id_operating_unit: Optional[str] = FieldInfo(alias="idOperatingUnit", default=None)
3810
- """Unique identifier of the associated operating unit object."""
3811
-
3812
- location: Optional[EntityGetAllTypesResponseItemLocation] = None
3813
- """
3814
- Model representation of a location, which is a specific fixed point on the earth
3815
- and is used to denote the locations of fixed sensors, operating units, etc.
3816
- """
3817
-
3818
- on_orbit: Optional[EntityGetAllTypesResponseItemOnOrbit] = FieldInfo(alias="onOrbit", default=None)
3819
- """Model object representing on-orbit objects or satellites in the system."""
3820
-
3821
- operating_unit: Optional[EntityGetAllTypesResponseItemOperatingUnit] = FieldInfo(
3822
- alias="operatingUnit", default=None
3823
- )
3824
- """
3825
- Model representation of a unit or organization which operates or controls a
3826
- space-related Entity such as an on-orbit payload, a sensor, etc. A contact may
3827
- belong to an organization.
3828
- """
3829
-
3830
- origin: Optional[str] = None
3831
- """
3832
- Originating system or organization which produced the data, if different from
3833
- the source. The origin may be different than the source if the source was a
3834
- mediating system which forwarded the data on behalf of the origin system. If
3835
- null, the source may be assumed to be the origin.
3836
- """
3837
-
3838
- orig_network: Optional[str] = FieldInfo(alias="origNetwork", default=None)
3839
- """
3840
- The originating source network on which this record was created, auto-populated
3841
- by the system.
3842
- """
3843
-
3844
- owner_type: Optional[Literal["Commercial", "Government", "Academic", "Consortium", "Other"]] = FieldInfo(
3845
- alias="ownerType", default=None
3846
- )
3847
- """Type of organization which owns this entity (e.g.
3848
-
3849
- Commercial, Government, Academic, Consortium, etc).
3850
- """
3851
-
3852
- rf_bands: Optional[List[EntityGetAllTypesResponseItemRfBand]] = FieldInfo(alias="rfBands", default=None)
3853
- """
3854
- Read-only collection of RF bands utilized by this entity for communication
3855
- and/or operation.
3856
- """
3857
-
3858
- status_collection: Optional[List[EntityGetAllTypesResponseItemStatusCollection]] = FieldInfo(
3859
- alias="statusCollection", default=None
3860
- )
3861
- """Read-only collection of statuses which can be collected by multiple sources."""
3862
-
3863
- taskable: Optional[bool] = None
3864
- """Boolean indicating if this entity is taskable."""
3865
-
3866
- updated_at: Optional[datetime] = FieldInfo(alias="updatedAt", default=None)
3867
- """Time the row was last updated in the database, auto-populated by the system."""
3868
-
3869
- updated_by: Optional[str] = FieldInfo(alias="updatedBy", default=None)
3870
- """
3871
- Application user who updated the row in the database, auto-populated by the
3872
- system.
3873
- """
3874
-
3875
- urls: Optional[List[str]] = None
3876
- """List of URLs to additional details/documents for this entity."""
3877
-
3878
-
3879
- EntityGetAllTypesResponse: TypeAlias = List[EntityGetAllTypesResponseItem]
8
+ EntityGetAllTypesResponse: TypeAlias = List[str]