udl-sdk 0.1.0a16__py3-none-any.whl → 0.1.0a18__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 (147) hide show
  1. {udl_sdk-0.1.0a16.dist-info → udl_sdk-0.1.0a18.dist-info}/METADATA +1 -1
  2. {udl_sdk-0.1.0a16.dist-info → udl_sdk-0.1.0a18.dist-info}/RECORD +136 -129
  3. unifieddatalibrary/_client.py +113 -82
  4. unifieddatalibrary/_version.py +1 -1
  5. unifieddatalibrary/resources/__init__.py +28 -84
  6. unifieddatalibrary/resources/air_operations/__init__.py +0 -14
  7. unifieddatalibrary/resources/air_operations/air_operations.py +0 -32
  8. unifieddatalibrary/resources/air_operations/aircraft_sorties.py +1507 -37
  9. unifieddatalibrary/resources/air_operations/crewpapers.py +4 -4
  10. unifieddatalibrary/resources/airload_plans.py +1311 -59
  11. unifieddatalibrary/resources/attitude_sets/attitude_sets.py +106 -0
  12. unifieddatalibrary/resources/conjunctions/conjunctions.py +4 -4
  13. unifieddatalibrary/resources/gnss_raw_if/gnss_raw_if.py +801 -0
  14. unifieddatalibrary/resources/iono_observations/__init__.py +33 -0
  15. unifieddatalibrary/resources/{iono_observation → iono_observations}/history.py +2 -2
  16. unifieddatalibrary/resources/{ion_oobservation.py → iono_observations/iono_observations.py} +123 -91
  17. unifieddatalibrary/resources/logistics_support/logistics_support.py +5 -4
  18. unifieddatalibrary/resources/onorbitantenna.py +5 -4
  19. unifieddatalibrary/resources/onorbitbattery.py +5 -4
  20. unifieddatalibrary/resources/onorbitsolararray.py +5 -4
  21. unifieddatalibrary/resources/onorbitthruster.py +5 -4
  22. unifieddatalibrary/resources/{report_and_activity → report_and_activities}/__init__.py +13 -13
  23. unifieddatalibrary/resources/{report_and_activity → report_and_activities}/poi/history.py +2 -2
  24. unifieddatalibrary/resources/{report_and_activity/report_and_activity.py → report_and_activities/report_and_activities.py} +35 -35
  25. unifieddatalibrary/resources/{report_and_activity → report_and_activities}/udl_h3geo.py +1 -1
  26. unifieddatalibrary/resources/{report_and_activity → report_and_activities}/udl_sigact.py +1 -1
  27. unifieddatalibrary/resources/scs/paths.py +4 -4
  28. unifieddatalibrary/resources/scs/scs.py +4 -4
  29. unifieddatalibrary/resources/scs/v2.py +4 -4
  30. unifieddatalibrary/resources/status.py +5 -4
  31. unifieddatalibrary/resources/supporting_data/__init__.py +0 -42
  32. unifieddatalibrary/resources/supporting_data/dataowner.py +257 -1
  33. unifieddatalibrary/resources/supporting_data/supporting_data.py +0 -96
  34. unifieddatalibrary/resources/track_route/track_route.py +26 -23
  35. unifieddatalibrary/types/__init__.py +40 -30
  36. unifieddatalibrary/types/air_operations/__init__.py +12 -12
  37. unifieddatalibrary/types/air_operations/{aircraft_sortie_list_params.py → aircraft_sorty_count_params.py} +2 -2
  38. unifieddatalibrary/types/air_operations/aircraft_sorty_count_response.py +7 -0
  39. unifieddatalibrary/types/air_operations/{aircraft_sortie_create_bulk_params.py → aircraft_sorty_create_bulk_params.py} +2 -2
  40. unifieddatalibrary/types/air_operations/{aircraft_sortie_create_params.py → aircraft_sorty_create_params.py} +2 -2
  41. unifieddatalibrary/types/air_operations/{aircraft_sortie_history_aodr_params.py → aircraft_sorty_history_aodr_params.py} +2 -2
  42. unifieddatalibrary/types/air_operations/{aircraft_sortie_history_count_params.py → aircraft_sorty_history_count_params.py} +2 -2
  43. unifieddatalibrary/types/{ion_oobservation_count_response.py → air_operations/aircraft_sorty_history_count_response.py} +2 -2
  44. unifieddatalibrary/types/air_operations/{aircraft_sortie_history_query_params.py → aircraft_sorty_history_query_params.py} +2 -2
  45. unifieddatalibrary/types/air_operations/{aircraft_sortie_history_query_response.py → aircraft_sorty_history_query_response.py} +2 -2
  46. unifieddatalibrary/types/air_operations/{aircraft_sortie_count_params.py → aircraft_sorty_list_params.py} +2 -2
  47. unifieddatalibrary/types/{air_load_plan_count_params.py → airload_plan_count_params.py} +2 -2
  48. unifieddatalibrary/types/{air_load_plan_count_response.py → airload_plan_count_response.py} +2 -2
  49. unifieddatalibrary/types/{air_load_plan_create_params.py → airload_plan_create_params.py} +2 -2
  50. unifieddatalibrary/types/{air_load_plan_list_params.py → airload_plan_list_params.py} +2 -2
  51. unifieddatalibrary/types/{air_load_plan_queryhelp_response.py → airload_plan_queryhelp_response.py} +2 -2
  52. unifieddatalibrary/types/{air_load_plan_retrieve_params.py → airload_plan_retrieve_params.py} +2 -2
  53. unifieddatalibrary/types/{air_load_plan_tuple_params.py → airload_plan_tuple_params.py} +2 -2
  54. unifieddatalibrary/types/{air_load_plan_tuple_response.py → airload_plan_tuple_response.py} +2 -2
  55. unifieddatalibrary/types/altitude_blocks_ingest_param.py +22 -0
  56. unifieddatalibrary/types/{attitudeset_retrieve_params.py → attitude_set_retrieve_params.py} +2 -2
  57. unifieddatalibrary/types/{gnss_rawif_count_params.py → gnss_raw_if_count_params.py} +2 -2
  58. unifieddatalibrary/types/{gnss_rawif_count_response.py → gnss_raw_if_count_response.py} +2 -2
  59. unifieddatalibrary/types/{gnss_rawif_file_get_params.py → gnss_raw_if_file_get_params.py} +2 -2
  60. unifieddatalibrary/types/{gnss_rawif_get_params.py → gnss_raw_if_get_params.py} +2 -2
  61. unifieddatalibrary/types/{gnss_rawif_get_response.py → gnss_raw_if_get_response.py} +2 -2
  62. unifieddatalibrary/types/{gnss_rawif_list_params.py → gnss_raw_if_list_params.py} +2 -2
  63. unifieddatalibrary/types/{gnss_rawif_list_response.py → gnss_raw_if_list_response.py} +2 -2
  64. unifieddatalibrary/types/{gnss_rawif_queryhelp_response.py → gnss_raw_if_queryhelp_response.py} +2 -2
  65. unifieddatalibrary/types/{gnss_rawif_tuple_params.py → gnss_raw_if_tuple_params.py} +2 -2
  66. unifieddatalibrary/types/{gnss_rawif_tuple_response.py → gnss_raw_if_tuple_response.py} +3 -3
  67. unifieddatalibrary/types/{gnss_rawif_upload_zip_params.py → gnss_raw_if_upload_zip_params.py} +2 -2
  68. unifieddatalibrary/types/{ion_oobservation_count_params.py → iono_observation_count_params.py} +2 -2
  69. unifieddatalibrary/types/{air_operations/aircraft_sortie_count_response.py → iono_observation_count_response.py} +2 -2
  70. unifieddatalibrary/types/{ion_oobservation_create_bulk_params.py → iono_observation_create_bulk_params.py} +2 -2
  71. unifieddatalibrary/types/{ion_oobservation_list_params.py → iono_observation_list_params.py} +2 -2
  72. unifieddatalibrary/types/{ion_oobservation_list_response.py → iono_observation_list_response.py} +2 -2
  73. unifieddatalibrary/types/{ion_oobservation_queryhelp_response.py → iono_observation_queryhelp_response.py} +2 -2
  74. unifieddatalibrary/types/{ion_oobservation_tuple_params.py → iono_observation_tuple_params.py} +2 -2
  75. unifieddatalibrary/types/{ion_oobservation_tuple_response.py → iono_observation_tuple_response.py} +82 -82
  76. unifieddatalibrary/types/{ion_oobservation_unvalidated_publish_params.py → iono_observation_unvalidated_publish_params.py} +2 -2
  77. unifieddatalibrary/types/logistics_remarks_ingest_param.py +25 -0
  78. unifieddatalibrary/types/logistics_support_create_bulk_params.py +4 -51
  79. unifieddatalibrary/types/logistics_support_create_params.py +4 -49
  80. unifieddatalibrary/types/logistics_support_unvalidated_publish_params.py +4 -51
  81. unifieddatalibrary/types/logistics_support_update_params.py +4 -49
  82. unifieddatalibrary/types/onorbitantenna_create_params.py +3 -38
  83. unifieddatalibrary/types/onorbitantenna_update_params.py +3 -38
  84. unifieddatalibrary/types/onorbitbattery_create_params.py +3 -38
  85. unifieddatalibrary/types/onorbitbattery_update_params.py +3 -38
  86. unifieddatalibrary/types/onorbitsolararray_create_params.py +3 -38
  87. unifieddatalibrary/types/onorbitsolararray_update_params.py +3 -38
  88. unifieddatalibrary/types/onorbitthruster_create_params.py +3 -41
  89. unifieddatalibrary/types/onorbitthruster_update_params.py +3 -41
  90. unifieddatalibrary/types/point_of_contact_ingest_param.py +41 -0
  91. unifieddatalibrary/types/route_points_ingest_param.py +82 -0
  92. unifieddatalibrary/types/shared/__init__.py +5 -0
  93. unifieddatalibrary/types/shared/antenna_ingest.py +62 -0
  94. unifieddatalibrary/types/shared/battery_ingest.py +62 -0
  95. unifieddatalibrary/types/shared/engine_ingest.py +65 -0
  96. unifieddatalibrary/types/shared/solar_array_ingest.py +62 -0
  97. unifieddatalibrary/types/shared/sub_status_ingest.py +74 -0
  98. unifieddatalibrary/types/shared_params/__init__.py +5 -0
  99. unifieddatalibrary/types/shared_params/antenna_ingest.py +45 -0
  100. unifieddatalibrary/types/shared_params/battery_ingest.py +45 -0
  101. unifieddatalibrary/types/shared_params/engine_ingest.py +48 -0
  102. unifieddatalibrary/types/shared_params/solar_array_ingest.py +45 -0
  103. unifieddatalibrary/types/shared_params/sub_status_ingest.py +57 -0
  104. unifieddatalibrary/types/status_create_params.py +3 -50
  105. unifieddatalibrary/types/status_update_params.py +3 -50
  106. unifieddatalibrary/types/supporting_data/__init__.py +13 -5
  107. unifieddatalibrary/types/supporting_data/{query_help_retrieve_response.py → dataowner_query_help_response.py} +2 -2
  108. unifieddatalibrary/types/supporting_data/{dataowner_type_list_params.py → dataowner_retrieve_data_owner_types_params.py} +2 -2
  109. unifieddatalibrary/types/supporting_data/dataowner_retrieve_data_owner_types_response.py +8 -0
  110. unifieddatalibrary/types/supporting_data/{provider_metadata_retrieve_params.py → dataowner_retrieve_provider_metadata_params.py} +2 -2
  111. unifieddatalibrary/types/supporting_data/{provider_metadata_retrieve_response.py → dataowner_retrieve_provider_metadata_response.py} +2 -2
  112. unifieddatalibrary/types/track_route_create_bulk_params.py +5 -267
  113. unifieddatalibrary/types/track_route_create_params.py +7 -122
  114. unifieddatalibrary/types/track_route_ingest_param.py +157 -0
  115. unifieddatalibrary/types/track_route_unvalidated_publish_params.py +7 -122
  116. unifieddatalibrary/types/track_route_update_params.py +7 -122
  117. unifieddatalibrary/resources/air_load_plans.py +0 -1341
  118. unifieddatalibrary/resources/air_operations/aircraft_sortie.py +0 -1557
  119. unifieddatalibrary/resources/attitudesets.py +0 -191
  120. unifieddatalibrary/resources/gnss_rawif.py +0 -871
  121. unifieddatalibrary/resources/iono_observation/__init__.py +0 -33
  122. unifieddatalibrary/resources/iono_observation/iono_observation.py +0 -102
  123. unifieddatalibrary/resources/supporting_data/dataowner_types.py +0 -186
  124. unifieddatalibrary/resources/supporting_data/provider_metadata.py +0 -179
  125. unifieddatalibrary/resources/supporting_data/query_help.py +0 -141
  126. unifieddatalibrary/types/air_operations/aircraft_sortie_history_count_response.py +0 -7
  127. unifieddatalibrary/types/supporting_data/dataowner_type_list_response.py +0 -7
  128. {udl_sdk-0.1.0a16.dist-info → udl_sdk-0.1.0a18.dist-info}/WHEEL +0 -0
  129. {udl_sdk-0.1.0a16.dist-info → udl_sdk-0.1.0a18.dist-info}/licenses/LICENSE +0 -0
  130. /unifieddatalibrary/resources/{report_and_activity → report_and_activities}/poi/__init__.py +0 -0
  131. /unifieddatalibrary/resources/{report_and_activity → report_and_activities}/poi/poi.py +0 -0
  132. /unifieddatalibrary/types/{iono_observation → iono_observations}/__init__.py +0 -0
  133. /unifieddatalibrary/types/{iono_observation → iono_observations}/history_aodr_params.py +0 -0
  134. /unifieddatalibrary/types/{iono_observation → iono_observations}/history_count_params.py +0 -0
  135. /unifieddatalibrary/types/{iono_observation → iono_observations}/history_count_response.py +0 -0
  136. /unifieddatalibrary/types/{iono_observation → iono_observations}/history_list_params.py +0 -0
  137. /unifieddatalibrary/types/{iono_observation → iono_observations}/history_list_response.py +0 -0
  138. /unifieddatalibrary/types/{report_and_activity → report_and_activities}/__init__.py +0 -0
  139. /unifieddatalibrary/types/{report_and_activity → report_and_activities}/poi/__init__.py +0 -0
  140. /unifieddatalibrary/types/{report_and_activity → report_and_activities}/poi/history_aodr_params.py +0 -0
  141. /unifieddatalibrary/types/{report_and_activity → report_and_activities}/poi/history_count_params.py +0 -0
  142. /unifieddatalibrary/types/{report_and_activity → report_and_activities}/poi/history_count_response.py +0 -0
  143. /unifieddatalibrary/types/{report_and_activity → report_and_activities}/poi/history_list_params.py +0 -0
  144. /unifieddatalibrary/types/{report_and_activity → report_and_activities}/poi/history_list_response.py +0 -0
  145. /unifieddatalibrary/types/{report_and_activity → report_and_activities}/udl_h3geo_unvalidated_publish_params.py +0 -0
  146. /unifieddatalibrary/types/{report_and_activity → report_and_activities}/udl_sigact_file_get_params.py +0 -0
  147. /unifieddatalibrary/types/{report_and_activity → report_and_activities}/udl_sigact_unvalidated_publish_params.py +0 -0
