@ourskyai/sda-api 1.3.2765 → 1.3.3181

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.
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * OurSky SDA
3
3
  * The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](#tag/satellite-targets/[get]/v1/satellite-targets) endpoint. Copy the id of the target you want to observe. 2. Create an organization target with the [organization target](#tag/organization-targets/[get]/v1/organization-targets) endpoint. Use the id copied from above. 3. Create a webhook with the [webhook](#tag/webhooks/[post]/v1/communications/webhook) endpoint to receive TDMs automatically (preferred) or use the [tdms](#tag/tdms/[get]/v1/tdms) endpoint to poll for TDMs.
4
4
  *
5
- * The version of the OpenAPI document: 1.3.2765
5
+ * The version of the OpenAPI document: 1.3.3181
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -161,55 +161,6 @@ export interface ObservationBoundingBox {
161
161
  */
162
162
  'endY': number;
163
163
  }
164
- /**
165
- * Observation Feature
166
- * @export
167
- * @interface ObservationFeature
168
- */
169
- export interface ObservationFeature {
170
- /**
171
- *
172
- * @type {number}
173
- * @memberof ObservationFeature
174
- */
175
- 'ra': number;
176
- /**
177
- *
178
- * @type {number}
179
- * @memberof ObservationFeature
180
- */
181
- 'dec': number;
182
- /**
183
- *
184
- * @type {string}
185
- * @memberof ObservationFeature
186
- */
187
- 'timestamp': string;
188
- /**
189
- *
190
- * @type {ObservationBoundingBox}
191
- * @memberof ObservationFeature
192
- */
193
- 'boundingBox'?: ObservationBoundingBox;
194
- /**
195
- * BETA: the apparent magnitude of the target at the time of the observation
196
- * @type {number}
197
- * @memberof ObservationFeature
198
- */
199
- 'apparentMagnitude'?: number;
200
- /**
201
- *
202
- * @type {number}
203
- * @memberof ObservationFeature
204
- */
205
- 'distanceFromPrediction'?: number;
206
- /**
207
- *
208
- * @type {Array<TargetCorrelation>}
209
- * @memberof ObservationFeature
210
- */
211
- 'targetCorrelations'?: Array<TargetCorrelation>;
212
- }
213
164
  /**
214
165
  *
215
166
  * @export
@@ -283,6 +234,18 @@ export interface ObservationResult {
283
234
  * @memberof ObservationResult
284
235
  */
285
236
  'dec': number;
237
+ /**
238
+ * The measured right ascension calibrated for stellar aberration in degrees
239
+ * @type {number}
240
+ * @memberof ObservationResult
241
+ */
242
+ 'correctedRa'?: number;
243
+ /**
244
+ * The measured declination calibrated for stellar aberration in degrees
245
+ * @type {number}
246
+ * @memberof ObservationResult
247
+ */
248
+ 'correctedDec'?: number;
286
249
  /**
287
250
  *
288
251
  * @type {ObservationBoundingBox}
@@ -309,11 +272,23 @@ export interface ObservationResult {
309
272
  'distanceFromPrediction'?: number;
310
273
  /**
311
274
  *
312
- * @type {Array<ObservationFeature>}
275
+ * @type {Array<V1ObservationFeature>}
313
276
  * @memberof ObservationResult
314
277
  */
315
- 'features'?: Array<ObservationFeature>;
278
+ 'features'?: Array<V1ObservationFeature>;
316
279
  }
280
+ /**
281
+ *
282
+ * @export
283
+ * @enum {string}
284
+ */
285
+ export declare const ObservationState: {
286
+ readonly PENDING: "PENDING";
287
+ readonly UNDERWAY: "UNDERWAY";
288
+ readonly COMPLETED: "COMPLETED";
289
+ readonly FAILED: "FAILED";
290
+ };
291
+ export type ObservationState = typeof ObservationState[keyof typeof ObservationState];
317
292
  /**
318
293
  *
319
294
  * @export
@@ -364,31 +339,6 @@ export interface SuccessfulCreate {
364
339
  */
365
340
  'id': string;
366
341
  }
367
- /**
368
- * Target Correlation
369
- * @export
370
- * @interface TargetCorrelation
371
- */
372
- export interface TargetCorrelation {
373
- /**
374
- *
375
- * @type {string}
376
- * @memberof TargetCorrelation
377
- */
378
- 'targetId': string;
379
- /**
380
- *
381
- * @type {number}
382
- * @memberof TargetCorrelation
383
- */
384
- 'ra': number;
385
- /**
386
- *
387
- * @type {number}
388
- * @memberof TargetCorrelation
389
- */
390
- 'dec': number;
391
- }
392
342
  /**
393
343
  *
394
344
  * @export
@@ -509,76 +459,46 @@ export interface V1CreateSatelliteTargetRequest {
509
459
  /**
510
460
  *
511
461
  * @export
512
- * @interface V1CreateSearchTaskRequest
462
+ * @interface V1CreateSearchInstructionRequest
513
463
  */
