@ourskyai/sda-api 1.3.8639 → 1.4.118

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 (119) hide show
  1. package/.openapi-generator/FILES +90 -0
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +180 -4
  4. package/api.ts +1224 -2821
  5. package/base.ts +14 -24
  6. package/common.ts +20 -44
  7. package/configuration.ts +37 -17
  8. package/dist/api.d.ts +692 -2672
  9. package/dist/api.js +811 -293
  10. package/dist/base.d.ts +11 -23
  11. package/dist/base.js +5 -18
  12. package/dist/common.d.ts +6 -37
  13. package/dist/common.js +18 -40
  14. package/dist/configuration.d.ts +30 -15
  15. package/dist/configuration.js +5 -3
  16. package/dist/esm/api.d.ts +692 -2672
  17. package/dist/esm/api.js +811 -293
  18. package/dist/esm/base.d.ts +11 -23
  19. package/dist/esm/base.js +4 -17
  20. package/dist/esm/common.d.ts +6 -37
  21. package/dist/esm/common.js +16 -39
  22. package/dist/esm/configuration.d.ts +30 -15
  23. package/dist/esm/configuration.js +5 -3
  24. package/dist/esm/index.d.ts +1 -1
  25. package/dist/esm/index.js +1 -1
  26. package/dist/index.d.ts +1 -1
  27. package/dist/index.js +1 -1
  28. package/docs/AstrometricOffsets.md +31 -0
  29. package/docs/DefaultApi.md +3166 -0
  30. package/docs/EmptySuccess.md +20 -0
  31. package/docs/FilterType.md +60 -0
  32. package/docs/FitsHeader.md +22 -0
  33. package/docs/ImageSetType.md +24 -0
  34. package/docs/Location.md +25 -0
  35. package/docs/MountGeometry.md +10 -0
  36. package/docs/MountType.md +10 -0
  37. package/docs/ObservationBoundingBox.md +26 -0
  38. package/docs/ObservationQuality.md +26 -0
  39. package/docs/ObservationResult.md +57 -0
  40. package/docs/ObservationState.md +16 -0
  41. package/docs/OrbitType.md +42 -0
  42. package/docs/SatelliteTargetTrackingStatus.md +12 -0
  43. package/docs/SearchCompletedReason.md +17 -0
  44. package/docs/ShutterType.md +10 -0
  45. package/docs/SuccessfulCreate.md +20 -0
  46. package/docs/SuccessfulDelete.md +20 -0
  47. package/docs/TrackingType.md +12 -0
  48. package/docs/V1AllSkyPredictionLabel.md +16 -0
  49. package/docs/V1BlackoutVolumeRequest.md +23 -0
  50. package/docs/V1CreateDirectTaskInstructionRequest.md +28 -0
  51. package/docs/V1CreateImageMetadataRequest.md +26 -0
  52. package/docs/V1CreateImageSetImageRequest.md +32 -0
  53. package/docs/V1CreateImageSetImageResponse.md +23 -0
  54. package/docs/V1CreateImageSetRequest.md +28 -0
  55. package/docs/V1CreateOrganizationTargetRequest.md +26 -0
  56. package/docs/V1CreateSatelliteTargetRequest.md +32 -0
  57. package/docs/V1CreateSearchInstructionRequest.md +24 -0
  58. package/docs/V1CreateSurveyInstructionRequest.md +24 -0
  59. package/docs/V1CreateWebhookConfigurationRequest.md +28 -0
  60. package/docs/V1CreateWebhookTestRequest.md +20 -0
  61. package/docs/V1GetSatelliteTargetsResponse.md +20 -0
  62. package/docs/V1GroundStationParticipant.md +52 -0
  63. package/docs/V1HFRStar.md +25 -0
  64. package/docs/V1ImageFileType.md +10 -0
  65. package/docs/V1ImageMetadata.md +32 -0
  66. package/docs/V1ImageRejectionReason.md +64 -0
  67. package/docs/V1ImageSet.md +43 -0
  68. package/docs/V1ImageSetImage.md +77 -0
  69. package/docs/V1MatchedStar.md +39 -0
  70. package/docs/V1NodeCalibrationResult.md +48 -0
  71. package/docs/V1ObservationFeature.md +39 -0
  72. package/docs/V1ObservationSequenceResult.md +37 -0
  73. package/docs/V1ObservationSequenceResultImageSetsInner.md +28 -0
  74. package/docs/V1ObservationStatus.md +56 -0
  75. package/docs/V1ObservationWeather.md +22 -0
  76. package/docs/V1ObservedWeather.md +23 -0
  77. package/docs/V1ObserverLocation.md +24 -0
  78. package/docs/V1OrganizationTarget.md +32 -0
  79. package/docs/V1PassStage.md +12 -0
  80. package/docs/V1PixelCoordinates.md +23 -0
  81. package/docs/V1PlaneScanRequest.md +25 -0
  82. package/docs/V1PlateSolveResult.md +40 -0
  83. package/docs/V1PlateSolveStatus.md +12 -0
  84. package/docs/V1Point.md +25 -0
  85. package/docs/V1PredictedStreakLocation.md +26 -0
  86. package/docs/V1PredictedWeather.md +21 -0
  87. package/docs/V1PutOrbitProviderTLERequest.md +33 -0
  88. package/docs/V1ResolvedImageMetadata.md +52 -0
  89. package/docs/V1ResolvedImageObservation.md +37 -0
  90. package/docs/V1ResolvedImagePair.md +41 -0
  91. package/docs/V1ResolvedImageSet.md +25 -0
  92. package/docs/V1RicVolumeSearchRequest.md +29 -0
  93. package/docs/V1SIPCoefficients.md +40 -0
  94. package/docs/V1SatelliteCalibrationFamily.md +12 -0
  95. package/docs/V1SatellitePotential.md +37 -0
  96. package/docs/V1SatelliteTarget.md +83 -0
  97. package/docs/V1SearchInstruction.md +29 -0
  98. package/docs/V1SearchInstructionStep.md +27 -0
  99. package/docs/V1SharpeningMethod.md +10 -0
  100. package/docs/V1StateVector.md +43 -0
  101. package/docs/V1SurveyInstruction.md +28 -0
  102. package/docs/V1SurveyInstructionStep.md +33 -0
  103. package/docs/V1TargetCorrelation.md +31 -0
  104. package/docs/V1Tdm.md +35 -0
  105. package/docs/V1TimeTaggedRaDec.md +28 -0
  106. package/docs/V1Track.md +24 -0
  107. package/docs/V1Transformation.md +77 -0
  108. package/docs/V1UpdateEmailConfigurationRequest.md +20 -0
  109. package/docs/V1UpdateOrganizationTargetRequest.md +24 -0
  110. package/docs/V1UpdateSatelliteTargetRequest.md +34 -0
  111. package/docs/V1UpdateWebhookConfigurationRequest.md +22 -0
  112. package/docs/V1WebhookConfiguration.md +34 -0
  113. package/docs/V1WebhookLog.md +30 -0
  114. package/docs/V2Search.md +29 -0
  115. package/docs/WeatherCondition.md +20 -0
  116. package/docs/WebhookAuthType.md +13 -0
  117. package/docs/WebhookEvent.md +35 -0
  118. package/index.ts +1 -1
  119. package/package.json +4 -4