@@ -8,7 +8,14 @@ from typing_extensions import Literal
8
8
 
9
9
  import httpx
10
10
 
11
- from ..types import airload_plan_update_params
11
+ from ..types import (
12
+ airload_plan_list_params,
13
+ airload_plan_count_params,
14
+ airload_plan_tuple_params,
15
+ airload_plan_create_params,
16
+ airload_plan_update_params,
17
+ airload_plan_retrieve_params,
18
+ )
12
19
  from .._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
13
20
  from .._utils import maybe_transform, async_maybe_transform
14
21
  from .._compat import cached_property
@@ -19,50 +26,1051 @@ from .._response import (
19
26
  async_to_raw_response_wrapper,
20
27
  async_to_streamed_response_wrapper,
21
28
  )
22
- from .._base_client import make_request_options
29
+ from ..pagination import SyncOffsetPage, AsyncOffsetPage
30
+ from .._base_client import AsyncPaginator, make_request_options
31
+ from ..types.airloadplan_abridged import AirloadplanAbridged
32
+ from ..types.shared.airloadplan_full import AirloadplanFull
33
+ from ..types.airload_plan_tuple_response import AirloadPlanTupleResponse
34
+ from ..types.airload_plan_queryhelp_response import AirloadPlanQueryhelpResponse
35
+
36
+ __all__ = ["AirloadPlansResource", "AsyncAirloadPlansResource"]
37
+
38
+
39
+ class AirloadPlansResource(SyncAPIResource):
40
+ @cached_property
41
+ def with_raw_response(self) -> AirloadPlansResourceWithRawResponse:
42
+ """
43
+ This property can be used as a prefix for any HTTP method call to return
44
+ the raw response object instead of the parsed content.
45
+
46
+ For more information, see https://www.github.com/Bluestaq/udl-python-sdk#accessing-raw-response-data-eg-headers
47
+ """
48
+ return AirloadPlansResourceWithRawResponse(self)
49
+
50
+ @cached_property
51
+ def with_streaming_response(self) -> AirloadPlansResourceWithStreamingResponse:
52
+ """
53
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
54
+
55
+ For more information, see https://www.github.com/Bluestaq/udl-python-sdk#with_streaming_response
56
+ """
57
+ return AirloadPlansResourceWithStreamingResponse(self)
58
+
59
+ def create(
60
+ self,
61
+ *,
62
+ classification_marking: str,
63
+ data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"],
64
+ est_dep_time: Union[str, datetime],
65
+ source: str,
66
+ id: str | NotGiven = NOT_GIVEN,
67
+ acl_onboard: float | NotGiven = NOT_GIVEN,
68
+ acl_released: float | NotGiven = NOT_GIVEN,
69
+ aircraft_mds: str | NotGiven = NOT_GIVEN,
70
+ air_load_plan_hazmat_actuals: Iterable[airload_plan_create_params.AirLoadPlanHazmatActual]
71
+ | NotGiven = NOT_GIVEN,
72
+ air_load_plan_hr: Iterable[airload_plan_create_params.AirLoadPlanHr] | NotGiven = NOT_GIVEN,
73
+ air_load_plan_pallet_details: Iterable[airload_plan_create_params.AirLoadPlanPalletDetail]
74
+ | NotGiven = NOT_GIVEN,
75
+ air_load_plan_pax_cargo: Iterable[airload_plan_create_params.AirLoadPlanPaxCargo] | NotGiven = NOT_GIVEN,
76
+ air_load_plan_uln_actuals: Iterable[airload_plan_create_params.AirLoadPlanUlnActual] | NotGiven = NOT_GIVEN,
77
+ arr_airfield: str | NotGiven = NOT_GIVEN,
78
+ arr_icao: str | NotGiven = NOT_GIVEN,
79
+ available_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
80
+ basic_moment: float | NotGiven = NOT_GIVEN,
81
+ basic_weight: float | NotGiven = NOT_GIVEN,
82
+ brief_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
83
+ call_sign: str | NotGiven = NOT_GIVEN,
84
+ cargo_bay_fs_max: float | NotGiven = NOT_GIVEN,
85
+ cargo_bay_fs_min: float | NotGiven = NOT_GIVEN,
86
+ cargo_bay_width: float | NotGiven = NOT_GIVEN,
87
+ cargo_config: str | NotGiven = NOT_GIVEN,
88
+ cargo_moment: float | NotGiven = NOT_GIVEN,
89
+ cargo_volume: float | NotGiven = NOT_GIVEN,
90
+ cargo_weight: float | NotGiven = NOT_GIVEN,
91
+ crew_size: int | NotGiven = NOT_GIVEN,
92
+ dep_airfield: str | NotGiven = NOT_GIVEN,
93
+ dep_icao: str | NotGiven = NOT_GIVEN,
94
+ equip_config: str | NotGiven = NOT_GIVEN,
95
+ est_arr_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
96
+ est_landing_fuel_moment: float | NotGiven = NOT_GIVEN,
97
+ est_landing_fuel_weight: float | NotGiven = NOT_GIVEN,
98
+ external_id: str | NotGiven = NOT_GIVEN,
99
+ fuel_moment: float | NotGiven = NOT_GIVEN,
100
+ fuel_weight: float | NotGiven = NOT_GIVEN,
101
+ gross_cg: float | NotGiven = NOT_GIVEN,
102
+ gross_moment: float | NotGiven = NOT_GIVEN,
103
+ gross_weight: float | NotGiven = NOT_GIVEN,
104
+ id_mission: str | NotGiven = NOT_GIVEN,
105
+ id_sortie: str | NotGiven = NOT_GIVEN,
106
+ landing_cg: float | NotGiven = NOT_GIVEN,
107
+ landing_moment: float | NotGiven = NOT_GIVEN,
108
+ landing_weight: float | NotGiven = NOT_GIVEN,
109
+ leg_num: int | NotGiven = NOT_GIVEN,
110
+ loadmaster_name: str | NotGiven = NOT_GIVEN,
111
+ loadmaster_rank: str | NotGiven = NOT_GIVEN,
112
+ load_remarks: str | NotGiven = NOT_GIVEN,
113
+ mission_number: str | NotGiven = NOT_GIVEN,
114
+ operating_moment: float | NotGiven = NOT_GIVEN,
115
+ operating_weight: float | NotGiven = NOT_GIVEN,
116
+ origin: str | NotGiven = NOT_GIVEN,
117
+ pp_onboard: int | NotGiven = NOT_GIVEN,
118
+ pp_released: int | NotGiven = NOT_GIVEN,
119
+ sched_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
120
+ seats_onboard: int | NotGiven = NOT_GIVEN,
121
+ seats_released: int | NotGiven = NOT_GIVEN,
122
+ tail_number: str | NotGiven = NOT_GIVEN,
123
+ tank_config: str | NotGiven = NOT_GIVEN,
124
+ util_code: str | NotGiven = NOT_GIVEN,
125
+ zero_fuel_cg: float | NotGiven = NOT_GIVEN,
126
+ zero_fuel_moment: float | NotGiven = NOT_GIVEN,
127
+ zero_fuel_weight: float | NotGiven = NOT_GIVEN,
128
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
129
+ # The extra values given here take precedence over values defined on the client or passed to this method.
130
+ extra_headers: Headers | None = None,
131
+ extra_query: Query | None = None,
132
+ extra_body: Body | None = None,
133
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
134
+ ) -> None:
135
+ """
136
+ Service operation to take a single airloadplan record as a POST body and ingest
137
+ into the database. A specific role is required to perform this service
138
+ operation. Please contact the UDL team for assistance.
139
+
140
+ Args:
141
+ classification_marking: Classification marking of the data in IC/CAPCO Portion-marked format.
142
+
143
+ data_mode:
144
+ Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
145
+
146
+ EXERCISE: Data pertaining to a government or military exercise. The data
147
+ may include both real and simulated data.
148
+
149
+ REAL: Data collected or produced that pertains to real-world objects,
150
+ events, and analysis.
151
+
152
+ SIMULATED: Synthetic data generated by a model to mimic real-world
153
+ datasets.
154
+
155
+ TEST: Specific datasets used to evaluate compliance with specifications and
156
+ requirements, and for validating technical, functional, and performance
157
+ characteristics.
158
+
159
+ est_dep_time: The current estimated time that the aircraft is planned to depart, in ISO 8601
160
+ UTC format with millisecond precision.
161
+
162
+ source: Source of the data.
163
+
164
+ id: Unique identifier of the record, auto-generated by the system.
165
+
166
+ acl_onboard: Allowable Cabin Load (ACL) onboard the aircraft. The maximum weight of
167
+ passengers, baggage, and cargo that can be safely transported in the aircraft
168
+ cabin, in kilograms.
169
+
170
+ acl_released: Allowable Cabin Load (ACL) released this leg. The weight of passengers, baggage,
171
+ and cargo released from the aircraft cabin, in kilograms.
172
+
173
+ aircraft_mds: The Model Design Series designation of the aircraft supporting this load plan.
174
+
175
+ air_load_plan_hazmat_actuals: Collection of hazmat actuals associated with this load plan.
176
+
177
+ air_load_plan_hr: Collection of human remains transport information associated with this load
178
+ plan.
179
+
180
+ air_load_plan_pallet_details: Collection of cargo information located at the pallet positions associated with
181
+ this load plan.
182
+
183
+ air_load_plan_pax_cargo: Collection of passenger and cargo details associated with this load plan for
184
+ this leg of the mission.
185
+
186
+ air_load_plan_uln_actuals: Collection of unit line number actuals associated with this load plan.
187
+
188
+ arr_airfield: Optional identifier of arrival airfield with no International Civil Organization
189
+ (ICAO) code.
190
+
191
+ arr_icao: The arrival International Civil Organization (ICAO) code of the landing
192
+ airfield.
193
+
194
+ available_time: Time the loadmaster or boom operator is available for cargo loading/unloading,
195
+ in ISO 8601 UTC format with millisecond precision.
196
+
197
+ basic_moment: The basic weight of the aircraft multiplied by the distance between the
198
+ reference datum and the aircraft's center of gravity, in Newton-meters.
199
+
200
+ basic_weight: The weight of the aircraft without passengers, cargo, equipment, or usable fuel,
201
+ in kilograms.
202
+
203
+ brief_time: Time the cargo briefing was given to the loadmaster or boom operator, in ISO
204
+ 8601 UTC format with millisecond precision.
205
+
206
+ call_sign: The call sign of the mission supporting this load plan.
207
+
208
+ cargo_bay_fs_max: Maximum fuselage station (FS) where cargo can be stored. FS is the distance from
209
+ the reference datum, in meters.
210
+
211
+ cargo_bay_fs_min: Minimum fuselage station (FS) where cargo can be stored. FS is the distance from
212
+ the reference datum, in meters.
213
+
214
+ cargo_bay_width: Width of the cargo bay, in meters.
215
+
216
+ cargo_config: The cargo configuration required for this leg (e.g. C-1, C-2, C-3, DV-1, DV-2,
217
+ AE-1, etc.). Configuration meanings are determined by the data source.
218
+
219
+ cargo_moment: The sum of cargo moments of all cargo on board the aircraft, in Newton-meters.
220
+ Each individual cargo moment is the weight of the cargo multiplied by the
221
+ distance between the reference datum and the cargo's center of gravity.
222
+
223
+ cargo_volume: Volume of cargo space in the aircraft, in cubic meters.
224
+
225
+ cargo_weight: The weight of the cargo on board the aircraft, in kilograms.
226
+
227
+ crew_size: The number of crew members on the aircraft.
228
+
229
+ dep_airfield: Optional identifier of departure airfield with no International Civil
230
+ Organization (ICAO) code.
231
+
232
+ dep_icao: The departure International Civil Organization (ICAO) code of the departure
233
+ airfield.
234
+
235
+ equip_config: Description of the equipment configuration (e.g. Standard, Ferry, JBLM, CHS,
236
+ Combat, etc.). Configuration meanings are determined by the data source.
237
+
238
+ est_arr_time: The current estimated time that the aircraft is planned to arrive, in ISO 8601
239
+ UTC format with millisecond precision.
240
+
241
+ est_landing_fuel_moment: The estimated weight of usable fuel upon landing multiplied by the distance
242
+ between the reference datum and the fuel's center of gravity, in Newton-meters.
243
+
244
+ est_landing_fuel_weight: The estimated weight of usable fuel upon landing, in kilograms.
245
+
246
+ external_id: Optional ID from external systems. This field has no meaning within UDL and is
247
+ provided as a convenience for systems that require tracking of an internal
248
+ system generated ID.
249
+
250
+ fuel_moment: The fuel weight on board the aircraft multiplied by the distance between the
251
+ reference datum and the fuel's center of gravity, in Newton-meters.
252
+
253
+ fuel_weight: The weight of usable fuel on board the aircraft, in kilograms.
254
+
255
+ gross_cg: The center of gravity of the aircraft using the gross weight and gross moment,
256
+ as a percentage of the mean aerodynamic chord (%MAC).
257
+
258
+ gross_moment: The sum of moments of all items making up the gross weight of the aircraft, in
259
+ Newton-meters.
260
+
261
+ gross_weight: The total weight of the aircraft at takeoff including passengers, cargo,
262
+ equipment, and usable fuel, in kilograms.
263
+
264
+ id_mission: The UDL ID of the mission this record is associated with.
265
+
266
+ id_sortie: The UDL ID of the aircraft sortie this record is associated with.
267
+
268
+ landing_cg: The center of gravity of the aircraft using the landing weight and landing
269
+ moment, as a percentage of the mean aerodynamic chord (%MAC).
270
+
271
+ landing_moment: The sum of moments of all items making up the gross weight of the aircraft upon
272
+ landing, in Newton-meters.
273
+
274
+ landing_weight: The gross weight of the aircraft upon landing, in kilograms.
275
+
276
+ leg_num: The leg number of the mission supporting this load plan.
277
+
278
+ loadmaster_name: Name of the loadmaster or boom operator who received the cargo briefing.
279
+
280
+ loadmaster_rank: Rank of the loadmaster or boom operator overseeing cargo loading/unloading.
281
+
282
+ load_remarks: Remarks concerning this load plan.
283
+
284
+ mission_number: The mission number of the mission supporting this load plan.
285
+
286
+ operating_moment: The operating weight of the aircraft multiplied by the distance between the
287
+ reference datum and the aircraft's center of gravity, in Newton-meters.
288
+
289
+ operating_weight: The basic weight of the aircraft including passengers and equipment, in
290
+ kilograms.
291
+
292
+ origin: Originating system or organization which produced the data, if different from
293
+ the source. The origin may be different than the source if the source was a
294
+ mediating system which forwarded the data on behalf of the origin system. If
295
+ null, the source may be assumed to be the origin.
296
+
297
+ pp_onboard: Number of pallet positions on the aircraft.
298
+
299
+ pp_released: Number of pallet positions released this leg.
300
+
301
+ sched_time: Time the loadmaster or boom operator is scheduled to begin overseeing cargo
302
+ loading/unloading, in ISO 8601 UTC format with millisecond precision.
303
+
304
+ seats_onboard: Number of passenger seats on the aircraft.
305
+
306
+ seats_released: Number of passenger seats released this leg.
307
+
308
+ tail_number: The tail number of the aircraft supporting this load plan.
309
+
310
+ tank_config: Description of the fuel tank(s) configuration (e.g. ER, NON-ER, etc.).
311
+ Configuration meanings are determined by the data source.
312
+
313
+ util_code: Alphanumeric code that describes general cargo-related utilization and
314
+ characteristics for an itinerary point.
315
+
316
+ zero_fuel_cg: The center of gravity of the aircraft using the zero fuel weight and zero fuel
317
+ total moment, as a percentage of the mean aerodynamic chord (%MAC).
318
+
319
+ zero_fuel_moment: The zero fuel weight of the aircraft multiplied by the distance between the
320
+ reference datum and the aircraft's center of gravity, in Newton-meters.
321
+
322
+ zero_fuel_weight: The operating weight of the aircraft including cargo, mail, baggage, and
323
+ passengers, but without usable fuel, in kilograms.
324
+
325
+ extra_headers: Send extra headers
326
+
327
+ extra_query: Add additional query parameters to the request
328
+
329
+ extra_body: Add additional JSON properties to the request
330
+
331
+ timeout: Override the client-level default timeout for this request, in seconds
332
+ """
333
+ extra_headers = {"Accept": "*/*", **(extra_headers or {})}
334
+ return self._post(
335
+ "/udl/airloadplan",
336
+ body=maybe_transform(
337
+ {
338
+ "classification_marking": classification_marking,
339
+ "data_mode": data_mode,
340
+ "est_dep_time": est_dep_time,
341
+ "source": source,
342
+ "id": id,
343
+ "acl_onboard": acl_onboard,
344
+ "acl_released": acl_released,
345
+ "aircraft_mds": aircraft_mds,
346
+ "air_load_plan_hazmat_actuals": air_load_plan_hazmat_actuals,
347
+ "air_load_plan_hr": air_load_plan_hr,
348
+ "air_load_plan_pallet_details": air_load_plan_pallet_details,
349
+ "air_load_plan_pax_cargo": air_load_plan_pax_cargo,
350
+ "air_load_plan_uln_actuals": air_load_plan_uln_actuals,
351
+ "arr_airfield": arr_airfield,
352
+ "arr_icao": arr_icao,
353
+ "available_time": available_time,
354
+ "basic_moment": basic_moment,
355
+ "basic_weight": basic_weight,
356
+ "brief_time": brief_time,
357
+ "call_sign": call_sign,
358
+ "cargo_bay_fs_max": cargo_bay_fs_max,
359
+ "cargo_bay_fs_min": cargo_bay_fs_min,
360
+ "cargo_bay_width": cargo_bay_width,
361
+ "cargo_config": cargo_config,
362
+ "cargo_moment": cargo_moment,
363
+ "cargo_volume": cargo_volume,
364
+ "cargo_weight": cargo_weight,
365
+ "crew_size": crew_size,
366
+ "dep_airfield": dep_airfield,
367
+ "dep_icao": dep_icao,
368
+ "equip_config": equip_config,
369
+ "est_arr_time": est_arr_time,
370
+ "est_landing_fuel_moment": est_landing_fuel_moment,
371
+ "est_landing_fuel_weight": est_landing_fuel_weight,
372
+ "external_id": external_id,
373
+ "fuel_moment": fuel_moment,
374
+ "fuel_weight": fuel_weight,
375
+ "gross_cg": gross_cg,
376
+ "gross_moment": gross_moment,
377
+ "gross_weight": gross_weight,
378
+ "id_mission": id_mission,
379
+ "id_sortie": id_sortie,
380
+ "landing_cg": landing_cg,
381
+ "landing_moment": landing_moment,
382
+ "landing_weight": landing_weight,
383
+ "leg_num": leg_num,
384
+ "loadmaster_name": loadmaster_name,
385
+ "loadmaster_rank": loadmaster_rank,
386
+ "load_remarks": load_remarks,
387
+ "mission_number": mission_number,
388
+ "operating_moment": operating_moment,
389
+ "operating_weight": operating_weight,
390
+ "origin": origin,
391
+ "pp_onboard": pp_onboard,
392
+ "pp_released": pp_released,
393
+ "sched_time": sched_time,
394
+ "seats_onboard": seats_onboard,
395
+ "seats_released": seats_released,
396
+ "tail_number": tail_number,
397
+ "tank_config": tank_config,
398
+ "util_code": util_code,
399
+ "zero_fuel_cg": zero_fuel_cg,
400
+ "zero_fuel_moment": zero_fuel_moment,
401
+ "zero_fuel_weight": zero_fuel_weight,
402
+ },
403
+ airload_plan_create_params.AirloadPlanCreateParams,
404
+ ),
405
+ options=make_request_options(
406
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
407
+ ),
408
+ cast_to=NoneType,
409
+ )
410
+
411
+ def retrieve(
412
+ self,
413
+ id: str,
414
+ *,
415
+ first_result: int | NotGiven = NOT_GIVEN,
416
+ max_results: int | NotGiven = NOT_GIVEN,
417
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
418
+ # The extra values given here take precedence over values defined on the client or passed to this method.
419
+ extra_headers: Headers | None = None,
420
+ extra_query: Query | None = None,
421
+ extra_body: Body | None = None,
422
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
423
+ ) -> AirloadplanFull:
424
+ """
425
+ Service operation to get a single airloadplan record by its unique ID passed as
426
+ a path parameter.
427
+
428
+ Args:
429
+ extra_headers: Send extra headers
430
+
431
+ extra_query: Add additional query parameters to the request
432
+
433
+ extra_body: Add additional JSON properties to the request
434
+
435
+ timeout: Override the client-level default timeout for this request, in seconds
436
+ """
437
+ if not id:
438
+ raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
439
+ return self._get(
440
+ f"/udl/airloadplan/{id}",
441
+ options=make_request_options(
442
+ extra_headers=extra_headers,
443
+ extra_query=extra_query,
444
+ extra_body=extra_body,
445
+ timeout=timeout,
446
+ query=maybe_transform(
447
+ {
448
+ "first_result": first_result,
449
+ "max_results": max_results,
450
+ },
451
+ airload_plan_retrieve_params.AirloadPlanRetrieveParams,
452
+ ),
453
+ ),
454
+ cast_to=AirloadplanFull,
455
+ )
456
+
457
+ def update(
458
+ self,
459
+ path_id: str,
460
+ *,
461
+ classification_marking: str,
462
+ data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"],
463
+ est_dep_time: Union[str, datetime],
464
+ source: str,
465
+ body_id: str | NotGiven = NOT_GIVEN,
466
+ acl_onboard: float | NotGiven = NOT_GIVEN,
467
+ acl_released: float | NotGiven = NOT_GIVEN,
468
+ aircraft_mds: str | NotGiven = NOT_GIVEN,
469
+ air_load_plan_hazmat_actuals: Iterable[airload_plan_update_params.AirLoadPlanHazmatActual]
470
+ | NotGiven = NOT_GIVEN,
471
+ air_load_plan_hr: Iterable[airload_plan_update_params.AirLoadPlanHr] | NotGiven = NOT_GIVEN,
472
+ air_load_plan_pallet_details: Iterable[airload_plan_update_params.AirLoadPlanPalletDetail]
473
+ | NotGiven = NOT_GIVEN,
474
+ air_load_plan_pax_cargo: Iterable[airload_plan_update_params.AirLoadPlanPaxCargo] | NotGiven = NOT_GIVEN,
475
+ air_load_plan_uln_actuals: Iterable[airload_plan_update_params.AirLoadPlanUlnActual] | NotGiven = NOT_GIVEN,
476
+ arr_airfield: str | NotGiven = NOT_GIVEN,
477
+ arr_icao: str | NotGiven = NOT_GIVEN,
478
+ available_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
479
+ basic_moment: float | NotGiven = NOT_GIVEN,
480
+ basic_weight: float | NotGiven = NOT_GIVEN,
481
+ brief_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
482
+ call_sign: str | NotGiven = NOT_GIVEN,
483
+ cargo_bay_fs_max: float | NotGiven = NOT_GIVEN,
484
+ cargo_bay_fs_min: float | NotGiven = NOT_GIVEN,
485
+ cargo_bay_width: float | NotGiven = NOT_GIVEN,
486
+ cargo_config: str | NotGiven = NOT_GIVEN,
487
+ cargo_moment: float | NotGiven = NOT_GIVEN,
488
+ cargo_volume: float | NotGiven = NOT_GIVEN,
489
+ cargo_weight: float | NotGiven = NOT_GIVEN,
490
+ crew_size: int | NotGiven = NOT_GIVEN,
491
+ dep_airfield: str | NotGiven = NOT_GIVEN,
492
+ dep_icao: str | NotGiven = NOT_GIVEN,
493
+ equip_config: str | NotGiven = NOT_GIVEN,
494
+ est_arr_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
495
+ est_landing_fuel_moment: float | NotGiven = NOT_GIVEN,
496
+ est_landing_fuel_weight: float | NotGiven = NOT_GIVEN,
497
+ external_id: str | NotGiven = NOT_GIVEN,
498
+ fuel_moment: float | NotGiven = NOT_GIVEN,
499
+ fuel_weight: float | NotGiven = NOT_GIVEN,
500
+ gross_cg: float | NotGiven = NOT_GIVEN,
501
+ gross_moment: float | NotGiven = NOT_GIVEN,
502
+ gross_weight: float | NotGiven = NOT_GIVEN,
503
+ id_mission: str | NotGiven = NOT_GIVEN,
504
+ id_sortie: str | NotGiven = NOT_GIVEN,
505
+ landing_cg: float | NotGiven = NOT_GIVEN,
506
+ landing_moment: float | NotGiven = NOT_GIVEN,
507
+ landing_weight: float | NotGiven = NOT_GIVEN,
508
+ leg_num: int | NotGiven = NOT_GIVEN,
509
+ loadmaster_name: str | NotGiven = NOT_GIVEN,
510
+ loadmaster_rank: str | NotGiven = NOT_GIVEN,
511
+ load_remarks: str | NotGiven = NOT_GIVEN,
512
+ mission_number: str | NotGiven = NOT_GIVEN,
513
+ operating_moment: float | NotGiven = NOT_GIVEN,
514
+ operating_weight: float | NotGiven = NOT_GIVEN,
515
+ origin: str | NotGiven = NOT_GIVEN,
516
+ pp_onboard: int | NotGiven = NOT_GIVEN,
517
+ pp_released: int | NotGiven = NOT_GIVEN,
518
+ sched_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
519
+ seats_onboard: int | NotGiven = NOT_GIVEN,
520
+ seats_released: int | NotGiven = NOT_GIVEN,
521
+ tail_number: str | NotGiven = NOT_GIVEN,
522
+ tank_config: str | NotGiven = NOT_GIVEN,
523
+ util_code: str | NotGiven = NOT_GIVEN,
524
+ zero_fuel_cg: float | NotGiven = NOT_GIVEN,
525
+ zero_fuel_moment: float | NotGiven = NOT_GIVEN,
526
+ zero_fuel_weight: float | NotGiven = NOT_GIVEN,
527
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
528
+ # The extra values given here take precedence over values defined on the client or passed to this method.
529
+ extra_headers: Headers | None = None,
530
+ extra_query: Query | None = None,
531
+ extra_body: Body | None = None,
532
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
533
+ ) -> None:
534
+ """Service operation to update a single airloadplan record.
535
+
536
+ A specific role is
537
+ required to perform this service operation. Please contact the UDL team for
538
+ assistance.
539
+
540
+ Args:
541
+ classification_marking: Classification marking of the data in IC/CAPCO Portion-marked format.
542
+
543
+ data_mode:
544
+ Indicator of whether the data is EXERCISE, REAL, SIMULATED, or TEST data:
545
+
546
+ EXERCISE: Data pertaining to a government or military exercise. The data
547
+ may include both real and simulated data.
548
+
549
+ REAL: Data collected or produced that pertains to real-world objects,
550
+ events, and analysis.
551
+
552
+ SIMULATED: Synthetic data generated by a model to mimic real-world
553
+ datasets.
554
+
555
+ TEST: Specific datasets used to evaluate compliance with specifications and
556
+ requirements, and for validating technical, functional, and performance
557
+ characteristics.
558
+
559
+ est_dep_time: The current estimated time that the aircraft is planned to depart, in ISO 8601
560
+ UTC format with millisecond precision.
561
+
562
+ source: Source of the data.
563
+
564
+ body_id: Unique identifier of the record, auto-generated by the system.
565
+
566
+ acl_onboard: Allowable Cabin Load (ACL) onboard the aircraft. The maximum weight of
567
+ passengers, baggage, and cargo that can be safely transported in the aircraft
568
+ cabin, in kilograms.
569
+
570
+ acl_released: Allowable Cabin Load (ACL) released this leg. The weight of passengers, baggage,
571
+ and cargo released from the aircraft cabin, in kilograms.
572
+
573
+ aircraft_mds: The Model Design Series designation of the aircraft supporting this load plan.
574
+
575
+ air_load_plan_hazmat_actuals: Collection of hazmat actuals associated with this load plan.
576
+
577
+ air_load_plan_hr: Collection of human remains transport information associated with this load
578
+ plan.
579
+
580
+ air_load_plan_pallet_details: Collection of cargo information located at the pallet positions associated with
581
+ this load plan.
582
+
583
+ air_load_plan_pax_cargo: Collection of passenger and cargo details associated with this load plan for
584
+ this leg of the mission.
585
+
586
+ air_load_plan_uln_actuals: Collection of unit line number actuals associated with this load plan.
587
+
588
+ arr_airfield: Optional identifier of arrival airfield with no International Civil Organization
589
+ (ICAO) code.
590
+
591
+ arr_icao: The arrival International Civil Organization (ICAO) code of the landing
592
+ airfield.
593
+
594
+ available_time: Time the loadmaster or boom operator is available for cargo loading/unloading,
595
+ in ISO 8601 UTC format with millisecond precision.
596
+
597
+ basic_moment: The basic weight of the aircraft multiplied by the distance between the
598
+ reference datum and the aircraft's center of gravity, in Newton-meters.
599
+
600
+ basic_weight: The weight of the aircraft without passengers, cargo, equipment, or usable fuel,
601
+ in kilograms.
602
+
603
+ brief_time: Time the cargo briefing was given to the loadmaster or boom operator, in ISO
604
+ 8601 UTC format with millisecond precision.
605
+
606
+ call_sign: The call sign of the mission supporting this load plan.
607
+
608
+ cargo_bay_fs_max: Maximum fuselage station (FS) where cargo can be stored. FS is the distance from
609
+ the reference datum, in meters.
610
+
611
+ cargo_bay_fs_min: Minimum fuselage station (FS) where cargo can be stored. FS is the distance from
612
+ the reference datum, in meters.
613
+
614
+ cargo_bay_width: Width of the cargo bay, in meters.
615
+
616
+ cargo_config: The cargo configuration required for this leg (e.g. C-1, C-2, C-3, DV-1, DV-2,
617
+ AE-1, etc.). Configuration meanings are determined by the data source.
618
+
619
+ cargo_moment: The sum of cargo moments of all cargo on board the aircraft, in Newton-meters.
620
+ Each individual cargo moment is the weight of the cargo multiplied by the
621
+ distance between the reference datum and the cargo's center of gravity.
622
+
623
+ cargo_volume: Volume of cargo space in the aircraft, in cubic meters.
624
+
625
+ cargo_weight: The weight of the cargo on board the aircraft, in kilograms.
626
+
627
+ crew_size: The number of crew members on the aircraft.
628
+
629
+ dep_airfield: Optional identifier of departure airfield with no International Civil
630
+ Organization (ICAO) code.
631
+
632
+ dep_icao: The departure International Civil Organization (ICAO) code of the departure
633
+ airfield.
634
+
635
+ equip_config: Description of the equipment configuration (e.g. Standard, Ferry, JBLM, CHS,
636
+ Combat, etc.). Configuration meanings are determined by the data source.
637
+
638
+ est_arr_time: The current estimated time that the aircraft is planned to arrive, in ISO 8601
639
+ UTC format with millisecond precision.
640
+
641
+ est_landing_fuel_moment: The estimated weight of usable fuel upon landing multiplied by the distance
642
+ between the reference datum and the fuel's center of gravity, in Newton-meters.
643
+
644
+ est_landing_fuel_weight: The estimated weight of usable fuel upon landing, in kilograms.
645
+
646
+ external_id: Optional ID from external systems. This field has no meaning within UDL and is
647
+ provided as a convenience for systems that require tracking of an internal
648
+ system generated ID.
649
+
650
+ fuel_moment: The fuel weight on board the aircraft multiplied by the distance between the
651
+ reference datum and the fuel's center of gravity, in Newton-meters.
652
+
653
+ fuel_weight: The weight of usable fuel on board the aircraft, in kilograms.
654
+
655
+ gross_cg: The center of gravity of the aircraft using the gross weight and gross moment,
656
+ as a percentage of the mean aerodynamic chord (%MAC).
657
+
658
+ gross_moment: The sum of moments of all items making up the gross weight of the aircraft, in
659
+ Newton-meters.
660
+
661
+ gross_weight: The total weight of the aircraft at takeoff including passengers, cargo,
662
+ equipment, and usable fuel, in kilograms.
663
+
664
+ id_mission: The UDL ID of the mission this record is associated with.
665
+
666
+ id_sortie: The UDL ID of the aircraft sortie this record is associated with.
667
+
668
+ landing_cg: The center of gravity of the aircraft using the landing weight and landing
669
+ moment, as a percentage of the mean aerodynamic chord (%MAC).
670
+
671
+ landing_moment: The sum of moments of all items making up the gross weight of the aircraft upon
672
+ landing, in Newton-meters.
673
+
674
+ landing_weight: The gross weight of the aircraft upon landing, in kilograms.
675
+
676
+ leg_num: The leg number of the mission supporting this load plan.
677
+
678
+ loadmaster_name: Name of the loadmaster or boom operator who received the cargo briefing.
679
+
680
+ loadmaster_rank: Rank of the loadmaster or boom operator overseeing cargo loading/unloading.
681
+
682
+ load_remarks: Remarks concerning this load plan.
683
+
684
+ mission_number: The mission number of the mission supporting this load plan.
685
+
686
+ operating_moment: The operating weight of the aircraft multiplied by the distance between the
687
+ reference datum and the aircraft's center of gravity, in Newton-meters.
688
+
689
+ operating_weight: The basic weight of the aircraft including passengers and equipment, in
690
+ kilograms.
691
+
692
+ origin: 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
+ pp_onboard: Number of pallet positions on the aircraft.
698
+
699
+ pp_released: Number of pallet positions released this leg.
700
+
701
+ sched_time: Time the loadmaster or boom operator is scheduled to begin overseeing cargo
702
+ loading/unloading, in ISO 8601 UTC format with millisecond precision.
703
+
704
+ seats_onboard: Number of passenger seats on the aircraft.
705
+
706
+ seats_released: Number of passenger seats released this leg.
707
+
708
+ tail_number: The tail number of the aircraft supporting this load plan.
709
+
710
+ tank_config: Description of the fuel tank(s) configuration (e.g. ER, NON-ER, etc.).
711
+ Configuration meanings are determined by the data source.
712
+
713
+ util_code: Alphanumeric code that describes general cargo-related utilization and
714
+ characteristics for an itinerary point.
715
+
716
+ zero_fuel_cg: The center of gravity of the aircraft using the zero fuel weight and zero fuel
717
+ total moment, as a percentage of the mean aerodynamic chord (%MAC).
718
+
719
+ zero_fuel_moment: The zero fuel weight of the aircraft multiplied by the distance between the
720
+ reference datum and the aircraft's center of gravity, in Newton-meters.
721
+
722
+ zero_fuel_weight: The operating weight of the aircraft including cargo, mail, baggage, and
723
+ passengers, but without usable fuel, in kilograms.
724
+
725
+ extra_headers: Send extra headers
726
+
727
+ extra_query: Add additional query parameters to the request
728
+
729
+ extra_body: Add additional JSON properties to the request
730
+
731
+ timeout: Override the client-level default timeout for this request, in seconds
732
+ """
733
+ if not path_id:
734
+ raise ValueError(f"Expected a non-empty value for `path_id` but received {path_id!r}")
735
+ extra_headers = {"Accept": "*/*", **(extra_headers or {})}
736
+ return self._put(
737
+ f"/udl/airloadplan/{path_id}",
738
+ body=maybe_transform(
739
+ {
740
+ "classification_marking": classification_marking,
741
+ "data_mode": data_mode,
742
+ "est_dep_time": est_dep_time,
743
+ "source": source,
744
+ "body_id": body_id,
745
+ "acl_onboard": acl_onboard,
746
+ "acl_released": acl_released,
747
+ "aircraft_mds": aircraft_mds,
748
+ "air_load_plan_hazmat_actuals": air_load_plan_hazmat_actuals,
749
+ "air_load_plan_hr": air_load_plan_hr,
750
+ "air_load_plan_pallet_details": air_load_plan_pallet_details,
751
+ "air_load_plan_pax_cargo": air_load_plan_pax_cargo,
752
+ "air_load_plan_uln_actuals": air_load_plan_uln_actuals,
753
+ "arr_airfield": arr_airfield,
754
+ "arr_icao": arr_icao,
755
+ "available_time": available_time,
756
+ "basic_moment": basic_moment,
757
+ "basic_weight": basic_weight,
758
+ "brief_time": brief_time,
759
+ "call_sign": call_sign,
760
+ "cargo_bay_fs_max": cargo_bay_fs_max,
761
+ "cargo_bay_fs_min": cargo_bay_fs_min,
762
+ "cargo_bay_width": cargo_bay_width,
763
+ "cargo_config": cargo_config,
764
+ "cargo_moment": cargo_moment,
765
+ "cargo_volume": cargo_volume,
766
+ "cargo_weight": cargo_weight,
767
+ "crew_size": crew_size,
768
+ "dep_airfield": dep_airfield,
769
+ "dep_icao": dep_icao,
770
+ "equip_config": equip_config,
771
+ "est_arr_time": est_arr_time,
772
+ "est_landing_fuel_moment": est_landing_fuel_moment,
773
+ "est_landing_fuel_weight": est_landing_fuel_weight,
774
+ "external_id": external_id,
775
+ "fuel_moment": fuel_moment,
776
+ "fuel_weight": fuel_weight,
777
+ "gross_cg": gross_cg,
778
+ "gross_moment": gross_moment,
779
+ "gross_weight": gross_weight,
780
+ "id_mission": id_mission,
781
+ "id_sortie": id_sortie,
782
+ "landing_cg": landing_cg,
783
+ "landing_moment": landing_moment,
784
+ "landing_weight": landing_weight,
785
+ "leg_num": leg_num,
786
+ "loadmaster_name": loadmaster_name,
787
+ "loadmaster_rank": loadmaster_rank,
788
+ "load_remarks": load_remarks,
789
+ "mission_number": mission_number,
790
+ "operating_moment": operating_moment,
791
+ "operating_weight": operating_weight,
792
+ "origin": origin,
793
+ "pp_onboard": pp_onboard,
794
+ "pp_released": pp_released,
795
+ "sched_time": sched_time,
796
+ "seats_onboard": seats_onboard,
797
+ "seats_released": seats_released,
798
+ "tail_number": tail_number,
799
+ "tank_config": tank_config,
800
+ "util_code": util_code,
801
+ "zero_fuel_cg": zero_fuel_cg,
802
+ "zero_fuel_moment": zero_fuel_moment,
803
+ "zero_fuel_weight": zero_fuel_weight,
804
+ },
805
+ airload_plan_update_params.AirloadPlanUpdateParams,
806
+ ),
807
+ options=make_request_options(
808
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
809
+ ),
810
+ cast_to=NoneType,
811
+ )
812
+
813
+ def list(
814
+ self,
815
+ *,
816
+ est_dep_time: Union[str, datetime],
817
+ first_result: int | NotGiven = NOT_GIVEN,
818
+ max_results: int | NotGiven = NOT_GIVEN,
819
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
820
+ # The extra values given here take precedence over values defined on the client or passed to this method.
821
+ extra_headers: Headers | None = None,
822
+ extra_query: Query | None = None,
823
+ extra_body: Body | None = None,
824
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
825
+ ) -> SyncOffsetPage[AirloadplanAbridged]:
826
+ """
827
+ Service operation to dynamically query data by a variety of query parameters not
828
+ specified in this API documentation. See the queryhelp operation
829
+ (/udl/<datatype>/queryhelp) for more details on valid/required query
830
+ parameter information.
831
+
832
+ Args:
833
+ est_dep_time: The current estimated time that the aircraft is planned to depart, in ISO 8601
834
+ UTC format with millisecond precision. (YYYY-MM-DDTHH:MM:SS.sssZ)
835
+
836
+ extra_headers: Send extra headers
837
+
838
+ extra_query: Add additional query parameters to the request
839
+
840
+ extra_body: Add additional JSON properties to the request
841
+
842
+ timeout: Override the client-level default timeout for this request, in seconds
843
+ """
844
+ return self._get_api_list(
845
+ "/udl/airloadplan",
846
+ page=SyncOffsetPage[AirloadplanAbridged],
847
+ options=make_request_options(
848
+ extra_headers=extra_headers,
849
+ extra_query=extra_query,
850
+ extra_body=extra_body,
851
+ timeout=timeout,
852
+ query=maybe_transform(
853
+ {
854
+ "est_dep_time": est_dep_time,
855
+ "first_result": first_result,
856
+ "max_results": max_results,
857
+ },
858
+ airload_plan_list_params.AirloadPlanListParams,
859
+ ),
860
+ ),
861
+ model=AirloadplanAbridged,
862
+ )
863
+
864
+ def delete(
865
+ self,
866
+ id: str,
867
+ *,
868
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
869
+ # The extra values given here take precedence over values defined on the client or passed to this method.
870
+ extra_headers: Headers | None = None,
871
+ extra_query: Query | None = None,
872
+ extra_body: Body | None = None,
873
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
874
+ ) -> None:
875
+ """
876
+ Service operation to delete a airloadplan record specified by the passed ID path
877
+ parameter. A specific role is required to perform this service operation. Please
878
+ contact the UDL team for assistance.
879
+
880
+ Args:
881
+ extra_headers: Send extra headers
882
+
883
+ extra_query: Add additional query parameters to the request
884
+
885
+ extra_body: Add additional JSON properties to the request
886
+
887
+ timeout: Override the client-level default timeout for this request, in seconds
888
+ """
889
+ if not id:
890
+ raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
891
+ extra_headers = {"Accept": "*/*", **(extra_headers or {})}
892
+ return self._delete(
893
+ f"/udl/airloadplan/{id}",
894
+ options=make_request_options(
895
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
896
+ ),
897
+ cast_to=NoneType,
898
+ )
23
899
 