514
- export interface V1CreateSearchTaskRequest {
515
- /**
516
- *
517
- * @type {string}
518
- * @memberof V1CreateSearchTaskRequest
519
- */
520
- 'nodeId': string;
464
+ export interface V1CreateSearchInstructionRequest {
521
465
  /**
522
466
  *
523
467
  * @type {string}
524
- * @memberof V1CreateSearchTaskRequest
468
+ * @memberof V1CreateSearchInstructionRequest
525
469
  */
526
470
  'targetId': string;
527
471
  /**
528
472
  *
529
473
  * @type {TrackingType}
530
- * @memberof V1CreateSearchTaskRequest
474
+ * @memberof V1CreateSearchInstructionRequest
531
475
  */
532
- 'trackingType'?: TrackingType;
476
+ 'trackingType': TrackingType;
533
477
  /**
534
478
  *
535
- * @type {Array<V1CreateSearchTaskRequestStepsInner>}
536
- * @memberof V1CreateSearchTaskRequest
479
+ * @type {Array<V1SearchInstructionStep>}
480
+ * @memberof V1CreateSearchInstructionRequest
537
481
  */
538
- 'steps': Array<V1CreateSearchTaskRequestStepsInner>;
482
+ 'steps': Array<V1SearchInstructionStep>;
539
483
  }
540
484
  /**
541
- * Search steps
485
+ *
542
486
  * @export
543
- * @interface V1CreateSearchTaskRequestStepsInner
487
+ * @interface V1CreateSurveyInstructionRequest
544
488
  */
545
- export interface V1CreateSearchTaskRequestStepsInner {
546
- /**
547
- * Right Ascension in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
548
- * @type {number}
549
- * @memberof V1CreateSearchTaskRequestStepsInner
550
- */
551
- 'ra'?: number;
552
- /**
553
- * Declination in degrees. Required for SIDEREAL trackingType. Should be null for TARGET_RATE trackingType.
554
- * @type {number}
555
- * @memberof V1CreateSearchTaskRequestStepsInner
556
- */
557
- 'dec'?: number;
558
- /**
559
- * Offset in degrees from the ra. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
560
- * @type {number}
561
- * @memberof V1CreateSearchTaskRequestStepsInner
562
- */
563
- 'raOffset'?: number;
564
- /**
565
- * Offset in degrees from the dec. Required for TARGET_RATE trackingType. Should be null for SIDEREAL trackingType.
566
- * @type {number}
567
- * @memberof V1CreateSearchTaskRequestStepsInner
568
- */
569
- 'decOffset'?: number;
489
+ export interface V1CreateSurveyInstructionRequest {
570
490
  /**
571
491
  *
572
492
  * @type {string}
573
- * @memberof V1CreateSearchTaskRequestStepsInner
493
+ * @memberof V1CreateSurveyInstructionRequest
574
494
  */
575
- 'startTime': string;
495
+ 'targetId': string;
576
496
  /**
577
497
  *
578
- * @type {string}
579
- * @memberof V1CreateSearchTaskRequestStepsInner
498
+ * @type {Array<V1SurveyInstructionStep>}
499
+ * @memberof V1CreateSurveyInstructionRequest
580
500
  */
581
- 'endTime': string;
501
+ 'steps': Array<V1SurveyInstructionStep>;
582
502
  }
583
503
  /**
584
504
  *
@@ -896,6 +816,55 @@ export interface V1ImageSetImage {
896
816
  */
897
817
  'exposureLength': number;
898
818
  }
819
+ /**
820
+ * Observation Feature
821
+ * @export
822
+ * @interface V1ObservationFeature
823
+ */
824
+ export interface V1ObservationFeature {
825
+ /**
826
+ *
827
+ * @type {number}
828
+ * @memberof V1ObservationFeature
829
+ */
830
+ 'ra': number;
831
+ /**
832
+ *
833
+ * @type {number}
834
+ * @memberof V1ObservationFeature
835
+ */
836
+ 'dec': number;
837
+ /**
838
+ *
839
+ * @type {string}
840
+ * @memberof V1ObservationFeature
841
+ */
842
+ 'timestamp': string;
843
+ /**
844
+ *
845
+ * @type {ObservationBoundingBox}
846
+ * @memberof V1ObservationFeature
847
+ */
848
+ 'boundingBox'?: ObservationBoundingBox;
849
+ /**
850
+ * BETA: the apparent magnitude of the target at the time of the observation
851
+ * @type {number}
852
+ * @memberof V1ObservationFeature
853
+ */
854
+ 'apparentMagnitude'?: number;
855
+ /**
856
+ *
857
+ * @type {number}
858
+ * @memberof V1ObservationFeature
859
+ */
860
+ 'distanceFromPrediction'?: number;
861
+ /**
862
+ *
863
+ * @type {Array<V1TargetCorrelation>}
864
+ * @memberof V1ObservationFeature
865
+ */
866
+ 'targetCorrelations'?: Array<V1TargetCorrelation>;
867
+ }
899
868
  /**
900
869
  * Observation Sequence Result
901
870
  * @export
@@ -976,6 +945,103 @@ export interface V1ObservationSequenceResultImageSetsInner {
976
945
  */
977
946
  'observationQuality'?: ObservationQuality;
978
947
  }