@@ -0,0 +1,3166 @@
1
+ # DefaultApi
2
+
3
+ All URIs are relative to *https://api.prod.oursky.ai*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getUncorrelatedTracks**](#getuncorrelatedtracks) | **GET** /v1/uncorrelated-tracks | Get uncorrelated tracks collected by the network.|
8
+ |[**v1CreateBlackoutVolume**](#v1createblackoutvolume) | **POST** /v2/search/blackout-volume | |
9
+ |[**v1CreateDirectTaskInstruction**](#v1createdirecttaskinstruction) | **POST** /v1/direct-task-instruction | |
10
+ |[**v1CreateImageMetadata**](#v1createimagemetadata) | **POST** /v1/image-metadata | |
11
+ |[**v1CreateImageSet**](#v1createimageset) | **POST** /v1/image-set | |
12
+ |[**v1CreateImageSetImage**](#v1createimagesetimage) | **POST** /v1/image-set-image | |
13
+ |[**v1CreateOrganizationTarget**](#v1createorganizationtarget) | **POST** /v1/organization-target | |
14
+ |[**v1CreateSatelliteTarget**](#v1createsatellitetarget) | **POST** /v1/satellite-target | |
15
+ |[**v1CreateSearchInstruction**](#v1createsearchinstruction) | **POST** /v1/search-instruction | |
16
+ |[**v1CreateSurveyInstruction**](#v1createsurveyinstruction) | **POST** /v1/survey-instruction | |
17
+ |[**v1CreateWebhookConfiguration**](#v1createwebhookconfiguration) | **POST** /v1/communications/webhook | |
18
+ |[**v1CreateWebhookTest**](#v1createwebhooktest) | **POST** /v1/communications/webhook-test | |
19
+ |[**v1DeleteBlackoutVolume**](#v1deleteblackoutvolume) | **DELETE** /v2/search/blackout-volume | |
20
+ |[**v1DeleteDirectTaskInstruction**](#v1deletedirecttaskinstruction) | **DELETE** /v1/direct-task-instruction | |
21
+ |[**v1DeleteImageSet**](#v1deleteimageset) | **DELETE** /v1/image-set | |
22
+ |[**v1DeleteImageSetImage**](#v1deleteimagesetimage) | **DELETE** /v1/image-set-image | |
23
+ |[**v1DeleteOrganizationTarget**](#v1deleteorganizationtarget) | **DELETE** /v1/organization-target | |
24
+ |[**v1DeleteSearchInstruction**](#v1deletesearchinstruction) | **DELETE** /v1/search-instruction | |
25
+ |[**v1DeleteSurveyInstruction**](#v1deletesurveyinstruction) | **DELETE** /v1/survey-instruction | |
26
+ |[**v1DeleteWebhookConfiguration**](#v1deletewebhookconfiguration) | **DELETE** /v1/communications/webhook | |
27
+ |[**v1GetImageMetadata**](#v1getimagemetadata) | **GET** /v1/image-metadata | |
28
+ |[**v1GetImageSet**](#v1getimageset) | **GET** /v1/image-set | |
29
+ |[**v1GetImageSetImage**](#v1getimagesetimage) | **GET** /v1/image-set-image | |
30
+ |[**v1GetImageSetImages**](#v1getimagesetimages) | **GET** /v1/image-set-images | |
31
+ |[**v1GetImageSets**](#v1getimagesets) | **GET** /v1/image-sets | |
32
+ |[**v1GetNodeProperties**](#v1getnodeproperties) | **GET** /v1/node-properties | |
33
+ |[**v1GetNodeSatelliteCalibrations**](#v1getnodesatellitecalibrations) | **GET** /v1/satellite-calibrations | |
34
+ |[**v1GetObservationFeatures**](#v1getobservationfeatures) | **GET** /v1/observation-features | |
35
+ |[**v1GetObservationSequenceResult**](#v1getobservationsequenceresult) | **GET** /v1/observation-sequence-result | |
36
+ |[**v1GetObservationSequenceResults**](#v1getobservationsequenceresults) | **GET** /v1/observation-sequence-results | |
37
+ |[**v1GetObservationStatuses**](#v1getobservationstatuses) | **GET** /v1/observation-statuses | |
38
+ |[**v1GetOrganizationSatellitePotentials**](#v1getorganizationsatellitepotentials) | **GET** /v1/organization-target-potentials | |
39
+ |[**v1GetOrganizationTarget**](#v1getorganizationtarget) | **GET** /v1/organization-target | |
40
+ |[**v1GetOrganizationTargets**](#v1getorganizationtargets) | **GET** /v1/organization-targets | |
41
+ |[**v1GetResolvedImageMetadata**](#v1getresolvedimagemetadata) | **GET** /v1/resolved-image-metadata | |
42
+ |[**v1GetResolvedImageObservations**](#v1getresolvedimageobservations) | **GET** /v1/resolved-image-observations | |
43
+ |[**v1GetResolvedImagePair**](#v1getresolvedimagepair) | **GET** /v1/resolved-image-pair | |
44
+ |[**v1GetResolvedImageSet**](#v1getresolvedimageset) | **GET** /v1/resolved-image-set | |
45
+ |[**v1GetSatellitePotentials**](#v1getsatellitepotentials) | **GET** /v1/satellite-target-potentials | |
46
+ |[**v1GetSatelliteTarget**](#v1getsatellitetarget) | **GET** /v1/satellite-target | |
47
+ |[**v1GetSatelliteTargets**](#v1getsatellitetargets) | **GET** /v1/satellite-targets | |
48
+ |[**v1GetSearchInstructions**](#v1getsearchinstructions) | **GET** /v1/search-instructions | |
49
+ |[**v1GetStateVectors**](#v1getstatevectors) | **GET** /v1/state-vectors | |
50
+ |[**v1GetSurveyInstructions**](#v1getsurveyinstructions) | **GET** /v1/survey-instructions | |
51
+ |[**v1GetTdm**](#v1gettdm) | **GET** /v1/tdm | |
52
+ |[**v1GetTdms**](#v1gettdms) | **GET** /v1/tdms | |
53
+ |[**v1GetWebhookConfigurations**](#v1getwebhookconfigurations) | **GET** /v1/communications/webhooks | |
54
+ |[**v1GetWebhookLogs**](#v1getwebhooklogs) | **GET** /v1/communications/webhook-logs | |
55
+ |[**v1PutOrbitProviderTLEOrbit**](#v1putorbitprovidertleorbit) | **PUT** /v1/orbit-provider/tle | |
56
+ |[**v1UpdateEmailConfiguration**](#v1updateemailconfiguration) | **PUT** /v1/communications/email | |
57
+ |[**v1UpdateOrganizationTarget**](#v1updateorganizationtarget) | **PUT** /v1/organization-target | |
58
+ |[**v1UpdateSatelliteTarget**](#v1updatesatellitetarget) | **PUT** /v1/satellite-target | |
59
+ |[**v1UpdateWebhookConfiguration**](#v1updatewebhookconfiguration) | **PUT** /v1/communications/webhook | |
60
+ |[**v2CreatePlaneScan**](#v2createplanescan) | **POST** /v2/search/plane-scan | |
61
+ |[**v2CreateRicVolumeSearch**](#v2createricvolumesearch) | **POST** /v2/search/ric-volumetric | |
62
+ |[**v2DeletePlaneScan**](#v2deleteplanescan) | **DELETE** /v2/search/plane-scan | |
63
+ |[**v2DeleteRicVolumeSearch**](#v2deletericvolumesearch) | **DELETE** /v2/search/ric-volumetric | |
64
+ |[**v2GetSearch**](#v2getsearch) | **GET** /v2/search | |
65
+ |[**v2GetSearches**](#v2getsearches) | **GET** /v2/searches | |
66
+
67
+ # **getUncorrelatedTracks**
68
+ > Array<V1Track> getUncorrelatedTracks()
69
+
70
+ This endpoint returns a list of uncorrelated tracks collected by the network.
71
+
72
+ ### Example
73
+
74
+ ```typescript
75
+ import {
76
+ DefaultApi,
77
+ Configuration
78
+ } from '@ourskyai/sda-api';
79
+
80
+ const configuration = new Configuration();
81
+ const apiInstance = new DefaultApi(configuration);
82
+
83
+ let after: string; //The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time. (optional) (default to undefined)
84
+
85
+ const { status, data } = await apiInstance.getUncorrelatedTracks(
86
+ after
87
+ );
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+ |Name | Type | Description | Notes|
93
+ |------------- | ------------- | ------------- | -------------|
94
+ | **after** | [**string**] | The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time. | (optional) defaults to undefined|
95
+
96
+
97
+ ### Return type
98
+
99
+ **Array<V1Track>**
100
+
101
+ ### Authorization
102
+
103
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
104
+
105
+ ### HTTP request headers
106
+
107
+ - **Content-Type**: Not defined
108
+ - **Accept**: application/json
109
+
110
+
111
+ ### HTTP response details
112
+ | Status code | Description | Response headers |
113
+ |-------------|-------------|------------------|
114
+ |**200** | V1Track[] | - |
115
+
116
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
117
+
118
+ # **v1CreateBlackoutVolume**
119
+ > SuccessfulCreate v1CreateBlackoutVolume(v1BlackoutVolumeRequest)
120
+
121
+ Create a blackout volume to avoid observing a region of space when scheduling searches.
122
+
123
+ ### Example
124
+
125
+ ```typescript
126
+ import {
127
+ DefaultApi,
128
+ Configuration,
129
+ V1BlackoutVolumeRequest
130
+ } from '@ourskyai/sda-api';
131
+
132
+ const configuration = new Configuration();
133
+ const apiInstance = new DefaultApi(configuration);
134
+
135
+ let v1BlackoutVolumeRequest: V1BlackoutVolumeRequest; //
136
+
137
+ const { status, data } = await apiInstance.v1CreateBlackoutVolume(
138
+ v1BlackoutVolumeRequest
139
+ );
140
+ ```
141
+
142
+ ### Parameters
143
+
144
+ |Name | Type | Description | Notes|
145
+ |------------- | ------------- | ------------- | -------------|
146
+ | **v1BlackoutVolumeRequest** | **V1BlackoutVolumeRequest**| | |
147
+
148
+
149
+ ### Return type
150
+
151
+ **SuccessfulCreate**
152
+
153
+ ### Authorization
154
+
155
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
156
+
157
+ ### HTTP request headers
158
+
159
+ - **Content-Type**: application/json
160
+ - **Accept**: application/json
161
+
162
+
163
+ ### HTTP response details
164
+ | Status code | Description | Response headers |
165
+ |-------------|-------------|------------------|
166
+ |**200** | Successful create | - |
167
+
168
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
169
+
170
+ # **v1CreateDirectTaskInstruction**
171
+ > SuccessfulCreate v1CreateDirectTaskInstruction(v1CreateDirectTaskInstructionRequest)
172
+
173
+ Create a direct-task instruction. This enables collecting observations on a target at a specific time, bypassing normal scheduling constraints.
174
+
175
+ ### Example
176
+
177
+ ```typescript
178
+ import {
179
+ DefaultApi,
180
+ Configuration,
181
+ V1CreateDirectTaskInstructionRequest
182
+ } from '@ourskyai/sda-api';
183
+
184
+ const configuration = new Configuration();
185
+ const apiInstance = new DefaultApi(configuration);
186
+
187
+ let v1CreateDirectTaskInstructionRequest: V1CreateDirectTaskInstructionRequest; //
188
+
189
+ const { status, data } = await apiInstance.v1CreateDirectTaskInstruction(
190
+ v1CreateDirectTaskInstructionRequest
191
+ );
192
+ ```
193
+
194
+ ### Parameters
195
+
196
+ |Name | Type | Description | Notes|
197
+ |------------- | ------------- | ------------- | -------------|
198
+ | **v1CreateDirectTaskInstructionRequest** | **V1CreateDirectTaskInstructionRequest**| | |
199
+
200
+
201
+ ### Return type
202
+
203
+ **SuccessfulCreate**
204
+
205
+ ### Authorization
206
+
207
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
208
+
209
+ ### HTTP request headers
210
+
211
+ - **Content-Type**: application/json
212
+ - **Accept**: application/json
213
+
214
+
215
+ ### HTTP response details
216
+ | Status code | Description | Response headers |
217
+ |-------------|-------------|------------------|
218
+ |**200** | Successful create | - |
219
+
220
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
221
+
222
+ # **v1CreateImageMetadata**
223
+ > EmptySuccess v1CreateImageMetadata(v1CreateImageMetadataRequest)
224
+
225
+ Create metadata about an image by image id. This includes plate solve results
226
+
227
+ ### Example
228
+
229
+ ```typescript
230
+ import {
231
+ DefaultApi,
232
+ Configuration,
233
+ V1CreateImageMetadataRequest
234
+ } from '@ourskyai/sda-api';
235
+
236
+ const configuration = new Configuration();
237
+ const apiInstance = new DefaultApi(configuration);
238
+
239
+ let imageId: string; // (default to undefined)
240
+ let v1CreateImageMetadataRequest: V1CreateImageMetadataRequest; //
241
+
242
+ const { status, data } = await apiInstance.v1CreateImageMetadata(
243
+ imageId,
244
+ v1CreateImageMetadataRequest
245
+ );
246
+ ```
247
+
248
+ ### Parameters
249
+
250
+ |Name | Type | Description | Notes|
251
+ |------------- | ------------- | ------------- | -------------|
252
+ | **v1CreateImageMetadataRequest** | **V1CreateImageMetadataRequest**| | |
253
+ | **imageId** | [**string**] | | defaults to undefined|
254
+
255
+
256
+ ### Return type
257
+
258
+ **EmptySuccess**
259
+
260
+ ### Authorization
261
+
262
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
263
+
264
+ ### HTTP request headers
265
+
266
+ - **Content-Type**: application/json
267
+ - **Accept**: application/json
268
+
269
+
270
+ ### HTTP response details
271
+ | Status code | Description | Response headers |
272
+ |-------------|-------------|------------------|
273
+ |**200** | Successful action | - |
274
+
275
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
276
+
277
+ # **v1CreateImageSet**
278
+ > SuccessfulCreate v1CreateImageSet(v1CreateImageSetRequest)
279
+
280
+ Create an image set.
281
+
282
+ ### Example
283
+
284
+ ```typescript
285
+ import {
286
+ DefaultApi,
287
+ Configuration,
288
+ V1CreateImageSetRequest
289
+ } from '@ourskyai/sda-api';
290
+
291
+ const configuration = new Configuration();
292
+ const apiInstance = new DefaultApi(configuration);
293
+
294
+ let v1CreateImageSetRequest: V1CreateImageSetRequest; //
295
+
296
+ const { status, data } = await apiInstance.v1CreateImageSet(
297
+ v1CreateImageSetRequest
298
+ );
299
+ ```
300
+
301
+ ### Parameters
302
+
303
+ |Name | Type | Description | Notes|
304
+ |------------- | ------------- | ------------- | -------------|
305
+ | **v1CreateImageSetRequest** | **V1CreateImageSetRequest**| | |
306
+
307
+
308
+ ### Return type
309
+
310
+ **SuccessfulCreate**
311
+
312
+ ### Authorization
313
+
314
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
315
+
316
+ ### HTTP request headers
317
+
318
+ - **Content-Type**: application/json
319
+ - **Accept**: application/json
320
+
321
+
322
+ ### HTTP response details
323
+ | Status code | Description | Response headers |
324
+ |-------------|-------------|------------------|
325
+ |**200** | Successful create | - |
326
+
327
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
328
+
329
+ # **v1CreateImageSetImage**
330
+ > V1CreateImageSetImageResponse v1CreateImageSetImage(v1CreateImageSetImageRequest)
331
+
332
+ Create an image set image.
333
+
334
+ ### Example
335
+
336
+ ```typescript
337
+ import {
338
+ DefaultApi,
339
+ Configuration,
340
+ V1CreateImageSetImageRequest
341
+ } from '@ourskyai/sda-api';
342
+
343
+ const configuration = new Configuration();
344
+ const apiInstance = new DefaultApi(configuration);
345
+
346
+ let v1CreateImageSetImageRequest: V1CreateImageSetImageRequest; //
347
+
348
+ const { status, data } = await apiInstance.v1CreateImageSetImage(
349
+ v1CreateImageSetImageRequest
350
+ );
351
+ ```
352
+
353
+ ### Parameters
354
+
355
+ |Name | Type | Description | Notes|
356
+ |------------- | ------------- | ------------- | -------------|
357
+ | **v1CreateImageSetImageRequest** | **V1CreateImageSetImageRequest**| | |
358
+
359
+
360
+ ### Return type
361
+
362
+ **V1CreateImageSetImageResponse**
363
+
364
+ ### Authorization
365
+
366
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
367
+
368
+ ### HTTP request headers
369
+
370
+ - **Content-Type**: application/json
371
+ - **Accept**: application/json
372
+
373
+
374
+ ### HTTP response details
375
+ | Status code | Description | Response headers |
376
+ |-------------|-------------|------------------|
377
+ |**200** | V1CreateImageSetImageResponse | - |
378
+
379
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
380
+
381
+ # **v1CreateOrganizationTarget**
382
+ > V1OrganizationTarget v1CreateOrganizationTarget(v1CreateOrganizationTargetRequest)
383
+
384
+ Request observations for a satellite target. By creating an organization target you are requesting for a specific target to be observed. The target will be observed best effort by the OurSky network. At the current time OurSky only supports observing satellite targets that are already registered with the platform. To see all possible satellite targets see the [satellite targets](#tag/satellite-targets/GET/v1/satellite-targets) endpoint. Organization targets also control which events are sent to your organization via webhooks. Webhooks are only sent for targets that you have an active \"organization target\" for.
385
+
386
+ ### Example
387
+
388
+ ```typescript
389
+ import {
390
+ DefaultApi,
391
+ Configuration,
392
+ V1CreateOrganizationTargetRequest
393
+ } from '@ourskyai/sda-api';
394
+
395
+ const configuration = new Configuration();
396
+ const apiInstance = new DefaultApi(configuration);
397
+
398
+ let v1CreateOrganizationTargetRequest: V1CreateOrganizationTargetRequest; //
399
+
400
+ const { status, data } = await apiInstance.v1CreateOrganizationTarget(
401
+ v1CreateOrganizationTargetRequest
402
+ );
403
+ ```
404
+
405
+ ### Parameters
406
+
407
+ |Name | Type | Description | Notes|
408
+ |------------- | ------------- | ------------- | -------------|
409
+ | **v1CreateOrganizationTargetRequest** | **V1CreateOrganizationTargetRequest**| | |
410
+
411
+
412
+ ### Return type
413
+
414
+ **V1OrganizationTarget**
415
+
416
+ ### Authorization
417
+
418
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
419
+
420
+ ### HTTP request headers
421
+
422
+ - **Content-Type**: application/json
423
+ - **Accept**: application/json
424
+
425
+
426
+ ### HTTP response details
427
+ | Status code | Description | Response headers |
428
+ |-------------|-------------|------------------|
429
+ |**200** | V1CreateOrganizationTarget | - |
430
+
431
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
432
+
433
+ # **v1CreateSatelliteTarget**
434
+ > SuccessfulCreate v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest)
435
+
436
+ Create a private satellite target. This target will only be visible to your organization
437
+
438
+ ### Example
439
+
440
+ ```typescript
441
+ import {
442
+ DefaultApi,
443
+ Configuration,
444
+ V1CreateSatelliteTargetRequest
445
+ } from '@ourskyai/sda-api';
446
+
447
+ const configuration = new Configuration();
448
+ const apiInstance = new DefaultApi(configuration);
449
+
450
+ let v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest; //
451
+
452
+ const { status, data } = await apiInstance.v1CreateSatelliteTarget(
453
+ v1CreateSatelliteTargetRequest
454
+ );
455
+ ```
456
+
457
+ ### Parameters
458
+
459
+ |Name | Type | Description | Notes|
460
+ |------------- | ------------- | ------------- | -------------|
461
+ | **v1CreateSatelliteTargetRequest** | **V1CreateSatelliteTargetRequest**| | |
462
+
463
+
464
+ ### Return type
465
+
466
+ **SuccessfulCreate**
467
+
468
+ ### Authorization
469
+
470
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
471
+
472
+ ### HTTP request headers
473
+
474
+ - **Content-Type**: application/json
475
+ - **Accept**: application/json
476
+
477
+
478
+ ### HTTP response details
479
+ | Status code | Description | Response headers |
480
+ |-------------|-------------|------------------|
481
+ |**200** | Successful create | - |
482
+
483
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
484
+
485
+ # **v1CreateSearchInstruction**
486
+ > SuccessfulCreate v1CreateSearchInstruction(v1CreateSearchInstructionRequest)
487
+
488
+ This endpoint is deprecated but will continue to work until 05/31/2025, please see [/v2/search/plane-scan](#tag/plane-scans/POST/v2/search/plane-scan) and [/v2/search/ric-volumetric](#tag/ric-volumetrics/POST/v2/search/ric-volumetric). Create a search instruction. Search instructions are the highest priority request in the system. The maximum duration for all steps is 5 minutes. Search patterns can be defined through both step offsets and timing. The system will execute the search and the resulting observations will be available in the observation status endpoint.
489
+
490
+ ### Example
491
+
492
+ ```typescript
493
+ import {
494
+ DefaultApi,
495
+ Configuration,
496
+ V1CreateSearchInstructionRequest
497
+ } from '@ourskyai/sda-api';
498
+
499
+ const configuration = new Configuration();
500
+ const apiInstance = new DefaultApi(configuration);
501
+
502
+ let v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest; //
503
+
504
+ const { status, data } = await apiInstance.v1CreateSearchInstruction(
505
+ v1CreateSearchInstructionRequest
506
+ );
507
+ ```
508
+
509
+ ### Parameters
510
+
511
+ |Name | Type | Description | Notes|
512
+ |------------- | ------------- | ------------- | -------------|
513
+ | **v1CreateSearchInstructionRequest** | **V1CreateSearchInstructionRequest**| | |
514
+
515
+
516
+ ### Return type
517
+
518
+ **SuccessfulCreate**
519
+
520
+ ### Authorization
521
+
522
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
523
+
524
+ ### HTTP request headers
525
+
526
+ - **Content-Type**: application/json
527
+ - **Accept**: application/json
528
+
529
+
530
+ ### HTTP response details
531
+ | Status code | Description | Response headers |
532
+ |-------------|-------------|------------------|
533
+ |**200** | Successful create | - |
534
+
535
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
536
+
537
+ # **v1CreateSurveyInstruction**
538
+ > SuccessfulCreate v1CreateSurveyInstruction(v1CreateSurveyInstructionRequest)
539
+
540
+ Create a survey instruction. Survey instructions are the highest priority request in the system. The system will execute the survey and the results will be available in the observation status endpoint. If `firstStepAt` is not specified, then the first node that is able to view an RA/Dec of any step will execute the instruction. If `firstStepAt` is specified, then the instruction will only execute starting at that time.
541
+
542
+ ### Example
543
+
544
+ ```typescript
545
+ import {
546
+ DefaultApi,
547
+ Configuration,
548
+ V1CreateSurveyInstructionRequest
549
+ } from '@ourskyai/sda-api';
550
+
551
+ const configuration = new Configuration();
552
+ const apiInstance = new DefaultApi(configuration);
553
+
554
+ let v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest; //
555
+
556
+ const { status, data } = await apiInstance.v1CreateSurveyInstruction(
557
+ v1CreateSurveyInstructionRequest
558
+ );
559
+ ```
560
+
561
+ ### Parameters
562
+
563
+ |Name | Type | Description | Notes|
564
+ |------------- | ------------- | ------------- | -------------|
565
+ | **v1CreateSurveyInstructionRequest** | **V1CreateSurveyInstructionRequest**| | |
566
+
567
+
568
+ ### Return type
569
+
570
+ **SuccessfulCreate**
571
+
572
+ ### Authorization
573
+
574
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
575
+
576
+ ### HTTP request headers
577
+
578
+ - **Content-Type**: application/json
579
+ - **Accept**: application/json
580
+
581
+
582
+ ### HTTP response details
583
+ | Status code | Description | Response headers |
584
+ |-------------|-------------|------------------|
585
+ |**200** | Successful create | - |
586
+
587
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
588
+
589
+ # **v1CreateWebhookConfiguration**
590
+ > SuccessfulCreate v1CreateWebhookConfiguration(v1CreateWebhookConfigurationRequest)
591
+
592
+ Create an organization webhook. Organization webhooks are used to send specific events to a remote http endpoint. A webhook can be configured for a list of event type. Please see the webhook event types for the currently supported types. The schemas are considered stable and will match their corresponding GET response schema. \"V1_TDM_CREATED\" -> `GET /v1/tdm?id={id}` For the `V1_EO_OBSERVATION_CREATED` event, please refer to the UDL API schema reference found at https://unifieddatalibrary.com The payload sent to the webhook endpoint will include a header field `\"X-OurSky-Signature\"` which is an HMAC-SHA256 using the secret as the key and the payload as the message. The payload is the byte stream of the entire JSON payload The signature is base64 encoded. If your webhook endpoint requires authorization, use the `authType` and `authorization` parameters to ensure we can reach your servers. Basic authorizations headers should already be base64 encoded.
593
+
594
+ ### Example
595
+
596
+ ```typescript
597
+ import {
598
+ DefaultApi,
599
+ Configuration,
600
+ V1CreateWebhookConfigurationRequest
601
+ } from '@ourskyai/sda-api';
602
+
603
+ const configuration = new Configuration();
604
+ const apiInstance = new DefaultApi(configuration);
605
+
606
+ let v1CreateWebhookConfigurationRequest: V1CreateWebhookConfigurationRequest; //
607
+
608
+ const { status, data } = await apiInstance.v1CreateWebhookConfiguration(
609
+ v1CreateWebhookConfigurationRequest
610
+ );
611
+ ```
612
+
613
+ ### Parameters
614
+
615
+ |Name | Type | Description | Notes|
616
+ |------------- | ------------- | ------------- | -------------|
617
+ | **v1CreateWebhookConfigurationRequest** | **V1CreateWebhookConfigurationRequest**| | |
618
+
619
+
620
+ ### Return type
621
+
622
+ **SuccessfulCreate**
623
+
624
+ ### Authorization
625
+
626
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
627
+
628
+ ### HTTP request headers
629
+
630
+ - **Content-Type**: application/json
631
+ - **Accept**: application/json
632
+
633
+
634
+ ### HTTP response details
635
+ | Status code | Description | Response headers |
636
+ |-------------|-------------|------------------|
637
+ |**200** | Successful create | - |
638
+
639
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
640
+
641
+ # **v1CreateWebhookTest**
642
+ > EmptySuccess v1CreateWebhookTest(v1CreateWebhookTestRequest)
643
+
644
+ Test your organization\'s webhooks.
645
+
646
+ ### Example
647
+
648
+ ```typescript
649
+ import {
650
+ DefaultApi,
651
+ Configuration,
652
+ V1CreateWebhookTestRequest
653
+ } from '@ourskyai/sda-api';
654
+
655
+ const configuration = new Configuration();
656
+ const apiInstance = new DefaultApi(configuration);
657
+
658
+ let v1CreateWebhookTestRequest: V1CreateWebhookTestRequest; //
659
+
660
+ const { status, data } = await apiInstance.v1CreateWebhookTest(
661
+ v1CreateWebhookTestRequest
662
+ );
663
+ ```
664
+
665
+ ### Parameters
666
+
667
+ |Name | Type | Description | Notes|
668
+ |------------- | ------------- | ------------- | -------------|
669
+ | **v1CreateWebhookTestRequest** | **V1CreateWebhookTestRequest**| | |
670
+
671
+
672
+ ### Return type
673
+
674
+ **EmptySuccess**
675
+
676
+ ### Authorization
677
+
678
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
679
+
680
+ ### HTTP request headers
681
+
682
+ - **Content-Type**: application/json
683
+ - **Accept**: application/json
684
+
685
+
686
+ ### HTTP response details
687
+ | Status code | Description | Response headers |
688
+ |-------------|-------------|------------------|
689
+ |**200** | Successful action | - |
690
+
691
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
692
+
693
+ # **v1DeleteBlackoutVolume**
694
+ > SuccessfulDelete v1DeleteBlackoutVolume()
695
+
696
+ Delete a blackout volume.
697
+
698
+ ### Example
699
+
700
+ ```typescript
701
+ import {
702
+ DefaultApi,
703
+ Configuration
704
+ } from '@ourskyai/sda-api';
705
+
706
+ const configuration = new Configuration();
707
+ const apiInstance = new DefaultApi(configuration);
708
+
709
+ let id: string; // (default to undefined)
710
+
711
+ const { status, data } = await apiInstance.v1DeleteBlackoutVolume(
712
+ id
713
+ );
714
+ ```
715
+
716
+ ### Parameters
717
+
718
+ |Name | Type | Description | Notes|
719
+ |------------- | ------------- | ------------- | -------------|
720
+ | **id** | [**string**] | | defaults to undefined|
721
+
722
+
723
+ ### Return type
724
+
725
+ **SuccessfulDelete**
726
+
727
+ ### Authorization
728
+
729
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
730
+
731
+ ### HTTP request headers
732
+
733
+ - **Content-Type**: Not defined
734
+ - **Accept**: application/json
735
+
736
+
737
+ ### HTTP response details
738
+ | Status code | Description | Response headers |
739
+ |-------------|-------------|------------------|
740
+ |**200** | Successful delete | - |
741
+
742
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
743
+
744
+ # **v1DeleteDirectTaskInstruction**
745
+ > EmptySuccess v1DeleteDirectTaskInstruction()
746
+
747
+ Delete a direct task instruction.
748
+
749
+ ### Example
750
+
751
+ ```typescript
752
+ import {
753
+ DefaultApi,
754
+ Configuration
755
+ } from '@ourskyai/sda-api';
756
+
757
+ const configuration = new Configuration();
758
+ const apiInstance = new DefaultApi(configuration);
759
+
760
+ let id: string; // (default to undefined)
761
+
762
+ const { status, data } = await apiInstance.v1DeleteDirectTaskInstruction(
763
+ id
764
+ );
765
+ ```
766
+
767
+ ### Parameters
768
+
769
+ |Name | Type | Description | Notes|
770
+ |------------- | ------------- | ------------- | -------------|
771
+ | **id** | [**string**] | | defaults to undefined|
772
+
773
+
774
+ ### Return type
775
+
776
+ **EmptySuccess**
777
+
778
+ ### Authorization
779
+
780
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
781
+
782
+ ### HTTP request headers
783
+
784
+ - **Content-Type**: Not defined
785
+ - **Accept**: application/json
786
+
787
+
788
+ ### HTTP response details
789
+ | Status code | Description | Response headers |
790
+ |-------------|-------------|------------------|
791
+ |**200** | Successful action | - |
792
+
793
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
794
+
795
+ # **v1DeleteImageSet**
796
+ > EmptySuccess v1DeleteImageSet()
797
+
798
+ Delete an image set.
799
+
800
+ ### Example
801
+
802
+ ```typescript
803
+ import {
804
+ DefaultApi,
805
+ Configuration
806
+ } from '@ourskyai/sda-api';
807
+
808
+ const configuration = new Configuration();
809
+ const apiInstance = new DefaultApi(configuration);
810
+
811
+ let id: string; // (default to undefined)
812
+
813
+ const { status, data } = await apiInstance.v1DeleteImageSet(
814
+ id
815
+ );
816
+ ```
817
+
818
+ ### Parameters
819
+
820
+ |Name | Type | Description | Notes|
821
+ |------------- | ------------- | ------------- | -------------|
822
+ | **id** | [**string**] | | defaults to undefined|
823
+
824
+
825
+ ### Return type
826
+
827
+ **EmptySuccess**
828
+
829
+ ### Authorization
830
+
831
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
832
+
833
+ ### HTTP request headers
834
+
835
+ - **Content-Type**: Not defined
836
+ - **Accept**: application/json
837
+
838
+
839
+ ### HTTP response details
840
+ | Status code | Description | Response headers |
841
+ |-------------|-------------|------------------|
842
+ |**200** | Successful action | - |
843
+
844
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
845
+
846
+ # **v1DeleteImageSetImage**
847
+ > EmptySuccess v1DeleteImageSetImage()
848
+
849
+ Delete an image.
850
+
851
+ ### Example
852
+
853
+ ```typescript
854
+ import {
855
+ DefaultApi,
856
+ Configuration
857
+ } from '@ourskyai/sda-api';
858
+
859
+ const configuration = new Configuration();
860
+ const apiInstance = new DefaultApi(configuration);
861
+
862
+ let imageId: string; // (default to undefined)
863
+
864
+ const { status, data } = await apiInstance.v1DeleteImageSetImage(
865
+ imageId
866
+ );
867
+ ```
868
+
869
+ ### Parameters
870
+
871
+ |Name | Type | Description | Notes|
872
+ |------------- | ------------- | ------------- | -------------|
873
+ | **imageId** | [**string**] | | defaults to undefined|
874
+
875
+
876
+ ### Return type
877
+
878
+ **EmptySuccess**
879
+
880
+ ### Authorization
881
+
882
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
883
+
884
+ ### HTTP request headers
885
+
886
+ - **Content-Type**: Not defined
887
+ - **Accept**: application/json
888
+
889
+
890
+ ### HTTP response details
891
+ | Status code | Description | Response headers |
892
+ |-------------|-------------|------------------|
893
+ |**200** | Successful action | - |
894
+
895
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
896
+
897
+ # **v1DeleteOrganizationTarget**
898
+ > SuccessfulDelete v1DeleteOrganizationTarget()
899
+
900
+ Delete an organization target.
901
+
902
+ ### Example
903
+
904
+ ```typescript
905
+ import {
906
+ DefaultApi,
907
+ Configuration
908
+ } from '@ourskyai/sda-api';
909
+
910
+ const configuration = new Configuration();
911
+ const apiInstance = new DefaultApi(configuration);
912
+
913
+ let satelliteTargetId: string; // (default to undefined)
914
+
915
+ const { status, data } = await apiInstance.v1DeleteOrganizationTarget(
916
+ satelliteTargetId
917
+ );
918
+ ```
919
+
920
+ ### Parameters
921
+
922
+ |Name | Type | Description | Notes|
923
+ |------------- | ------------- | ------------- | -------------|
924
+ | **satelliteTargetId** | [**string**] | | defaults to undefined|
925
+
926
+
927
+ ### Return type
928
+
929
+ **SuccessfulDelete**
930
+
931
+ ### Authorization
932
+
933
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
934
+
935
+ ### HTTP request headers
936
+
937
+ - **Content-Type**: Not defined
938
+ - **Accept**: application/json
939
+
940
+
941
+ ### HTTP response details
942
+ | Status code | Description | Response headers |
943
+ |-------------|-------------|------------------|
944
+ |**200** | Successful delete | - |
945
+
946
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
947
+
948
+ # **v1DeleteSearchInstruction**
949
+ > EmptySuccess v1DeleteSearchInstruction()
950
+
951
+ Delete a search instruction.
952
+
953
+ ### Example
954
+
955
+ ```typescript
956
+ import {
957
+ DefaultApi,
958
+ Configuration
959
+ } from '@ourskyai/sda-api';
960
+
961
+ const configuration = new Configuration();
962
+ const apiInstance = new DefaultApi(configuration);
963
+
964
+ let id: string; // (default to undefined)
965
+
966
+ const { status, data } = await apiInstance.v1DeleteSearchInstruction(
967
+ id
968
+ );
969
+ ```
970
+
971
+ ### Parameters
972
+
973
+ |Name | Type | Description | Notes|
974
+ |------------- | ------------- | ------------- | -------------|
975
+ | **id** | [**string**] | | defaults to undefined|
976
+
977
+
978
+ ### Return type
979
+
980
+ **EmptySuccess**
981
+
982
+ ### Authorization
983
+
984
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
985
+
986
+ ### HTTP request headers
987
+
988
+ - **Content-Type**: Not defined
989
+ - **Accept**: application/json
990
+
991
+
992
+ ### HTTP response details
993
+ | Status code | Description | Response headers |
994
+ |-------------|-------------|------------------|
995
+ |**200** | Successful action | - |
996
+
997
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
998
+
999
+ # **v1DeleteSurveyInstruction**
1000
+ > EmptySuccess v1DeleteSurveyInstruction()
1001
+
1002
+ Delete a survey instruction.
1003
+
1004
+ ### Example
1005
+
1006
+ ```typescript
1007
+ import {
1008
+ DefaultApi,
1009
+ Configuration
1010
+ } from '@ourskyai/sda-api';
1011
+
1012
+ const configuration = new Configuration();
1013
+ const apiInstance = new DefaultApi(configuration);
1014
+
1015
+ let id: string; // (default to undefined)
1016
+
1017
+ const { status, data } = await apiInstance.v1DeleteSurveyInstruction(
1018
+ id
1019
+ );
1020
+ ```
1021
+
1022
+ ### Parameters
1023
+
1024
+ |Name | Type | Description | Notes|
1025
+ |------------- | ------------- | ------------- | -------------|
1026
+ | **id** | [**string**] | | defaults to undefined|
1027
+
1028
+
1029
+ ### Return type
1030
+
1031
+ **EmptySuccess**
1032
+
1033
+ ### Authorization
1034
+
1035
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1036
+
1037
+ ### HTTP request headers
1038
+
1039
+ - **Content-Type**: Not defined
1040
+ - **Accept**: application/json
1041
+
1042
+
1043
+ ### HTTP response details
1044
+ | Status code | Description | Response headers |
1045
+ |-------------|-------------|------------------|
1046
+ |**200** | Successful action | - |
1047
+
1048
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1049
+
1050
+ # **v1DeleteWebhookConfiguration**
1051
+ > EmptySuccess v1DeleteWebhookConfiguration()
1052
+
1053
+ Delete a webhook configuration.
1054
+
1055
+ ### Example
1056
+
1057
+ ```typescript
1058
+ import {
1059
+ DefaultApi,
1060
+ Configuration
1061
+ } from '@ourskyai/sda-api';
1062
+
1063
+ const configuration = new Configuration();
1064
+ const apiInstance = new DefaultApi(configuration);
1065
+
1066
+ let id: string; // (default to undefined)
1067
+
1068
+ const { status, data } = await apiInstance.v1DeleteWebhookConfiguration(
1069
+ id
1070
+ );
1071
+ ```
1072
+
1073
+ ### Parameters
1074
+
1075
+ |Name | Type | Description | Notes|
1076
+ |------------- | ------------- | ------------- | -------------|
1077
+ | **id** | [**string**] | | defaults to undefined|
1078
+
1079
+
1080
+ ### Return type
1081
+
1082
+ **EmptySuccess**
1083
+
1084
+ ### Authorization
1085
+
1086
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1087
+
1088
+ ### HTTP request headers
1089
+
1090
+ - **Content-Type**: Not defined
1091
+ - **Accept**: application/json
1092
+
1093
+
1094
+ ### HTTP response details
1095
+ | Status code | Description | Response headers |
1096
+ |-------------|-------------|------------------|
1097
+ |**200** | Successful action | - |
1098
+
1099
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1100
+
1101
+ # **v1GetImageMetadata**
1102
+ > V1ImageMetadata v1GetImageMetadata()
1103
+
1104
+ Get metadata about an image by image id. This includes plate solve results
1105
+
1106
+ ### Example
1107
+
1108
+ ```typescript
1109
+ import {
1110
+ DefaultApi,
1111
+ Configuration
1112
+ } from '@ourskyai/sda-api';
1113
+
1114
+ const configuration = new Configuration();
1115
+ const apiInstance = new DefaultApi(configuration);
1116
+
1117
+ let imageId: string; // (default to undefined)
1118
+
1119
+ const { status, data } = await apiInstance.v1GetImageMetadata(
1120
+ imageId
1121
+ );
1122
+ ```
1123
+
1124
+ ### Parameters
1125
+
1126
+ |Name | Type | Description | Notes|
1127
+ |------------- | ------------- | ------------- | -------------|
1128
+ | **imageId** | [**string**] | | defaults to undefined|
1129
+
1130
+
1131
+ ### Return type
1132
+
1133
+ **V1ImageMetadata**
1134
+
1135
+ ### Authorization
1136
+
1137
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1138
+
1139
+ ### HTTP request headers
1140
+
1141
+ - **Content-Type**: Not defined
1142
+ - **Accept**: application/json
1143
+
1144
+
1145
+ ### HTTP response details
1146
+ | Status code | Description | Response headers |
1147
+ |-------------|-------------|------------------|
1148
+ |**200** | V1ImageMetadata | - |
1149
+
1150
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1151
+
1152
+ # **v1GetImageSet**
1153
+ > V1ImageSet v1GetImageSet()
1154
+
1155
+ Get an image set.
1156
+
1157
+ ### Example
1158
+
1159
+ ```typescript
1160
+ import {
1161
+ DefaultApi,
1162
+ Configuration
1163
+ } from '@ourskyai/sda-api';
1164
+
1165
+ const configuration = new Configuration();
1166
+ const apiInstance = new DefaultApi(configuration);
1167
+
1168
+ let id: string; // (default to undefined)
1169
+
1170
+ const { status, data } = await apiInstance.v1GetImageSet(
1171
+ id
1172
+ );
1173
+ ```
1174
+
1175
+ ### Parameters
1176
+
1177
+ |Name | Type | Description | Notes|
1178
+ |------------- | ------------- | ------------- | -------------|
1179
+ | **id** | [**string**] | | defaults to undefined|
1180
+
1181
+
1182
+ ### Return type
1183
+
1184
+ **V1ImageSet**
1185
+
1186
+ ### Authorization
1187
+
1188
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1189
+
1190
+ ### HTTP request headers
1191
+
1192
+ - **Content-Type**: Not defined
1193
+ - **Accept**: application/json
1194
+
1195
+
1196
+ ### HTTP response details
1197
+ | Status code | Description | Response headers |
1198
+ |-------------|-------------|------------------|
1199
+ |**200** | V1ImageSet | - |
1200
+
1201
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1202
+
1203
+ # **v1GetImageSetImage**
1204
+ > V1ImageSetImage v1GetImageSetImage()
1205
+
1206
+ Get an image.
1207
+
1208
+ ### Example
1209
+
1210
+ ```typescript
1211
+ import {
1212
+ DefaultApi,
1213
+ Configuration
1214
+ } from '@ourskyai/sda-api';
1215
+
1216
+ const configuration = new Configuration();
1217
+ const apiInstance = new DefaultApi(configuration);
1218
+
1219
+ let imageId: string; // (default to undefined)
1220
+
1221
+ const { status, data } = await apiInstance.v1GetImageSetImage(
1222
+ imageId
1223
+ );
1224
+ ```
1225
+
1226
+ ### Parameters
1227
+
1228
+ |Name | Type | Description | Notes|
1229
+ |------------- | ------------- | ------------- | -------------|
1230
+ | **imageId** | [**string**] | | defaults to undefined|
1231
+
1232
+
1233
+ ### Return type
1234
+
1235
+ **V1ImageSetImage**
1236
+
1237
+ ### Authorization
1238
+
1239
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1240
+
1241
+ ### HTTP request headers
1242
+
1243
+ - **Content-Type**: Not defined
1244
+ - **Accept**: application/json
1245
+
1246
+
1247
+ ### HTTP response details
1248
+ | Status code | Description | Response headers |
1249
+ |-------------|-------------|------------------|
1250
+ |**200** | V1ImageSetImage | - |
1251
+
1252
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1253
+
1254
+ # **v1GetImageSetImages**
1255
+ > Array<V1ImageSetImage> v1GetImageSetImages()
1256
+
1257
+ Get image set images for an explicit list of image set ids. Star parties are owned by the edge controller, so the starPartyId param is not supported in the cloud API and returns 400 if provided; use the node-platform star party endpoints to resolve a party\'s image sets.
1258
+
1259
+ ### Example
1260
+
1261
+ ```typescript
1262
+ import {
1263
+ DefaultApi,
1264
+ Configuration
1265
+ } from '@ourskyai/sda-api';
1266
+
1267
+ const configuration = new Configuration();
1268
+ const apiInstance = new DefaultApi(configuration);
1269
+
1270
+ let imageSets: Array<string>; // (optional) (default to undefined)
1271
+ let starPartyId: string; // (optional) (default to undefined)
1272
+
1273
+ const { status, data } = await apiInstance.v1GetImageSetImages(
1274
+ imageSets,
1275
+ starPartyId
1276
+ );
1277
+ ```
1278
+
1279
+ ### Parameters
1280
+
1281
+ |Name | Type | Description | Notes|
1282
+ |------------- | ------------- | ------------- | -------------|
1283
+ | **imageSets** | **Array&lt;string&gt;** | | (optional) defaults to undefined|
1284
+ | **starPartyId** | [**string**] | | (optional) defaults to undefined|
1285
+
1286
+
1287
+ ### Return type
1288
+
1289
+ **Array<V1ImageSetImage>**
1290
+
1291
+ ### Authorization
1292
+
1293
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1294
+
1295
+ ### HTTP request headers
1296
+
1297
+ - **Content-Type**: Not defined
1298
+ - **Accept**: application/json
1299
+
1300
+
1301
+ ### HTTP response details
1302
+ | Status code | Description | Response headers |
1303
+ |-------------|-------------|------------------|
1304
+ |**200** | V1ImageSetImage[] | - |
1305
+
1306
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1307
+
1308
+ # **v1GetImageSets**
1309
+ > Array<V1ImageSet> v1GetImageSets()
1310
+
1311
+ Get image sets. Star parties are owned by the edge controller, so the starPartyId param is not supported in the cloud API and returns 400 if provided; use the node-platform star party endpoints to resolve a party\'s image sets.
1312
+
1313
+ ### Example
1314
+
1315
+ ```typescript
1316
+ import {
1317
+ DefaultApi,
1318
+ Configuration
1319
+ } from '@ourskyai/sda-api';
1320
+
1321
+ const configuration = new Configuration();
1322
+ const apiInstance = new DefaultApi(configuration);
1323
+
1324
+ let starPartyId: string; // (optional) (default to undefined)
1325
+
1326
+ const { status, data } = await apiInstance.v1GetImageSets(
1327
+ starPartyId
1328
+ );
1329
+ ```
1330
+
1331
+ ### Parameters
1332
+
1333
+ |Name | Type | Description | Notes|
1334
+ |------------- | ------------- | ------------- | -------------|
1335
+ | **starPartyId** | [**string**] | | (optional) defaults to undefined|
1336
+
1337
+
1338
+ ### Return type
1339
+
1340
+ **Array<V1ImageSet>**
1341
+
1342
+ ### Authorization
1343
+
1344
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1345
+
1346
+ ### HTTP request headers
1347
+
1348
+ - **Content-Type**: Not defined
1349
+ - **Accept**: application/json
1350
+
1351
+
1352
+ ### HTTP response details
1353
+ | Status code | Description | Response headers |
1354
+ |-------------|-------------|------------------|
1355
+ |**200** | V1ImageSet[] | - |
1356
+
1357
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1358
+
1359
+ # **v1GetNodeProperties**
1360
+ > V1GroundStationParticipant v1GetNodeProperties()
1361
+
1362
+ Get node properties.
1363
+
1364
+ ### Example
1365
+
1366
+ ```typescript
1367
+ import {
1368
+ DefaultApi,
1369
+ Configuration
1370
+ } from '@ourskyai/sda-api';
1371
+
1372
+ const configuration = new Configuration();
1373
+ const apiInstance = new DefaultApi(configuration);
1374
+
1375
+ let nodeId: string; // (default to undefined)
1376
+
1377
+ const { status, data } = await apiInstance.v1GetNodeProperties(
1378
+ nodeId
1379
+ );
1380
+ ```
1381
+
1382
+ ### Parameters
1383
+
1384
+ |Name | Type | Description | Notes|
1385
+ |------------- | ------------- | ------------- | -------------|
1386
+ | **nodeId** | [**string**] | | defaults to undefined|
1387
+
1388
+
1389
+ ### Return type
1390
+
1391
+ **V1GroundStationParticipant**
1392
+
1393
+ ### Authorization
1394
+
1395
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1396
+
1397
+ ### HTTP request headers
1398
+
1399
+ - **Content-Type**: Not defined
1400
+ - **Accept**: application/json
1401
+
1402
+
1403
+ ### HTTP response details
1404
+ | Status code | Description | Response headers |
1405
+ |-------------|-------------|------------------|
1406
+ |**200** | V1GroundStationParticipant | - |
1407
+
1408
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1409
+
1410
+ # **v1GetNodeSatelliteCalibrations**
1411
+ > Array<V1NodeCalibrationResult> v1GetNodeSatelliteCalibrations()
1412
+
1413
+ Get recent satellite calibrations by node. Paginate using `before` and `limit` to retrieve previous calibrations
1414
+
1415
+ ### Example
1416
+
1417
+ ```typescript
1418
+ import {
1419
+ DefaultApi,
1420
+ Configuration
1421
+ } from '@ourskyai/sda-api';
1422
+
1423
+ const configuration = new Configuration();
1424
+ const apiInstance = new DefaultApi(configuration);
1425
+
1426
+ let nodeId: string; // (default to undefined)
1427
+ let limit: number; // (optional) (default to undefined)
1428
+ let before: string; // (optional) (default to undefined)
1429
+
1430
+ const { status, data } = await apiInstance.v1GetNodeSatelliteCalibrations(
1431
+ nodeId,
1432
+ limit,
1433
+ before
1434
+ );
1435
+ ```
1436
+
1437
+ ### Parameters
1438
+
1439
+ |Name | Type | Description | Notes|
1440
+ |------------- | ------------- | ------------- | -------------|
1441
+ | **nodeId** | [**string**] | | defaults to undefined|
1442
+ | **limit** | [**number**] | | (optional) defaults to undefined|
1443
+ | **before** | [**string**] | | (optional) defaults to undefined|
1444
+
1445
+
1446
+ ### Return type
1447
+
1448
+ **Array<V1NodeCalibrationResult>**
1449
+
1450
+ ### Authorization
1451
+
1452
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1453
+
1454
+ ### HTTP request headers
1455
+
1456
+ - **Content-Type**: Not defined
1457
+ - **Accept**: application/json
1458
+
1459
+
1460
+ ### HTTP response details
1461
+ | Status code | Description | Response headers |
1462
+ |-------------|-------------|------------------|
1463
+ |**200** | V1NodeCalibrationResult[] | - |
1464
+
1465
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1466
+
1467
+ # **v1GetObservationFeatures**
1468
+ > Array<V1ObservationFeature> v1GetObservationFeatures()
1469
+
1470
+ Get observation features.
1471
+
1472
+ ### Example
1473
+
1474
+ ```typescript
1475
+ import {
1476
+ DefaultApi,
1477
+ Configuration
1478
+ } from '@ourskyai/sda-api';
1479
+
1480
+ const configuration = new Configuration();
1481
+ const apiInstance = new DefaultApi(configuration);
1482
+
1483
+ let imageId: string; // (default to undefined)
1484
+
1485
+ const { status, data } = await apiInstance.v1GetObservationFeatures(
1486
+ imageId
1487
+ );
1488
+ ```
1489
+
1490
+ ### Parameters
1491
+
1492
+ |Name | Type | Description | Notes|
1493
+ |------------- | ------------- | ------------- | -------------|
1494
+ | **imageId** | [**string**] | | defaults to undefined|
1495
+
1496
+
1497
+ ### Return type
1498
+
1499
+ **Array<V1ObservationFeature>**
1500
+
1501
+ ### Authorization
1502
+
1503
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1504
+
1505
+ ### HTTP request headers
1506
+
1507
+ - **Content-Type**: Not defined
1508
+ - **Accept**: application/json
1509
+
1510
+
1511
+ ### HTTP response details
1512
+ | Status code | Description | Response headers |
1513
+ |-------------|-------------|------------------|
1514
+ |**200** | V1ObservationFeature[] | - |
1515
+
1516
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1517
+
1518
+ # **v1GetObservationSequenceResult**
1519
+ > V1ObservationSequenceResult v1GetObservationSequenceResult()
1520
+
1521
+ Get an observation sequence result for a specific image id.
1522
+
1523
+ ### Example
1524
+
1525
+ ```typescript
1526
+ import {
1527
+ DefaultApi,
1528
+ Configuration
1529
+ } from '@ourskyai/sda-api';
1530
+
1531
+ const configuration = new Configuration();
1532
+ const apiInstance = new DefaultApi(configuration);
1533
+
1534
+ let observationSequenceResultId: string; // (optional) (default to undefined)
1535
+ let imageId: string; // (optional) (default to undefined)
1536
+
1537
+ const { status, data } = await apiInstance.v1GetObservationSequenceResult(
1538
+ observationSequenceResultId,
1539
+ imageId
1540
+ );
1541
+ ```
1542
+
1543
+ ### Parameters
1544
+
1545
+ |Name | Type | Description | Notes|
1546
+ |------------- | ------------- | ------------- | -------------|
1547
+ | **observationSequenceResultId** | [**string**] | | (optional) defaults to undefined|
1548
+ | **imageId** | [**string**] | | (optional) defaults to undefined|
1549
+
1550
+
1551
+ ### Return type
1552
+
1553
+ **V1ObservationSequenceResult**
1554
+
1555
+ ### Authorization
1556
+
1557
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1558
+
1559
+ ### HTTP request headers
1560
+
1561
+ - **Content-Type**: Not defined
1562
+ - **Accept**: application/json
1563
+
1564
+
1565
+ ### HTTP response details
1566
+ | Status code | Description | Response headers |
1567
+ |-------------|-------------|------------------|
1568
+ |**200** | V1ObservationSequenceResult | - |
1569
+
1570
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1571
+
1572
+ # **v1GetObservationSequenceResults**
1573
+ > Array<V1ObservationSequenceResult> v1GetObservationSequenceResults()
1574
+
1575
+ Get all observation sequence results for a specific target or all for an organization. This response is paginated. It will only return at most 5 at a time. To get the next page, pass in the `created_at` timestamp of the last observation sequence in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
1576
+
1577
+ ### Example
1578
+
1579
+ ```typescript
1580
+ import {
1581
+ DefaultApi,
1582
+ Configuration
1583
+ } from '@ourskyai/sda-api';
1584
+
1585
+ const configuration = new Configuration();
1586
+ const apiInstance = new DefaultApi(configuration);
1587
+
1588
+ let targetId: string; // (optional) (default to undefined)
1589
+ let after: string; // (optional) (default to undefined)
1590
+
1591
+ const { status, data } = await apiInstance.v1GetObservationSequenceResults(
1592
+ targetId,
1593
+ after
1594
+ );
1595
+ ```
1596
+
1597
+ ### Parameters
1598
+
1599
+ |Name | Type | Description | Notes|
1600
+ |------------- | ------------- | ------------- | -------------|
1601
+ | **targetId** | [**string**] | | (optional) defaults to undefined|
1602
+ | **after** | [**string**] | | (optional) defaults to undefined|
1603
+
1604
+
1605
+ ### Return type
1606
+
1607
+ **Array<V1ObservationSequenceResult>**
1608
+
1609
+ ### Authorization
1610
+
1611
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1612
+
1613
+ ### HTTP request headers
1614
+
1615
+ - **Content-Type**: Not defined
1616
+ - **Accept**: application/json
1617
+
1618
+
1619
+ ### HTTP response details
1620
+ | Status code | Description | Response headers |
1621
+ |-------------|-------------|------------------|
1622
+ |**200** | V1ObservationSequenceResult[] | - |
1623
+
1624
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1625
+
1626
+ # **v1GetObservationStatuses**
1627
+ > Array<V1ObservationStatus> v1GetObservationStatuses()
1628
+
1629
+ Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, `searchInstructionId`, `directTaskId`, or by `surveyInstructionId`. By default `before` is set to the current time and returns 20 results with `observationTime` less than `before`. To paginate through responses, pass the earliest timestamp in the previous response as the `before` parameter. When searching by `searchInstructionId`, `directTaskId`, or `surveyInstructionId`, a `before` timestamp is not required.
1630
+
1631
+ ### Example
1632
+
1633
+ ```typescript
1634
+ import {
1635
+ DefaultApi,
1636
+ Configuration
1637
+ } from '@ourskyai/sda-api';
1638
+
1639
+ const configuration = new Configuration();
1640
+ const apiInstance = new DefaultApi(configuration);
1641
+
1642
+ let targetId: string; // (optional) (default to undefined)
1643
+ let before: string; // (optional) (default to undefined)
1644
+ let searchInstructionId: string; // (optional) (default to undefined)
1645
+ let surveyInstructionId: string; // (optional) (default to undefined)
1646
+ let resolvedImageInstructionId: string; // (optional) (default to undefined)
1647
+ let directTaskId: string; // (optional) (default to undefined)
1648
+ let imageId: string; // (optional) (default to undefined)
1649
+
1650
+ const { status, data } = await apiInstance.v1GetObservationStatuses(
1651
+ targetId,
1652
+ before,
1653
+ searchInstructionId,
1654
+ surveyInstructionId,
1655
+ resolvedImageInstructionId,
1656
+ directTaskId,
1657
+ imageId
1658
+ );
1659
+ ```
1660
+
1661
+ ### Parameters
1662
+
1663
+ |Name | Type | Description | Notes|
1664
+ |------------- | ------------- | ------------- | -------------|
1665
+ | **targetId** | [**string**] | | (optional) defaults to undefined|
1666
+ | **before** | [**string**] | | (optional) defaults to undefined|
1667
+ | **searchInstructionId** | [**string**] | | (optional) defaults to undefined|
1668
+ | **surveyInstructionId** | [**string**] | | (optional) defaults to undefined|
1669
+ | **resolvedImageInstructionId** | [**string**] | | (optional) defaults to undefined|
1670
+ | **directTaskId** | [**string**] | | (optional) defaults to undefined|
1671
+ | **imageId** | [**string**] | | (optional) defaults to undefined|
1672
+
1673
+
1674
+ ### Return type
1675
+
1676
+ **Array<V1ObservationStatus>**
1677
+
1678
+ ### Authorization
1679
+
1680
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1681
+
1682
+ ### HTTP request headers
1683
+
1684
+ - **Content-Type**: Not defined
1685
+ - **Accept**: application/json
1686
+
1687
+
1688
+ ### HTTP response details
1689
+ | Status code | Description | Response headers |
1690
+ |-------------|-------------|------------------|
1691
+ |**200** | V1ObservationStatus[] | - |
1692
+
1693
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1694
+
1695
+ # **v1GetOrganizationSatellitePotentials**
1696
+ > Array<V1SatellitePotential> v1GetOrganizationSatellitePotentials()
1697
+
1698
+ Get potential observation windows for all satellites of your organization across the network up to 72 hours from now (or from the optional `from` datetime) until `until`
1699
+
1700
+ ### Example
1701
+
1702
+ ```typescript
1703
+ import {
1704
+ DefaultApi,
1705
+ Configuration
1706
+ } from '@ourskyai/sda-api';
1707
+
1708
+ const configuration = new Configuration();
1709
+ const apiInstance = new DefaultApi(configuration);
1710
+
1711
+ let until: string; //End of the window. Must be within 72 hours of `from`. (default to undefined)
1712
+ let from: string; //Start of the window. Defaults to now. (optional) (default to undefined)
1713
+ let includeWeather: boolean; // (optional) (default to false)
1714
+
1715
+ const { status, data } = await apiInstance.v1GetOrganizationSatellitePotentials(
1716
+ until,
1717
+ from,
1718
+ includeWeather
1719
+ );
1720
+ ```
1721
+
1722
+ ### Parameters
1723
+
1724
+ |Name | Type | Description | Notes|
1725
+ |------------- | ------------- | ------------- | -------------|
1726
+ | **until** | [**string**] | End of the window. Must be within 72 hours of &#x60;from&#x60;. | defaults to undefined|
1727
+ | **from** | [**string**] | Start of the window. Defaults to now. | (optional) defaults to undefined|
1728
+ | **includeWeather** | [**boolean**] | | (optional) defaults to false|
1729
+
1730
+
1731
+ ### Return type
1732
+
1733
+ **Array<V1SatellitePotential>**
1734
+
1735
+ ### Authorization
1736
+
1737
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1738
+
1739
+ ### HTTP request headers
1740
+
1741
+ - **Content-Type**: Not defined
1742
+ - **Accept**: application/json
1743
+
1744
+
1745
+ ### HTTP response details
1746
+ | Status code | Description | Response headers |
1747
+ |-------------|-------------|------------------|
1748
+ |**200** | V1SatellitePotential[] | - |
1749
+
1750
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1751
+
1752
+ # **v1GetOrganizationTarget**
1753
+ > V1OrganizationTarget v1GetOrganizationTarget()
1754
+
1755
+ Get an existing organization target
1756
+
1757
+ ### Example
1758
+
1759
+ ```typescript
1760
+ import {
1761
+ DefaultApi,
1762
+ Configuration
1763
+ } from '@ourskyai/sda-api';
1764
+
1765
+ const configuration = new Configuration();
1766
+ const apiInstance = new DefaultApi(configuration);
1767
+
1768
+ let organizationTargetId: string; // (default to undefined)
1769
+
1770
+ const { status, data } = await apiInstance.v1GetOrganizationTarget(
1771
+ organizationTargetId
1772
+ );
1773
+ ```
1774
+
1775
+ ### Parameters
1776
+
1777
+ |Name | Type | Description | Notes|
1778
+ |------------- | ------------- | ------------- | -------------|
1779
+ | **organizationTargetId** | [**string**] | | defaults to undefined|
1780
+
1781
+
1782
+ ### Return type
1783
+
1784
+ **V1OrganizationTarget**
1785
+
1786
+ ### Authorization
1787
+
1788
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1789
+
1790
+ ### HTTP request headers
1791
+
1792
+ - **Content-Type**: Not defined
1793
+ - **Accept**: application/json
1794
+
1795
+
1796
+ ### HTTP response details
1797
+ | Status code | Description | Response headers |
1798
+ |-------------|-------------|------------------|
1799
+ |**200** | V1GetOrganizationTarget | - |
1800
+
1801
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1802
+
1803
+ # **v1GetOrganizationTargets**
1804
+ > Array<V1OrganizationTarget> v1GetOrganizationTargets()
1805
+
1806
+ Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
1807
+
1808
+ ### Example
1809
+
1810
+ ```typescript
1811
+ import {
1812
+ DefaultApi,
1813
+ Configuration
1814
+ } from '@ourskyai/sda-api';
1815
+
1816
+ const configuration = new Configuration();
1817
+ const apiInstance = new DefaultApi(configuration);
1818
+
1819
+ const { status, data } = await apiInstance.v1GetOrganizationTargets();
1820
+ ```
1821
+
1822
+ ### Parameters
1823
+ This endpoint does not have any parameters.
1824
+
1825
+
1826
+ ### Return type
1827
+
1828
+ **Array<V1OrganizationTarget>**
1829
+
1830
+ ### Authorization
1831
+
1832
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1833
+
1834
+ ### HTTP request headers
1835
+
1836
+ - **Content-Type**: Not defined
1837
+ - **Accept**: application/json
1838
+
1839
+
1840
+ ### HTTP response details
1841
+ | Status code | Description | Response headers |
1842
+ |-------------|-------------|------------------|
1843
+ |**200** | V1OrganizationTarget[] | - |
1844
+
1845
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1846
+
1847
+ # **v1GetResolvedImageMetadata**
1848
+ > V1ResolvedImageMetadata v1GetResolvedImageMetadata()
1849
+
1850
+ Get rich per-image metadata for a resolved image by its unsharpened source imageId, scoped to the principal\'s organization. Requires the `RESOLVED_IMAGING` product feature on the principal\'s organization.
1851
+
1852
+ ### Example
1853
+
1854
+ ```typescript
1855
+ import {
1856
+ DefaultApi,
1857
+ Configuration
1858
+ } from '@ourskyai/sda-api';
1859
+
1860
+ const configuration = new Configuration();
1861
+ const apiInstance = new DefaultApi(configuration);
1862
+
1863
+ let imageId: string; // (default to undefined)
1864
+
1865
+ const { status, data } = await apiInstance.v1GetResolvedImageMetadata(
1866
+ imageId
1867
+ );
1868
+ ```
1869
+
1870
+ ### Parameters
1871
+
1872
+ |Name | Type | Description | Notes|
1873
+ |------------- | ------------- | ------------- | -------------|
1874
+ | **imageId** | [**string**] | | defaults to undefined|
1875
+
1876
+
1877
+ ### Return type
1878
+
1879
+ **V1ResolvedImageMetadata**
1880
+
1881
+ ### Authorization
1882
+
1883
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1884
+
1885
+ ### HTTP request headers
1886
+
1887
+ - **Content-Type**: Not defined
1888
+ - **Accept**: application/json
1889
+
1890
+
1891
+ ### HTTP response details
1892
+ | Status code | Description | Response headers |
1893
+ |-------------|-------------|------------------|
1894
+ |**200** | V1ResolvedImageMetadata | - |
1895
+
1896
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1897
+
1898
+ # **v1GetResolvedImageObservations**
1899
+ > Array<V1ResolvedImageObservation> v1GetResolvedImageObservations()
1900
+
1901
+ List resolved-image observations for the principal\'s organization, ordered by observation time descending. Each entry is a lightweight summary with the top-9 sharpest images (presigned thumbnail URLs only) for grid preview. For full unsharpened/sharpened FITS and JPG URLs, call `GET /v1/resolved-image-set?imageSetId=<imageSetId>` (operationId `V1GetResolvedImageSet`). Requires the `RESOLVED_IMAGING` product feature on the principal\'s organization.
1902
+
1903
+ ### Example
1904
+
1905
+ ```typescript
1906
+ import {
1907
+ DefaultApi,
1908
+ Configuration
1909
+ } from '@ourskyai/sda-api';
1910
+
1911
+ const configuration = new Configuration();
1912
+ const apiInstance = new DefaultApi(configuration);
1913
+
1914
+ let before: string; //Return observations whose time_utc is strictly less than this timestamp. Defaults to now. (optional) (default to undefined)
1915
+ let limit: number; //Maximum number of rows to return. Defaults to 20, capped at 100. (optional) (default to undefined)
1916
+
1917
+ const { status, data } = await apiInstance.v1GetResolvedImageObservations(
1918
+ before,
1919
+ limit
1920
+ );
1921
+ ```
1922
+
1923
+ ### Parameters
1924
+
1925
+ |Name | Type | Description | Notes|
1926
+ |------------- | ------------- | ------------- | -------------|
1927
+ | **before** | [**string**] | Return observations whose time_utc is strictly less than this timestamp. Defaults to now. | (optional) defaults to undefined|
1928
+ | **limit** | [**number**] | Maximum number of rows to return. Defaults to 20, capped at 100. | (optional) defaults to undefined|
1929
+
1930
+
1931
+ ### Return type
1932
+
1933
+ **Array<V1ResolvedImageObservation>**
1934
+
1935
+ ### Authorization
1936
+
1937
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1938
+
1939
+ ### HTTP request headers
1940
+
1941
+ - **Content-Type**: Not defined
1942
+ - **Accept**: application/json
1943
+
1944
+
1945
+ ### HTTP response details
1946
+ | Status code | Description | Response headers |
1947
+ |-------------|-------------|------------------|
1948
+ |**200** | V1ResolvedImageObservation[] | - |
1949
+
1950
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1951
+
1952
+ # **v1GetResolvedImagePair**
1953
+ > V1ResolvedImagePair v1GetResolvedImagePair()
1954
+
1955
+ Get a resolved image pair by unsharpened or sharpened image ID, scoped to the principal\'s organization. Requires the `RESOLVED_IMAGING` product feature on the principal\'s organization.
1956
+
1957
+ ### Example
1958
+
1959
+ ```typescript
1960
+ import {
1961
+ DefaultApi,
1962
+ Configuration
1963
+ } from '@ourskyai/sda-api';
1964
+
1965
+ const configuration = new Configuration();
1966
+ const apiInstance = new DefaultApi(configuration);
1967
+
1968
+ let imageId: string; //An image ID (either unsharpened or sharpened) (default to undefined)
1969
+
1970
+ const { status, data } = await apiInstance.v1GetResolvedImagePair(
1971
+ imageId
1972
+ );
1973
+ ```
1974
+
1975
+ ### Parameters
1976
+
1977
+ |Name | Type | Description | Notes|
1978
+ |------------- | ------------- | ------------- | -------------|
1979
+ | **imageId** | [**string**] | An image ID (either unsharpened or sharpened) | defaults to undefined|
1980
+
1981
+
1982
+ ### Return type
1983
+
1984
+ **V1ResolvedImagePair**
1985
+
1986
+ ### Authorization
1987
+
1988
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
1989
+
1990
+ ### HTTP request headers
1991
+
1992
+ - **Content-Type**: Not defined
1993
+ - **Accept**: application/json
1994
+
1995
+
1996
+ ### HTTP response details
1997
+ | Status code | Description | Response headers |
1998
+ |-------------|-------------|------------------|
1999
+ |**200** | V1ResolvedImagePair | - |
2000
+
2001
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2002
+
2003
+ # **v1GetResolvedImageSet**
2004
+ > V1ResolvedImageSet v1GetResolvedImageSet()
2005
+
2006
+ Get a resolved image set by its unsharpened image set ID. Returns paired unsharpened and sharpened images with sharpness scores. Requires the `RESOLVED_IMAGING` product feature on the principal\'s organization.
2007
+
2008
+ ### Example
2009
+
2010
+ ```typescript
2011
+ import {
2012
+ DefaultApi,
2013
+ Configuration
2014
+ } from '@ourskyai/sda-api';
2015
+
2016
+ const configuration = new Configuration();
2017
+ const apiInstance = new DefaultApi(configuration);
2018
+
2019
+ let imageSetId: string; //The unsharpened image set ID (default to undefined)
2020
+
2021
+ const { status, data } = await apiInstance.v1GetResolvedImageSet(
2022
+ imageSetId
2023
+ );
2024
+ ```
2025
+
2026
+ ### Parameters
2027
+
2028
+ |Name | Type | Description | Notes|
2029
+ |------------- | ------------- | ------------- | -------------|
2030
+ | **imageSetId** | [**string**] | The unsharpened image set ID | defaults to undefined|
2031
+
2032
+
2033
+ ### Return type
2034
+
2035
+ **V1ResolvedImageSet**
2036
+
2037
+ ### Authorization
2038
+
2039
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2040
+
2041
+ ### HTTP request headers
2042
+
2043
+ - **Content-Type**: Not defined
2044
+ - **Accept**: application/json
2045
+
2046
+
2047
+ ### HTTP response details
2048
+ | Status code | Description | Response headers |
2049
+ |-------------|-------------|------------------|
2050
+ |**200** | V1ResolvedImageSet | - |
2051
+
2052
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2053
+
2054
+ # **v1GetSatellitePotentials**
2055
+ > Array<V1SatellitePotential> v1GetSatellitePotentials()
2056
+
2057
+ Get potential observation windows for a satellite across the network up to 72 hours from now (or from the optional `from` datetime) until `until`
2058
+
2059
+ ### Example
2060
+
2061
+ ```typescript
2062
+ import {
2063
+ DefaultApi,
2064
+ Configuration
2065
+ } from '@ourskyai/sda-api';
2066
+
2067
+ const configuration = new Configuration();
2068
+ const apiInstance = new DefaultApi(configuration);
2069
+
2070
+ let satelliteTargetId: string; // (default to undefined)
2071
+ let until: string; //End of the window. Must be within 72 hours of `from`. (default to undefined)
2072
+ let from: string; //Start of the window. Defaults to now. (optional) (default to undefined)
2073
+ let includeWeather: boolean; // (optional) (default to false)
2074
+
2075
+ const { status, data } = await apiInstance.v1GetSatellitePotentials(
2076
+ satelliteTargetId,
2077
+ until,
2078
+ from,
2079
+ includeWeather
2080
+ );
2081
+ ```
2082
+
2083
+ ### Parameters
2084
+
2085
+ |Name | Type | Description | Notes|
2086
+ |------------- | ------------- | ------------- | -------------|
2087
+ | **satelliteTargetId** | [**string**] | | defaults to undefined|
2088
+ | **until** | [**string**] | End of the window. Must be within 72 hours of &#x60;from&#x60;. | defaults to undefined|
2089
+ | **from** | [**string**] | Start of the window. Defaults to now. | (optional) defaults to undefined|
2090
+ | **includeWeather** | [**boolean**] | | (optional) defaults to false|
2091
+
2092
+
2093
+ ### Return type
2094
+
2095
+ **Array<V1SatellitePotential>**
2096
+
2097
+ ### Authorization
2098
+
2099
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2100
+
2101
+ ### HTTP request headers
2102
+
2103
+ - **Content-Type**: Not defined
2104
+ - **Accept**: application/json
2105
+
2106
+
2107
+ ### HTTP response details
2108
+ | Status code | Description | Response headers |
2109
+ |-------------|-------------|------------------|
2110
+ |**200** | V1SatellitePotential[] | - |
2111
+
2112
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2113
+
2114
+ # **v1GetSatelliteTarget**
2115
+ > V1SatelliteTarget v1GetSatelliteTarget()
2116
+
2117
+ Get a satellite target that the OurSky platform can currently track by id.
2118
+
2119
+ ### Example
2120
+
2121
+ ```typescript
2122
+ import {
2123
+ DefaultApi,
2124
+ Configuration
2125
+ } from '@ourskyai/sda-api';
2126
+
2127
+ const configuration = new Configuration();
2128
+ const apiInstance = new DefaultApi(configuration);
2129
+
2130
+ let id: string; // (default to undefined)
2131
+
2132
+ const { status, data } = await apiInstance.v1GetSatelliteTarget(
2133
+ id
2134
+ );
2135
+ ```
2136
+
2137
+ ### Parameters
2138
+
2139
+ |Name | Type | Description | Notes|
2140
+ |------------- | ------------- | ------------- | -------------|
2141
+ | **id** | [**string**] | | defaults to undefined|
2142
+
2143
+
2144
+ ### Return type
2145
+
2146
+ **V1SatelliteTarget**
2147
+
2148
+ ### Authorization
2149
+
2150
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2151
+
2152
+ ### HTTP request headers
2153
+
2154
+ - **Content-Type**: Not defined
2155
+ - **Accept**: application/json
2156
+
2157
+
2158
+ ### HTTP response details
2159
+ | Status code | Description | Response headers |
2160
+ |-------------|-------------|------------------|
2161
+ |**200** | V1SatelliteTarget | - |
2162
+
2163
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2164
+
2165
+ # **v1GetSatelliteTargets**
2166
+ > V1GetSatelliteTargetsResponse v1GetSatelliteTargets()
2167
+
2168
+ The available satellite objects that the OurSky platform can currently track.
2169
+
2170
+ ### Example
2171
+
2172
+ ```typescript
2173
+ import {
2174
+ DefaultApi,
2175
+ Configuration
2176
+ } from '@ourskyai/sda-api';
2177
+
2178
+ const configuration = new Configuration();
2179
+ const apiInstance = new DefaultApi(configuration);
2180
+
2181
+ let offset: number; // (optional) (default to undefined)
2182
+ let limit: number; // (optional) (default to undefined)
2183
+ let orbitType: OrbitType; // (optional) (default to undefined)
2184
+ let noradId: string; // (optional) (default to undefined)
2185
+ let publicTargets: boolean; // (optional) (default to undefined)
2186
+ let privateTargets: boolean; // (optional) (default to undefined)
2187
+
2188
+ const { status, data } = await apiInstance.v1GetSatelliteTargets(
2189
+ offset,
2190
+ limit,
2191
+ orbitType,
2192
+ noradId,
2193
+ publicTargets,
2194
+ privateTargets
2195
+ );
2196
+ ```
2197
+
2198
+ ### Parameters
2199
+
2200
+ |Name | Type | Description | Notes|
2201
+ |------------- | ------------- | ------------- | -------------|
2202
+ | **offset** | [**number**] | | (optional) defaults to undefined|
2203
+ | **limit** | [**number**] | | (optional) defaults to undefined|
2204
+ | **orbitType** | **OrbitType** | | (optional) defaults to undefined|
2205
+ | **noradId** | [**string**] | | (optional) defaults to undefined|
2206
+ | **publicTargets** | [**boolean**] | | (optional) defaults to undefined|
2207
+ | **privateTargets** | [**boolean**] | | (optional) defaults to undefined|
2208
+
2209
+
2210
+ ### Return type
2211
+
2212
+ **V1GetSatelliteTargetsResponse**
2213
+
2214
+ ### Authorization
2215
+
2216
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2217
+
2218
+ ### HTTP request headers
2219
+
2220
+ - **Content-Type**: Not defined
2221
+ - **Accept**: application/json
2222
+
2223
+
2224
+ ### HTTP response details
2225
+ | Status code | Description | Response headers |
2226
+ |-------------|-------------|------------------|
2227
+ |**200** | V1GetSatelliteTargetsResponse | - |
2228
+
2229
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2230
+
2231
+ # **v1GetSearchInstructions**
2232
+ > Array<V1SearchInstruction> v1GetSearchInstructions()
2233
+
2234
+ Get a list of search instructions. Search instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
2235
+
2236
+ ### Example
2237
+
2238
+ ```typescript
2239
+ import {
2240
+ DefaultApi,
2241
+ Configuration
2242
+ } from '@ourskyai/sda-api';
2243
+
2244
+ const configuration = new Configuration();
2245
+ const apiInstance = new DefaultApi(configuration);
2246
+
2247
+ let before: string; //The timestamp to get the next page of results. Defaults to the current time. (optional) (default to undefined)
2248
+
2249
+ const { status, data } = await apiInstance.v1GetSearchInstructions(
2250
+ before
2251
+ );
2252
+ ```
2253
+
2254
+ ### Parameters
2255
+
2256
+ |Name | Type | Description | Notes|
2257
+ |------------- | ------------- | ------------- | -------------|
2258
+ | **before** | [**string**] | The timestamp to get the next page of results. Defaults to the current time. | (optional) defaults to undefined|
2259
+
2260
+
2261
+ ### Return type
2262
+
2263
+ **Array<V1SearchInstruction>**
2264
+
2265
+ ### Authorization
2266
+
2267
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2268
+
2269
+ ### HTTP request headers
2270
+
2271
+ - **Content-Type**: Not defined
2272
+ - **Accept**: application/json
2273
+
2274
+
2275
+ ### HTTP response details
2276
+ | Status code | Description | Response headers |
2277
+ |-------------|-------------|------------------|
2278
+ |**200** | V1SearchInstruction[] | - |
2279
+
2280
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2281
+
2282
+ # **v1GetStateVectors**
2283
+ > Array<V1StateVector> v1GetStateVectors()
2284
+
2285
+ Get state vectors for a satellite.
2286
+
2287
+ ### Example
2288
+
2289
+ ```typescript
2290
+ import {
2291
+ DefaultApi,
2292
+ Configuration
2293
+ } from '@ourskyai/sda-api';
2294
+
2295
+ const configuration = new Configuration();
2296
+ const apiInstance = new DefaultApi(configuration);
2297
+
2298
+ let targetId: string; // (default to undefined)
2299
+ let before: string; // (optional) (default to undefined)
2300
+ let after: string; // (optional) (default to undefined)
2301
+
2302
+ const { status, data } = await apiInstance.v1GetStateVectors(
2303
+ targetId,
2304
+ before,
2305
+ after
2306
+ );
2307
+ ```
2308
+
2309
+ ### Parameters
2310
+
2311
+ |Name | Type | Description | Notes|
2312
+ |------------- | ------------- | ------------- | -------------|
2313
+ | **targetId** | [**string**] | | defaults to undefined|
2314
+ | **before** | [**string**] | | (optional) defaults to undefined|
2315
+ | **after** | [**string**] | | (optional) defaults to undefined|
2316
+
2317
+
2318
+ ### Return type
2319
+
2320
+ **Array<V1StateVector>**
2321
+
2322
+ ### Authorization
2323
+
2324
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2325
+
2326
+ ### HTTP request headers
2327
+
2328
+ - **Content-Type**: Not defined
2329
+ - **Accept**: application/json
2330
+
2331
+
2332
+ ### HTTP response details
2333
+ | Status code | Description | Response headers |
2334
+ |-------------|-------------|------------------|
2335
+ |**200** | V1StateVector[] | - |
2336
+
2337
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2338
+
2339
+ # **v1GetSurveyInstructions**
2340
+ > Array<V1SurveyInstruction> v1GetSurveyInstructions()
2341
+
2342
+ Get a list of survey instructions. Survey instructions are the highest priority request in the system. This endpoint is paginated and will return a maximum of 20 results per page. Use the before timestamp to get the next page of results.
2343
+
2344
+ ### Example
2345
+
2346
+ ```typescript
2347
+ import {
2348
+ DefaultApi,
2349
+ Configuration
2350
+ } from '@ourskyai/sda-api';
2351
+
2352
+ const configuration = new Configuration();
2353
+ const apiInstance = new DefaultApi(configuration);
2354
+
2355
+ let before: string; //The timestamp to get the next page of results. Defaults to the current time. (optional) (default to undefined)
2356
+
2357
+ const { status, data } = await apiInstance.v1GetSurveyInstructions(
2358
+ before
2359
+ );
2360
+ ```
2361
+
2362
+ ### Parameters
2363
+
2364
+ |Name | Type | Description | Notes|
2365
+ |------------- | ------------- | ------------- | -------------|
2366
+ | **before** | [**string**] | The timestamp to get the next page of results. Defaults to the current time. | (optional) defaults to undefined|
2367
+
2368
+
2369
+ ### Return type
2370
+
2371
+ **Array<V1SurveyInstruction>**
2372
+
2373
+ ### Authorization
2374
+
2375
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2376
+
2377
+ ### HTTP request headers
2378
+
2379
+ - **Content-Type**: Not defined
2380
+ - **Accept**: application/json
2381
+
2382
+
2383
+ ### HTTP response details
2384
+ | Status code | Description | Response headers |
2385
+ |-------------|-------------|------------------|
2386
+ |**200** | V1SurveyInstruction[] | - |
2387
+
2388
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2389
+
2390
+ # **v1GetTdm**
2391
+ > V1Tdm v1GetTdm()
2392
+
2393
+ Get a TDM.
2394
+
2395
+ ### Example
2396
+
2397
+ ```typescript
2398
+ import {
2399
+ DefaultApi,
2400
+ Configuration
2401
+ } from '@ourskyai/sda-api';
2402
+
2403
+ const configuration = new Configuration();
2404
+ const apiInstance = new DefaultApi(configuration);
2405
+
2406
+ let tdmId: string; // (default to undefined)
2407
+
2408
+ const { status, data } = await apiInstance.v1GetTdm(
2409
+ tdmId
2410
+ );
2411
+ ```
2412
+
2413
+ ### Parameters
2414
+
2415
+ |Name | Type | Description | Notes|
2416
+ |------------- | ------------- | ------------- | -------------|
2417
+ | **tdmId** | [**string**] | | defaults to undefined|
2418
+
2419
+
2420
+ ### Return type
2421
+
2422
+ **V1Tdm**
2423
+
2424
+ ### Authorization
2425
+
2426
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2427
+
2428
+ ### HTTP request headers
2429
+
2430
+ - **Content-Type**: Not defined
2431
+ - **Accept**: application/json
2432
+
2433
+
2434
+ ### HTTP response details
2435
+ | Status code | Description | Response headers |
2436
+ |-------------|-------------|------------------|
2437
+ |**200** | V1Tdm | - |
2438
+
2439
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2440
+
2441
+ # **v1GetTdms**
2442
+ > Array<V1Tdm> v1GetTdms()
2443
+
2444
+ Get all TDMS or all TDMS for a specific target. This response is paginated. It will only return at most 20 TDMs at a time. To get the next page, pass in the `created_at` timestamp of the last TDM in the current page as the `after` query parameter. Omitting this field uses the current time as the `after` timestamp.
2445
+
2446
+ ### Example
2447
+
2448
+ ```typescript
2449
+ import {
2450
+ DefaultApi,
2451
+ Configuration
2452
+ } from '@ourskyai/sda-api';
2453
+
2454
+ const configuration = new Configuration();
2455
+ const apiInstance = new DefaultApi(configuration);
2456
+
2457
+ let targetId: string; // (optional) (default to undefined)
2458
+ let after: string; // (optional) (default to undefined)
2459
+
2460
+ const { status, data } = await apiInstance.v1GetTdms(
2461
+ targetId,
2462
+ after
2463
+ );
2464
+ ```
2465
+
2466
+ ### Parameters
2467
+
2468
+ |Name | Type | Description | Notes|
2469
+ |------------- | ------------- | ------------- | -------------|
2470
+ | **targetId** | [**string**] | | (optional) defaults to undefined|
2471
+ | **after** | [**string**] | | (optional) defaults to undefined|
2472
+
2473
+
2474
+ ### Return type
2475
+
2476
+ **Array<V1Tdm>**
2477
+
2478
+ ### Authorization
2479
+
2480
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2481
+
2482
+ ### HTTP request headers
2483
+
2484
+ - **Content-Type**: Not defined
2485
+ - **Accept**: application/json
2486
+
2487
+
2488
+ ### HTTP response details
2489
+ | Status code | Description | Response headers |
2490
+ |-------------|-------------|------------------|
2491
+ |**200** | V1Tdm[] | - |
2492
+
2493
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2494
+
2495
+ # **v1GetWebhookConfigurations**
2496
+ > Array<V1WebhookConfiguration> v1GetWebhookConfigurations()
2497
+
2498
+ Get webhook configurations.
2499
+
2500
+ ### Example
2501
+
2502
+ ```typescript
2503
+ import {
2504
+ DefaultApi,
2505
+ Configuration
2506
+ } from '@ourskyai/sda-api';
2507
+
2508
+ const configuration = new Configuration();
2509
+ const apiInstance = new DefaultApi(configuration);
2510
+
2511
+ const { status, data } = await apiInstance.v1GetWebhookConfigurations();
2512
+ ```
2513
+
2514
+ ### Parameters
2515
+ This endpoint does not have any parameters.
2516
+
2517
+
2518
+ ### Return type
2519
+
2520
+ **Array<V1WebhookConfiguration>**
2521
+
2522
+ ### Authorization
2523
+
2524
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2525
+
2526
+ ### HTTP request headers
2527
+
2528
+ - **Content-Type**: Not defined
2529
+ - **Accept**: application/json
2530
+
2531
+
2532
+ ### HTTP response details
2533
+ | Status code | Description | Response headers |
2534
+ |-------------|-------------|------------------|
2535
+ |**200** | V1WebhookConfiguration[] | - |
2536
+
2537
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2538
+
2539
+ # **v1GetWebhookLogs**
2540
+ > Array<V1WebhookLog> v1GetWebhookLogs()
2541
+
2542
+ Get webhook logs.
2543
+
2544
+ ### Example
2545
+
2546
+ ```typescript
2547
+ import {
2548
+ DefaultApi,
2549
+ Configuration
2550
+ } from '@ourskyai/sda-api';
2551
+
2552
+ const configuration = new Configuration();
2553
+ const apiInstance = new DefaultApi(configuration);
2554
+
2555
+ let webhookId: string; // (default to undefined)
2556
+ let limit: number; // (optional) (default to undefined)
2557
+ let offset: number; // (optional) (default to undefined)
2558
+
2559
+ const { status, data } = await apiInstance.v1GetWebhookLogs(
2560
+ webhookId,
2561
+ limit,
2562
+ offset
2563
+ );
2564
+ ```
2565
+
2566
+ ### Parameters
2567
+
2568
+ |Name | Type | Description | Notes|
2569
+ |------------- | ------------- | ------------- | -------------|
2570
+ | **webhookId** | [**string**] | | defaults to undefined|
2571
+ | **limit** | [**number**] | | (optional) defaults to undefined|
2572
+ | **offset** | [**number**] | | (optional) defaults to undefined|
2573
+
2574
+
2575
+ ### Return type
2576
+
2577
+ **Array<V1WebhookLog>**
2578
+
2579
+ ### Authorization
2580
+
2581
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2582
+
2583
+ ### HTTP request headers
2584
+
2585
+ - **Content-Type**: Not defined
2586
+ - **Accept**: application/json
2587
+
2588
+
2589
+ ### HTTP response details
2590
+ | Status code | Description | Response headers |
2591
+ |-------------|-------------|------------------|
2592
+ |**200** | V1WebhookLog[] | - |
2593
+
2594
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2595
+
2596
+ # **v1PutOrbitProviderTLEOrbit**
2597
+ > SuccessfulCreate v1PutOrbitProviderTLEOrbit(v1PutOrbitProviderTLERequest)
2598
+
2599
+ Create or update an orbit for a target via a two-line element set (TLE)
2600
+
2601
+ ### Example
2602
+
2603
+ ```typescript
2604
+ import {
2605
+ DefaultApi,
2606
+ Configuration,
2607
+ V1PutOrbitProviderTLERequest
2608
+ } from '@ourskyai/sda-api';
2609
+
2610
+ const configuration = new Configuration();
2611
+ const apiInstance = new DefaultApi(configuration);
2612
+
2613
+ let v1PutOrbitProviderTLERequest: V1PutOrbitProviderTLERequest; //
2614
+
2615
+ const { status, data } = await apiInstance.v1PutOrbitProviderTLEOrbit(
2616
+ v1PutOrbitProviderTLERequest
2617
+ );
2618
+ ```
2619
+
2620
+ ### Parameters
2621
+
2622
+ |Name | Type | Description | Notes|
2623
+ |------------- | ------------- | ------------- | -------------|
2624
+ | **v1PutOrbitProviderTLERequest** | **V1PutOrbitProviderTLERequest**| | |
2625
+
2626
+
2627
+ ### Return type
2628
+
2629
+ **SuccessfulCreate**
2630
+
2631
+ ### Authorization
2632
+
2633
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2634
+
2635
+ ### HTTP request headers
2636
+
2637
+ - **Content-Type**: application/json
2638
+ - **Accept**: application/json
2639
+
2640
+
2641
+ ### HTTP response details
2642
+ | Status code | Description | Response headers |
2643
+ |-------------|-------------|------------------|
2644
+ |**200** | Successful create | - |
2645
+
2646
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2647
+
2648
+ # **v1UpdateEmailConfiguration**
2649
+ > EmptySuccess v1UpdateEmailConfiguration(v1UpdateEmailConfigurationRequest)
2650
+
2651
+ Update your organization email communication preferences. This will overwrite any existing preferences. This communication preference is meant as an audit log, it is a fire hose of all events. The schemas are not considered stable and may change at any time. If you are looking for machine to machine communication, please use webhooks.
2652
+
2653
+ ### Example
2654
+
2655
+ ```typescript
2656
+ import {
2657
+ DefaultApi,
2658
+ Configuration,
2659
+ V1UpdateEmailConfigurationRequest
2660
+ } from '@ourskyai/sda-api';
2661
+
2662
+ const configuration = new Configuration();
2663
+ const apiInstance = new DefaultApi(configuration);
2664
+
2665
+ let v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest; //
2666
+
2667
+ const { status, data } = await apiInstance.v1UpdateEmailConfiguration(
2668
+ v1UpdateEmailConfigurationRequest
2669
+ );
2670
+ ```
2671
+
2672
+ ### Parameters
2673
+
2674
+ |Name | Type | Description | Notes|
2675
+ |------------- | ------------- | ------------- | -------------|
2676
+ | **v1UpdateEmailConfigurationRequest** | **V1UpdateEmailConfigurationRequest**| | |
2677
+
2678
+
2679
+ ### Return type
2680
+
2681
+ **EmptySuccess**
2682
+
2683
+ ### Authorization
2684
+
2685
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2686
+
2687
+ ### HTTP request headers
2688
+
2689
+ - **Content-Type**: application/json
2690
+ - **Accept**: application/json
2691
+
2692
+
2693
+ ### HTTP response details
2694
+ | Status code | Description | Response headers |
2695
+ |-------------|-------------|------------------|
2696
+ |**200** | Successful action | - |
2697
+
2698
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2699
+
2700
+ # **v1UpdateOrganizationTarget**
2701
+ > V1OrganizationTarget v1UpdateOrganizationTarget(v1UpdateOrganizationTargetRequest)
2702
+
2703
+ Update an existing organization target. The satellite target id cannot be changed. If you need to change the target you must delete the existing target and create a new one.
2704
+
2705
+ ### Example
2706
+
2707
+ ```typescript
2708
+ import {
2709
+ DefaultApi,
2710
+ Configuration,
2711
+ V1UpdateOrganizationTargetRequest
2712
+ } from '@ourskyai/sda-api';
2713
+
2714
+ const configuration = new Configuration();
2715
+ const apiInstance = new DefaultApi(configuration);
2716
+
2717
+ let v1UpdateOrganizationTargetRequest: V1UpdateOrganizationTargetRequest; //
2718
+
2719
+ const { status, data } = await apiInstance.v1UpdateOrganizationTarget(
2720
+ v1UpdateOrganizationTargetRequest
2721
+ );
2722
+ ```
2723
+
2724
+ ### Parameters
2725
+
2726
+ |Name | Type | Description | Notes|
2727
+ |------------- | ------------- | ------------- | -------------|
2728
+ | **v1UpdateOrganizationTargetRequest** | **V1UpdateOrganizationTargetRequest**| | |
2729
+
2730
+
2731
+ ### Return type
2732
+
2733
+ **V1OrganizationTarget**
2734
+
2735
+ ### Authorization
2736
+
2737
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2738
+
2739
+ ### HTTP request headers
2740
+
2741
+ - **Content-Type**: application/json
2742
+ - **Accept**: application/json
2743
+
2744
+
2745
+ ### HTTP response details
2746
+ | Status code | Description | Response headers |
2747
+ |-------------|-------------|------------------|
2748
+ |**200** | V1OrganizationTarget | - |
2749
+
2750
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2751
+
2752
+ # **v1UpdateSatelliteTarget**
2753
+ > EmptySuccess v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest)
2754
+
2755
+ Update a private satellite target.
2756
+
2757
+ ### Example
2758
+
2759
+ ```typescript
2760
+ import {
2761
+ DefaultApi,
2762
+ Configuration,
2763
+ V1UpdateSatelliteTargetRequest
2764
+ } from '@ourskyai/sda-api';
2765
+
2766
+ const configuration = new Configuration();
2767
+ const apiInstance = new DefaultApi(configuration);
2768
+
2769
+ let v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest; //
2770
+
2771
+ const { status, data } = await apiInstance.v1UpdateSatelliteTarget(
2772
+ v1UpdateSatelliteTargetRequest
2773
+ );
2774
+ ```
2775
+
2776
+ ### Parameters
2777
+
2778
+ |Name | Type | Description | Notes|
2779
+ |------------- | ------------- | ------------- | -------------|
2780
+ | **v1UpdateSatelliteTargetRequest** | **V1UpdateSatelliteTargetRequest**| | |
2781
+
2782
+
2783
+ ### Return type
2784
+
2785
+ **EmptySuccess**
2786
+
2787
+ ### Authorization
2788
+
2789
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2790
+
2791
+ ### HTTP request headers
2792
+
2793
+ - **Content-Type**: application/json
2794
+ - **Accept**: application/json
2795
+
2796
+
2797
+ ### HTTP response details
2798
+ | Status code | Description | Response headers |
2799
+ |-------------|-------------|------------------|
2800
+ |**200** | Successful action | - |
2801
+
2802
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2803
+
2804
+ # **v1UpdateWebhookConfiguration**
2805
+ > EmptySuccess v1UpdateWebhookConfiguration(v1UpdateWebhookConfigurationRequest)
2806
+
2807
+ Update a webhook configuration.
2808
+
2809
+ ### Example
2810
+
2811
+ ```typescript
2812
+ import {
2813
+ DefaultApi,
2814
+ Configuration,
2815
+ V1UpdateWebhookConfigurationRequest
2816
+ } from '@ourskyai/sda-api';
2817
+
2818
+ const configuration = new Configuration();
2819
+ const apiInstance = new DefaultApi(configuration);
2820
+
2821
+ let v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest; //
2822
+
2823
+ const { status, data } = await apiInstance.v1UpdateWebhookConfiguration(
2824
+ v1UpdateWebhookConfigurationRequest
2825
+ );
2826
+ ```
2827
+
2828
+ ### Parameters
2829
+
2830
+ |Name | Type | Description | Notes|
2831
+ |------------- | ------------- | ------------- | -------------|
2832
+ | **v1UpdateWebhookConfigurationRequest** | **V1UpdateWebhookConfigurationRequest**| | |
2833
+
2834
+
2835
+ ### Return type
2836
+
2837
+ **EmptySuccess**
2838
+
2839
+ ### Authorization
2840
+
2841
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2842
+
2843
+ ### HTTP request headers
2844
+
2845
+ - **Content-Type**: application/json
2846
+ - **Accept**: application/json
2847
+
2848
+
2849
+ ### HTTP response details
2850
+ | Status code | Description | Response headers |
2851
+ |-------------|-------------|------------------|
2852
+ |**200** | Successful action | - |
2853
+
2854
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2855
+
2856
+ # **v2CreatePlaneScan**
2857
+ > SuccessfulCreate v2CreatePlaneScan(v1PlaneScanRequest)
2858
+
2859
+ Create a plane scan: a 1D search along the target\'s orbital plane, centered on the target\'s predicted anomaly and extending `plusMinusAnomalyAngleDegrees` on either side. Use a plane scan when the target\'s uncertainty is dominated by along-track error. For 3D uncertainty - freshly cataloged targets, post-maneuver reacquisitions, or searches seeded from a raw state vector - use [/v2/search/ric-volumetric](#tag/ric-volumetrics/POST/v2/search/ric-volumetric) instead. Sizing `plusMinusAnomalyAngleDegrees`: for a day-old LEO TLE, 1-3 degrees is typically sufficient; a week-old TLE wants 5-10 degrees. GEO targets can use much smaller values (0.1-0.5 degrees). Returns the created search ID. See a runnable Python example: https://github.com/ourskyai/oursky-examples/tree/main/python-search
2860
+
2861
+ ### Example
2862
+
2863
+ ```typescript
2864
+ import {
2865
+ DefaultApi,
2866
+ Configuration,
2867
+ V1PlaneScanRequest
2868
+ } from '@ourskyai/sda-api';
2869
+
2870
+ const configuration = new Configuration();
2871
+ const apiInstance = new DefaultApi(configuration);
2872
+
2873
+ let v1PlaneScanRequest: V1PlaneScanRequest; //
2874
+
2875
+ const { status, data } = await apiInstance.v2CreatePlaneScan(
2876
+ v1PlaneScanRequest
2877
+ );
2878
+ ```
2879
+
2880
+ ### Parameters
2881
+
2882
+ |Name | Type | Description | Notes|
2883
+ |------------- | ------------- | ------------- | -------------|
2884
+ | **v1PlaneScanRequest** | **V1PlaneScanRequest**| | |
2885
+
2886
+
2887
+ ### Return type
2888
+
2889
+ **SuccessfulCreate**
2890
+
2891
+ ### Authorization
2892
+
2893
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2894
+
2895
+ ### HTTP request headers
2896
+
2897
+ - **Content-Type**: application/json
2898
+ - **Accept**: application/json
2899
+
2900
+
2901
+ ### HTTP response details
2902
+ | Status code | Description | Response headers |
2903
+ |-------------|-------------|------------------|
2904
+ |**200** | Successful create | - |
2905
+
2906
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2907
+
2908
+ # **v2CreateRicVolumeSearch**
2909
+ > SuccessfulCreate v2CreateRicVolumeSearch(v1RicVolumeSearchRequest)
2910
+
2911
+ Create a RIC volume search: a 3D search covering the target\'s Radial / In-track / Cross-track frame, sized by three independent 3-sigma uncertainty values. Use a RIC volume search when uncertainty is non-trivial in more than just the along-track direction. For along-track-dominated uncertainty, use [/v2/search/plane-scan](#tag/plane-scans/POST/v2/search/plane-scan) instead. Sizing 3-sigma values (LEO starting points): `radial3SigmaMeters` 500, `intrack3SigmaMeters` 10000, `crosstrack3SigmaMeters` 1000. GEO targets can use much smaller values. Returns the created search ID. See a runnable Python example: https://github.com/ourskyai/oursky-examples/tree/main/python-search
2912
+
2913
+ ### Example
2914
+
2915
+ ```typescript
2916
+ import {
2917
+ DefaultApi,
2918
+ Configuration,
2919
+ V1RicVolumeSearchRequest
2920
+ } from '@ourskyai/sda-api';
2921
+
2922
+ const configuration = new Configuration();
2923
+ const apiInstance = new DefaultApi(configuration);
2924
+
2925
+ let v1RicVolumeSearchRequest: V1RicVolumeSearchRequest; //
2926
+
2927
+ const { status, data } = await apiInstance.v2CreateRicVolumeSearch(
2928
+ v1RicVolumeSearchRequest
2929
+ );
2930
+ ```
2931
+
2932
+ ### Parameters
2933
+
2934
+ |Name | Type | Description | Notes|
2935
+ |------------- | ------------- | ------------- | -------------|
2936
+ | **v1RicVolumeSearchRequest** | **V1RicVolumeSearchRequest**| | |
2937
+
2938
+
2939
+ ### Return type
2940
+
2941
+ **SuccessfulCreate**
2942
+
2943
+ ### Authorization
2944
+
2945
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2946
+
2947
+ ### HTTP request headers
2948
+
2949
+ - **Content-Type**: application/json
2950
+ - **Accept**: application/json
2951
+
2952
+
2953
+ ### HTTP response details
2954
+ | Status code | Description | Response headers |
2955
+ |-------------|-------------|------------------|
2956
+ |**200** | Successful create | - |
2957
+
2958
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2959
+
2960
+ # **v2DeletePlaneScan**
2961
+ > EmptySuccess v2DeletePlaneScan()
2962
+
2963
+ Delete a plane scan.
2964
+
2965
+ ### Example
2966
+
2967
+ ```typescript
2968
+ import {
2969
+ DefaultApi,
2970
+ Configuration
2971
+ } from '@ourskyai/sda-api';
2972
+
2973
+ const configuration = new Configuration();
2974
+ const apiInstance = new DefaultApi(configuration);
2975
+
2976
+ let id: string; // (default to undefined)
2977
+
2978
+ const { status, data } = await apiInstance.v2DeletePlaneScan(
2979
+ id
2980
+ );
2981
+ ```
2982
+
2983
+ ### Parameters
2984
+
2985
+ |Name | Type | Description | Notes|
2986
+ |------------- | ------------- | ------------- | -------------|
2987
+ | **id** | [**string**] | | defaults to undefined|
2988
+
2989
+
2990
+ ### Return type
2991
+
2992
+ **EmptySuccess**
2993
+
2994
+ ### Authorization
2995
+
2996
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
2997
+
2998
+ ### HTTP request headers
2999
+
3000
+ - **Content-Type**: Not defined
3001
+ - **Accept**: application/json
3002
+
3003
+
3004
+ ### HTTP response details
3005
+ | Status code | Description | Response headers |
3006
+ |-------------|-------------|------------------|
3007
+ |**200** | Successful action | - |
3008
+
3009
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
3010
+
3011
+ # **v2DeleteRicVolumeSearch**
3012
+ > EmptySuccess v2DeleteRicVolumeSearch()
3013
+
3014
+ Delete a RIC volume search.
3015
+
3016
+ ### Example
3017
+
3018
+ ```typescript
3019
+ import {
3020
+ DefaultApi,
3021
+ Configuration
3022
+ } from '@ourskyai/sda-api';
3023
+
3024
+ const configuration = new Configuration();
3025
+ const apiInstance = new DefaultApi(configuration);
3026
+
3027
+ let id: string; // (default to undefined)
3028
+
3029
+ const { status, data } = await apiInstance.v2DeleteRicVolumeSearch(
3030
+ id
3031
+ );
3032
+ ```
3033
+
3034
+ ### Parameters
3035
+
3036
+ |Name | Type | Description | Notes|
3037
+ |------------- | ------------- | ------------- | -------------|
3038
+ | **id** | [**string**] | | defaults to undefined|
3039
+
3040
+
3041
+ ### Return type
3042
+
3043
+ **EmptySuccess**
3044
+
3045
+ ### Authorization
3046
+
3047
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
3048
+
3049
+ ### HTTP request headers
3050
+
3051
+ - **Content-Type**: Not defined
3052
+ - **Accept**: application/json
3053
+
3054
+
3055
+ ### HTTP response details
3056
+ | Status code | Description | Response headers |
3057
+ |-------------|-------------|------------------|
3058
+ |**200** | Successful action | - |
3059
+
3060
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
3061
+
3062
+ # **v2GetSearch**
3063
+ > V2Search v2GetSearch()
3064
+
3065
+ Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
3066
+
3067
+ ### Example
3068
+
3069
+ ```typescript
3070
+ import {
3071
+ DefaultApi,
3072
+ Configuration
3073
+ } from '@ourskyai/sda-api';
3074
+
3075
+ const configuration = new Configuration();
3076
+ const apiInstance = new DefaultApi(configuration);
3077
+
3078
+ let searchId: string; // (default to undefined)
3079
+
3080
+ const { status, data } = await apiInstance.v2GetSearch(
3081
+ searchId
3082
+ );
3083
+ ```
3084
+
3085
+ ### Parameters
3086
+
3087
+ |Name | Type | Description | Notes|
3088
+ |------------- | ------------- | ------------- | -------------|
3089
+ | **searchId** | [**string**] | | defaults to undefined|
3090
+
3091
+
3092
+ ### Return type
3093
+
3094
+ **V2Search**
3095
+
3096
+ ### Authorization
3097
+
3098
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
3099
+
3100
+ ### HTTP request headers
3101
+
3102
+ - **Content-Type**: Not defined
3103
+ - **Accept**: application/json
3104
+
3105
+
3106
+ ### HTTP response details
3107
+ | Status code | Description | Response headers |
3108
+ |-------------|-------------|------------------|
3109
+ |**200** | V2Search | - |
3110
+
3111
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
3112
+
3113
+ # **v2GetSearches**
3114
+ > Array<V2Search> v2GetSearches()
3115
+
3116
+ Get a list of your organization\'s V2 searches by time range or status.
3117
+
3118
+ ### Example
3119
+
3120
+ ```typescript
3121
+ import {
3122
+ DefaultApi,
3123
+ Configuration
3124
+ } from '@ourskyai/sda-api';
3125
+
3126
+ const configuration = new Configuration();
3127
+ const apiInstance = new DefaultApi(configuration);
3128
+
3129
+ let after: string; //The timestamp after which to return results. Defaults to one day prior to the current time. (optional) (default to undefined)
3130
+ let status: 'COMPLETED' | 'IN_PROGRESS' | 'FAILED'; //The status of the searches to return. Defaults to all statuses. (optional) (default to undefined)
3131
+
3132
+ const { status, data } = await apiInstance.v2GetSearches(
3133
+ after,
3134
+ status
3135
+ );
3136
+ ```
3137
+
3138
+ ### Parameters
3139
+
3140
+ |Name | Type | Description | Notes|
3141
+ |------------- | ------------- | ------------- | -------------|
3142
+ | **after** | [**string**] | The timestamp after which to return results. Defaults to one day prior to the current time. | (optional) defaults to undefined|
3143
+ | **status** | [**&#39;COMPLETED&#39; | &#39;IN_PROGRESS&#39; | &#39;FAILED&#39;**]**Array<&#39;COMPLETED&#39; &#124; &#39;IN_PROGRESS&#39; &#124; &#39;FAILED&#39;>** | The status of the searches to return. Defaults to all statuses. | (optional) defaults to undefined|
3144
+
3145
+
3146
+ ### Return type
3147
+
3148
+ **Array<V2Search>**
3149
+
3150
+ ### Authorization
3151
+
3152
+ [Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
3153
+
3154
+ ### HTTP request headers
3155
+
3156
+ - **Content-Type**: Not defined
3157
+ - **Accept**: application/json
3158
+
3159
+
3160
+ ### HTTP response details
3161
+ | Status code | Description | Response headers |
3162
+ |-------------|-------------|------------------|
3163
+ |**200** | V2Search[] | - |
3164
+
3165
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
3166
+