24
- __all__ = ["AirloadPlansResource", "AsyncAirloadPlansResource"]
900
+ def count(
901
+ self,
902
+ *,
903
+ est_dep_time: Union[str, datetime],
904
+ first_result: int | NotGiven = NOT_GIVEN,
905
+ max_results: int | NotGiven = NOT_GIVEN,
906
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
907
+ # The extra values given here take precedence over values defined on the client or passed to this method.
908
+ extra_headers: Headers | None = None,
909
+ extra_query: Query | None = None,
910
+ extra_body: Body | None = None,
911
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
912
+ ) -> str:
913
+ """
914
+ Service operation to return the count of records satisfying the specified query
915
+ parameters. This operation is useful to determine how many records pass a
916
+ particular query criteria without retrieving large amounts of data. See the
917
+ queryhelp operation (/udl/<datatype>/queryhelp) for more details on
918
+ valid/required query parameter information.
919
+
920
+ Args:
921
+ est_dep_time: The current estimated time that the aircraft is planned to depart, in ISO 8601
922
+ UTC format with millisecond precision. (YYYY-MM-DDTHH:MM:SS.sssZ)
25
923
 
924
+ extra_headers: Send extra headers
26
925
 
27
- class AirloadPlansResource(SyncAPIResource):
926
+ extra_query: Add additional query parameters to the request
927
+
928
+ extra_body: Add additional JSON properties to the request
929
+
930
+ timeout: Override the client-level default timeout for this request, in seconds
931
+ """
932
+ extra_headers = {"Accept": "text/plain", **(extra_headers or {})}
933
+ return self._get(
934
+ "/udl/airloadplan/count",
935
+ options=make_request_options(
936
+ extra_headers=extra_headers,
937
+ extra_query=extra_query,
938
+ extra_body=extra_body,
939
+ timeout=timeout,
940
+ query=maybe_transform(
941
+ {
942
+ "est_dep_time": est_dep_time,
943
+ "first_result": first_result,
944
+ "max_results": max_results,
945
+ },
946
+ airload_plan_count_params.AirloadPlanCountParams,
947
+ ),
948
+ ),
949
+ cast_to=str,
950
+ )
951
+
952
+ def queryhelp(
953
+ self,
954
+ *,
955
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
956
+ # The extra values given here take precedence over values defined on the client or passed to this method.
957
+ extra_headers: Headers | None = None,
958
+ extra_query: Query | None = None,
959
+ extra_body: Body | None = None,
960
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
961
+ ) -> AirloadPlanQueryhelpResponse:
962
+ """
963
+ Service operation to provide detailed information on available dynamic query
964
+ parameters for a particular data type.
965
+ """
966
+ return self._get(
967
+ "/udl/airloadplan/queryhelp",
968
+ options=make_request_options(
969
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
970
+ ),
971
+ cast_to=AirloadPlanQueryhelpResponse,
972
+ )
973
+
974
+ def tuple(
975
+ self,
976
+ *,
977
+ columns: str,
978
+ est_dep_time: Union[str, datetime],
979
+ first_result: int | NotGiven = NOT_GIVEN,
980
+ max_results: int | NotGiven = NOT_GIVEN,
981
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
982
+ # The extra values given here take precedence over values defined on the client or passed to this method.
983
+ extra_headers: Headers | None = None,
984
+ extra_query: Query | None = None,
985
+ extra_body: Body | None = None,
986
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
987
+ ) -> AirloadPlanTupleResponse:
988
+ """
989
+ Service operation to dynamically query data and only return specified
990
+ columns/fields. Requested columns are specified by the 'columns' query parameter
991
+ and should be a comma separated list of valid fields for the specified data
992
+ type. classificationMarking is always returned. See the queryhelp operation
993
+ (/udl/<datatype>/queryhelp) for more details on valid/required query parameter
994
+ information. An example URI: /udl/elset/tuple?columns=satNo,period&epoch=>now-5
995
+ hours would return the satNo and period of elsets with an epoch greater than 5
996
+ hours ago.
997
+
998
+ Args:
999
+ columns: Comma-separated list of valid field names for this data type to be returned in
1000
+ the response. Only the fields specified will be returned as well as the
1001
+ classification marking of the data, if applicable. See the ‘queryhelp’ operation
1002
+ for a complete list of possible fields.
1003
+
1004
+ est_dep_time: The current estimated time that the aircraft is planned to depart, in ISO 8601
1005
+ UTC format with millisecond precision. (YYYY-MM-DDTHH:MM:SS.sssZ)
1006
+
1007
+ extra_headers: Send extra headers
1008
+
1009
+ extra_query: Add additional query parameters to the request
1010
+
1011
+ extra_body: Add additional JSON properties to the request
1012
+
1013
+ timeout: Override the client-level default timeout for this request, in seconds
1014
+ """
1015
+ return self._get(
1016
+ "/udl/airloadplan/tuple",
1017
+ options=make_request_options(
1018
+ extra_headers=extra_headers,
1019
+ extra_query=extra_query,
1020
+ extra_body=extra_body,
1021
+ timeout=timeout,
1022
+ query=maybe_transform(
1023
+ {
1024
+ "columns": columns,
1025
+ "est_dep_time": est_dep_time,
1026
+ "first_result": first_result,
1027
+ "max_results": max_results,
1028
+ },
1029
+ airload_plan_tuple_params.AirloadPlanTupleParams,
1030
+ ),
1031
+ ),
1032
+ cast_to=AirloadPlanTupleResponse,
1033
+ )
1034
+
1035
+
1036
+ class AsyncAirloadPlansResource(AsyncAPIResource):
28
1037
  @cached_property