948
+ /**
949
+ *
950
+ * @export
951
+ * @interface V1ObservationStatus
952
+ */
953
+ export interface V1ObservationStatus {
954
+ /**
955
+ *
956
+ * @type {string}
957
+ * @memberof V1ObservationStatus
958
+ */
959
+ 'id': string;
960
+ /**
961
+ *
962
+ * @type {string}
963
+ * @memberof V1ObservationStatus
964
+ */
965
+ 'targetId': string;
966
+ /**
967
+ *
968
+ * @type {TrackingType}
969
+ * @memberof V1ObservationStatus
970
+ */
971
+ 'trackingType'?: TrackingType;
972
+ /**
973
+ *
974
+ * @type {number}
975
+ * @memberof V1ObservationStatus
976
+ */
977
+ 'ra': number;
978
+ /**
979
+ *
980
+ * @type {number}
981
+ * @memberof V1ObservationStatus
982
+ */
983
+ 'dec': number;
984
+ /**
985
+ *
986
+ * @type {string}
987
+ * @memberof V1ObservationStatus
988
+ */
989
+ 'observationTime': string;
990
+ /**
991
+ * TLE line 1 of when the observation was tasked
992
+ * @type {string}
993
+ * @memberof V1ObservationStatus
994
+ */
995
+ 'tleLine1': string;
996
+ /**
997
+ * TLE line 2 of when the observation was tasked
998
+ * @type {string}
999
+ * @memberof V1ObservationStatus
1000
+ */
1001
+ 'tleLine2': string;
1002
+ /**
1003
+ *
1004
+ * @type {string}
1005
+ * @memberof V1ObservationStatus
1006
+ */
1007
+ 'tleEpoch': string;
1008
+ /**
1009
+ *
1010
+ * @type {string}
1011
+ * @memberof V1ObservationStatus
1012
+ */
1013
+ 'imageSetId'?: string;
1014
+ /**
1015
+ *
1016
+ * @type {string}
1017
+ * @memberof V1ObservationStatus
1018
+ */
1019
+ 'observationSequenceResultId'?: string;
1020
+ /**
1021
+ *
1022
+ * @type {string}
1023
+ * @memberof V1ObservationStatus
1024
+ */
1025
+ 'searchInstructionId'?: string;
1026
+ /**
1027
+ *
1028
+ * @type {string}
1029
+ * @memberof V1ObservationStatus
1030
+ */
1031
+ 'surveyInstructionId'?: string;
1032
+ /**
1033
+ *
1034
+ * @type {string}
1035
+ * @memberof V1ObservationStatus
1036
+ */
1037
+ 'completedAt'?: string;
1038
+ /**
1039
+ *
1040
+ * @type {ObservationState}
1041
+ * @memberof V1ObservationStatus
1042
+ */
1043
+ 'state': ObservationState;
1044
+ }
979
1045
  /**
980
1046
  *
981
1047
  * @export
@@ -1064,40 +1130,201 @@ export interface V1SatelliteTarget {
1064
1130
  'cosparId'?: string;
1065
1131
  /**
1066
1132
  *
1067
- * @type {string}
1068
- * @memberof V1SatelliteTarget
1133
+ * @type {string}
1134
+ * @memberof V1SatelliteTarget
1135
+ */
1136
+ 'noradId'?: string;
1137
+ /**
1138
+ *
1139
+ * @type {OrbitType}
1140
+ * @memberof V1SatelliteTarget
1141
+ */
1142
+ 'orbitType': OrbitType;
1143
+ /**
1144
+ *
1145
+ * @type {string}
1146
+ * @memberof V1SatelliteTarget
1147
+ */
1148
+ 'tleEpoch'?: string;
1149
+ /**
1150
+ *
1151
+ * @type {string}
1152
+ * @memberof V1SatelliteTarget
1153
+ */
1154
+ 'tleLine1'?: string;
1155
+ /**
1156
+ *
1157
+ * @type {string}
1158
+ * @memberof V1SatelliteTarget
1159
+ */
1160
+ 'tleLine2'?: string;
1161
+ /**
1162
+ *
1163
+ * @type {SatelliteTargetTrackingStatus}
1164
+ * @memberof V1SatelliteTarget
1165
+ */
1166
+ 'trackingStatus'?: SatelliteTargetTrackingStatus;
1167
+ }
1168
+ /**
1169
+ * Search Instruction
1170
+ * @export
1171
+ * @interface V1SearchInstruction
1172
+ */
1173
+ export interface V1SearchInstruction {
1174
+ /**
1175
+ *
1176
+ * @type {string}
1177
+ * @memberof V1SearchInstruction
1178
+ */
1179
+ 'id': string;
1180
+ /**
1181
+ *
1182
+ * @type {string}
1183
+ * @memberof V1SearchInstruction
1184
+ */
1185
+ 'nodeId'?: string;
1186
+ /**
1187
+ *
1188
+ * @type {string}
1189
+ * @memberof V1SearchInstruction
1190
+ */
1191
+ 'targetId': string;
1192
+ /**
1193
+ *
1194
+ * @type {TrackingType}
1195
+ * @memberof V1SearchInstruction
1196
+ */
1197
+ 'trackingType': TrackingType;
1198
+ /**
1199
+ * Each step indicates an observation attempt at a given distance offset in the local spacecraft frame. Offset values for each step should always be entered in absolute distance offset from the target\'s TLE, not relative to the previous step.
1200
+ * @type {Array<V1SearchInstructionStep>}
1201
+ * @memberof V1SearchInstruction
1202
+ */
1203
+ 'steps': Array<V1SearchInstructionStep>;
1204
+ }
1205
+ /**
1206
+ * Search Instruction Step
1207
+ * @export
1208
+ * @interface V1SearchInstructionStep
1209
+ */
1210
+ export interface V1SearchInstructionStep {
1211
+ /**
1212
+ * Along-track offset in the local spacecraft frame.
1213
+ * @type {number}
1214
+ * @memberof V1SearchInstructionStep
1215
+ */
1216
+ 'alongTrackOffsetMeters': number;
1217
+ /**
1218
+ * Cross-track offset in the local spacecraft frame.
1219
+ * @type {number}
1220
+ * @memberof V1SearchInstructionStep
1221
+ */
1222
+ 'crossTrackOffsetMeters': number;
1223
+ /**
1224
+ * Radial offset in the local spacecraft frame.
1225
+ * @type {number}
1226
+ * @memberof V1SearchInstructionStep
1227
+ */
1228
+ 'radialOffsetMeters': number;
1229
+ /**
1230
+ *
1231
+ * @type {string}
1232
+ * @memberof V1SearchInstructionStep
1233
+ */
1234
+ 'startTime': string;
1235
+ /**
1236
+ *
1237
+ * @type {string}
1238
+ * @memberof V1SearchInstructionStep
1239
+ */
1240
+ 'endTime': string;
1241
+ }
1242
+ /**
1243
+ *
1244
+ * @export
1245
+ * @interface V1SurveyInstruction
1246
+ */
1247
+ export interface V1SurveyInstruction {
1248
+ /**
1249
+ *
1250
+ * @type {string}
1251
+ * @memberof V1SurveyInstruction
1252
+ */
1253
+ 'id': string;
1254
+ /**
1255
+ *
1256
+ * @type {string}
1257
+ * @memberof V1SurveyInstruction
1258
+ */
1259
+ 'nodeId'?: string;
1260
+ /**
1261
+ *
1262
+ * @type {string}
1263
+ * @memberof V1SurveyInstruction
1264
+ */
1265
+ 'targetId': string;
1266
+ /**
1267
+ * Each step indicates a sidereal observation attempt at a given (Ra, Dec). When supplying coordinates, they should be given in J2000 reference frames using an SGP4 model for propagation.
1268
+ * @type {Array<V1SurveyInstructionStep>}
1269
+ * @memberof V1SurveyInstruction
1270
+ */
1271
+ 'steps': Array<V1SurveyInstructionStep>;
1272
+ }
1273
+ /**
1274
+ * Survey Instruction Step
1275
+ * @export
1276
+ * @interface V1SurveyInstructionStep
1277
+ */
1278
+ export interface V1SurveyInstructionStep {
1279
+ /**
1280
+ *
1281
+ * @type {number}
1282
+ * @memberof V1SurveyInstructionStep
1283
+ */
1284
+ 'ra': number;
1285
+ /**
1286
+ *
1287
+ * @type {number}
1288
+ * @memberof V1SurveyInstructionStep
1069
1289
  */
1070
- 'noradId'?: string;
1290
+ 'dec': number;
1071
1291
  /**
1072
1292
  *
1073
- * @type {OrbitType}
1074
- * @memberof V1SatelliteTarget
1293
+ * @type {string}
1294
+ * @memberof V1SurveyInstructionStep
1075
1295
  */
1076
- 'orbitType': OrbitType;
1296
+ 'startTime': string;
1077
1297
  /**
1078
1298
  *
1079
1299
  * @type {string}
1080
- * @memberof V1SatelliteTarget
1300
+ * @memberof V1SurveyInstructionStep
1081
1301
  */
1082
- 'tleEpoch'?: string;
1302
+ 'endTime': string;
1303
+ }
1304
+ /**
1305
+ * Target Correlation
1306
+ * @export
1307
+ * @interface V1TargetCorrelation
1308
+ */
1309
+ export interface V1TargetCorrelation {
1083
1310
  /**
1084
1311
  *
1085
1312
  * @type {string}
1086
- * @memberof V1SatelliteTarget
1313
+ * @memberof V1TargetCorrelation
1087
1314
  */
1088
- 'tleLine1'?: string;
1315
+ 'targetId': string;
1089
1316
  /**
1090
1317
  *
1091
- * @type {string}
1092
- * @memberof V1SatelliteTarget
1318
+ * @type {number}
1319
+ * @memberof V1TargetCorrelation
1093
1320
  */
1094
- 'tleLine2'?: string;
1321
+ 'ra': number;
1095
1322
  /**
1096
1323
  *
1097
- * @type {SatelliteTargetTrackingStatus}
1098
- * @memberof V1SatelliteTarget
1324
+ * @type {number}
1325
+ * @memberof V1TargetCorrelation
1099
1326
  */
1100
- 'trackingStatus'?: SatelliteTargetTrackingStatus;
1327
+ 'dec': number;
1101
1328
  }