29
- def with_raw_response(self) -> AirloadPlansResourceWithRawResponse:
1038
+ def with_raw_response(self) -> AsyncAirloadPlansResourceWithRawResponse:
30
1039
  """
31
1040
  This property can be used as a prefix for any HTTP method call to return
32
1041
  the raw response object instead of the parsed content.
33
1042
 
34
1043
  For more information, see https://www.github.com/Bluestaq/udl-python-sdk#accessing-raw-response-data-eg-headers
35
1044
  """
36
- return AirloadPlansResourceWithRawResponse(self)
1045
+ return AsyncAirloadPlansResourceWithRawResponse(self)
37
1046
 
38
1047
  @cached_property
39
- def with_streaming_response(self) -> AirloadPlansResourceWithStreamingResponse:
1048
+ def with_streaming_response(self) -> AsyncAirloadPlansResourceWithStreamingResponse:
40
1049
  """
41
1050
  An alternative to `.with_raw_response` that doesn't eagerly read the response body.
42
1051
 
43
1052
  For more information, see https://www.github.com/Bluestaq/udl-python-sdk#with_streaming_response
44
1053
  """
45
- return AirloadPlansResourceWithStreamingResponse(self)
1054
+ return AsyncAirloadPlansResourceWithStreamingResponse(self)
46
1055
 
47
- def update(
1056
+ async def create(
48
1057
  self,
49
- path_id: str,
50
1058
  *,
51
1059
  classification_marking: str,
52
1060
  data_mode: Literal["REAL", "TEST", "SIMULATED", "EXERCISE"],
53
1061
  est_dep_time: Union[str, datetime],
54
1062
  source: str,
55
- body_id: str | NotGiven = NOT_GIVEN,
1063
+ id: str | NotGiven = NOT_GIVEN,
56
1064
  acl_onboard: float | NotGiven = NOT_GIVEN,
57
1065
  acl_released: float | NotGiven = NOT_GIVEN,
58
1066
  aircraft_mds: str | NotGiven = NOT_GIVEN,
59
- air_load_plan_hazmat_actuals: Iterable[airload_plan_update_params.AirLoadPlanHazmatActual]
1067
+ air_load_plan_hazmat_actuals: Iterable[airload_plan_create_params.AirLoadPlanHazmatActual]
60
1068
  | NotGiven = NOT_GIVEN,
61
- air_load_plan_hr: Iterable[airload_plan_update_params.AirLoadPlanHr] | NotGiven = NOT_GIVEN,
62
- air_load_plan_pallet_details: Iterable[airload_plan_update_params.AirLoadPlanPalletDetail]
1069
+ air_load_plan_hr: Iterable[airload_plan_create_params.AirLoadPlanHr] | NotGiven = NOT_GIVEN,
1070
+ air_load_plan_pallet_details: Iterable[airload_plan_create_params.AirLoadPlanPalletDetail]
63
1071
  | NotGiven = NOT_GIVEN,
64
- air_load_plan_pax_cargo: Iterable[airload_plan_update_params.AirLoadPlanPaxCargo] | NotGiven = NOT_GIVEN,
65
- air_load_plan_uln_actuals: Iterable[airload_plan_update_params.AirLoadPlanUlnActual] | NotGiven = NOT_GIVEN,
1072
+ air_load_plan_pax_cargo: Iterable[airload_plan_create_params.AirLoadPlanPaxCargo] | NotGiven = NOT_GIVEN,
1073
+ air_load_plan_uln_actuals: Iterable[airload_plan_create_params.AirLoadPlanUlnActual] | NotGiven = NOT_GIVEN,
66
1074
  arr_airfield: str | NotGiven = NOT_GIVEN,
67
1075
  arr_icao: str | NotGiven = NOT_GIVEN,
68
1076
  available_time: Union[str, datetime] | NotGiven = NOT_GIVEN,
@@ -121,11 +1129,10 @@ class AirloadPlansResource(SyncAPIResource):
121
1129
  extra_body: Body | None = None,
122
1130
  timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
123
1131
  ) -> None:
124
- """Service operation to update a single airloadplan record.
125
-
126
- A specific role is
127
- required to perform this service operation. Please contact the UDL team for
128
- assistance.
1132
+ """
1133
+ Service operation to take a single airloadplan record as a POST body and ingest
1134
+ into the database. A specific role is required to perform this service
1135
+ operation. Please contact the UDL team for assistance.
129
1136
 
130
1137
  Args:
131
1138
  classification_marking: Classification marking of the data in IC/CAPCO Portion-marked format.
@@ -151,7 +1158,7 @@ class AirloadPlansResource(SyncAPIResource):
151
1158
 
152
1159
  source: Source of the data.
153
1160
 
154
- body_id: Unique identifier of the record, auto-generated by the system.
1161
+ id: Unique identifier of the record, auto-generated by the system.
155
1162
 
156
1163
  acl_onboard: Allowable Cabin Load (ACL) onboard the aircraft. The maximum weight of
157
1164
  passengers, baggage, and cargo that can be safely transported in the aircraft
@@ -320,18 +1327,16 @@ class AirloadPlansResource(SyncAPIResource):
320
1327
 
321
1328
  timeout: Override the client-level default timeout for this request, in seconds
322
1329
  """
323
- if not path_id:
324
- raise ValueError(f"Expected a non-empty value for `path_id` but received {path_id!r}")
325
1330
  extra_headers = {"Accept": "*/*", **(extra_headers or {})}
326
- return self._put(
327
- f"/udl/airloadplan/{path_id}",
328
- body=maybe_transform(
1331
+ return await self._post(
1332
+ "/udl/airloadplan",
1333
+ body=await async_maybe_transform(
329
1334
  {
330
1335
  "classification_marking": classification_marking,
331
1336
  "data_mode": data_mode,
332
1337
  "est_dep_time": est_dep_time,
333
1338
  "source": source,
334
- "body_id": body_id,
1339
+ "id": id,
335
1340
  "acl_onboard": acl_onboard,
336
1341
  "acl_released": acl_released,
337
1342
  "aircraft_mds": aircraft_mds,
@@ -392,7 +1397,7 @@ class AirloadPlansResource(SyncAPIResource):
392
1397
  "zero_fuel_moment": zero_fuel_moment,
393
1398
  "zero_fuel_weight": zero_fuel_weight,
394
1399
  },
395
- airload_plan_update_params.AirloadPlanUpdateParams,
1400
+ airload_plan_create_params.AirloadPlanCreateParams,
396
1401
  ),
397
1402
  options=make_request_options(
398
1403
  extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
@@ -400,21 +1405,22 @@ class AirloadPlansResource(SyncAPIResource):
400
1405
  cast_to=NoneType,
401
1406
  )
402
1407
 
403
- def delete(
1408
+ async def retrieve(
404
1409
  self,
405
1410
  id: str,
406
1411
  *,
1412
+ first_result: int | NotGiven = NOT_GIVEN,
1413
+ max_results: int | NotGiven = NOT_GIVEN,
407
1414
  # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
408
1415
  # The extra values given here take precedence over values defined on the client or passed to this method.
409
1416
  extra_headers: Headers | None = None,
410
1417
  extra_query: Query | None = None,
411
1418
  extra_body: Body | None = None,
412
1419
  timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
413
- ) -> None:
1420
+ ) -> AirloadplanFull:
414
1421
  """
415
- Service operation to delete a airloadplan record specified by the passed ID path
416
- parameter. A specific role is required to perform this service operation. Please
417
- contact the UDL team for assistance.
1422
+ Service operation to get a single airloadplan record by its unique ID passed as
1423
+ a path parameter.
418
1424
 
419
1425
  Args:
420
1426
  extra_headers: Send extra headers
@@ -427,36 +1433,24 @@ class AirloadPlansResource(SyncAPIResource):
427
1433
  """
428
1434
  if not id:
429
1435
  raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
430
- extra_headers = {"Accept": "*/*", **(extra_headers or {})}
431
- return self._delete(
1436
+ return await self._get(
432
1437
  f"/udl/airloadplan/{id}",
433
1438
  options=make_request_options(
434
- extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
1439
+ extra_headers=extra_headers,
1440
+ extra_query=extra_query,
1441
+ extra_body=extra_body,
1442
+ timeout=timeout,
1443
+ query=await async_maybe_transform(
1444
+ {
1445
+ "first_result": first_result,
1446
+ "max_results": max_results,
1447
+ },
1448
+ airload_plan_retrieve_params.AirloadPlanRetrieveParams,
1449
+ ),
435
1450
  ),
436
- cast_to=NoneType,
1451
+ cast_to=AirloadplanFull,
437
1452
  )
438
1453
 
439
-
440
- class AsyncAirloadPlansResource(AsyncAPIResource):
441
- @cached_property
442
- def with_raw_response(self) -> AsyncAirloadPlansResourceWithRawResponse:
443
- """
444
- This property can be used as a prefix for any HTTP method call to return
445
- the raw response object instead of the parsed content.
446
-
447
- For more information, see https://www.github.com/Bluestaq/udl-python-sdk#accessing-raw-response-data-eg-headers
448
- """
449
- return AsyncAirloadPlansResourceWithRawResponse(self)
450
-
451
- @cached_property
452
- def with_streaming_response(self) -> AsyncAirloadPlansResourceWithStreamingResponse:
453
- """
454
- An alternative to `.with_raw_response` that doesn't eagerly read the response body.
455
-
456
- For more information, see https://www.github.com/Bluestaq/udl-python-sdk#with_streaming_response
457
- """
458
- return AsyncAirloadPlansResourceWithStreamingResponse(self)
459
-
460
1454
  async def update(
461
1455
  self,
462
1456
  path_id: str,
@@ -813,6 +1807,57 @@ class AsyncAirloadPlansResource(AsyncAPIResource):
813
1807
  cast_to=NoneType,
814
1808
  )
815
1809
 
1810
+ def list(
1811
+ self,
1812
+ *,
1813
+ est_dep_time: Union[str, datetime],
1814
+ first_result: int | NotGiven = NOT_GIVEN,
1815
+ max_results: int | NotGiven = NOT_GIVEN,
1816
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
1817
+ # The extra values given here take precedence over values defined on the client or passed to this method.
1818
+ extra_headers: Headers | None = None,
1819
+ extra_query: Query | None = None,
1820
+ extra_body: Body | None = None,
1821
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1822
+ ) -> AsyncPaginator[AirloadplanAbridged, AsyncOffsetPage[AirloadplanAbridged]]:
1823
+ """
1824
+ Service operation to dynamically query data by a variety of query parameters not
1825
+ specified in this API documentation. See the queryhelp operation
1826
+ (/udl/&lt;datatype&gt;/queryhelp) for more details on valid/required query
1827
+ parameter information.
1828
+
1829
+ Args:
1830
+ est_dep_time: The current estimated time that the aircraft is planned to depart, in ISO 8601
1831
+ UTC format with millisecond precision. (YYYY-MM-DDTHH:MM:SS.sssZ)
1832
+
1833
+ extra_headers: Send extra headers
1834
+
1835
+ extra_query: Add additional query parameters to the request
1836
+
1837
+ extra_body: Add additional JSON properties to the request
1838
+
1839
+ timeout: Override the client-level default timeout for this request, in seconds
1840
+ """
1841
+ return self._get_api_list(
1842
+ "/udl/airloadplan",
1843
+ page=AsyncOffsetPage[AirloadplanAbridged],
1844
+ options=make_request_options(
1845
+ extra_headers=extra_headers,
1846
+ extra_query=extra_query,
1847
+ extra_body=extra_body,
1848
+ timeout=timeout,
1849
+ query=maybe_transform(
1850
+ {
1851
+ "est_dep_time": est_dep_time,
1852
+ "first_result": first_result,
1853
+ "max_results": max_results,
1854
+ },
1855
+ airload_plan_list_params.AirloadPlanListParams,
1856
+ ),
1857
+ ),
1858
+ model=AirloadplanAbridged,
1859
+ )
1860
+
816
1861
  async def delete(
817
1862
  self,
818
1863
  id: str,
@@ -849,50 +1894,257 @@ class AsyncAirloadPlansResource(AsyncAPIResource):
849
1894
  cast_to=NoneType,
850
1895
  )
851
1896
 
1897
+ async def count(
1898
+ self,
1899
+ *,
1900
+ est_dep_time: Union[str, datetime],
1901
+ first_result: int | NotGiven = NOT_GIVEN,
1902
+ max_results: int | NotGiven = NOT_GIVEN,
1903
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
1904
+ # The extra values given here take precedence over values defined on the client or passed to this method.
1905
+ extra_headers: Headers | None = None,
1906
+ extra_query: Query | None = None,
1907
+ extra_body: Body | None = None,
1908
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1909
+ ) -> str:
1910
+ """
1911
+ Service operation to return the count of records satisfying the specified query
1912
+ parameters. This operation is useful to determine how many records pass a
1913
+ particular query criteria without retrieving large amounts of data. See the
1914
+ queryhelp operation (/udl/&lt;datatype&gt;/queryhelp) for more details on
1915
+ valid/required query parameter information.
1916
+
1917
+ Args:
1918
+ est_dep_time: The current estimated time that the aircraft is planned to depart, in ISO 8601
1919
+ UTC format with millisecond precision. (YYYY-MM-DDTHH:MM:SS.sssZ)
1920
+
1921
+ extra_headers: Send extra headers
1922
+
1923
+ extra_query: Add additional query parameters to the request
1924
+
1925
+ extra_body: Add additional JSON properties to the request
1926
+
1927
+ timeout: Override the client-level default timeout for this request, in seconds
1928
+ """
1929
+ extra_headers = {"Accept": "text/plain", **(extra_headers or {})}
1930
+ return await self._get(
1931
+ "/udl/airloadplan/count",
1932
+ options=make_request_options(
1933
+ extra_headers=extra_headers,
1934
+ extra_query=extra_query,
1935
+ extra_body=extra_body,
1936
+ timeout=timeout,
1937
+ query=await async_maybe_transform(
1938
+ {
1939
+ "est_dep_time": est_dep_time,
1940
+ "first_result": first_result,
1941
+ "max_results": max_results,
1942
+ },
1943
+ airload_plan_count_params.AirloadPlanCountParams,
1944
+ ),
1945
+ ),
1946
+ cast_to=str,
1947
+ )
1948
+
1949
+ async def queryhelp(
1950
+ self,
1951
+ *,
1952
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
1953
+ # The extra values given here take precedence over values defined on the client or passed to this method.
1954
+ extra_headers: Headers | None = None,
1955
+ extra_query: Query | None = None,
1956
+ extra_body: Body | None = None,
1957
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1958
+ ) -> AirloadPlanQueryhelpResponse:
1959
+ """
1960
+ Service operation to provide detailed information on available dynamic query
1961
+ parameters for a particular data type.
1962
+ """
1963
+ return await self._get(
1964
+ "/udl/airloadplan/queryhelp",
1965
+ options=make_request_options(
1966
+ extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
1967
+ ),
1968
+ cast_to=AirloadPlanQueryhelpResponse,
1969
+ )
1970
+
1971
+ async def tuple(
1972
+ self,
1973
+ *,
1974
+ columns: str,
1975
+ est_dep_time: Union[str, datetime],
1976
+ first_result: int | NotGiven = NOT_GIVEN,
1977
+ max_results: int | NotGiven = NOT_GIVEN,
1978
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
1979
+ # The extra values given here take precedence over values defined on the client or passed to this method.
1980
+ extra_headers: Headers | None = None,
1981
+ extra_query: Query | None = None,
1982
+ extra_body: Body | None = None,
1983
+ timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
1984
+ ) -> AirloadPlanTupleResponse:
1985
+ """
1986
+ Service operation to dynamically query data and only return specified
1987
+ columns/fields. Requested columns are specified by the 'columns' query parameter
1988
+ and should be a comma separated list of valid fields for the specified data
1989
+ type. classificationMarking is always returned. See the queryhelp operation
1990
+ (/udl/<datatype>/queryhelp) for more details on valid/required query parameter
1991
+ information. An example URI: /udl/elset/tuple?columns=satNo,period&epoch=>now-5
1992
+ hours would return the satNo and period of elsets with an epoch greater than 5
1993
+ hours ago.
1994
+
1995
+ Args:
1996
+ columns: Comma-separated list of valid field names for this data type to be returned in
1997
+ the response. Only the fields specified will be returned as well as the
1998
+ classification marking of the data, if applicable. See the ‘queryhelp’ operation
1999
+ for a complete list of possible fields.
2000
+
2001
+ est_dep_time: The current estimated time that the aircraft is planned to depart, in ISO 8601
2002
+ UTC format with millisecond precision. (YYYY-MM-DDTHH:MM:SS.sssZ)
2003
+
2004
+ extra_headers: Send extra headers
2005
+
2006
+ extra_query: Add additional query parameters to the request
2007
+
2008
+ extra_body: Add additional JSON properties to the request
2009
+
2010
+ timeout: Override the client-level default timeout for this request, in seconds
2011
+ """
2012
+ return await self._get(
2013
+ "/udl/airloadplan/tuple",
2014
+ options=make_request_options(
2015
+ extra_headers=extra_headers,
2016
+ extra_query=extra_query,
2017
+ extra_body=extra_body,
2018
+ timeout=timeout,
2019
+ query=await async_maybe_transform(
2020
+ {
2021
+ "columns": columns,
2022
+ "est_dep_time": est_dep_time,
2023
+ "first_result": first_result,
2024
+ "max_results": max_results,
2025
+ },
2026
+ airload_plan_tuple_params.AirloadPlanTupleParams,
2027
+ ),
2028
+ ),
2029
+ cast_to=AirloadPlanTupleResponse,
2030
+ )
2031
+
852
2032
 
853
2033
  class AirloadPlansResourceWithRawResponse:
854
2034
  def __init__(self, airload_plans: AirloadPlansResource) -> None:
855
2035
  self._airload_plans = airload_plans
856
2036
 
2037
+ self.create = to_raw_response_wrapper(
2038
+ airload_plans.create,
2039
+ )
2040
+ self.retrieve = to_raw_response_wrapper(
2041
+ airload_plans.retrieve,
2042
+ )
857
2043
  self.update = to_raw_response_wrapper(
858
2044
  airload_plans.update,
859
2045
  )
2046
+ self.list = to_raw_response_wrapper(
2047
+ airload_plans.list,
2048
+ )
860
2049
  self.delete = to_raw_response_wrapper(
861
2050
  airload_plans.delete,
862
2051
  )
2052
+ self.count = to_raw_response_wrapper(
2053
+ airload_plans.count,
2054
+ )
2055
+ self.queryhelp = to_raw_response_wrapper(
2056
+ airload_plans.queryhelp,
2057
+ )
2058
+ self.tuple = to_raw_response_wrapper(
2059
+ airload_plans.tuple,
2060
+ )
863
2061
 
864
2062
 
865
2063
  class AsyncAirloadPlansResourceWithRawResponse:
866
2064
  def __init__(self, airload_plans: AsyncAirloadPlansResource) -> None:
867
2065
  self._airload_plans = airload_plans
868
2066
 
2067
+ self.create = async_to_raw_response_wrapper(
2068
+ airload_plans.create,
2069
+ )
2070
+ self.retrieve = async_to_raw_response_wrapper(
2071
+ airload_plans.retrieve,
2072
+ )
869
2073
  self.update = async_to_raw_response_wrapper(
870
2074
  airload_plans.update,
871
2075
  )
2076
+ self.list = async_to_raw_response_wrapper(
2077
+ airload_plans.list,
2078
+ )
872
2079
  self.delete = async_to_raw_response_wrapper(
873
2080
  airload_plans.delete,
874
2081
  )
2082
+ self.count = async_to_raw_response_wrapper(
2083
+ airload_plans.count,
2084
+ )
2085
+ self.queryhelp = async_to_raw_response_wrapper(
2086
+ airload_plans.queryhelp,
2087
+ )
2088
+ self.tuple = async_to_raw_response_wrapper(
2089
+ airload_plans.tuple,
2090
+ )
875
2091
 
876
2092
 
877
2093
  class AirloadPlansResourceWithStreamingResponse:
878
2094
  def __init__(self, airload_plans: AirloadPlansResource) -> None:
879
2095
  self._airload_plans = airload_plans
880
2096
 
2097
+ self.create = to_streamed_response_wrapper(
2098
+ airload_plans.create,
2099
+ )
2100
+ self.retrieve = to_streamed_response_wrapper(
2101
+ airload_plans.retrieve,
2102
+ )
881
2103
  self.update = to_streamed_response_wrapper(
882
2104
  airload_plans.update,
883
2105
  )
2106
+ self.list = to_streamed_response_wrapper(
2107
+ airload_plans.list,
2108
+ )
884
2109
  self.delete = to_streamed_response_wrapper(
885
2110
  airload_plans.delete,
886
2111
  )
2112
+ self.count = to_streamed_response_wrapper(
2113
+ airload_plans.count,
2114
+ )
2115
+ self.queryhelp = to_streamed_response_wrapper(
2116
+ airload_plans.queryhelp,
2117
+ )
2118
+ self.tuple = to_streamed_response_wrapper(
2119
+ airload_plans.tuple,
2120
+ )
887
2121
 
888
2122
 
889
2123
  class AsyncAirloadPlansResourceWithStreamingResponse:
890
2124
  def __init__(self, airload_plans: AsyncAirloadPlansResource) -> None:
891
2125
  self._airload_plans = airload_plans
892
2126
 
2127
+ self.create = async_to_streamed_response_wrapper(
2128
+ airload_plans.create,
2129
+ )
2130
+ self.retrieve = async_to_streamed_response_wrapper(
2131
+ airload_plans.retrieve,
2132
+ )
893
2133
  self.update = async_to_streamed_response_wrapper(
894
2134
  airload_plans.update,
895
2135
  )
2136
+ self.list = async_to_streamed_response_wrapper(
2137
+ airload_plans.list,
2138
+ )
896
2139
  self.delete = async_to_streamed_response_wrapper(
897
2140
  airload_plans.delete,
898
2141
  )
2142
+ self.count = async_to_streamed_response_wrapper(
2143
+ airload_plans.count,
2144
+ )
2145
+ self.queryhelp = async_to_streamed_response_wrapper(
2146
+ airload_plans.queryhelp,
2147
+ )
2148
+ self.tuple = async_to_streamed_response_wrapper(
2149
+ airload_plans.tuple,
2150
+ )