1102
1329
  /**
1103
1330
  * TDM
@@ -1332,12 +1559,19 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1332
1559
  */
1333
1560
  v1CreateSatelliteTarget: (v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1334
1561
  /**
1335
- * \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
1336
- * @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
1562
+ * Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
1563
+ * @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
1337
1564
  * @param {*} [options] Override http request option.
1338
1565
  * @throws {RequiredError}
1339
1566
  */
1340
- v1CreateSearchTask: (v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1567
+ v1CreateSearchInstruction: (v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1568
+ /**
1569
+ * 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.
1570
+ * @param {V1CreateSurveyInstructionRequest} v1CreateSurveyInstructionRequest
1571
+ * @param {*} [options] Override http request option.
1572
+ * @throws {RequiredError}
1573
+ */
1574
+ v1CreateSurveyInstruction: (v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1341
1575
  /**
1342
1576
  * 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.
1343
1577
  * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
@@ -1366,6 +1600,20 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1366
1600
  * @throws {RequiredError}
1367
1601
  */
1368
1602
  v1DeleteOrganizationTarget: (satelliteTargetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1603
+ /**
1604
+ * Delete a search instruction.
1605
+ * @param {string} id
1606
+ * @param {*} [options] Override http request option.
1607
+ * @throws {RequiredError}
1608
+ */
1609
+ v1DeleteSearchInstruction: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1610
+ /**
1611
+ * Delete a survey instruction.
1612
+ * @param {string} id
1613
+ * @param {*} [options] Override http request option.
1614
+ * @throws {RequiredError}
1615
+ */
1616
+ v1DeleteSurveyInstruction: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1369
1617
  /**
1370
1618
  * Delete a webhook configuration.
1371
1619
  * @param {string} id
@@ -1407,6 +1655,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1407
1655
  * @throws {RequiredError}
1408
1656
  */
1409
1657
  v1GetNodeProperties: (nodeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1658
+ /**
1659
+ * Get observation features.
1660
+ * @param {string} imageId
1661
+ * @param {*} [options] Override http request option.
1662
+ * @throws {RequiredError}
1663
+ */
1664
+ v1GetObservationFeatures: (imageId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1410
1665
  /**
1411
1666
  * 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.
1412
1667
  * @param {string} [targetId]
@@ -1415,6 +1670,16 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1415
1670
  * @throws {RequiredError}
1416
1671
  */
1417
1672
  v1GetObservationSequenceResults: (targetId?: string, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1673
+ /**
1674
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, 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` or `surveyInstructionId`, a `before` timestamp is not required.
1675
+ * @param {string} [targetId]
1676
+ * @param {string} [before]
1677
+ * @param {string} [searchInstructionId]
1678
+ * @param {string} [surveyInstructionId]
1679
+ * @param {*} [options] Override http request option.
1680
+ * @throws {RequiredError}
1681
+ */
1682
+ v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1418
1683
  /**
1419
1684
  * Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
1420
1685
  * @param {*} [options] Override http request option.
@@ -1429,6 +1694,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1429
1694
  * @throws {RequiredError}
1430
1695
  */
1431
1696
  v1GetSatellitePotentials: (satelliteTargetId: string, until: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1697
+ /**
1698
+ * Get a satellite target that the OurSky platform can currently track by id.
1699
+ * @param {string} id
1700
+ * @param {*} [options] Override http request option.
1701
+ * @throws {RequiredError}
1702
+ */
1703
+ v1GetSatelliteTarget: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1432
1704
  /**
1433
1705
  * The available satellite objects that the OurSky platform can currently track.
1434
1706
  * @param {OrbitType} [orbitType]
@@ -1437,6 +1709,20 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1437
1709
  * @throws {RequiredError}
1438
1710
  */
1439
1711
  v1GetSatelliteTargets: (orbitType?: OrbitType, noradId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1712
+ /**
1713
+ * 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.
1714
+ * @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
1715
+ * @param {*} [options] Override http request option.
1716
+ * @throws {RequiredError}
1717
+ */
1718
+ v1GetSearchInstructions: (before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1719
+ /**
1720
+ * 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.
1721
+ * @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
1722
+ * @param {*} [options] Override http request option.
1723
+ * @throws {RequiredError}
1724
+ */
1725
+ v1GetSurveyInstructions: (before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
1440
1726
  /**
1441
1727
  * Get a TDM.
1442
1728
  * @param {string} tdmId
@@ -1507,12 +1793,19 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1507
1793
  */
1508
1794
  v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
1509
1795
  /**
1510
- * \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
1511
- * @param {V1CreateSearchTaskRequest} v1CreateSearchTaskRequest
1796
+ * Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
1797
+ * @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
1798
+ * @param {*} [options] Override http request option.
1799
+ * @throws {RequiredError}
1800
+ */
1801
+ v1CreateSearchInstruction(v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
1802
+ /**
1803
+ * 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.
1804
+ * @param {V1CreateSurveyInstructionRequest} v1CreateSurveyInstructionRequest
1512
1805
  * @param {*} [options] Override http request option.
1513
1806
  * @throws {RequiredError}
1514
1807
  */
1515
- v1CreateSearchTask(v1CreateSearchTaskRequest: V1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
1808
+ v1CreateSurveyInstruction(v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
1516
1809
  /**
1517
1810
  * 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.
1518
1811
  * @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
@@ -1541,6 +1834,20 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1541
1834
  * @throws {RequiredError}
1542
1835
  */
1543
1836
  v1DeleteOrganizationTarget(satelliteTargetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
1837
+ /**
1838
+ * Delete a search instruction.
1839
+ * @param {string} id
1840
+ * @param {*} [options] Override http request option.
1841
+ * @throws {RequiredError}
1842
+ */
1843
+ v1DeleteSearchInstruction(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
1844
+ /**
1845
+ * Delete a survey instruction.
1846
+ * @param {string} id
1847
+ * @param {*} [options] Override http request option.
1848
+ * @throws {RequiredError}
1849
+ */
1850
+ v1DeleteSurveyInstruction(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
1544
1851
  /**
1545
1852
  * Delete a webhook configuration.
1546
1853
  * @param {string} id
@@ -1582,6 +1889,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1582
1889
  * @throws {RequiredError}
1583
1890
  */
1584
1891
  v1GetNodeProperties(nodeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1GroundStationParticipant>>;
1892
+ /**
1893
+ * Get observation features.
1894
+ * @param {string} imageId
1895
+ * @param {*} [options] Override http request option.
1896
+ * @throws {RequiredError}
1897
+ */
1898
+ v1GetObservationFeatures(imageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationFeature>>>;
1585
1899
  /**
1586
1900
  * 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.
1587
1901
  * @param {string} [targetId]
@@ -1590,6 +1904,16 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1590
1904
  * @throws {RequiredError}
1591
1905
  */
1592
1906
  v1GetObservationSequenceResults(targetId?: string, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationSequenceResult>>>;
1907
+ /**
1908
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, 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` or `surveyInstructionId`, a `before` timestamp is not required.
1909
+ * @param {string} [targetId]
1910
+ * @param {string} [before]
1911
+ * @param {string} [searchInstructionId]
1912
+ * @param {string} [surveyInstructionId]
1913
+ * @param {*} [options] Override http request option.
1914
+ * @throws {RequiredError}
1915
+ */
1916
+ v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
1593
1917
  /**
1594
1918
  * Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
1595
1919
  * @param {*} [options] Override http request option.
@@ -1604,6 +1928,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1604
1928
  * @throws {RequiredError}
1605
1929
  */
1606
1930
  v1GetSatellitePotentials(satelliteTargetId: string, until: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SatellitePotential>>>;
1931
+ /**
1932
+ * Get a satellite target that the OurSky platform can currently track by id.
1933
+ * @param {string} id
1934
+ * @param {*} [options] Override http request option.
1935
+ * @throws {RequiredError}
1936
+ */
1937
+ v1GetSatelliteTarget(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1SatelliteTarget>>;
1607
1938
  /**
1608
1939
  * The available satellite objects that the OurSky platform can currently track.
1609
1940
  * @param {OrbitType} [orbitType]
@@ -1612,6 +1943,20 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1612
1943
  * @throws {RequiredError}
1613
1944
  */
1614
1945
  v1GetSatelliteTargets(orbitType?: OrbitType, noradId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1GetSatelliteTargetsResponse>>;
1946
+ /**
1947
+ * 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.
1948
+ * @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
1949
+ * @param {*} [options] Override http request option.
1950
+ * @throws {RequiredError}
1951
+ */
1952
+ v1GetSearchInstructions(before?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SearchInstruction>>>;
1953
+ /**
1954
+ * 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.
1955
+ * @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
1956
+ * @param {*} [options] Override http request option.
1957
+ * @throws {RequiredError}
1958
+ */
1959
+ v1GetSurveyInstructions(before?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SurveyInstruction>>>;
1615
1960
  /**
1616
1961
  * Get a TDM.
1617
1962
  * @param {string} tdmId
@@ -1682,12 +2027,19 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
1682
2027
  */
1683
2028
  v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
1684
2029
  /**
1685
- * \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
1686
- * @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
2030
+ * Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
2031
+ * @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
2032
+ * @param {*} [options] Override http request option.
2033
+ * @throws {RequiredError}
2034
+ */
2035
+ v1CreateSearchInstruction(requestParameters: DefaultApiV1CreateSearchInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
2036
+ /**
2037
+ * 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.
2038
+ * @param {DefaultApiV1CreateSurveyInstructionRequest} requestParameters Request parameters.
1687
2039
  * @param {*} [options] Override http request option.
1688
2040
  * @throws {RequiredError}
1689
2041
  */
1690
- v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
2042
+ v1CreateSurveyInstruction(requestParameters: DefaultApiV1CreateSurveyInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
1691
2043
  /**
1692
2044
  * 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.
1693
2045
  * @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
@@ -1716,6 +2068,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
1716
2068
  * @throws {RequiredError}
1717
2069
  */
1718
2070
  v1DeleteOrganizationTarget(requestParameters: DefaultApiV1DeleteOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
2071
+ /**
2072
+ * Delete a search instruction.
2073
+ * @param {DefaultApiV1DeleteSearchInstructionRequest} requestParameters Request parameters.
2074
+ * @param {*} [options] Override http request option.
2075
+ * @throws {RequiredError}
2076
+ */
2077
+ v1DeleteSearchInstruction(requestParameters: DefaultApiV1DeleteSearchInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
2078
+ /**
2079
+ * Delete a survey instruction.
2080
+ * @param {DefaultApiV1DeleteSurveyInstructionRequest} requestParameters Request parameters.
2081
+ * @param {*} [options] Override http request option.
2082
+ * @throws {RequiredError}
2083
+ */
2084
+ v1DeleteSurveyInstruction(requestParameters: DefaultApiV1DeleteSurveyInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
1719
2085
  /**
1720
2086
  * Delete a webhook configuration.
1721
2087
  * @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
@@ -1757,6 +2123,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
1757
2123
  * @throws {RequiredError}
1758
2124
  */
1759
2125
  v1GetNodeProperties(requestParameters: DefaultApiV1GetNodePropertiesRequest, options?: AxiosRequestConfig): AxiosPromise<V1GroundStationParticipant>;
2126
+ /**
2127
+ * Get observation features.
2128
+ * @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
2129
+ * @param {*} [options] Override http request option.
2130
+ * @throws {RequiredError}
2131
+ */
2132
+ v1GetObservationFeatures(requestParameters: DefaultApiV1GetObservationFeaturesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationFeature>>;
1760
2133
  /**
1761
2134
  * 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.
1762
2135
  * @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
@@ -1764,6 +2137,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
1764
2137
  * @throws {RequiredError}
1765
2138
  */
1766
2139
  v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationSequenceResult>>;
2140
+ /**
2141
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, 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` or `surveyInstructionId`, a `before` timestamp is not required.
2142
+ * @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
2143
+ * @param {*} [options] Override http request option.
2144
+ * @throws {RequiredError}
2145
+ */
2146
+ v1GetObservationStatuses(requestParameters?: DefaultApiV1GetObservationStatusesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1ObservationStatus>>;
1767
2147
  /**
1768
2148
  * Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
1769
2149
  * @param {*} [options] Override http request option.
@@ -1777,6 +2157,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
1777
2157
  * @throws {RequiredError}
1778
2158
  */
1779
2159
  v1GetSatellitePotentials(requestParameters: DefaultApiV1GetSatellitePotentialsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SatellitePotential>>;
2160
+ /**
2161
+ * Get a satellite target that the OurSky platform can currently track by id.
2162
+ * @param {DefaultApiV1GetSatelliteTargetRequest} requestParameters Request parameters.
2163
+ * @param {*} [options] Override http request option.
2164
+ * @throws {RequiredError}
2165
+ */
2166
+ v1GetSatelliteTarget(requestParameters: DefaultApiV1GetSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<V1SatelliteTarget>;
1780
2167
  /**
1781
2168
  * The available satellite objects that the OurSky platform can currently track.
1782
2169
  * @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
@@ -1784,6 +2171,20 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
1784
2171
  * @throws {RequiredError}
1785
2172
  */
1786
2173
  v1GetSatelliteTargets(requestParameters?: DefaultApiV1GetSatelliteTargetsRequest, options?: AxiosRequestConfig): AxiosPromise<V1GetSatelliteTargetsResponse>;
2174
+ /**
2175
+ * 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.
2176
+ * @param {DefaultApiV1GetSearchInstructionsRequest} requestParameters Request parameters.
2177
+ * @param {*} [options] Override http request option.
2178
+ * @throws {RequiredError}
2179
+ */
2180
+ v1GetSearchInstructions(requestParameters?: DefaultApiV1GetSearchInstructionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SearchInstruction>>;
2181
+ /**
2182
+ * 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.
2183
+ * @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
2184
+ * @param {*} [options] Override http request option.
2185
+ * @throws {RequiredError}
2186
+ */
2187
+ v1GetSurveyInstructions(requestParameters?: DefaultApiV1GetSurveyInstructionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SurveyInstruction>>;
1787
2188
  /**
1788
2189
  * Get a TDM.
1789
2190
  * @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.
@@ -1872,17 +2273,30 @@ export interface DefaultApiV1CreateSatelliteTargetRequest {
1872
2273
  readonly v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest;
1873
2274
  }
1874
2275
  /**
1875
- * Request parameters for v1CreateSearchTask operation in DefaultApi.
2276
+ * Request parameters for v1CreateSearchInstruction operation in DefaultApi.
2277
+ * @export
2278
+ * @interface DefaultApiV1CreateSearchInstructionRequest
2279
+ */
2280
+ export interface DefaultApiV1CreateSearchInstructionRequest {
2281
+ /**
2282
+ *
2283
+ * @type {V1CreateSearchInstructionRequest}
2284
+ * @memberof DefaultApiV1CreateSearchInstruction
2285
+ */
2286
+ readonly v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest;
2287
+ }
2288
+ /**
2289
+ * Request parameters for v1CreateSurveyInstruction operation in DefaultApi.
1876
2290
  * @export
1877
- * @interface DefaultApiV1CreateSearchTaskRequest
2291
+ * @interface DefaultApiV1CreateSurveyInstructionRequest
1878
2292
  */
1879
- export interface DefaultApiV1CreateSearchTaskRequest {
2293
+ export interface DefaultApiV1CreateSurveyInstructionRequest {
1880
2294
  /**
1881
2295
  *
1882
- * @type {V1CreateSearchTaskRequest}
1883
- * @memberof DefaultApiV1CreateSearchTask
2296
+ * @type {V1CreateSurveyInstructionRequest}
2297
+ * @memberof DefaultApiV1CreateSurveyInstruction
1884
2298
  */
1885
- readonly v1CreateSearchTaskRequest: V1CreateSearchTaskRequest;
2299
+ readonly v1CreateSurveyInstructionRequest: V1CreateSurveyInstructionRequest;
1886
2300
  }
1887
2301
  /**
1888
2302
  * Request parameters for v1CreateWebhookConfiguration operation in DefaultApi.
@@ -1936,6 +2350,32 @@ export interface DefaultApiV1DeleteOrganizationTargetRequest {
1936
2350
  */
1937
2351
  readonly satelliteTargetId: string;
1938
2352
  }
2353
+ /**
2354
+ * Request parameters for v1DeleteSearchInstruction operation in DefaultApi.
2355
+ * @export
2356
+ * @interface DefaultApiV1DeleteSearchInstructionRequest
2357
+ */
2358
+ export interface DefaultApiV1DeleteSearchInstructionRequest {
2359
+ /**
2360
+ *
2361
+ * @type {string}
2362
+ * @memberof DefaultApiV1DeleteSearchInstruction
2363
+ */
2364
+ readonly id: string;
2365
+ }
2366
+ /**
2367
+ * Request parameters for v1DeleteSurveyInstruction operation in DefaultApi.
2368
+ * @export
2369
+ * @interface DefaultApiV1DeleteSurveyInstructionRequest
2370
+ */
2371
+ export interface DefaultApiV1DeleteSurveyInstructionRequest {
2372
+ /**
2373
+ *
2374
+ * @type {string}
2375
+ * @memberof DefaultApiV1DeleteSurveyInstruction
2376
+ */
2377
+ readonly id: string;
2378
+ }
1939
2379
  /**
1940
2380
  * Request parameters for v1DeleteWebhookConfiguration operation in DefaultApi.
1941
2381
  * @export
@@ -2001,6 +2441,19 @@ export interface DefaultApiV1GetNodePropertiesRequest {
2001
2441
  */
2002
2442
  readonly nodeId: string;
2003
2443
  }
2444
+ /**
2445
+ * Request parameters for v1GetObservationFeatures operation in DefaultApi.
2446
+ * @export
2447
+ * @interface DefaultApiV1GetObservationFeaturesRequest
2448
+ */
2449
+ export interface DefaultApiV1GetObservationFeaturesRequest {
2450
+ /**
2451
+ *
2452
+ * @type {string}
2453
+ * @memberof DefaultApiV1GetObservationFeatures
2454
+ */
2455
+ readonly imageId: string;
2456
+ }
2004
2457
  /**
2005
2458
  * Request parameters for v1GetObservationSequenceResults operation in DefaultApi.
2006
2459
  * @export
@@ -2020,6 +2473,37 @@ export interface DefaultApiV1GetObservationSequenceResultsRequest {
2020
2473
  */
2021
2474
  readonly after?: string;
2022
2475
  }
2476
+ /**
2477
+ * Request parameters for v1GetObservationStatuses operation in DefaultApi.
2478
+ * @export
2479
+ * @interface DefaultApiV1GetObservationStatusesRequest
2480
+ */
2481
+ export interface DefaultApiV1GetObservationStatusesRequest {
2482
+ /**
2483
+ *
2484
+ * @type {string}
2485
+ * @memberof DefaultApiV1GetObservationStatuses
2486
+ */
2487
+ readonly targetId?: string;
2488
+ /**
2489
+ *
2490
+ * @type {string}
2491
+ * @memberof DefaultApiV1GetObservationStatuses
2492
+ */
2493
+ readonly before?: string;
2494
+ /**
2495
+ *
2496
+ * @type {string}
2497
+ * @memberof DefaultApiV1GetObservationStatuses
2498
+ */
2499
+ readonly searchInstructionId?: string;
2500
+ /**
2501
+ *
2502
+ * @type {string}
2503
+ * @memberof DefaultApiV1GetObservationStatuses
2504
+ */
2505
+ readonly surveyInstructionId?: string;
2506
+ }
2023
2507
  /**
2024
2508
  * Request parameters for v1GetSatellitePotentials operation in DefaultApi.
2025
2509
  * @export
@@ -2039,6 +2523,19 @@ export interface DefaultApiV1GetSatellitePotentialsRequest {
2039
2523
  */
2040
2524
  readonly until: string;
2041
2525
  }
2526
+ /**
2527
+ * Request parameters for v1GetSatelliteTarget operation in DefaultApi.
2528
+ * @export
2529
+ * @interface DefaultApiV1GetSatelliteTargetRequest
2530
+ */
2531
+ export interface DefaultApiV1GetSatelliteTargetRequest {
2532
+ /**
2533
+ *
2534
+ * @type {string}
2535
+ * @memberof DefaultApiV1GetSatelliteTarget
2536
+ */
2537
+ readonly id: string;
2538
+ }
2042
2539
  /**
2043
2540
  * Request parameters for v1GetSatelliteTargets operation in DefaultApi.
2044
2541
  * @export
@@ -2058,6 +2555,32 @@ export interface DefaultApiV1GetSatelliteTargetsRequest {
2058
2555
  */
2059
2556
  readonly noradId?: string;
2060
2557
  }
2558
+ /**
2559
+ * Request parameters for v1GetSearchInstructions operation in DefaultApi.
2560
+ * @export
2561
+ * @interface DefaultApiV1GetSearchInstructionsRequest
2562
+ */
2563
+ export interface DefaultApiV1GetSearchInstructionsRequest {
2564
+ /**
2565
+ * The timestamp to get the next page of results. Defaults to the current time.
2566
+ * @type {string}
2567
+ * @memberof DefaultApiV1GetSearchInstructions
2568
+ */
2569
+ readonly before?: string;
2570
+ }
2571
+ /**
2572
+ * Request parameters for v1GetSurveyInstructions operation in DefaultApi.
2573
+ * @export
2574
+ * @interface DefaultApiV1GetSurveyInstructionsRequest
2575
+ */
2576
+ export interface DefaultApiV1GetSurveyInstructionsRequest {
2577
+ /**
2578
+ * The timestamp to get the next page of results. Defaults to the current time.
2579
+ * @type {string}
2580
+ * @memberof DefaultApiV1GetSurveyInstructions
2581
+ */
2582
+ readonly before?: string;
2583
+ }
2061
2584
  /**
2062
2585
  * Request parameters for v1GetTdm operation in DefaultApi.
2063
2586
  * @export
@@ -2156,13 +2679,21 @@ export declare class DefaultApi extends BaseAPI {
2156
2679
  */
2157
2680
  v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
2158
2681
  /**
2159
- * \' Create an search task. Search tasks are the highest priority request in the system. The system will execute the search and the results will be available in the search task status endpoint. \'
2160
- * @param {DefaultApiV1CreateSearchTaskRequest} requestParameters Request parameters.
2682
+ * Create a search instruction. Search instructions are the highest priority request in the system. The system will execute the search and the results will be available in the observation status endpoint.
2683
+ * @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
2161
2684
  * @param {*} [options] Override http request option.
2162
2685
  * @throws {RequiredError}
2163
2686
  * @memberof DefaultApi
2164
2687
  */
2165
- v1CreateSearchTask(requestParameters: DefaultApiV1CreateSearchTaskRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
2688
+ v1CreateSearchInstruction(requestParameters: DefaultApiV1CreateSearchInstructionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
2689
+ /**
2690
+ * 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.
2691
+ * @param {DefaultApiV1CreateSurveyInstructionRequest} requestParameters Request parameters.
2692
+ * @param {*} [options] Override http request option.
2693
+ * @throws {RequiredError}
2694
+ * @memberof DefaultApi
2695
+ */
2696
+ v1CreateSurveyInstruction(requestParameters: DefaultApiV1CreateSurveyInstructionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
2166
2697
  /**
2167
2698
  * 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.
2168
2699
  * @param {DefaultApiV1CreateWebhookConfigurationRequest} requestParameters Request parameters.
@@ -2195,6 +2726,22 @@ export declare class DefaultApi extends BaseAPI {
2195
2726
  * @memberof DefaultApi
2196
2727
  */
2197
2728
  v1DeleteOrganizationTarget(requestParameters: DefaultApiV1DeleteOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
2729
+ /**
2730
+ * Delete a search instruction.
2731
+ * @param {DefaultApiV1DeleteSearchInstructionRequest} requestParameters Request parameters.
2732
+ * @param {*} [options] Override http request option.
2733
+ * @throws {RequiredError}
2734
+ * @memberof DefaultApi
2735
+ */
2736
+ v1DeleteSearchInstruction(requestParameters: DefaultApiV1DeleteSearchInstructionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
2737
+ /**
2738
+ * Delete a survey instruction.
2739
+ * @param {DefaultApiV1DeleteSurveyInstructionRequest} requestParameters Request parameters.
2740
+ * @param {*} [options] Override http request option.
2741
+ * @throws {RequiredError}
2742
+ * @memberof DefaultApi
2743
+ */
2744
+ v1DeleteSurveyInstruction(requestParameters: DefaultApiV1DeleteSurveyInstructionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
2198
2745
  /**
2199
2746
  * Delete a webhook configuration.
2200
2747
  * @param {DefaultApiV1DeleteWebhookConfigurationRequest} requestParameters Request parameters.
@@ -2242,6 +2789,14 @@ export declare class DefaultApi extends BaseAPI {
2242
2789
  * @memberof DefaultApi
2243
2790
  */
2244
2791
  v1GetNodeProperties(requestParameters: DefaultApiV1GetNodePropertiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1GroundStationParticipant, any>>;
2792
+ /**
2793
+ * Get observation features.
2794
+ * @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
2795
+ * @param {*} [options] Override http request option.
2796
+ * @throws {RequiredError}
2797
+ * @memberof DefaultApi
2798
+ */
2799
+ v1GetObservationFeatures(requestParameters: DefaultApiV1GetObservationFeaturesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationFeature[], any>>;
2245
2800
  /**
2246
2801
  * 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.
2247
2802
  * @param {DefaultApiV1GetObservationSequenceResultsRequest} requestParameters Request parameters.
@@ -2250,6 +2805,14 @@ export declare class DefaultApi extends BaseAPI {
2250
2805
  * @memberof DefaultApi
2251
2806
  */
2252
2807
  v1GetObservationSequenceResults(requestParameters?: DefaultApiV1GetObservationSequenceResultsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationSequenceResult[], any>>;
2808
+ /**
2809
+ * Get the status of observations tasked on our network either for an entire organization, by a specific `targetId`, by `searchInstructionId`, 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` or `surveyInstructionId`, a `before` timestamp is not required.
2810
+ * @param {DefaultApiV1GetObservationStatusesRequest} requestParameters Request parameters.
2811
+ * @param {*} [options] Override http request option.
2812
+ * @throws {RequiredError}
2813
+ * @memberof DefaultApi
2814
+ */
2815
+ v1GetObservationStatuses(requestParameters?: DefaultApiV1GetObservationStatusesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ObservationStatus[], any>>;
2253
2816
  /**
2254
2817
  * Get organization targets see the [create](#operation/v1CreateOrganizationTarget) endpoint for more details.
2255
2818
  * @param {*} [options] Override http request option.
@@ -2265,6 +2828,14 @@ export declare class DefaultApi extends BaseAPI {
2265
2828
  * @memberof DefaultApi
2266
2829
  */
2267
2830
  v1GetSatellitePotentials(requestParameters: DefaultApiV1GetSatellitePotentialsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SatellitePotential[], any>>;
2831
+ /**
2832
+ * Get a satellite target that the OurSky platform can currently track by id.
2833
+ * @param {DefaultApiV1GetSatelliteTargetRequest} requestParameters Request parameters.
2834
+ * @param {*} [options] Override http request option.
2835
+ * @throws {RequiredError}
2836
+ * @memberof DefaultApi
2837
+ */
2838
+ v1GetSatelliteTarget(requestParameters: DefaultApiV1GetSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SatelliteTarget, any>>;
2268
2839
  /**
2269
2840
  * The available satellite objects that the OurSky platform can currently track.
2270
2841
  * @param {DefaultApiV1GetSatelliteTargetsRequest} requestParameters Request parameters.
@@ -2273,6 +2844,22 @@ export declare class DefaultApi extends BaseAPI {
2273
2844
  * @memberof DefaultApi
2274
2845
  */
2275
2846
  v1GetSatelliteTargets(requestParameters?: DefaultApiV1GetSatelliteTargetsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1GetSatelliteTargetsResponse, any>>;
2847
+ /**
2848
+ * 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.
2849
+ * @param {DefaultApiV1GetSearchInstructionsRequest} requestParameters Request parameters.
2850
+ * @param {*} [options] Override http request option.
2851
+ * @throws {RequiredError}
2852
+ * @memberof DefaultApi
2853
+ */
2854
+ v1GetSearchInstructions(requestParameters?: DefaultApiV1GetSearchInstructionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SearchInstruction[], any>>;
2855
+ /**
2856
+ * 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.
2857
+ * @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
2858
+ * @param {*} [options] Override http request option.
2859
+ * @throws {RequiredError}
2860
+ * @memberof DefaultApi
2861
+ */
2862
+ v1GetSurveyInstructions(requestParameters?: DefaultApiV1GetSurveyInstructionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SurveyInstruction[], any>>;
2276
2863
  /**
2277
2864
  * Get a TDM.
2278
2865
  * @param {DefaultApiV1GetTdmRequest} requestParameters Request parameters.