@ourskyai/sda-api 1.3.5667 → 1.3.8106
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/README.md +2 -2
- package/api.ts +2359 -140
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +1764 -136
- package/dist/api.js +949 -56
- package/dist/base.d.ts +2 -2
- package/dist/base.js +2 -2
- package/dist/common.d.ts +2 -2
- package/dist/common.js +2 -2
- package/dist/configuration.d.ts +2 -2
- package/dist/configuration.js +2 -2
- package/dist/esm/api.d.ts +1764 -136
- package/dist/esm/api.js +948 -55
- package/dist/esm/base.d.ts +2 -2
- package/dist/esm/base.js +2 -2
- package/dist/esm/common.d.ts +2 -2
- package/dist/esm/common.js +2 -2
- package/dist/esm/configuration.d.ts +2 -2
- package/dist/esm/configuration.js +2 -2
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/index.ts +2 -2
- package/package.json +1 -1
package/dist/esm/api.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* OurSky SDA
|
|
3
|
-
* The basic flow for a new organization is as follows: 1. View the available satellite targets with the [satellite targets](
|
|
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 OSRs automatically (preferred) or use the [OSRs](#tag/observation-sequence-results/GET/v1/observation-sequence-results) endpoint to poll for OSRs. Check out our [examples](https://github.com/ourskyai/oursky-examples) repository to see usage in each language.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 1.3.
|
|
5
|
+
* The version of the OpenAPI document: 1.3.8106
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -93,6 +93,15 @@ export declare const FilterType: {
|
|
|
93
93
|
readonly PHOTO_JOHNSON_V: "PHOTO_JOHNSON_V";
|
|
94
94
|
readonly PHOTO_COUSINS_R: "PHOTO_COUSINS_R";
|
|
95
95
|
readonly PHOTO_COUSINS_I: "PHOTO_COUSINS_I";
|
|
96
|
+
readonly PHOTO_SLOAN_U: "PHOTO_SLOAN_U";
|
|
97
|
+
readonly PHOTO_SLOAN_G: "PHOTO_SLOAN_G";
|
|
98
|
+
readonly PHOTO_SLOAN_R: "PHOTO_SLOAN_R";
|
|
99
|
+
readonly PHOTO_SLOAN_I: "PHOTO_SLOAN_I";
|
|
100
|
+
readonly PHOTO_SLOAN_Z: "PHOTO_SLOAN_Z";
|
|
101
|
+
readonly TRIPLE_BAND: "TRIPLE_BAND";
|
|
102
|
+
readonly QUAD_BAND: "QUAD_BAND";
|
|
103
|
+
readonly DARK: "DARK";
|
|
104
|
+
readonly OTHER: "OTHER";
|
|
96
105
|
};
|
|
97
106
|
export type FilterType = typeof FilterType[keyof typeof FilterType];
|
|
98
107
|
/**
|
|
@@ -120,6 +129,10 @@ export interface FitsHeader {
|
|
|
120
129
|
* @enum {string}
|
|
121
130
|
*/
|
|
122
131
|
export declare const ImageSetType: {
|
|
132
|
+
readonly ASTRONOMICAL: "ASTRONOMICAL";
|
|
133
|
+
readonly EARTH_ORBITAL: "EARTH_ORBITAL";
|
|
134
|
+
readonly GNSS_CALIBRATION: "GNSS_CALIBRATION";
|
|
135
|
+
readonly SATELLITE_CALIBRATION: "SATELLITE_CALIBRATION";
|
|
123
136
|
readonly ALL_SKY: "ALL_SKY";
|
|
124
137
|
};
|
|
125
138
|
export type ImageSetType = typeof ImageSetType[keyof typeof ImageSetType];
|
|
@@ -385,6 +398,18 @@ export declare const SatelliteTargetTrackingStatus: {
|
|
|
385
398
|
readonly DEORBITED: "DEORBITED";
|
|
386
399
|
};
|
|
387
400
|
export type SatelliteTargetTrackingStatus = typeof SatelliteTargetTrackingStatus[keyof typeof SatelliteTargetTrackingStatus];
|
|
401
|
+
/**
|
|
402
|
+
* The reason a search was completed.
|
|
403
|
+
* @export
|
|
404
|
+
* @enum {string}
|
|
405
|
+
*/
|
|
406
|
+
export declare const SearchCompletedReason: {
|
|
407
|
+
readonly ALL_HYPOTHESES_TESTED: "ALL_HYPOTHESES_TESTED";
|
|
408
|
+
readonly FOUND_TARGET: "FOUND_TARGET";
|
|
409
|
+
readonly CANCELLED: "CANCELLED";
|
|
410
|
+
readonly FAILED: "FAILED";
|
|
411
|
+
};
|
|
412
|
+
export type SearchCompletedReason = typeof SearchCompletedReason[keyof typeof SearchCompletedReason];
|
|
388
413
|
/**
|
|
389
414
|
*
|
|
390
415
|
* @export
|
|
@@ -432,6 +457,30 @@ export declare const TrackingType: {
|
|
|
432
457
|
readonly NONE: "NONE";
|
|
433
458
|
};
|
|
434
459
|
export type TrackingType = typeof TrackingType[keyof typeof TrackingType];
|
|
460
|
+
/**
|
|
461
|
+
* A designated volume of space that is not to be observed.
|
|
462
|
+
* @export
|
|
463
|
+
* @interface V1BlackoutVolumeRequest
|
|
464
|
+
*/
|
|
465
|
+
export interface V1BlackoutVolumeRequest {
|
|
466
|
+
/**
|
|
467
|
+
* The reference frame in which the volume is defined.
|
|
468
|
+
* @type {string}
|
|
469
|
+
* @memberof V1BlackoutVolumeRequest
|
|
470
|
+
*/
|
|
471
|
+
'reference_frame': V1BlackoutVolumeRequestReferenceFrameEnum;
|
|
472
|
+
/**
|
|
473
|
+
* The set of 8 points that define the volume, coordinates should be in the selected reference frame.
|
|
474
|
+
* @type {Array<V1Point>}
|
|
475
|
+
* @memberof V1BlackoutVolumeRequest
|
|
476
|
+
*/
|
|
477
|
+
'points': Array<V1Point>;
|
|
478
|
+
}
|
|
479
|
+
export declare const V1BlackoutVolumeRequestReferenceFrameEnum: {
|
|
480
|
+
readonly ECI_J2000: "ECI_J2000";
|
|
481
|
+
readonly ECEF: "ECEF";
|
|
482
|
+
};
|
|
483
|
+
export type V1BlackoutVolumeRequestReferenceFrameEnum = typeof V1BlackoutVolumeRequestReferenceFrameEnum[keyof typeof V1BlackoutVolumeRequestReferenceFrameEnum];
|
|
435
484
|
/**
|
|
436
485
|
*
|
|
437
486
|
* @export
|
|
@@ -444,9 +493,45 @@ export interface V1CreateImageSetImageRequest {
|
|
|
444
493
|
* @memberof V1CreateImageSetImageRequest
|
|
445
494
|
*/
|
|
446
495
|
'imageSetId': string;
|
|
496
|
+
/**
|
|
497
|
+
*
|
|
498
|
+
* @type {V1ImageFileType}
|
|
499
|
+
* @memberof V1CreateImageSetImageRequest
|
|
500
|
+
*/
|
|
501
|
+
'imageFileType'?: V1ImageFileType;
|
|
502
|
+
/**
|
|
503
|
+
*
|
|
504
|
+
* @type {number}
|
|
505
|
+
* @memberof V1CreateImageSetImageRequest
|
|
506
|
+
*/
|
|
507
|
+
'binning'?: number;
|
|
508
|
+
/**
|
|
509
|
+
*
|
|
510
|
+
* @type {number}
|
|
511
|
+
* @memberof V1CreateImageSetImageRequest
|
|
512
|
+
*/
|
|
513
|
+
'exposureLength'?: number;
|
|
514
|
+
/**
|
|
515
|
+
*
|
|
516
|
+
* @type {string}
|
|
517
|
+
* @memberof V1CreateImageSetImageRequest
|
|
518
|
+
*/
|
|
519
|
+
'imageSha'?: string;
|
|
520
|
+
/**
|
|
521
|
+
*
|
|
522
|
+
* @type {number}
|
|
523
|
+
* @memberof V1CreateImageSetImageRequest
|
|
524
|
+
*/
|
|
525
|
+
'imageSizeMb'?: number;
|
|
526
|
+
/**
|
|
527
|
+
*
|
|
528
|
+
* @type {string}
|
|
529
|
+
* @memberof V1CreateImageSetImageRequest
|
|
530
|
+
*/
|
|
531
|
+
'capturedAt'?: string;
|
|
447
532
|
}
|
|
448
533
|
/**
|
|
449
|
-
*
|
|
534
|
+
* Response from image creation, with image ID and presigned S3 upload URL.
|
|
450
535
|
* @export
|
|
451
536
|
* @interface V1CreateImageSetImageResponse
|
|
452
537
|
*/
|
|
@@ -767,6 +852,90 @@ export interface V1GroundStationParticipant {
|
|
|
767
852
|
*/
|
|
768
853
|
'focuserTravelDistanceMm'?: number;
|
|
769
854
|
}
|
|
855
|
+
/**
|
|
856
|
+
* HFR extracted star from the image
|
|
857
|
+
* @export
|
|
858
|
+
* @interface V1HFRStar
|
|
859
|
+
*/
|
|
860
|
+
export interface V1HFRStar {
|
|
861
|
+
/**
|
|
862
|
+
*
|
|
863
|
+
* @type {V1PixelCoordinates}
|
|
864
|
+
* @memberof V1HFRStar
|
|
865
|
+
*/
|
|
866
|
+
'coordinates'?: V1PixelCoordinates;
|
|
867
|
+
/**
|
|
868
|
+
*
|
|
869
|
+
* @type {number}
|
|
870
|
+
* @memberof V1HFRStar
|
|
871
|
+
*/
|
|
872
|
+
'hfr': number;
|
|
873
|
+
/**
|
|
874
|
+
*
|
|
875
|
+
* @type {number}
|
|
876
|
+
* @memberof V1HFRStar
|
|
877
|
+
*/
|
|
878
|
+
'flux': number;
|
|
879
|
+
}
|
|
880
|
+
/**
|
|
881
|
+
*
|
|
882
|
+
* @export
|
|
883
|
+
* @enum {string}
|
|
884
|
+
*/
|
|
885
|
+
export declare const V1ImageFileType: {
|
|
886
|
+
readonly FITS: "FITS";
|
|
887
|
+
readonly JPG: "JPG";
|
|
888
|
+
};
|
|
889
|
+
export type V1ImageFileType = typeof V1ImageFileType[keyof typeof V1ImageFileType];
|
|
890
|
+
/**
|
|
891
|
+
*
|
|
892
|
+
* @export
|
|
893
|
+
* @interface V1ImageMetadata
|
|
894
|
+
*/
|
|
895
|
+
export interface V1ImageMetadata {
|
|
896
|
+
/**
|
|
897
|
+
*
|
|
898
|
+
* @type {string}
|
|
899
|
+
* @memberof V1ImageMetadata
|
|
900
|
+
*/
|
|
901
|
+
'id': string;
|
|
902
|
+
/**
|
|
903
|
+
*
|
|
904
|
+
* @type {string}
|
|
905
|
+
* @memberof V1ImageMetadata
|
|
906
|
+
*/
|
|
907
|
+
'imageId': string;
|
|
908
|
+
/**
|
|
909
|
+
*
|
|
910
|
+
* @type {V1PlateSolveResult}
|
|
911
|
+
* @memberof V1ImageMetadata
|
|
912
|
+
*/
|
|
913
|
+
'plateSolveResult': V1PlateSolveResult;
|
|
914
|
+
/**
|
|
915
|
+
* Extracted star features from the image. Used as inputs to plate solving
|
|
916
|
+
* @type {Array<V1HFRStar>}
|
|
917
|
+
* @memberof V1ImageMetadata
|
|
918
|
+
*/
|
|
919
|
+
'inputStars'?: Array<V1HFRStar>;
|
|
920
|
+
/**
|
|
921
|
+
*
|
|
922
|
+
* @type {V1SIPCoefficients}
|
|
923
|
+
* @memberof V1ImageMetadata
|
|
924
|
+
*/
|
|
925
|
+
'sipCoefficients'?: V1SIPCoefficients;
|
|
926
|
+
/**
|
|
927
|
+
* Photometric zero point offset. Add to instrumental magnitude (-2.5*log10(flux)) to get calibrated magnitude in standard photometric system.
|
|
928
|
+
* @type {number}
|
|
929
|
+
* @memberof V1ImageMetadata
|
|
930
|
+
*/
|
|
931
|
+
'photometricZeroPoint'?: number;
|
|
932
|
+
/**
|
|
933
|
+
*
|
|
934
|
+
* @type {string}
|
|
935
|
+
* @memberof V1ImageMetadata
|
|
936
|
+
*/
|
|
937
|
+
'createdAt': string;
|
|
938
|
+
}
|
|
770
939
|
/**
|
|
771
940
|
* An image set represents a contiguous set of observations of the same target captured by the same node.
|
|
772
941
|
* @export
|
|
@@ -1003,6 +1172,170 @@ export interface V1ImageSetImage {
|
|
|
1003
1172
|
*/
|
|
1004
1173
|
'predictedStreakLocation'?: V1PredictedStreakLocation;
|
|
1005
1174
|
}
|
|
1175
|
+
/**
|
|
1176
|
+
* Extracted stars that matched during plate solving
|
|
1177
|
+
* @export
|
|
1178
|
+
* @interface V1MatchedStar
|
|
1179
|
+
*/
|
|
1180
|
+
export interface V1MatchedStar {
|
|
1181
|
+
/**
|
|
1182
|
+
* The x-centroid
|
|
1183
|
+
* @type {number}
|
|
1184
|
+
* @memberof V1MatchedStar
|
|
1185
|
+
*/
|
|
1186
|
+
'xCentroid': number;
|
|
1187
|
+
/**
|
|
1188
|
+
* The y-centroid
|
|
1189
|
+
* @type {number}
|
|
1190
|
+
* @memberof V1MatchedStar
|
|
1191
|
+
*/
|
|
1192
|
+
'yCentroid': number;
|
|
1193
|
+
/**
|
|
1194
|
+
* The UCAC4 or GaiaUD number if known
|
|
1195
|
+
* @type {number}
|
|
1196
|
+
* @memberof V1MatchedStar
|
|
1197
|
+
*/
|
|
1198
|
+
'sequenceNumber': number;
|
|
1199
|
+
/**
|
|
1200
|
+
* Extracted magnitude
|
|
1201
|
+
* @type {number}
|
|
1202
|
+
* @memberof V1MatchedStar
|
|
1203
|
+
*/
|
|
1204
|
+
'magnitude': number;
|
|
1205
|
+
/**
|
|
1206
|
+
* The star RA
|
|
1207
|
+
* @type {number}
|
|
1208
|
+
* @memberof V1MatchedStar
|
|
1209
|
+
*/
|
|
1210
|
+
'raRad': number;
|
|
1211
|
+
/**
|
|
1212
|
+
* The star Dec
|
|
1213
|
+
* @type {number}
|
|
1214
|
+
* @memberof V1MatchedStar
|
|
1215
|
+
*/
|
|
1216
|
+
'decRad': number;
|
|
1217
|
+
/**
|
|
1218
|
+
* The calculated offset from the catalog star, if known. 0 otherwise
|
|
1219
|
+
* @type {number}
|
|
1220
|
+
* @memberof V1MatchedStar
|
|
1221
|
+
*/
|
|
1222
|
+
'catalogOffsetRad': number;
|
|
1223
|
+
/**
|
|
1224
|
+
*
|
|
1225
|
+
* @type {number}
|
|
1226
|
+
* @memberof V1MatchedStar
|
|
1227
|
+
*/
|
|
1228
|
+
'catalogOffsetMagnitude'?: number;
|
|
1229
|
+
/**
|
|
1230
|
+
*
|
|
1231
|
+
* @type {number}
|
|
1232
|
+
* @memberof V1MatchedStar
|
|
1233
|
+
*/
|
|
1234
|
+
'flux': number;
|
|
1235
|
+
/**
|
|
1236
|
+
*
|
|
1237
|
+
* @type {number}
|
|
1238
|
+
* @memberof V1MatchedStar
|
|
1239
|
+
*/
|
|
1240
|
+
'hfr': number;
|
|
1241
|
+
}
|
|
1242
|
+
/**
|
|
1243
|
+
*
|
|
1244
|
+
* @export
|
|
1245
|
+
* @interface V1NodeCalibrationResult
|
|
1246
|
+
*/
|
|
1247
|
+
export interface V1NodeCalibrationResult {
|
|
1248
|
+
/**
|
|
1249
|
+
*
|
|
1250
|
+
* @type {string}
|
|
1251
|
+
* @memberof V1NodeCalibrationResult
|
|
1252
|
+
*/
|
|
1253
|
+
'id': string;
|
|
1254
|
+
/**
|
|
1255
|
+
*
|
|
1256
|
+
* @type {string}
|
|
1257
|
+
* @memberof V1NodeCalibrationResult
|
|
1258
|
+
*/
|
|
1259
|
+
'nodeId': string;
|
|
1260
|
+
/**
|
|
1261
|
+
*
|
|
1262
|
+
* @type {string}
|
|
1263
|
+
* @memberof V1NodeCalibrationResult
|
|
1264
|
+
*/
|
|
1265
|
+
'targetId': string;
|
|
1266
|
+
/**
|
|
1267
|
+
*
|
|
1268
|
+
* @type {string}
|
|
1269
|
+
* @memberof V1NodeCalibrationResult
|
|
1270
|
+
*/
|
|
1271
|
+
'imageId': string;
|
|
1272
|
+
/**
|
|
1273
|
+
* The right ascension of the center of the extracted streak, in radians
|
|
1274
|
+
* @type {number}
|
|
1275
|
+
* @memberof V1NodeCalibrationResult
|
|
1276
|
+
*/
|
|
1277
|
+
'calculatedRaRadians'?: number;
|
|
1278
|
+
/**
|
|
1279
|
+
* The declination of the center of the extracted streak, in radians
|
|
1280
|
+
* @type {number}
|
|
1281
|
+
* @memberof V1NodeCalibrationResult
|
|
1282
|
+
*/
|
|
1283
|
+
'calculatedDecRadians'?: number;
|
|
1284
|
+
/**
|
|
1285
|
+
* Ground truth right ascension in radians, from SP3 file
|
|
1286
|
+
* @type {number}
|
|
1287
|
+
* @memberof V1NodeCalibrationResult
|
|
1288
|
+
*/
|
|
1289
|
+
'groundTruthRaRadians'?: number;
|
|
1290
|
+
/**
|
|
1291
|
+
* Ground truth declination in radians, from SP3 file
|
|
1292
|
+
* @type {number}
|
|
1293
|
+
* @memberof V1NodeCalibrationResult
|
|
1294
|
+
*/
|
|
1295
|
+
'groundTruthDecRadians'?: number;
|
|
1296
|
+
/**
|
|
1297
|
+
* Calculated error in RA, in arc-seconds
|
|
1298
|
+
* @type {number}
|
|
1299
|
+
* @memberof V1NodeCalibrationResult
|
|
1300
|
+
*/
|
|
1301
|
+
'raErrorArcSeconds'?: number;
|
|
1302
|
+
/**
|
|
1303
|
+
* Calculated error in Dec, in arc-seconds
|
|
1304
|
+
* @type {number}
|
|
1305
|
+
* @memberof V1NodeCalibrationResult
|
|
1306
|
+
*/
|
|
1307
|
+
'decErrorArcSeconds'?: number;
|
|
1308
|
+
/**
|
|
1309
|
+
* Total error in RA/Dec, in arc-seconds
|
|
1310
|
+
* @type {number}
|
|
1311
|
+
* @memberof V1NodeCalibrationResult
|
|
1312
|
+
*/
|
|
1313
|
+
'totalErrorArcSeconds'?: number;
|
|
1314
|
+
/**
|
|
1315
|
+
*
|
|
1316
|
+
* @type {string}
|
|
1317
|
+
* @memberof V1NodeCalibrationResult
|
|
1318
|
+
*/
|
|
1319
|
+
'centerTime': string;
|
|
1320
|
+
/**
|
|
1321
|
+
*
|
|
1322
|
+
* @type {V1SatelliteCalibrationFamily}
|
|
1323
|
+
* @memberof V1NodeCalibrationResult
|
|
1324
|
+
*/
|
|
1325
|
+
'calibrationFamily': V1SatelliteCalibrationFamily;
|
|
1326
|
+
/**
|
|
1327
|
+
*
|
|
1328
|
+
* @type {string}
|
|
1329
|
+
* @memberof V1NodeCalibrationResult
|
|
1330
|
+
*/
|
|
1331
|
+
'sp3File': string;
|
|
1332
|
+
/**
|
|
1333
|
+
*
|
|
1334
|
+
* @type {string}
|
|
1335
|
+
* @memberof V1NodeCalibrationResult
|
|
1336
|
+
*/
|
|
1337
|
+
'createdAt': string;
|
|
1338
|
+
}
|
|
1006
1339
|
/**
|
|
1007
1340
|
* Observation Feature
|
|
1008
1341
|
* @export
|
|
@@ -1010,13 +1343,25 @@ export interface V1ImageSetImage {
|
|
|
1010
1343
|
*/
|
|
1011
1344
|
export interface V1ObservationFeature {
|
|
1012
1345
|
/**
|
|
1013
|
-
*
|
|
1346
|
+
* EME2000 right ascension, corrected for stellar aberration [degrees]
|
|
1347
|
+
* @type {number}
|
|
1348
|
+
* @memberof V1ObservationFeature
|
|
1349
|
+
*/
|
|
1350
|
+
'correctedRa'?: number;
|
|
1351
|
+
/**
|
|
1352
|
+
* EME2000 declination, corrected for stellar aberration [degrees]
|
|
1353
|
+
* @type {number}
|
|
1354
|
+
* @memberof V1ObservationFeature
|
|
1355
|
+
*/
|
|
1356
|
+
'correctedDec'?: number;
|
|
1357
|
+
/**
|
|
1358
|
+
* the right ascension in degrees in EME2000 frame, not corrected for stellar aberration
|
|
1014
1359
|
* @type {number}
|
|
1015
1360
|
* @memberof V1ObservationFeature
|
|
1016
1361
|
*/
|
|
1017
1362
|
'ra': number;
|
|
1018
1363
|
/**
|
|
1019
|
-
* the declination in degrees in EME2000 frame
|
|
1364
|
+
* the declination in degrees in EME2000 frame, not corrected for stellar aberration
|
|
1020
1365
|
* @type {number}
|
|
1021
1366
|
* @memberof V1ObservationFeature
|
|
1022
1367
|
*/
|
|
@@ -1241,6 +1586,31 @@ export interface V1ObservationStatus {
|
|
|
1241
1586
|
*/
|
|
1242
1587
|
'state': ObservationState;
|
|
1243
1588
|
}
|
|
1589
|
+
/**
|
|
1590
|
+
*
|
|
1591
|
+
* @export
|
|
1592
|
+
* @interface V1ObserverLocation
|
|
1593
|
+
*/
|
|
1594
|
+
export interface V1ObserverLocation {
|
|
1595
|
+
/**
|
|
1596
|
+
*
|
|
1597
|
+
* @type {number}
|
|
1598
|
+
* @memberof V1ObserverLocation
|
|
1599
|
+
*/
|
|
1600
|
+
'latitudeRadians': number;
|
|
1601
|
+
/**
|
|
1602
|
+
*
|
|
1603
|
+
* @type {number}
|
|
1604
|
+
* @memberof V1ObserverLocation
|
|
1605
|
+
*/
|
|
1606
|
+
'longitudeRadians': number;
|
|
1607
|
+
/**
|
|
1608
|
+
*
|
|
1609
|
+
* @type {number}
|
|
1610
|
+
* @memberof V1ObserverLocation
|
|
1611
|
+
*/
|
|
1612
|
+
'elevationMeters': number;
|
|
1613
|
+
}
|
|
1244
1614
|
/**
|
|
1245
1615
|
*
|
|
1246
1616
|
* @export
|
|
@@ -1253,6 +1623,12 @@ export interface V1OrganizationTarget {
|
|
|
1253
1623
|
* @memberof V1OrganizationTarget
|
|
1254
1624
|
*/
|
|
1255
1625
|
'id': string;
|
|
1626
|
+
/**
|
|
1627
|
+
*
|
|
1628
|
+
* @type {number}
|
|
1629
|
+
* @memberof V1OrganizationTarget
|
|
1630
|
+
*/
|
|
1631
|
+
'revisitRateMinutes'?: number;
|
|
1256
1632
|
/**
|
|
1257
1633
|
*
|
|
1258
1634
|
* @type {V1SatelliteTarget}
|
|
@@ -1273,44 +1649,197 @@ export interface V1OrganizationTarget {
|
|
|
1273
1649
|
'createdAt': string;
|
|
1274
1650
|
}
|
|
1275
1651
|
/**
|
|
1276
|
-
*
|
|
1652
|
+
* An (x,y) pixel location in the image
|
|
1277
1653
|
* @export
|
|
1278
|
-
* @interface
|
|
1654
|
+
* @interface V1PixelCoordinates
|
|
1279
1655
|
*/
|
|
1280
|
-
export interface
|
|
1656
|
+
export interface V1PixelCoordinates {
|
|
1281
1657
|
/**
|
|
1282
1658
|
*
|
|
1283
1659
|
* @type {number}
|
|
1284
|
-
* @memberof
|
|
1660
|
+
* @memberof V1PixelCoordinates
|
|
1285
1661
|
*/
|
|
1286
|
-
'
|
|
1662
|
+
'x': number;
|
|
1287
1663
|
/**
|
|
1288
1664
|
*
|
|
1289
1665
|
* @type {number}
|
|
1290
|
-
* @memberof
|
|
1666
|
+
* @memberof V1PixelCoordinates
|
|
1291
1667
|
*/
|
|
1292
|
-
'
|
|
1668
|
+
'y': number;
|
|
1669
|
+
}
|
|
1670
|
+
/**
|
|
1671
|
+
* Parameters to create a plane scan to search for a target
|
|
1672
|
+
* @export
|
|
1673
|
+
* @interface V1PlaneScanRequest
|
|
1674
|
+
*/
|
|
1675
|
+
export interface V1PlaneScanRequest {
|
|
1293
1676
|
/**
|
|
1294
1677
|
*
|
|
1678
|
+
* @type {string}
|
|
1679
|
+
* @memberof V1PlaneScanRequest
|
|
1680
|
+
*/
|
|
1681
|
+
'targetId': string;
|
|
1682
|
+
/**
|
|
1683
|
+
* The angle in degrees to search around the target\'s anomaly- centered on the target\'s prior position.
|
|
1295
1684
|
* @type {number}
|
|
1296
|
-
* @memberof
|
|
1685
|
+
* @memberof V1PlaneScanRequest
|
|
1297
1686
|
*/
|
|
1298
|
-
'
|
|
1687
|
+
'plusMinusAnomalyAngleDegrees': number;
|
|
1299
1688
|
/**
|
|
1300
|
-
*
|
|
1689
|
+
* The step size in degrees to search across the specified anomaly angle range
|
|
1301
1690
|
* @type {number}
|
|
1302
|
-
* @memberof
|
|
1691
|
+
* @memberof V1PlaneScanRequest
|
|
1303
1692
|
*/
|
|
1304
|
-
'
|
|
1693
|
+
'stepSizeDegrees': number;
|
|
1305
1694
|
}
|
|
1306
1695
|
/**
|
|
1307
|
-
*
|
|
1696
|
+
*
|
|
1308
1697
|
* @export
|
|
1309
|
-
* @interface
|
|
1698
|
+
* @interface V1PlateSolveResult
|
|
1310
1699
|
*/
|
|
1311
|
-
export interface
|
|
1700
|
+
export interface V1PlateSolveResult {
|
|
1312
1701
|
/**
|
|
1313
|
-
*
|
|
1702
|
+
*
|
|
1703
|
+
* @type {V1PlateSolveStatus}
|
|
1704
|
+
* @memberof V1PlateSolveResult
|
|
1705
|
+
*/
|
|
1706
|
+
'status'?: V1PlateSolveStatus;
|
|
1707
|
+
/**
|
|
1708
|
+
*
|
|
1709
|
+
* @type {Array<V1MatchedStar>}
|
|
1710
|
+
* @memberof V1PlateSolveResult
|
|
1711
|
+
*/
|
|
1712
|
+
'matchedStars'?: Array<V1MatchedStar>;
|
|
1713
|
+
/**
|
|
1714
|
+
* The number of pixels in X directions
|
|
1715
|
+
* @type {number}
|
|
1716
|
+
* @memberof V1PlateSolveResult
|
|
1717
|
+
*/
|
|
1718
|
+
'pixelWidth': number;
|
|
1719
|
+
/**
|
|
1720
|
+
* The number of pixels in Y directions
|
|
1721
|
+
* @type {number}
|
|
1722
|
+
* @memberof V1PlateSolveResult
|
|
1723
|
+
*/
|
|
1724
|
+
'pixelHeight': number;
|
|
1725
|
+
/**
|
|
1726
|
+
* The number of matched stars
|
|
1727
|
+
* @type {number}
|
|
1728
|
+
* @memberof V1PlateSolveResult
|
|
1729
|
+
*/
|
|
1730
|
+
'numberMatchedStars': number;
|
|
1731
|
+
/**
|
|
1732
|
+
* In radians, the exact RA center when matched
|
|
1733
|
+
* @type {number}
|
|
1734
|
+
* @memberof V1PlateSolveResult
|
|
1735
|
+
*/
|
|
1736
|
+
'centerRightAscensionRadians': number;
|
|
1737
|
+
/**
|
|
1738
|
+
* In radians, the exact Dec center when matched
|
|
1739
|
+
* @type {number}
|
|
1740
|
+
* @memberof V1PlateSolveResult
|
|
1741
|
+
*/
|
|
1742
|
+
'centerDeclinationRadians': number;
|
|
1743
|
+
/**
|
|
1744
|
+
* The approximate plate size in X-direction, in radians
|
|
1745
|
+
* @type {number}
|
|
1746
|
+
* @memberof V1PlateSolveResult
|
|
1747
|
+
*/
|
|
1748
|
+
'xSizeRadians': number;
|
|
1749
|
+
/**
|
|
1750
|
+
* The approximate plate size in Y-direction, in radians
|
|
1751
|
+
* @type {number}
|
|
1752
|
+
* @memberof V1PlateSolveResult
|
|
1753
|
+
*/
|
|
1754
|
+
'ySizeRadians': number;
|
|
1755
|
+
/**
|
|
1756
|
+
* True if there is a valid plate match
|
|
1757
|
+
* @type {boolean}
|
|
1758
|
+
* @memberof V1PlateSolveResult
|
|
1759
|
+
*/
|
|
1760
|
+
'isMatched': boolean;
|
|
1761
|
+
/**
|
|
1762
|
+
*
|
|
1763
|
+
* @type {V1Transformation}
|
|
1764
|
+
* @memberof V1PlateSolveResult
|
|
1765
|
+
*/
|
|
1766
|
+
'transformation': V1Transformation;
|
|
1767
|
+
}
|
|
1768
|
+
/**
|
|
1769
|
+
*
|
|
1770
|
+
* @export
|
|
1771
|
+
* @enum {string}
|
|
1772
|
+
*/
|
|
1773
|
+
export declare const V1PlateSolveStatus: {
|
|
1774
|
+
readonly MATCH_FOUND: "MATCH_FOUND";
|
|
1775
|
+
readonly NO_MATCH_FOUND: "NO_MATCH_FOUND";
|
|
1776
|
+
readonly CANCELLED: "CANCELLED";
|
|
1777
|
+
};
|
|
1778
|
+
export type V1PlateSolveStatus = typeof V1PlateSolveStatus[keyof typeof V1PlateSolveStatus];
|
|
1779
|
+
/**
|
|
1780
|
+
* A point in 3D space.
|
|
1781
|
+
* @export
|
|
1782
|
+
* @interface V1Point
|
|
1783
|
+
*/
|
|
1784
|
+
export interface V1Point {
|
|
1785
|
+
/**
|
|
1786
|
+
* The x-coordinate of the point in meters.
|
|
1787
|
+
* @type {number}
|
|
1788
|
+
* @memberof V1Point
|
|
1789
|
+
*/
|
|
1790
|
+
'x': number;
|
|
1791
|
+
/**
|
|
1792
|
+
* The y-coordinate of the point in meters.
|
|
1793
|
+
* @type {number}
|
|
1794
|
+
* @memberof V1Point
|
|
1795
|
+
*/
|
|
1796
|
+
'y': number;
|
|
1797
|
+
/**
|
|
1798
|
+
* The z-coordinate of the point in meters.
|
|
1799
|
+
* @type {number}
|
|
1800
|
+
* @memberof V1Point
|
|
1801
|
+
*/
|
|
1802
|
+
'z': number;
|
|
1803
|
+
}
|
|
1804
|
+
/**
|
|
1805
|
+
*
|
|
1806
|
+
* @export
|
|
1807
|
+
* @interface V1PredictedStreakLocation
|
|
1808
|
+
*/
|
|
1809
|
+
export interface V1PredictedStreakLocation {
|
|
1810
|
+
/**
|
|
1811
|
+
*
|
|
1812
|
+
* @type {number}
|
|
1813
|
+
* @memberof V1PredictedStreakLocation
|
|
1814
|
+
*/
|
|
1815
|
+
'startX'?: number;
|
|
1816
|
+
/**
|
|
1817
|
+
*
|
|
1818
|
+
* @type {number}
|
|
1819
|
+
* @memberof V1PredictedStreakLocation
|
|
1820
|
+
*/
|
|
1821
|
+
'startY'?: number;
|
|
1822
|
+
/**
|
|
1823
|
+
*
|
|
1824
|
+
* @type {number}
|
|
1825
|
+
* @memberof V1PredictedStreakLocation
|
|
1826
|
+
*/
|
|
1827
|
+
'endX'?: number;
|
|
1828
|
+
/**
|
|
1829
|
+
*
|
|
1830
|
+
* @type {number}
|
|
1831
|
+
* @memberof V1PredictedStreakLocation
|
|
1832
|
+
*/
|
|
1833
|
+
'endY'?: number;
|
|
1834
|
+
}
|
|
1835
|
+
/**
|
|
1836
|
+
* Upsert (create or update) a satellite target with new a new TLE. If creating a new target, do not enter a `satellite_target_id`. If updating an existing satellite target, the satellite target id must be one found in the OurSky database using the `/v1/satellite-targets` endpoint.
|
|
1837
|
+
* @export
|
|
1838
|
+
* @interface V1PutOrbitProviderTLERequest
|
|
1839
|
+
*/
|
|
1840
|
+
export interface V1PutOrbitProviderTLERequest {
|
|
1841
|
+
/**
|
|
1842
|
+
* Existing target id of an OurSky target that you are providing a TLE for. Leave null if one does not exist in the database.
|
|
1314
1843
|
* @type {string}
|
|
1315
1844
|
* @memberof V1PutOrbitProviderTLERequest
|
|
1316
1845
|
*/
|
|
@@ -1352,6 +1881,127 @@ export interface V1PutOrbitProviderTLERequest {
|
|
|
1352
1881
|
*/
|
|
1353
1882
|
'crossSection'?: number;
|
|
1354
1883
|
}
|
|
1884
|
+
/**
|
|
1885
|
+
* Parameters to create a RIC volume search to search for a target - 3-sigma values should be at most 10% of the target\'s perigee altitude
|
|
1886
|
+
* @export
|
|
1887
|
+
* @interface V1RicVolumeSearchRequest
|
|
1888
|
+
*/
|
|
1889
|
+
export interface V1RicVolumeSearchRequest {
|
|
1890
|
+
/**
|
|
1891
|
+
*
|
|
1892
|
+
* @type {string}
|
|
1893
|
+
* @memberof V1RicVolumeSearchRequest
|
|
1894
|
+
*/
|
|
1895
|
+
'targetId': string;
|
|
1896
|
+
/**
|
|
1897
|
+
* The radial 3-sigma uncertainty in meters
|
|
1898
|
+
* @type {number}
|
|
1899
|
+
* @memberof V1RicVolumeSearchRequest
|
|
1900
|
+
*/
|
|
1901
|
+
'radial3SigmaMeters': number;
|
|
1902
|
+
/**
|
|
1903
|
+
* The intrack 3-sigma uncertainty in meters
|
|
1904
|
+
* @type {number}
|
|
1905
|
+
* @memberof V1RicVolumeSearchRequest
|
|
1906
|
+
*/
|
|
1907
|
+
'intrack3SigmaMeters': number;
|
|
1908
|
+
/**
|
|
1909
|
+
* The crosstrack 3-sigma uncertainty in meters
|
|
1910
|
+
* @type {number}
|
|
1911
|
+
* @memberof V1RicVolumeSearchRequest
|
|
1912
|
+
*/
|
|
1913
|
+
'crosstrack3SigmaMeters': number;
|
|
1914
|
+
/**
|
|
1915
|
+
* The epoch of the RIC standard deviation- if none is provided the current time is used
|
|
1916
|
+
* @type {string}
|
|
1917
|
+
* @memberof V1RicVolumeSearchRequest
|
|
1918
|
+
*/
|
|
1919
|
+
'ricStdevEpoch'?: string;
|
|
1920
|
+
}
|
|
1921
|
+
/**
|
|
1922
|
+
*
|
|
1923
|
+
* @export
|
|
1924
|
+
* @interface V1SIPCoefficients
|
|
1925
|
+
*/
|
|
1926
|
+
export interface V1SIPCoefficients {
|
|
1927
|
+
/**
|
|
1928
|
+
* Order of the SIP transformation
|
|
1929
|
+
* @type {number}
|
|
1930
|
+
* @memberof V1SIPCoefficients
|
|
1931
|
+
*/
|
|
1932
|
+
'order': number;
|
|
1933
|
+
/**
|
|
1934
|
+
* Forward SIP coefficients matrix A
|
|
1935
|
+
* @type {Array<Array<number>>}
|
|
1936
|
+
* @memberof V1SIPCoefficients
|
|
1937
|
+
*/
|
|
1938
|
+
'A': Array<Array<number>>;
|
|
1939
|
+
/**
|
|
1940
|
+
* Forward SIP coefficients matrix B
|
|
1941
|
+
* @type {Array<Array<number>>}
|
|
1942
|
+
* @memberof V1SIPCoefficients
|
|
1943
|
+
*/
|
|
1944
|
+
'B': Array<Array<number>>;
|
|
1945
|
+
/**
|
|
1946
|
+
* Coordinate description matrix element (1,1) - maps pixel coordinates to sky coordinates in degrees, encapsulating scale, rotation and skew
|
|
1947
|
+
* @type {number}
|
|
1948
|
+
* @memberof V1SIPCoefficients
|
|
1949
|
+
*/
|
|
1950
|
+
'CD1_1': number;
|
|
1951
|
+
/**
|
|
1952
|
+
* Coordinate description matrix element (1,2) - maps pixel coordinates to sky coordinates in degrees, encapsulating scale, rotation and skew
|
|
1953
|
+
* @type {number}
|
|
1954
|
+
* @memberof V1SIPCoefficients
|
|
1955
|
+
*/
|
|
1956
|
+
'CD1_2': number;
|
|
1957
|
+
/**
|
|
1958
|
+
* Coordinate description matrix element (2,1) - maps pixel coordinates to sky coordinates in degrees, encapsulating scale, rotation and skew
|
|
1959
|
+
* @type {number}
|
|
1960
|
+
* @memberof V1SIPCoefficients
|
|
1961
|
+
*/
|
|
1962
|
+
'CD2_1': number;
|
|
1963
|
+
/**
|
|
1964
|
+
* Coordinate description matrix element (2,2) - maps pixel coordinates to sky coordinates in degrees, encapsulating scale, rotation and skew
|
|
1965
|
+
* @type {number}
|
|
1966
|
+
* @memberof V1SIPCoefficients
|
|
1967
|
+
*/
|
|
1968
|
+
'CD2_2': number;
|
|
1969
|
+
/**
|
|
1970
|
+
* X coordinate of the reference pixel
|
|
1971
|
+
* @type {number}
|
|
1972
|
+
* @memberof V1SIPCoefficients
|
|
1973
|
+
*/
|
|
1974
|
+
'coordinateReferencePixelX': number;
|
|
1975
|
+
/**
|
|
1976
|
+
* Y coordinate of the reference pixel
|
|
1977
|
+
* @type {number}
|
|
1978
|
+
* @memberof V1SIPCoefficients
|
|
1979
|
+
*/
|
|
1980
|
+
'coordinateReferencePixelY': number;
|
|
1981
|
+
/**
|
|
1982
|
+
* Right ascension of the reference coordinate in degrees
|
|
1983
|
+
* @type {number}
|
|
1984
|
+
* @memberof V1SIPCoefficients
|
|
1985
|
+
*/
|
|
1986
|
+
'coordinateReferenceRADegrees': number;
|
|
1987
|
+
/**
|
|
1988
|
+
* Declination of the reference coordinate in degrees
|
|
1989
|
+
* @type {number}
|
|
1990
|
+
* @memberof V1SIPCoefficients
|
|
1991
|
+
*/
|
|
1992
|
+
'coordinateReferenceDecDegrees': number;
|
|
1993
|
+
}
|
|
1994
|
+
/**
|
|
1995
|
+
*
|
|
1996
|
+
* @export
|
|
1997
|
+
* @enum {string}
|
|
1998
|
+
*/
|
|
1999
|
+
export declare const V1SatelliteCalibrationFamily: {
|
|
2000
|
+
readonly GPS: "GPS";
|
|
2001
|
+
readonly ILRS: "ILRS";
|
|
2002
|
+
readonly SWARM: "SWARM";
|
|
2003
|
+
};
|
|
2004
|
+
export type V1SatelliteCalibrationFamily = typeof V1SatelliteCalibrationFamily[keyof typeof V1SatelliteCalibrationFamily];
|
|
1355
2005
|
/**
|
|
1356
2006
|
* SatellitePotential
|
|
1357
2007
|
* @export
|
|
@@ -1581,6 +2231,24 @@ export interface V1SatelliteTarget {
|
|
|
1581
2231
|
* @memberof V1SatelliteTarget
|
|
1582
2232
|
*/
|
|
1583
2233
|
'area'?: number;
|
|
2234
|
+
/**
|
|
2235
|
+
* Linked satellite target id on our system. See [POST /v1/satellite-target](#tag/satellite-targets/POST/v1/satellite-target)
|
|
2236
|
+
* @type {string}
|
|
2237
|
+
* @memberof V1SatelliteTarget
|
|
2238
|
+
*/
|
|
2239
|
+
'linkedSatelliteTargetId'?: string;
|
|
2240
|
+
/**
|
|
2241
|
+
*
|
|
2242
|
+
* @type {string}
|
|
2243
|
+
* @memberof V1SatelliteTarget
|
|
2244
|
+
*/
|
|
2245
|
+
'orbitSourceId'?: string;
|
|
2246
|
+
/**
|
|
2247
|
+
*
|
|
2248
|
+
* @type {string}
|
|
2249
|
+
* @memberof V1SatelliteTarget
|
|
2250
|
+
*/
|
|
2251
|
+
'orbitSourceProviderName'?: string;
|
|
1584
2252
|
}
|
|
1585
2253
|
/**
|
|
1586
2254
|
* Search Instruction
|
|
@@ -1650,6 +2318,90 @@ export interface V1SearchInstructionStep {
|
|
|
1650
2318
|
*/
|
|
1651
2319
|
'durationSeconds': number;
|
|
1652
2320
|
}
|
|
2321
|
+
/**
|
|
2322
|
+
* State vector representing a satellite\'s position and velocity in space.
|
|
2323
|
+
* @export
|
|
2324
|
+
* @interface V1StateVector
|
|
2325
|
+
*/
|
|
2326
|
+
export interface V1StateVector {
|
|
2327
|
+
/**
|
|
2328
|
+
* Unique identifier for the state vector.
|
|
2329
|
+
* @type {string}
|
|
2330
|
+
* @memberof V1StateVector
|
|
2331
|
+
*/
|
|
2332
|
+
'id': string;
|
|
2333
|
+
/**
|
|
2334
|
+
* Identifier of the satellite target this state vector belongs to.
|
|
2335
|
+
* @type {string}
|
|
2336
|
+
* @memberof V1StateVector
|
|
2337
|
+
*/
|
|
2338
|
+
'targetId': string;
|
|
2339
|
+
/**
|
|
2340
|
+
* Position in the X direction in meters.
|
|
2341
|
+
* @type {number}
|
|
2342
|
+
* @memberof V1StateVector
|
|
2343
|
+
*/
|
|
2344
|
+
'posX': number;
|
|
2345
|
+
/**
|
|
2346
|
+
* Position in the Y direction in meters.
|
|
2347
|
+
* @type {number}
|
|
2348
|
+
* @memberof V1StateVector
|
|
2349
|
+
*/
|
|
2350
|
+
'posY': number;
|
|
2351
|
+
/**
|
|
2352
|
+
* Position in the Z direction in meters.
|
|
2353
|
+
* @type {number}
|
|
2354
|
+
* @memberof V1StateVector
|
|
2355
|
+
*/
|
|
2356
|
+
'posZ': number;
|
|
2357
|
+
/**
|
|
2358
|
+
* Velocity in the X direction in meters per second.
|
|
2359
|
+
* @type {number}
|
|
2360
|
+
* @memberof V1StateVector
|
|
2361
|
+
*/
|
|
2362
|
+
'velX': number;
|
|
2363
|
+
/**
|
|
2364
|
+
* Velocity in the Y direction in meters per second.
|
|
2365
|
+
* @type {number}
|
|
2366
|
+
* @memberof V1StateVector
|
|
2367
|
+
*/
|
|
2368
|
+
'velY': number;
|
|
2369
|
+
/**
|
|
2370
|
+
* Velocity in the Z direction in meters per second.
|
|
2371
|
+
* @type {number}
|
|
2372
|
+
* @memberof V1StateVector
|
|
2373
|
+
*/
|
|
2374
|
+
'velZ': number;
|
|
2375
|
+
/**
|
|
2376
|
+
* UTC epoch of the state vector
|
|
2377
|
+
* @type {string}
|
|
2378
|
+
* @memberof V1StateVector
|
|
2379
|
+
*/
|
|
2380
|
+
'epoch': string;
|
|
2381
|
+
/**
|
|
2382
|
+
*
|
|
2383
|
+
* @type {string}
|
|
2384
|
+
* @memberof V1StateVector
|
|
2385
|
+
*/
|
|
2386
|
+
'referenceFrame': V1StateVectorReferenceFrameEnum;
|
|
2387
|
+
/**
|
|
2388
|
+
* Drag coefficient of the satellite- normalized to a 1m^2 cross-sectional area and a 1kg mass.
|
|
2389
|
+
* @type {number}
|
|
2390
|
+
* @memberof V1StateVector
|
|
2391
|
+
*/
|
|
2392
|
+
'dragCoefficient': number;
|
|
2393
|
+
/**
|
|
2394
|
+
* Solar radiation pressure coefficient of the satellite- normalized to a 1m^2 cross-sectional area and a 1kg mass.
|
|
2395
|
+
* @type {number}
|
|
2396
|
+
* @memberof V1StateVector
|
|
2397
|
+
*/
|
|
2398
|
+
'srpCoefficient': number;
|
|
2399
|
+
}
|
|
2400
|
+
export declare const V1StateVectorReferenceFrameEnum: {
|
|
2401
|
+
readonly ECI_J2000: "ECI_J2000";
|
|
2402
|
+
readonly ECEF: "ECEF";
|
|
2403
|
+
};
|
|
2404
|
+
export type V1StateVectorReferenceFrameEnum = typeof V1StateVectorReferenceFrameEnum[keyof typeof V1StateVectorReferenceFrameEnum];
|
|
1653
2405
|
/**
|
|
1654
2406
|
*
|
|
1655
2407
|
* @export
|
|
@@ -1679,136 +2431,403 @@ export interface V1SurveyInstruction {
|
|
|
1679
2431
|
* @type {string}
|
|
1680
2432
|
* @memberof V1SurveyInstruction
|
|
1681
2433
|
*/
|
|
1682
|
-
'firstStepAt'?: string;
|
|
2434
|
+
'firstStepAt'?: string;
|
|
2435
|
+
/**
|
|
2436
|
+
* Each step indicates a sidereal observation attempt at a given (Ra, Dec) or local az/el. If az/el is used, a node ID must also be provided.
|
|
2437
|
+
* @type {Array<V1SurveyInstructionStep>}
|
|
2438
|
+
* @memberof V1SurveyInstruction
|
|
2439
|
+
*/
|
|
2440
|
+
'steps': Array<V1SurveyInstructionStep>;
|
|
2441
|
+
}
|
|
2442
|
+
/**
|
|
2443
|
+
* Survey Instruction Step. Each step is associated with one observation.
|
|
2444
|
+
* @export
|
|
2445
|
+
* @interface V1SurveyInstructionStep
|
|
2446
|
+
*/
|
|
2447
|
+
export interface V1SurveyInstructionStep {
|
|
2448
|
+
/**
|
|
2449
|
+
*
|
|
2450
|
+
* @type {number}
|
|
2451
|
+
* @memberof V1SurveyInstructionStep
|
|
2452
|
+
*/
|
|
2453
|
+
'ra'?: number;
|
|
2454
|
+
/**
|
|
2455
|
+
*
|
|
2456
|
+
* @type {number}
|
|
2457
|
+
* @memberof V1SurveyInstructionStep
|
|
2458
|
+
*/
|
|
2459
|
+
'dec'?: number;
|
|
2460
|
+
/**
|
|
2461
|
+
*
|
|
2462
|
+
* @type {number}
|
|
2463
|
+
* @memberof V1SurveyInstructionStep
|
|
2464
|
+
*/
|
|
2465
|
+
'az'?: number;
|
|
2466
|
+
/**
|
|
2467
|
+
*
|
|
2468
|
+
* @type {number}
|
|
2469
|
+
* @memberof V1SurveyInstructionStep
|
|
2470
|
+
*/
|
|
2471
|
+
'el'?: number;
|
|
2472
|
+
/**
|
|
2473
|
+
*
|
|
2474
|
+
* @type {string}
|
|
2475
|
+
* @memberof V1SurveyInstructionStep
|
|
2476
|
+
*/
|
|
2477
|
+
'nodeId'?: string;
|
|
2478
|
+
/**
|
|
2479
|
+
*
|
|
2480
|
+
* @type {string}
|
|
2481
|
+
* @memberof V1SurveyInstructionStep
|
|
2482
|
+
*/
|
|
2483
|
+
'time'?: string;
|
|
2484
|
+
/**
|
|
2485
|
+
*
|
|
2486
|
+
* @type {number}
|
|
2487
|
+
* @memberof V1SurveyInstructionStep
|
|
2488
|
+
*/
|
|
2489
|
+
'durationSeconds': number;
|
|
2490
|
+
}
|
|
2491
|
+
/**
|
|
2492
|
+
* Target Correlation
|
|
2493
|
+
* @export
|
|
2494
|
+
* @interface V1TargetCorrelation
|
|
2495
|
+
*/
|
|
2496
|
+
export interface V1TargetCorrelation {
|
|
2497
|
+
/**
|
|
2498
|
+
*
|
|
2499
|
+
* @type {string}
|
|
2500
|
+
* @memberof V1TargetCorrelation
|
|
2501
|
+
*/
|
|
2502
|
+
'targetId': string;
|
|
2503
|
+
/**
|
|
2504
|
+
* The predicted (propagated) center of the targetId in Right Ascension in degrees
|
|
2505
|
+
* @type {number}
|
|
2506
|
+
* @memberof V1TargetCorrelation
|
|
2507
|
+
*/
|
|
2508
|
+
'ra': number;
|
|
2509
|
+
/**
|
|
2510
|
+
* The predicted (propagated) center of the streak in Declination in degrees
|
|
2511
|
+
* @type {number}
|
|
2512
|
+
* @memberof V1TargetCorrelation
|
|
2513
|
+
*/
|
|
2514
|
+
'dec': number;
|
|
2515
|
+
/**
|
|
2516
|
+
* The predicted (propagated) length of the target streak in degrees
|
|
2517
|
+
* @type {number}
|
|
2518
|
+
* @memberof V1TargetCorrelation
|
|
2519
|
+
*/
|
|
2520
|
+
'streakLength'?: number;
|
|
2521
|
+
/**
|
|
2522
|
+
* The distance between the predicted and actual center of the streak in degrees
|
|
2523
|
+
* @type {number}
|
|
2524
|
+
* @memberof V1TargetCorrelation
|
|
2525
|
+
*/
|
|
2526
|
+
'distanceFromStreak'?: number;
|
|
2527
|
+
/**
|
|
2528
|
+
* The angle between the predicted and actual angle-to-celestial-north for the streak in degrees
|
|
2529
|
+
* @type {number}
|
|
2530
|
+
* @memberof V1TargetCorrelation
|
|
2531
|
+
*/
|
|
2532
|
+
'angleFromStreak'?: number;
|
|
2533
|
+
}
|
|
2534
|
+
/**
|
|
2535
|
+
* TDM
|
|
2536
|
+
* @export
|
|
2537
|
+
* @interface V1Tdm
|
|
2538
|
+
*/
|
|
2539
|
+
export interface V1Tdm {
|
|
2540
|
+
/**
|
|
2541
|
+
*
|
|
2542
|
+
* @type {string}
|
|
2543
|
+
* @memberof V1Tdm
|
|
2544
|
+
*/
|
|
2545
|
+
'id': string;
|
|
2546
|
+
/**
|
|
2547
|
+
*
|
|
2548
|
+
* @type {string}
|
|
2549
|
+
* @memberof V1Tdm
|
|
2550
|
+
*/
|
|
2551
|
+
'targetId': string;
|
|
2552
|
+
/**
|
|
2553
|
+
*
|
|
2554
|
+
* @type {Array<string>}
|
|
2555
|
+
* @memberof V1Tdm
|
|
2556
|
+
*/
|
|
2557
|
+
'streaks': Array<string>;
|
|
2558
|
+
/**
|
|
2559
|
+
*
|
|
2560
|
+
* @type {string}
|
|
2561
|
+
* @memberof V1Tdm
|
|
2562
|
+
*/
|
|
2563
|
+
'assetUrl': string;
|
|
2564
|
+
/**
|
|
2565
|
+
*
|
|
2566
|
+
* @type {string}
|
|
2567
|
+
* @memberof V1Tdm
|
|
2568
|
+
*/
|
|
2569
|
+
'imageSetId': string;
|
|
2570
|
+
/**
|
|
2571
|
+
*
|
|
2572
|
+
* @type {Array<string>}
|
|
2573
|
+
* @memberof V1Tdm
|
|
2574
|
+
*/
|
|
2575
|
+
'imageUrls': Array<string>;
|
|
2576
|
+
/**
|
|
2577
|
+
*
|
|
2578
|
+
* @type {string}
|
|
2579
|
+
* @memberof V1Tdm
|
|
2580
|
+
*/
|
|
2581
|
+
'createdAt': string;
|
|
2582
|
+
/**
|
|
2583
|
+
*
|
|
2584
|
+
* @type {string}
|
|
2585
|
+
* @memberof V1Tdm
|
|
2586
|
+
*/
|
|
2587
|
+
'createdBy': string;
|
|
2588
|
+
}
|
|
2589
|
+
/**
|
|
2590
|
+
*
|
|
2591
|
+
* @export
|
|
2592
|
+
* @interface V1TimeTaggedRaDec
|
|
2593
|
+
*/
|
|
2594
|
+
export interface V1TimeTaggedRaDec {
|
|
2595
|
+
/**
|
|
2596
|
+
*
|
|
2597
|
+
* @type {number}
|
|
2598
|
+
* @memberof V1TimeTaggedRaDec
|
|
2599
|
+
*/
|
|
2600
|
+
'raRadians': number;
|
|
2601
|
+
/**
|
|
2602
|
+
*
|
|
2603
|
+
* @type {number}
|
|
2604
|
+
* @memberof V1TimeTaggedRaDec
|
|
2605
|
+
*/
|
|
2606
|
+
'decRadians': number;
|
|
2607
|
+
/**
|
|
2608
|
+
*
|
|
2609
|
+
* @type {number}
|
|
2610
|
+
* @memberof V1TimeTaggedRaDec
|
|
2611
|
+
*/
|
|
2612
|
+
'magnitude'?: number;
|
|
2613
|
+
/**
|
|
2614
|
+
*
|
|
2615
|
+
* @type {number}
|
|
2616
|
+
* @memberof V1TimeTaggedRaDec
|
|
2617
|
+
*/
|
|
2618
|
+
'solarPhaseAngleRadians'?: number;
|
|
2619
|
+
/**
|
|
2620
|
+
*
|
|
2621
|
+
* @type {string}
|
|
2622
|
+
* @memberof V1TimeTaggedRaDec
|
|
2623
|
+
*/
|
|
2624
|
+
'epoch': string;
|
|
2625
|
+
}
|
|
2626
|
+
/**
|
|
2627
|
+
*
|
|
2628
|
+
* @export
|
|
2629
|
+
* @interface V1Track
|
|
2630
|
+
*/
|
|
2631
|
+
export interface V1Track {
|
|
2632
|
+
/**
|
|
2633
|
+
*
|
|
2634
|
+
* @type {string}
|
|
2635
|
+
* @memberof V1Track
|
|
2636
|
+
*/
|
|
2637
|
+
'id': string;
|
|
2638
|
+
/**
|
|
2639
|
+
*
|
|
2640
|
+
* @type {Array<V1TimeTaggedRaDec>}
|
|
2641
|
+
* @memberof V1Track
|
|
2642
|
+
*/
|
|
2643
|
+
'observations': Array<V1TimeTaggedRaDec>;
|
|
2644
|
+
/**
|
|
2645
|
+
*
|
|
2646
|
+
* @type {V1ObserverLocation}
|
|
2647
|
+
* @memberof V1Track
|
|
2648
|
+
*/
|
|
2649
|
+
'observerLocation': V1ObserverLocation;
|
|
2650
|
+
}
|
|
2651
|
+
/**
|
|
2652
|
+
* Plate to catplate transform with 3rd-order distortion
|
|
2653
|
+
* @export
|
|
2654
|
+
* @interface V1Transformation
|
|
2655
|
+
*/
|
|
2656
|
+
export interface V1Transformation {
|
|
2657
|
+
/**
|
|
2658
|
+
* Affine transformation coefficient
|
|
2659
|
+
* @type {number}
|
|
2660
|
+
* @memberof V1Transformation
|
|
2661
|
+
*/
|
|
2662
|
+
'a': number;
|
|
2663
|
+
/**
|
|
2664
|
+
* Affine transformation coefficient
|
|
2665
|
+
* @type {number}
|
|
2666
|
+
* @memberof V1Transformation
|
|
2667
|
+
*/
|
|
2668
|
+
'b': number;
|
|
2669
|
+
/**
|
|
2670
|
+
* Affine transformation coefficient
|
|
2671
|
+
* @type {number}
|
|
2672
|
+
* @memberof V1Transformation
|
|
2673
|
+
*/
|
|
2674
|
+
'c': number;
|
|
2675
|
+
/**
|
|
2676
|
+
* Affine transformation coefficient
|
|
2677
|
+
* @type {number}
|
|
2678
|
+
* @memberof V1Transformation
|
|
2679
|
+
*/
|
|
2680
|
+
'd': number;
|
|
2681
|
+
/**
|
|
2682
|
+
* Horizontal offset for the affine transformation
|
|
2683
|
+
* @type {number}
|
|
2684
|
+
* @memberof V1Transformation
|
|
2685
|
+
*/
|
|
2686
|
+
'u0': number;
|
|
2687
|
+
/**
|
|
2688
|
+
* Vertical offset for the affine transformation
|
|
2689
|
+
* @type {number}
|
|
2690
|
+
* @memberof V1Transformation
|
|
2691
|
+
*/
|
|
2692
|
+
'v0': number;
|
|
2693
|
+
/**
|
|
2694
|
+
* Scale
|
|
2695
|
+
* @type {number}
|
|
2696
|
+
* @memberof V1Transformation
|
|
2697
|
+
*/
|
|
2698
|
+
'alpha'?: number;
|
|
1683
2699
|
/**
|
|
1684
|
-
*
|
|
1685
|
-
* @type {
|
|
1686
|
-
* @memberof
|
|
2700
|
+
* Stretch
|
|
2701
|
+
* @type {number}
|
|
2702
|
+
* @memberof V1Transformation
|
|
1687
2703
|
*/
|
|
1688
|
-
'
|
|
1689
|
-
}
|
|
1690
|
-
/**
|
|
1691
|
-
* Survey Instruction Step. Each step is associated with one observation.
|
|
1692
|
-
* @export
|
|
1693
|
-
* @interface V1SurveyInstructionStep
|
|
1694
|
-
*/
|
|
1695
|
-
export interface V1SurveyInstructionStep {
|
|
2704
|
+
'beta': number;
|
|
1696
2705
|
/**
|
|
1697
|
-
*
|
|
2706
|
+
* Rotation
|
|
1698
2707
|
* @type {number}
|
|
1699
|
-
* @memberof
|
|
2708
|
+
* @memberof V1Transformation
|
|
1700
2709
|
*/
|
|
1701
|
-
'
|
|
2710
|
+
'theta': number;
|
|
1702
2711
|
/**
|
|
1703
|
-
*
|
|
2712
|
+
* Skew
|
|
1704
2713
|
* @type {number}
|
|
1705
|
-
* @memberof
|
|
2714
|
+
* @memberof V1Transformation
|
|
1706
2715
|
*/
|
|
1707
|
-
'
|
|
2716
|
+
'gamma': number;
|
|
1708
2717
|
/**
|
|
1709
|
-
*
|
|
2718
|
+
* 3rd-order plate distortion, X-direction
|
|
1710
2719
|
* @type {number}
|
|
1711
|
-
* @memberof
|
|
2720
|
+
* @memberof V1Transformation
|
|
1712
2721
|
*/
|
|
1713
|
-
'
|
|
1714
|
-
}
|
|
1715
|
-
/**
|
|
1716
|
-
* Target Correlation
|
|
1717
|
-
* @export
|
|
1718
|
-
* @interface V1TargetCorrelation
|
|
1719
|
-
*/
|
|
1720
|
-
export interface V1TargetCorrelation {
|
|
2722
|
+
'epsX': number;
|
|
1721
2723
|
/**
|
|
1722
|
-
*
|
|
1723
|
-
* @type {
|
|
1724
|
-
* @memberof
|
|
2724
|
+
* 3rd-order plate distortion, Y-direction
|
|
2725
|
+
* @type {number}
|
|
2726
|
+
* @memberof V1Transformation
|
|
1725
2727
|
*/
|
|
1726
|
-
'
|
|
2728
|
+
'epsY': number;
|
|
1727
2729
|
/**
|
|
1728
|
-
* The
|
|
2730
|
+
* The reference RA and Dec, in radians, at U = 0, V = 0
|
|
1729
2731
|
* @type {number}
|
|
1730
|
-
* @memberof
|
|
2732
|
+
* @memberof V1Transformation
|
|
1731
2733
|
*/
|
|
1732
|
-
'
|
|
2734
|
+
'raCen': number;
|
|
1733
2735
|
/**
|
|
1734
|
-
* The
|
|
2736
|
+
* The reference RA and Dec, in radians, at U = 0, V = 0
|
|
1735
2737
|
* @type {number}
|
|
1736
|
-
* @memberof
|
|
2738
|
+
* @memberof V1Transformation
|
|
1737
2739
|
*/
|
|
1738
|
-
'
|
|
2740
|
+
'decCen': number;
|
|
1739
2741
|
/**
|
|
1740
|
-
* The
|
|
2742
|
+
* The number of plate pixels in the X and Y directions. The following coordinate transforms use normalized plate coordinates X/Norm, Y/Norm, where Norm is sqrt(Px^2 + Py^2)/2
|
|
1741
2743
|
* @type {number}
|
|
1742
|
-
* @memberof
|
|
2744
|
+
* @memberof V1Transformation
|
|
1743
2745
|
*/
|
|
1744
|
-
'
|
|
2746
|
+
'px': number;
|
|
1745
2747
|
/**
|
|
1746
|
-
* The
|
|
2748
|
+
* The number of plate pixels in the X and Y directions. The following coordinate transforms use normalized plate coordinates X/Norm, Y/Norm, where Norm is sqrt(Px^2 + Py^2)/2
|
|
1747
2749
|
* @type {number}
|
|
1748
|
-
* @memberof
|
|
2750
|
+
* @memberof V1Transformation
|
|
1749
2751
|
*/
|
|
1750
|
-
'
|
|
2752
|
+
'py': number;
|
|
1751
2753
|
/**
|
|
1752
|
-
* The
|
|
2754
|
+
* The U-coefficients of the full N-th order match, if available. UCoef(0..NumCoef)
|
|
2755
|
+
* @type {Array<number>}
|
|
2756
|
+
* @memberof V1Transformation
|
|
2757
|
+
*/
|
|
2758
|
+
'uCoef': Array<number>;
|
|
2759
|
+
/**
|
|
2760
|
+
* The V-coefficients of the full N-th order match, if available. VCoef(0..NumCoef)
|
|
2761
|
+
* @type {Array<number>}
|
|
2762
|
+
* @memberof V1Transformation
|
|
2763
|
+
*/
|
|
2764
|
+
'vCoef': Array<number>;
|
|
2765
|
+
/**
|
|
2766
|
+
* The X-coefficients of the full N-th order match, if available. XCoef(0..NumCoef)
|
|
2767
|
+
* @type {Array<number>}
|
|
2768
|
+
* @memberof V1Transformation
|
|
2769
|
+
*/
|
|
2770
|
+
'xCoef': Array<number>;
|
|
2771
|
+
/**
|
|
2772
|
+
* The Y-coefficients of the full N-th order match, if available. YCoef(0..NumCoef)
|
|
2773
|
+
* @type {Array<number>}
|
|
2774
|
+
* @memberof V1Transformation
|
|
2775
|
+
*/
|
|
2776
|
+
'yCoef': Array<number>;
|
|
2777
|
+
/**
|
|
2778
|
+
* The number of coefficients + 1. 0 if there is no high-order match
|
|
1753
2779
|
* @type {number}
|
|
1754
|
-
* @memberof
|
|
2780
|
+
* @memberof V1Transformation
|
|
1755
2781
|
*/
|
|
1756
|
-
'
|
|
1757
|
-
}
|
|
1758
|
-
/**
|
|
1759
|
-
* TDM
|
|
1760
|
-
* @export
|
|
1761
|
-
* @interface V1Tdm
|
|
1762
|
-
*/
|
|
1763
|
-
export interface V1Tdm {
|
|
2782
|
+
'numCoef': number;
|
|
1764
2783
|
/**
|
|
1765
|
-
*
|
|
1766
|
-
* @type {
|
|
1767
|
-
* @memberof
|
|
2784
|
+
* The RMS fit error, in radians, for the simple affine + third-order distortion transform
|
|
2785
|
+
* @type {number}
|
|
2786
|
+
* @memberof V1Transformation
|
|
1768
2787
|
*/
|
|
1769
|
-
'
|
|
2788
|
+
'fitErrorRadians': number;
|
|
1770
2789
|
/**
|
|
1771
|
-
*
|
|
1772
|
-
* @type {
|
|
1773
|
-
* @memberof
|
|
2790
|
+
* The RMS fit error, in pixels, for the simple affine + third-order distortion transform
|
|
2791
|
+
* @type {number}
|
|
2792
|
+
* @memberof V1Transformation
|
|
1774
2793
|
*/
|
|
1775
|
-
'
|
|
2794
|
+
'fitErrorPix': number;
|
|
1776
2795
|
/**
|
|
1777
|
-
*
|
|
1778
|
-
* @type {
|
|
1779
|
-
* @memberof
|
|
2796
|
+
* The RMS fit error, in radians, for the full third-order transform
|
|
2797
|
+
* @type {number}
|
|
2798
|
+
* @memberof V1Transformation
|
|
1780
2799
|
*/
|
|
1781
|
-
'
|
|
2800
|
+
'fitError3Radians': number;
|
|
1782
2801
|
/**
|
|
1783
|
-
*
|
|
1784
|
-
* @type {
|
|
1785
|
-
* @memberof
|
|
2802
|
+
* The RMS fit error, in pixels, for the full third-order transform
|
|
2803
|
+
* @type {number}
|
|
2804
|
+
* @memberof V1Transformation
|
|
1786
2805
|
*/
|
|
1787
|
-
'
|
|
2806
|
+
'fitError3Pix': number;
|
|
1788
2807
|
/**
|
|
1789
|
-
*
|
|
1790
|
-
* @type {
|
|
1791
|
-
* @memberof
|
|
2808
|
+
* The difference in scale values between the X and Y axes, used to test the match geometry
|
|
2809
|
+
* @type {number}
|
|
2810
|
+
* @memberof V1Transformation
|
|
1792
2811
|
*/
|
|
1793
|
-
'
|
|
2812
|
+
'stretch': number;
|
|
1794
2813
|
/**
|
|
1795
|
-
*
|
|
1796
|
-
* @type {
|
|
1797
|
-
* @memberof
|
|
2814
|
+
* The image skew, used to test the match geometry
|
|
2815
|
+
* @type {number}
|
|
2816
|
+
* @memberof V1Transformation
|
|
1798
2817
|
*/
|
|
1799
|
-
'
|
|
2818
|
+
'skew': number;
|
|
1800
2819
|
/**
|
|
1801
|
-
*
|
|
1802
|
-
* @type {
|
|
1803
|
-
* @memberof
|
|
2820
|
+
* The matched image scale, in pixels per radian
|
|
2821
|
+
* @type {number}
|
|
2822
|
+
* @memberof V1Transformation
|
|
1804
2823
|
*/
|
|
1805
|
-
'
|
|
2824
|
+
'scale': number;
|
|
1806
2825
|
/**
|
|
1807
|
-
*
|
|
1808
|
-
* @type {
|
|
1809
|
-
* @memberof
|
|
2826
|
+
* The image rotation, in degrees, agrees with PinPoint
|
|
2827
|
+
* @type {number}
|
|
2828
|
+
* @memberof V1Transformation
|
|
1810
2829
|
*/
|
|
1811
|
-
'
|
|
2830
|
+
'rotation': number;
|
|
1812
2831
|
}
|
|
1813
2832
|
/**
|
|
1814
2833
|
*
|
|
@@ -2014,6 +3033,43 @@ export interface V1WebhookLog {
|
|
|
2014
3033
|
*/
|
|
2015
3034
|
'log'?: string;
|
|
2016
3035
|
}
|
|
3036
|
+
/**
|
|
3037
|
+
* V2 Search- created by either RIC volumetric search or plane scan.
|
|
3038
|
+
* @export
|
|
3039
|
+
* @interface V2Search
|
|
3040
|
+
*/
|
|
3041
|
+
export interface V2Search {
|
|
3042
|
+
/**
|
|
3043
|
+
*
|
|
3044
|
+
* @type {string}
|
|
3045
|
+
* @memberof V2Search
|
|
3046
|
+
*/
|
|
3047
|
+
'searchId': string;
|
|
3048
|
+
/**
|
|
3049
|
+
*
|
|
3050
|
+
* @type {string}
|
|
3051
|
+
* @memberof V2Search
|
|
3052
|
+
*/
|
|
3053
|
+
'targetId': string;
|
|
3054
|
+
/**
|
|
3055
|
+
*
|
|
3056
|
+
* @type {string}
|
|
3057
|
+
* @memberof V2Search
|
|
3058
|
+
*/
|
|
3059
|
+
'completedAt'?: string | null;
|
|
3060
|
+
/**
|
|
3061
|
+
*
|
|
3062
|
+
* @type {SearchCompletedReason}
|
|
3063
|
+
* @memberof V2Search
|
|
3064
|
+
*/
|
|
3065
|
+
'completedReason'?: SearchCompletedReason;
|
|
3066
|
+
/**
|
|
3067
|
+
*
|
|
3068
|
+
* @type {Array<string>}
|
|
3069
|
+
* @memberof V2Search
|
|
3070
|
+
*/
|
|
3071
|
+
'observationSequenceResultIds': Array<string>;
|
|
3072
|
+
}
|
|
2017
3073
|
/**
|
|
2018
3074
|
*
|
|
2019
3075
|
* @export
|
|
@@ -2057,6 +3113,9 @@ export declare const WebhookEvent: {
|
|
|
2057
3113
|
readonly V1_EO_CALIBRATION_OBSERVATION_CREATED: "V1_EO_CALIBRATION_OBSERVATION_CREATED";
|
|
2058
3114
|
readonly V1_NODE_CALIBRATION_DATA_CREATED: "V1_NODE_CALIBRATION_DATA_CREATED";
|
|
2059
3115
|
readonly V1_NODE_UPDATED: "V1_NODE_UPDATED";
|
|
3116
|
+
readonly V1_EO_SKY_IMAGERY_CREATED: "V1_EO_SKY_IMAGERY_CREATED";
|
|
3117
|
+
readonly V2_SEARCH_COMPLETED: "V2_SEARCH_COMPLETED";
|
|
3118
|
+
readonly V1_UCT_CREATED: "V1_UCT_CREATED";
|
|
2060
3119
|
};
|
|
2061
3120
|
export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
2062
3121
|
/**
|
|
@@ -2064,6 +3123,21 @@ export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
|
2064
3123
|
* @export
|
|
2065
3124
|
*/
|
|
2066
3125
|
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
3126
|
+
/**
|
|
3127
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
3128
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
3129
|
+
* @param {string} [after] The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time.
|
|
3130
|
+
* @param {*} [options] Override http request option.
|
|
3131
|
+
* @throws {RequiredError}
|
|
3132
|
+
*/
|
|
3133
|
+
getUncorrelatedTracks: (after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3134
|
+
/**
|
|
3135
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
3136
|
+
* @param {V1BlackoutVolumeRequest} v1BlackoutVolumeRequest
|
|
3137
|
+
* @param {*} [options] Override http request option.
|
|
3138
|
+
* @throws {RequiredError}
|
|
3139
|
+
*/
|
|
3140
|
+
v1CreateBlackoutVolume: (v1BlackoutVolumeRequest: V1BlackoutVolumeRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2067
3141
|
/**
|
|
2068
3142
|
* Create an image set.
|
|
2069
3143
|
* @param {V1CreateImageSetRequest} v1CreateImageSetRequest
|
|
@@ -2079,7 +3153,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2079
3153
|
*/
|
|
2080
3154
|
v1CreateImageSetImage: (v1CreateImageSetImageRequest: V1CreateImageSetImageRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2081
3155
|
/**
|
|
2082
|
-
* 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](#
|
|
3156
|
+
* 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.
|
|
2083
3157
|
* @param {V1CreateOrganizationTargetRequest} v1CreateOrganizationTargetRequest
|
|
2084
3158
|
* @param {*} [options] Override http request option.
|
|
2085
3159
|
* @throws {RequiredError}
|
|
@@ -2093,9 +3167,10 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2093
3167
|
*/
|
|
2094
3168
|
v1CreateSatelliteTarget: (v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2095
3169
|
/**
|
|
2096
|
-
* 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.
|
|
3170
|
+
* 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.
|
|
2097
3171
|
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
2098
3172
|
* @param {*} [options] Override http request option.
|
|
3173
|
+
* @deprecated
|
|
2099
3174
|
* @throws {RequiredError}
|
|
2100
3175
|
*/
|
|
2101
3176
|
v1CreateSearchInstruction: (v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -2120,6 +3195,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2120
3195
|
* @throws {RequiredError}
|
|
2121
3196
|
*/
|
|
2122
3197
|
v1CreateWebhookTest: (v1CreateWebhookTestRequest: V1CreateWebhookTestRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3198
|
+
/**
|
|
3199
|
+
* Delete a blackout volume.
|
|
3200
|
+
* @param {string} id
|
|
3201
|
+
* @param {*} [options] Override http request option.
|
|
3202
|
+
* @throws {RequiredError}
|
|
3203
|
+
*/
|
|
3204
|
+
v1DeleteBlackoutVolume: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2123
3205
|
/**
|
|
2124
3206
|
* Delete an image set.
|
|
2125
3207
|
* @param {string} id
|
|
@@ -2162,6 +3244,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2162
3244
|
* @throws {RequiredError}
|
|
2163
3245
|
*/
|
|
2164
3246
|
v1DeleteWebhookConfiguration: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3247
|
+
/**
|
|
3248
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
3249
|
+
* @param {string} imageId
|
|
3250
|
+
* @param {*} [options] Override http request option.
|
|
3251
|
+
* @throws {RequiredError}
|
|
3252
|
+
*/
|
|
3253
|
+
v1GetImageMetadata: (imageId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2165
3254
|
/**
|
|
2166
3255
|
* Get an image set.
|
|
2167
3256
|
* @param {string} id
|
|
@@ -2196,6 +3285,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2196
3285
|
* @throws {RequiredError}
|
|
2197
3286
|
*/
|
|
2198
3287
|
v1GetNodeProperties: (nodeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3288
|
+
/**
|
|
3289
|
+
* Get recent satellite calibrations by node. Paginate using `before` and `limit` to retrieve previous calibrations
|
|
3290
|
+
* @param {string} nodeId
|
|
3291
|
+
* @param {number} [limit]
|
|
3292
|
+
* @param {string} [before]
|
|
3293
|
+
* @param {*} [options] Override http request option.
|
|
3294
|
+
* @throws {RequiredError}
|
|
3295
|
+
*/
|
|
3296
|
+
v1GetNodeSatelliteCalibrations: (nodeId: string, limit?: number, before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2199
3297
|
/**
|
|
2200
3298
|
* Get observation features.
|
|
2201
3299
|
* @param {string} imageId
|
|
@@ -2225,11 +3323,12 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2225
3323
|
* @param {string} [before]
|
|
2226
3324
|
* @param {string} [searchInstructionId]
|
|
2227
3325
|
* @param {string} [surveyInstructionId]
|
|
3326
|
+
* @param {string} [resolvedImageInstructionId]
|
|
2228
3327
|
* @param {string} [imageId]
|
|
2229
3328
|
* @param {*} [options] Override http request option.
|
|
2230
3329
|
* @throws {RequiredError}
|
|
2231
3330
|
*/
|
|
2232
|
-
v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, imageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3331
|
+
v1GetObservationStatuses: (targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, imageId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2233
3332
|
/**
|
|
2234
3333
|
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
2235
3334
|
* @param {string} until
|
|
@@ -2246,7 +3345,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2246
3345
|
*/
|
|
2247
3346
|
v1GetOrganizationTarget: (organizationTargetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2248
3347
|
/**
|
|
2249
|
-
* Get organization targets see the [create](#
|
|
3348
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
2250
3349
|
* @param {*} [options] Override http request option.
|
|
2251
3350
|
* @throws {RequiredError}
|
|
2252
3351
|
*/
|
|
@@ -2286,6 +3385,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2286
3385
|
* @throws {RequiredError}
|
|
2287
3386
|
*/
|
|
2288
3387
|
v1GetSearchInstructions: (before?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3388
|
+
/**
|
|
3389
|
+
* Get state vectors for a satellite.
|
|
3390
|
+
* @param {string} targetId
|
|
3391
|
+
* @param {string} [before]
|
|
3392
|
+
* @param {string} [after]
|
|
3393
|
+
* @param {*} [options] Override http request option.
|
|
3394
|
+
* @throws {RequiredError}
|
|
3395
|
+
*/
|
|
3396
|
+
v1GetStateVectors: (targetId: string, before?: string, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2289
3397
|
/**
|
|
2290
3398
|
* 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.
|
|
2291
3399
|
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
@@ -2358,12 +3466,70 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2358
3466
|
* @throws {RequiredError}
|
|
2359
3467
|
*/
|
|
2360
3468
|
v1UpdateWebhookConfiguration: (v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3469
|
+
/**
|
|
3470
|
+
* Create a plane scan to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
3471
|
+
* @param {V1PlaneScanRequest} v1PlaneScanRequest
|
|
3472
|
+
* @param {*} [options] Override http request option.
|
|
3473
|
+
* @throws {RequiredError}
|
|
3474
|
+
*/
|
|
3475
|
+
v2CreatePlaneScan: (v1PlaneScanRequest: V1PlaneScanRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3476
|
+
/**
|
|
3477
|
+
* Create a RIC volume search to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
3478
|
+
* @param {V1RicVolumeSearchRequest} v1RicVolumeSearchRequest
|
|
3479
|
+
* @param {*} [options] Override http request option.
|
|
3480
|
+
* @throws {RequiredError}
|
|
3481
|
+
*/
|
|
3482
|
+
v2CreateRicVolumeSearch: (v1RicVolumeSearchRequest: V1RicVolumeSearchRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3483
|
+
/**
|
|
3484
|
+
* Delete a plane scan.
|
|
3485
|
+
* @param {string} id
|
|
3486
|
+
* @param {*} [options] Override http request option.
|
|
3487
|
+
* @throws {RequiredError}
|
|
3488
|
+
*/
|
|
3489
|
+
v2DeletePlaneScan: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3490
|
+
/**
|
|
3491
|
+
* Delete a RIC volume search.
|
|
3492
|
+
* @param {string} id
|
|
3493
|
+
* @param {*} [options] Override http request option.
|
|
3494
|
+
* @throws {RequiredError}
|
|
3495
|
+
*/
|
|
3496
|
+
v2DeleteRicVolumeSearch: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3497
|
+
/**
|
|
3498
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
3499
|
+
* @param {string} searchId
|
|
3500
|
+
* @param {*} [options] Override http request option.
|
|
3501
|
+
* @throws {RequiredError}
|
|
3502
|
+
*/
|
|
3503
|
+
v2GetSearch: (searchId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3504
|
+
/**
|
|
3505
|
+
* Get a list of your organization\'s V2 searches by time range or status.
|
|
3506
|
+
* @param {string} [after] The timestamp after which to return results. Defaults to one day prior to the current time.
|
|
3507
|
+
* @param {V2GetSearchesStatusEnum} [status] The status of the searches to return. Defaults to all statuses.
|
|
3508
|
+
* @param {*} [options] Override http request option.
|
|
3509
|
+
* @throws {RequiredError}
|
|
3510
|
+
*/
|
|
3511
|
+
v2GetSearches: (after?: string, status?: V2GetSearchesStatusEnum, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2361
3512
|
};
|
|
2362
3513
|
/**
|
|
2363
3514
|
* DefaultApi - functional programming interface
|
|
2364
3515
|
* @export
|
|
2365
3516
|
*/
|
|
2366
3517
|
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
3518
|
+
/**
|
|
3519
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
3520
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
3521
|
+
* @param {string} [after] The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time.
|
|
3522
|
+
* @param {*} [options] Override http request option.
|
|
3523
|
+
* @throws {RequiredError}
|
|
3524
|
+
*/
|
|
3525
|
+
getUncorrelatedTracks(after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1Track>>>;
|
|
3526
|
+
/**
|
|
3527
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
3528
|
+
* @param {V1BlackoutVolumeRequest} v1BlackoutVolumeRequest
|
|
3529
|
+
* @param {*} [options] Override http request option.
|
|
3530
|
+
* @throws {RequiredError}
|
|
3531
|
+
*/
|
|
3532
|
+
v1CreateBlackoutVolume(v1BlackoutVolumeRequest: V1BlackoutVolumeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
2367
3533
|
/**
|
|
2368
3534
|
* Create an image set.
|
|
2369
3535
|
* @param {V1CreateImageSetRequest} v1CreateImageSetRequest
|
|
@@ -2379,7 +3545,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2379
3545
|
*/
|
|
2380
3546
|
v1CreateImageSetImage(v1CreateImageSetImageRequest: V1CreateImageSetImageRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1CreateImageSetImageResponse>>;
|
|
2381
3547
|
/**
|
|
2382
|
-
* 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](#
|
|
3548
|
+
* 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.
|
|
2383
3549
|
* @param {V1CreateOrganizationTargetRequest} v1CreateOrganizationTargetRequest
|
|
2384
3550
|
* @param {*} [options] Override http request option.
|
|
2385
3551
|
* @throws {RequiredError}
|
|
@@ -2393,9 +3559,10 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2393
3559
|
*/
|
|
2394
3560
|
v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
2395
3561
|
/**
|
|
2396
|
-
* 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.
|
|
3562
|
+
* 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.
|
|
2397
3563
|
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
2398
3564
|
* @param {*} [options] Override http request option.
|
|
3565
|
+
* @deprecated
|
|
2399
3566
|
* @throws {RequiredError}
|
|
2400
3567
|
*/
|
|
2401
3568
|
v1CreateSearchInstruction(v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
@@ -2420,6 +3587,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2420
3587
|
* @throws {RequiredError}
|
|
2421
3588
|
*/
|
|
2422
3589
|
v1CreateWebhookTest(v1CreateWebhookTestRequest: V1CreateWebhookTestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
3590
|
+
/**
|
|
3591
|
+
* Delete a blackout volume.
|
|
3592
|
+
* @param {string} id
|
|
3593
|
+
* @param {*} [options] Override http request option.
|
|
3594
|
+
* @throws {RequiredError}
|
|
3595
|
+
*/
|
|
3596
|
+
v1DeleteBlackoutVolume(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulDelete>>;
|
|
2423
3597
|
/**
|
|
2424
3598
|
* Delete an image set.
|
|
2425
3599
|
* @param {string} id
|
|
@@ -2462,6 +3636,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2462
3636
|
* @throws {RequiredError}
|
|
2463
3637
|
*/
|
|
2464
3638
|
v1DeleteWebhookConfiguration(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
3639
|
+
/**
|
|
3640
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
3641
|
+
* @param {string} imageId
|
|
3642
|
+
* @param {*} [options] Override http request option.
|
|
3643
|
+
* @throws {RequiredError}
|
|
3644
|
+
*/
|
|
3645
|
+
v1GetImageMetadata(imageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1ImageMetadata>>;
|
|
2465
3646
|
/**
|
|
2466
3647
|
* Get an image set.
|
|
2467
3648
|
* @param {string} id
|
|
@@ -2496,6 +3677,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2496
3677
|
* @throws {RequiredError}
|
|
2497
3678
|
*/
|
|
2498
3679
|
v1GetNodeProperties(nodeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1GroundStationParticipant>>;
|
|
3680
|
+
/**
|
|
3681
|
+
* Get recent satellite calibrations by node. Paginate using `before` and `limit` to retrieve previous calibrations
|
|
3682
|
+
* @param {string} nodeId
|
|
3683
|
+
* @param {number} [limit]
|
|
3684
|
+
* @param {string} [before]
|
|
3685
|
+
* @param {*} [options] Override http request option.
|
|
3686
|
+
* @throws {RequiredError}
|
|
3687
|
+
*/
|
|
3688
|
+
v1GetNodeSatelliteCalibrations(nodeId: string, limit?: number, before?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1NodeCalibrationResult>>>;
|
|
2499
3689
|
/**
|
|
2500
3690
|
* Get observation features.
|
|
2501
3691
|
* @param {string} imageId
|
|
@@ -2525,11 +3715,12 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2525
3715
|
* @param {string} [before]
|
|
2526
3716
|
* @param {string} [searchInstructionId]
|
|
2527
3717
|
* @param {string} [surveyInstructionId]
|
|
3718
|
+
* @param {string} [resolvedImageInstructionId]
|
|
2528
3719
|
* @param {string} [imageId]
|
|
2529
3720
|
* @param {*} [options] Override http request option.
|
|
2530
3721
|
* @throws {RequiredError}
|
|
2531
3722
|
*/
|
|
2532
|
-
v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, imageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
|
|
3723
|
+
v1GetObservationStatuses(targetId?: string, before?: string, searchInstructionId?: string, surveyInstructionId?: string, resolvedImageInstructionId?: string, imageId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1ObservationStatus>>>;
|
|
2533
3724
|
/**
|
|
2534
3725
|
* Get potential observation windows for all satellites of your organization across the network from now until the `until` datetime
|
|
2535
3726
|
* @param {string} until
|
|
@@ -2546,7 +3737,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2546
3737
|
*/
|
|
2547
3738
|
v1GetOrganizationTarget(organizationTargetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OrganizationTarget>>;
|
|
2548
3739
|
/**
|
|
2549
|
-
* Get organization targets see the [create](#
|
|
3740
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
2550
3741
|
* @param {*} [options] Override http request option.
|
|
2551
3742
|
* @throws {RequiredError}
|
|
2552
3743
|
*/
|
|
@@ -2586,6 +3777,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2586
3777
|
* @throws {RequiredError}
|
|
2587
3778
|
*/
|
|
2588
3779
|
v1GetSearchInstructions(before?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1SearchInstruction>>>;
|
|
3780
|
+
/**
|
|
3781
|
+
* Get state vectors for a satellite.
|
|
3782
|
+
* @param {string} targetId
|
|
3783
|
+
* @param {string} [before]
|
|
3784
|
+
* @param {string} [after]
|
|
3785
|
+
* @param {*} [options] Override http request option.
|
|
3786
|
+
* @throws {RequiredError}
|
|
3787
|
+
*/
|
|
3788
|
+
v1GetStateVectors(targetId: string, before?: string, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1StateVector>>>;
|
|
2589
3789
|
/**
|
|
2590
3790
|
* 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.
|
|
2591
3791
|
* @param {string} [before] The timestamp to get the next page of results. Defaults to the current time.
|
|
@@ -2624,46 +3824,104 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2624
3824
|
*/
|
|
2625
3825
|
v1GetWebhookLogs(webhookId: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1WebhookLog>>>;
|
|
2626
3826
|
/**
|
|
2627
|
-
* Create or update an orbit for a target via a two-line element set (TLE)
|
|
2628
|
-
* @param {V1PutOrbitProviderTLERequest} v1PutOrbitProviderTLERequest
|
|
3827
|
+
* Create or update an orbit for a target via a two-line element set (TLE)
|
|
3828
|
+
* @param {V1PutOrbitProviderTLERequest} v1PutOrbitProviderTLERequest
|
|
3829
|
+
* @param {*} [options] Override http request option.
|
|
3830
|
+
* @throws {RequiredError}
|
|
3831
|
+
*/
|
|
3832
|
+
v1PutOrbitProviderTLEOrbit(v1PutOrbitProviderTLERequest: V1PutOrbitProviderTLERequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
3833
|
+
/**
|
|
3834
|
+
* 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.
|
|
3835
|
+
* @param {V1UpdateEmailConfigurationRequest} v1UpdateEmailConfigurationRequest
|
|
3836
|
+
* @param {*} [options] Override http request option.
|
|
3837
|
+
* @throws {RequiredError}
|
|
3838
|
+
*/
|
|
3839
|
+
v1UpdateEmailConfiguration(v1UpdateEmailConfigurationRequest: V1UpdateEmailConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
3840
|
+
/**
|
|
3841
|
+
* 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.
|
|
3842
|
+
* @param {V1UpdateOrganizationTargetRequest} v1UpdateOrganizationTargetRequest
|
|
3843
|
+
* @param {*} [options] Override http request option.
|
|
3844
|
+
* @throws {RequiredError}
|
|
3845
|
+
*/
|
|
3846
|
+
v1UpdateOrganizationTarget(v1UpdateOrganizationTargetRequest: V1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OrganizationTarget>>;
|
|
3847
|
+
/**
|
|
3848
|
+
* Update a private satellite target.
|
|
3849
|
+
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
3850
|
+
* @param {*} [options] Override http request option.
|
|
3851
|
+
* @throws {RequiredError}
|
|
3852
|
+
*/
|
|
3853
|
+
v1UpdateSatelliteTarget(v1UpdateSatelliteTargetRequest: V1UpdateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
3854
|
+
/**
|
|
3855
|
+
* Update a webhook configuration.
|
|
3856
|
+
* @param {V1UpdateWebhookConfigurationRequest} v1UpdateWebhookConfigurationRequest
|
|
3857
|
+
* @param {*} [options] Override http request option.
|
|
3858
|
+
* @throws {RequiredError}
|
|
3859
|
+
*/
|
|
3860
|
+
v1UpdateWebhookConfiguration(v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
3861
|
+
/**
|
|
3862
|
+
* Create a plane scan to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
3863
|
+
* @param {V1PlaneScanRequest} v1PlaneScanRequest
|
|
3864
|
+
* @param {*} [options] Override http request option.
|
|
3865
|
+
* @throws {RequiredError}
|
|
3866
|
+
*/
|
|
3867
|
+
v2CreatePlaneScan(v1PlaneScanRequest: V1PlaneScanRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
3868
|
+
/**
|
|
3869
|
+
* Create a RIC volume search to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
3870
|
+
* @param {V1RicVolumeSearchRequest} v1RicVolumeSearchRequest
|
|
2629
3871
|
* @param {*} [options] Override http request option.
|
|
2630
3872
|
* @throws {RequiredError}
|
|
2631
3873
|
*/
|
|
2632
|
-
|
|
3874
|
+
v2CreateRicVolumeSearch(v1RicVolumeSearchRequest: V1RicVolumeSearchRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
2633
3875
|
/**
|
|
2634
|
-
*
|
|
2635
|
-
* @param {
|
|
3876
|
+
* Delete a plane scan.
|
|
3877
|
+
* @param {string} id
|
|
2636
3878
|
* @param {*} [options] Override http request option.
|
|
2637
3879
|
* @throws {RequiredError}
|
|
2638
3880
|
*/
|
|
2639
|
-
|
|
3881
|
+
v2DeletePlaneScan(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
2640
3882
|
/**
|
|
2641
|
-
*
|
|
2642
|
-
* @param {
|
|
3883
|
+
* Delete a RIC volume search.
|
|
3884
|
+
* @param {string} id
|
|
2643
3885
|
* @param {*} [options] Override http request option.
|
|
2644
3886
|
* @throws {RequiredError}
|
|
2645
3887
|
*/
|
|
2646
|
-
|
|
3888
|
+
v2DeleteRicVolumeSearch(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
2647
3889
|
/**
|
|
2648
|
-
*
|
|
2649
|
-
* @param {
|
|
3890
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
3891
|
+
* @param {string} searchId
|
|
2650
3892
|
* @param {*} [options] Override http request option.
|
|
2651
3893
|
* @throws {RequiredError}
|
|
2652
3894
|
*/
|
|
2653
|
-
|
|
3895
|
+
v2GetSearch(searchId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2Search>>;
|
|
2654
3896
|
/**
|
|
2655
|
-
*
|
|
2656
|
-
* @param {
|
|
3897
|
+
* Get a list of your organization\'s V2 searches by time range or status.
|
|
3898
|
+
* @param {string} [after] The timestamp after which to return results. Defaults to one day prior to the current time.
|
|
3899
|
+
* @param {V2GetSearchesStatusEnum} [status] The status of the searches to return. Defaults to all statuses.
|
|
2657
3900
|
* @param {*} [options] Override http request option.
|
|
2658
3901
|
* @throws {RequiredError}
|
|
2659
3902
|
*/
|
|
2660
|
-
|
|
3903
|
+
v2GetSearches(after?: string, status?: V2GetSearchesStatusEnum, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V2Search>>>;
|
|
2661
3904
|
};
|
|
2662
3905
|
/**
|
|
2663
3906
|
* DefaultApi - factory interface
|
|
2664
3907
|
* @export
|
|
2665
3908
|
*/
|
|
2666
3909
|
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3910
|
+
/**
|
|
3911
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
3912
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
3913
|
+
* @param {DefaultApiGetUncorrelatedTracksRequest} requestParameters Request parameters.
|
|
3914
|
+
* @param {*} [options] Override http request option.
|
|
3915
|
+
* @throws {RequiredError}
|
|
3916
|
+
*/
|
|
3917
|
+
getUncorrelatedTracks(requestParameters?: DefaultApiGetUncorrelatedTracksRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1Track>>;
|
|
3918
|
+
/**
|
|
3919
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
3920
|
+
* @param {DefaultApiV1CreateBlackoutVolumeRequest} requestParameters Request parameters.
|
|
3921
|
+
* @param {*} [options] Override http request option.
|
|
3922
|
+
* @throws {RequiredError}
|
|
3923
|
+
*/
|
|
3924
|
+
v1CreateBlackoutVolume(requestParameters: DefaultApiV1CreateBlackoutVolumeRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
2667
3925
|
/**
|
|
2668
3926
|
* Create an image set.
|
|
2669
3927
|
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
@@ -2679,7 +3937,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2679
3937
|
*/
|
|
2680
3938
|
v1CreateImageSetImage(requestParameters: DefaultApiV1CreateImageSetImageRequest, options?: AxiosRequestConfig): AxiosPromise<V1CreateImageSetImageResponse>;
|
|
2681
3939
|
/**
|
|
2682
|
-
* 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](#
|
|
3940
|
+
* 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.
|
|
2683
3941
|
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
2684
3942
|
* @param {*} [options] Override http request option.
|
|
2685
3943
|
* @throws {RequiredError}
|
|
@@ -2693,9 +3951,10 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2693
3951
|
*/
|
|
2694
3952
|
v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
2695
3953
|
/**
|
|
2696
|
-
* 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.
|
|
3954
|
+
* 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.
|
|
2697
3955
|
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
2698
3956
|
* @param {*} [options] Override http request option.
|
|
3957
|
+
* @deprecated
|
|
2699
3958
|
* @throws {RequiredError}
|
|
2700
3959
|
*/
|
|
2701
3960
|
v1CreateSearchInstruction(requestParameters: DefaultApiV1CreateSearchInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
@@ -2720,6 +3979,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2720
3979
|
* @throws {RequiredError}
|
|
2721
3980
|
*/
|
|
2722
3981
|
v1CreateWebhookTest(requestParameters: DefaultApiV1CreateWebhookTestRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
3982
|
+
/**
|
|
3983
|
+
* Delete a blackout volume.
|
|
3984
|
+
* @param {DefaultApiV1DeleteBlackoutVolumeRequest} requestParameters Request parameters.
|
|
3985
|
+
* @param {*} [options] Override http request option.
|
|
3986
|
+
* @throws {RequiredError}
|
|
3987
|
+
*/
|
|
3988
|
+
v1DeleteBlackoutVolume(requestParameters: DefaultApiV1DeleteBlackoutVolumeRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulDelete>;
|
|
2723
3989
|
/**
|
|
2724
3990
|
* Delete an image set.
|
|
2725
3991
|
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
@@ -2762,6 +4028,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2762
4028
|
* @throws {RequiredError}
|
|
2763
4029
|
*/
|
|
2764
4030
|
v1DeleteWebhookConfiguration(requestParameters: DefaultApiV1DeleteWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
4031
|
+
/**
|
|
4032
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
4033
|
+
* @param {DefaultApiV1GetImageMetadataRequest} requestParameters Request parameters.
|
|
4034
|
+
* @param {*} [options] Override http request option.
|
|
4035
|
+
* @throws {RequiredError}
|
|
4036
|
+
*/
|
|
4037
|
+
v1GetImageMetadata(requestParameters: DefaultApiV1GetImageMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<V1ImageMetadata>;
|
|
2765
4038
|
/**
|
|
2766
4039
|
* Get an image set.
|
|
2767
4040
|
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
@@ -2796,6 +4069,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2796
4069
|
* @throws {RequiredError}
|
|
2797
4070
|
*/
|
|
2798
4071
|
v1GetNodeProperties(requestParameters: DefaultApiV1GetNodePropertiesRequest, options?: AxiosRequestConfig): AxiosPromise<V1GroundStationParticipant>;
|
|
4072
|
+
/**
|
|
4073
|
+
* Get recent satellite calibrations by node. Paginate using `before` and `limit` to retrieve previous calibrations
|
|
4074
|
+
* @param {DefaultApiV1GetNodeSatelliteCalibrationsRequest} requestParameters Request parameters.
|
|
4075
|
+
* @param {*} [options] Override http request option.
|
|
4076
|
+
* @throws {RequiredError}
|
|
4077
|
+
*/
|
|
4078
|
+
v1GetNodeSatelliteCalibrations(requestParameters: DefaultApiV1GetNodeSatelliteCalibrationsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1NodeCalibrationResult>>;
|
|
2799
4079
|
/**
|
|
2800
4080
|
* Get observation features.
|
|
2801
4081
|
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
@@ -2839,7 +4119,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2839
4119
|
*/
|
|
2840
4120
|
v1GetOrganizationTarget(requestParameters: DefaultApiV1GetOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<V1OrganizationTarget>;
|
|
2841
4121
|
/**
|
|
2842
|
-
* Get organization targets see the [create](#
|
|
4122
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
2843
4123
|
* @param {*} [options] Override http request option.
|
|
2844
4124
|
* @throws {RequiredError}
|
|
2845
4125
|
*/
|
|
@@ -2872,6 +4152,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2872
4152
|
* @throws {RequiredError}
|
|
2873
4153
|
*/
|
|
2874
4154
|
v1GetSearchInstructions(requestParameters?: DefaultApiV1GetSearchInstructionsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1SearchInstruction>>;
|
|
4155
|
+
/**
|
|
4156
|
+
* Get state vectors for a satellite.
|
|
4157
|
+
* @param {DefaultApiV1GetStateVectorsRequest} requestParameters Request parameters.
|
|
4158
|
+
* @param {*} [options] Override http request option.
|
|
4159
|
+
* @throws {RequiredError}
|
|
4160
|
+
*/
|
|
4161
|
+
v1GetStateVectors(requestParameters: DefaultApiV1GetStateVectorsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1StateVector>>;
|
|
2875
4162
|
/**
|
|
2876
4163
|
* 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.
|
|
2877
4164
|
* @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
|
|
@@ -2941,7 +4228,75 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2941
4228
|
* @throws {RequiredError}
|
|
2942
4229
|
*/
|
|
2943
4230
|
v1UpdateWebhookConfiguration(requestParameters: DefaultApiV1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
4231
|
+
/**
|
|
4232
|
+
* Create a plane scan to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
4233
|
+
* @param {DefaultApiV2CreatePlaneScanRequest} requestParameters Request parameters.
|
|
4234
|
+
* @param {*} [options] Override http request option.
|
|
4235
|
+
* @throws {RequiredError}
|
|
4236
|
+
*/
|
|
4237
|
+
v2CreatePlaneScan(requestParameters: DefaultApiV2CreatePlaneScanRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
4238
|
+
/**
|
|
4239
|
+
* Create a RIC volume search to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
4240
|
+
* @param {DefaultApiV2CreateRicVolumeSearchRequest} requestParameters Request parameters.
|
|
4241
|
+
* @param {*} [options] Override http request option.
|
|
4242
|
+
* @throws {RequiredError}
|
|
4243
|
+
*/
|
|
4244
|
+
v2CreateRicVolumeSearch(requestParameters: DefaultApiV2CreateRicVolumeSearchRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
4245
|
+
/**
|
|
4246
|
+
* Delete a plane scan.
|
|
4247
|
+
* @param {DefaultApiV2DeletePlaneScanRequest} requestParameters Request parameters.
|
|
4248
|
+
* @param {*} [options] Override http request option.
|
|
4249
|
+
* @throws {RequiredError}
|
|
4250
|
+
*/
|
|
4251
|
+
v2DeletePlaneScan(requestParameters: DefaultApiV2DeletePlaneScanRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
4252
|
+
/**
|
|
4253
|
+
* Delete a RIC volume search.
|
|
4254
|
+
* @param {DefaultApiV2DeleteRicVolumeSearchRequest} requestParameters Request parameters.
|
|
4255
|
+
* @param {*} [options] Override http request option.
|
|
4256
|
+
* @throws {RequiredError}
|
|
4257
|
+
*/
|
|
4258
|
+
v2DeleteRicVolumeSearch(requestParameters: DefaultApiV2DeleteRicVolumeSearchRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
4259
|
+
/**
|
|
4260
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
4261
|
+
* @param {DefaultApiV2GetSearchRequest} requestParameters Request parameters.
|
|
4262
|
+
* @param {*} [options] Override http request option.
|
|
4263
|
+
* @throws {RequiredError}
|
|
4264
|
+
*/
|
|
4265
|
+
v2GetSearch(requestParameters: DefaultApiV2GetSearchRequest, options?: AxiosRequestConfig): AxiosPromise<V2Search>;
|
|
4266
|
+
/**
|
|
4267
|
+
* Get a list of your organization\'s V2 searches by time range or status.
|
|
4268
|
+
* @param {DefaultApiV2GetSearchesRequest} requestParameters Request parameters.
|
|
4269
|
+
* @param {*} [options] Override http request option.
|
|
4270
|
+
* @throws {RequiredError}
|
|
4271
|
+
*/
|
|
4272
|
+
v2GetSearches(requestParameters?: DefaultApiV2GetSearchesRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V2Search>>;
|
|
2944
4273
|
};
|
|
4274
|
+
/**
|
|
4275
|
+
* Request parameters for getUncorrelatedTracks operation in DefaultApi.
|
|
4276
|
+
* @export
|
|
4277
|
+
* @interface DefaultApiGetUncorrelatedTracksRequest
|
|
4278
|
+
*/
|
|
4279
|
+
export interface DefaultApiGetUncorrelatedTracksRequest {
|
|
4280
|
+
/**
|
|
4281
|
+
* The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time.
|
|
4282
|
+
* @type {string}
|
|
4283
|
+
* @memberof DefaultApiGetUncorrelatedTracks
|
|
4284
|
+
*/
|
|
4285
|
+
readonly after?: string;
|
|
4286
|
+
}
|
|
4287
|
+
/**
|
|
4288
|
+
* Request parameters for v1CreateBlackoutVolume operation in DefaultApi.
|
|
4289
|
+
* @export
|
|
4290
|
+
* @interface DefaultApiV1CreateBlackoutVolumeRequest
|
|
4291
|
+
*/
|
|
4292
|
+
export interface DefaultApiV1CreateBlackoutVolumeRequest {
|
|
4293
|
+
/**
|
|
4294
|
+
*
|
|
4295
|
+
* @type {V1BlackoutVolumeRequest}
|
|
4296
|
+
* @memberof DefaultApiV1CreateBlackoutVolume
|
|
4297
|
+
*/
|
|
4298
|
+
readonly v1BlackoutVolumeRequest: V1BlackoutVolumeRequest;
|
|
4299
|
+
}
|
|
2945
4300
|
/**
|
|
2946
4301
|
* Request parameters for v1CreateImageSet operation in DefaultApi.
|
|
2947
4302
|
* @export
|
|
@@ -3046,6 +4401,19 @@ export interface DefaultApiV1CreateWebhookTestRequest {
|
|
|
3046
4401
|
*/
|
|
3047
4402
|
readonly v1CreateWebhookTestRequest: V1CreateWebhookTestRequest;
|
|
3048
4403
|
}
|
|
4404
|
+
/**
|
|
4405
|
+
* Request parameters for v1DeleteBlackoutVolume operation in DefaultApi.
|
|
4406
|
+
* @export
|
|
4407
|
+
* @interface DefaultApiV1DeleteBlackoutVolumeRequest
|
|
4408
|
+
*/
|
|
4409
|
+
export interface DefaultApiV1DeleteBlackoutVolumeRequest {
|
|
4410
|
+
/**
|
|
4411
|
+
*
|
|
4412
|
+
* @type {string}
|
|
4413
|
+
* @memberof DefaultApiV1DeleteBlackoutVolume
|
|
4414
|
+
*/
|
|
4415
|
+
readonly id: string;
|
|
4416
|
+
}
|
|
3049
4417
|
/**
|
|
3050
4418
|
* Request parameters for v1DeleteImageSet operation in DefaultApi.
|
|
3051
4419
|
* @export
|
|
@@ -3124,6 +4492,19 @@ export interface DefaultApiV1DeleteWebhookConfigurationRequest {
|
|
|
3124
4492
|
*/
|
|
3125
4493
|
readonly id: string;
|
|
3126
4494
|
}
|
|
4495
|
+
/**
|
|
4496
|
+
* Request parameters for v1GetImageMetadata operation in DefaultApi.
|
|
4497
|
+
* @export
|
|
4498
|
+
* @interface DefaultApiV1GetImageMetadataRequest
|
|
4499
|
+
*/
|
|
4500
|
+
export interface DefaultApiV1GetImageMetadataRequest {
|
|
4501
|
+
/**
|
|
4502
|
+
*
|
|
4503
|
+
* @type {string}
|
|
4504
|
+
* @memberof DefaultApiV1GetImageMetadata
|
|
4505
|
+
*/
|
|
4506
|
+
readonly imageId: string;
|
|
4507
|
+
}
|
|
3127
4508
|
/**
|
|
3128
4509
|
* Request parameters for v1GetImageSet operation in DefaultApi.
|
|
3129
4510
|
* @export
|
|
@@ -3176,6 +4557,31 @@ export interface DefaultApiV1GetNodePropertiesRequest {
|
|
|
3176
4557
|
*/
|
|
3177
4558
|
readonly nodeId: string;
|
|
3178
4559
|
}
|
|
4560
|
+
/**
|
|
4561
|
+
* Request parameters for v1GetNodeSatelliteCalibrations operation in DefaultApi.
|
|
4562
|
+
* @export
|
|
4563
|
+
* @interface DefaultApiV1GetNodeSatelliteCalibrationsRequest
|
|
4564
|
+
*/
|
|
4565
|
+
export interface DefaultApiV1GetNodeSatelliteCalibrationsRequest {
|
|
4566
|
+
/**
|
|
4567
|
+
*
|
|
4568
|
+
* @type {string}
|
|
4569
|
+
* @memberof DefaultApiV1GetNodeSatelliteCalibrations
|
|
4570
|
+
*/
|
|
4571
|
+
readonly nodeId: string;
|
|
4572
|
+
/**
|
|
4573
|
+
*
|
|
4574
|
+
* @type {number}
|
|
4575
|
+
* @memberof DefaultApiV1GetNodeSatelliteCalibrations
|
|
4576
|
+
*/
|
|
4577
|
+
readonly limit?: number;
|
|
4578
|
+
/**
|
|
4579
|
+
*
|
|
4580
|
+
* @type {string}
|
|
4581
|
+
* @memberof DefaultApiV1GetNodeSatelliteCalibrations
|
|
4582
|
+
*/
|
|
4583
|
+
readonly before?: string;
|
|
4584
|
+
}
|
|
3179
4585
|
/**
|
|
3180
4586
|
* Request parameters for v1GetObservationFeatures operation in DefaultApi.
|
|
3181
4587
|
* @export
|
|
@@ -3257,6 +4663,12 @@ export interface DefaultApiV1GetObservationStatusesRequest {
|
|
|
3257
4663
|
* @memberof DefaultApiV1GetObservationStatuses
|
|
3258
4664
|
*/
|
|
3259
4665
|
readonly surveyInstructionId?: string;
|
|
4666
|
+
/**
|
|
4667
|
+
*
|
|
4668
|
+
* @type {string}
|
|
4669
|
+
* @memberof DefaultApiV1GetObservationStatuses
|
|
4670
|
+
*/
|
|
4671
|
+
readonly resolvedImageInstructionId?: string;
|
|
3260
4672
|
/**
|
|
3261
4673
|
*
|
|
3262
4674
|
* @type {string}
|
|
@@ -3390,6 +4802,31 @@ export interface DefaultApiV1GetSearchInstructionsRequest {
|
|
|
3390
4802
|
*/
|
|
3391
4803
|
readonly before?: string;
|
|
3392
4804
|
}
|
|
4805
|
+
/**
|
|
4806
|
+
* Request parameters for v1GetStateVectors operation in DefaultApi.
|
|
4807
|
+
* @export
|
|
4808
|
+
* @interface DefaultApiV1GetStateVectorsRequest
|
|
4809
|
+
*/
|
|
4810
|
+
export interface DefaultApiV1GetStateVectorsRequest {
|
|
4811
|
+
/**
|
|
4812
|
+
*
|
|
4813
|
+
* @type {string}
|
|
4814
|
+
* @memberof DefaultApiV1GetStateVectors
|
|
4815
|
+
*/
|
|
4816
|
+
readonly targetId: string;
|
|
4817
|
+
/**
|
|
4818
|
+
*
|
|
4819
|
+
* @type {string}
|
|
4820
|
+
* @memberof DefaultApiV1GetStateVectors
|
|
4821
|
+
*/
|
|
4822
|
+
readonly before?: string;
|
|
4823
|
+
/**
|
|
4824
|
+
*
|
|
4825
|
+
* @type {string}
|
|
4826
|
+
* @memberof DefaultApiV1GetStateVectors
|
|
4827
|
+
*/
|
|
4828
|
+
readonly after?: string;
|
|
4829
|
+
}
|
|
3393
4830
|
/**
|
|
3394
4831
|
* Request parameters for v1GetSurveyInstructions operation in DefaultApi.
|
|
3395
4832
|
* @export
|
|
@@ -3525,6 +4962,90 @@ export interface DefaultApiV1UpdateWebhookConfigurationRequest {
|
|
|
3525
4962
|
*/
|
|
3526
4963
|
readonly v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest;
|
|
3527
4964
|
}
|
|
4965
|
+
/**
|
|
4966
|
+
* Request parameters for v2CreatePlaneScan operation in DefaultApi.
|
|
4967
|
+
* @export
|
|
4968
|
+
* @interface DefaultApiV2CreatePlaneScanRequest
|
|
4969
|
+
*/
|
|
4970
|
+
export interface DefaultApiV2CreatePlaneScanRequest {
|
|
4971
|
+
/**
|
|
4972
|
+
*
|
|
4973
|
+
* @type {V1PlaneScanRequest}
|
|
4974
|
+
* @memberof DefaultApiV2CreatePlaneScan
|
|
4975
|
+
*/
|
|
4976
|
+
readonly v1PlaneScanRequest: V1PlaneScanRequest;
|
|
4977
|
+
}
|
|
4978
|
+
/**
|
|
4979
|
+
* Request parameters for v2CreateRicVolumeSearch operation in DefaultApi.
|
|
4980
|
+
* @export
|
|
4981
|
+
* @interface DefaultApiV2CreateRicVolumeSearchRequest
|
|
4982
|
+
*/
|
|
4983
|
+
export interface DefaultApiV2CreateRicVolumeSearchRequest {
|
|
4984
|
+
/**
|
|
4985
|
+
*
|
|
4986
|
+
* @type {V1RicVolumeSearchRequest}
|
|
4987
|
+
* @memberof DefaultApiV2CreateRicVolumeSearch
|
|
4988
|
+
*/
|
|
4989
|
+
readonly v1RicVolumeSearchRequest: V1RicVolumeSearchRequest;
|
|
4990
|
+
}
|
|
4991
|
+
/**
|
|
4992
|
+
* Request parameters for v2DeletePlaneScan operation in DefaultApi.
|
|
4993
|
+
* @export
|
|
4994
|
+
* @interface DefaultApiV2DeletePlaneScanRequest
|
|
4995
|
+
*/
|
|
4996
|
+
export interface DefaultApiV2DeletePlaneScanRequest {
|
|
4997
|
+
/**
|
|
4998
|
+
*
|
|
4999
|
+
* @type {string}
|
|
5000
|
+
* @memberof DefaultApiV2DeletePlaneScan
|
|
5001
|
+
*/
|
|
5002
|
+
readonly id: string;
|
|
5003
|
+
}
|
|
5004
|
+
/**
|
|
5005
|
+
* Request parameters for v2DeleteRicVolumeSearch operation in DefaultApi.
|
|
5006
|
+
* @export
|
|
5007
|
+
* @interface DefaultApiV2DeleteRicVolumeSearchRequest
|
|
5008
|
+
*/
|
|
5009
|
+
export interface DefaultApiV2DeleteRicVolumeSearchRequest {
|
|
5010
|
+
/**
|
|
5011
|
+
*
|
|
5012
|
+
* @type {string}
|
|
5013
|
+
* @memberof DefaultApiV2DeleteRicVolumeSearch
|
|
5014
|
+
*/
|
|
5015
|
+
readonly id: string;
|
|
5016
|
+
}
|
|
5017
|
+
/**
|
|
5018
|
+
* Request parameters for v2GetSearch operation in DefaultApi.
|
|
5019
|
+
* @export
|
|
5020
|
+
* @interface DefaultApiV2GetSearchRequest
|
|
5021
|
+
*/
|
|
5022
|
+
export interface DefaultApiV2GetSearchRequest {
|
|
5023
|
+
/**
|
|
5024
|
+
*
|
|
5025
|
+
* @type {string}
|
|
5026
|
+
* @memberof DefaultApiV2GetSearch
|
|
5027
|
+
*/
|
|
5028
|
+
readonly searchId: string;
|
|
5029
|
+
}
|
|
5030
|
+
/**
|
|
5031
|
+
* Request parameters for v2GetSearches operation in DefaultApi.
|
|
5032
|
+
* @export
|
|
5033
|
+
* @interface DefaultApiV2GetSearchesRequest
|
|
5034
|
+
*/
|
|
5035
|
+
export interface DefaultApiV2GetSearchesRequest {
|
|
5036
|
+
/**
|
|
5037
|
+
* The timestamp after which to return results. Defaults to one day prior to the current time.
|
|
5038
|
+
* @type {string}
|
|
5039
|
+
* @memberof DefaultApiV2GetSearches
|
|
5040
|
+
*/
|
|
5041
|
+
readonly after?: string;
|
|
5042
|
+
/**
|
|
5043
|
+
* The status of the searches to return. Defaults to all statuses.
|
|
5044
|
+
* @type {'COMPLETED' | 'IN_PROGRESS' | 'FAILED'}
|
|
5045
|
+
* @memberof DefaultApiV2GetSearches
|
|
5046
|
+
*/
|
|
5047
|
+
readonly status?: V2GetSearchesStatusEnum;
|
|
5048
|
+
}
|
|
3528
5049
|
/**
|
|
3529
5050
|
* DefaultApi - object-oriented interface
|
|
3530
5051
|
* @export
|
|
@@ -3532,6 +5053,23 @@ export interface DefaultApiV1UpdateWebhookConfigurationRequest {
|
|
|
3532
5053
|
* @extends {BaseAPI}
|
|
3533
5054
|
*/
|
|
3534
5055
|
export declare class DefaultApi extends BaseAPI {
|
|
5056
|
+
/**
|
|
5057
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
5058
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
5059
|
+
* @param {DefaultApiGetUncorrelatedTracksRequest} requestParameters Request parameters.
|
|
5060
|
+
* @param {*} [options] Override http request option.
|
|
5061
|
+
* @throws {RequiredError}
|
|
5062
|
+
* @memberof DefaultApi
|
|
5063
|
+
*/
|
|
5064
|
+
getUncorrelatedTracks(requestParameters?: DefaultApiGetUncorrelatedTracksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1Track[], any>>;
|
|
5065
|
+
/**
|
|
5066
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
5067
|
+
* @param {DefaultApiV1CreateBlackoutVolumeRequest} requestParameters Request parameters.
|
|
5068
|
+
* @param {*} [options] Override http request option.
|
|
5069
|
+
* @throws {RequiredError}
|
|
5070
|
+
* @memberof DefaultApi
|
|
5071
|
+
*/
|
|
5072
|
+
v1CreateBlackoutVolume(requestParameters: DefaultApiV1CreateBlackoutVolumeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
3535
5073
|
/**
|
|
3536
5074
|
* Create an image set.
|
|
3537
5075
|
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
@@ -3549,7 +5087,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3549
5087
|
*/
|
|
3550
5088
|
v1CreateImageSetImage(requestParameters: DefaultApiV1CreateImageSetImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1CreateImageSetImageResponse, any>>;
|
|
3551
5089
|
/**
|
|
3552
|
-
* 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](#
|
|
5090
|
+
* 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.
|
|
3553
5091
|
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
3554
5092
|
* @param {*} [options] Override http request option.
|
|
3555
5093
|
* @throws {RequiredError}
|
|
@@ -3565,9 +5103,10 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3565
5103
|
*/
|
|
3566
5104
|
v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
3567
5105
|
/**
|
|
3568
|
-
* 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.
|
|
5106
|
+
* 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.
|
|
3569
5107
|
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
3570
5108
|
* @param {*} [options] Override http request option.
|
|
5109
|
+
* @deprecated
|
|
3571
5110
|
* @throws {RequiredError}
|
|
3572
5111
|
* @memberof DefaultApi
|
|
3573
5112
|
*/
|
|
@@ -3596,6 +5135,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3596
5135
|
* @memberof DefaultApi
|
|
3597
5136
|
*/
|
|
3598
5137
|
v1CreateWebhookTest(requestParameters: DefaultApiV1CreateWebhookTestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
5138
|
+
/**
|
|
5139
|
+
* Delete a blackout volume.
|
|
5140
|
+
* @param {DefaultApiV1DeleteBlackoutVolumeRequest} requestParameters Request parameters.
|
|
5141
|
+
* @param {*} [options] Override http request option.
|
|
5142
|
+
* @throws {RequiredError}
|
|
5143
|
+
* @memberof DefaultApi
|
|
5144
|
+
*/
|
|
5145
|
+
v1DeleteBlackoutVolume(requestParameters: DefaultApiV1DeleteBlackoutVolumeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulDelete, any>>;
|
|
3599
5146
|
/**
|
|
3600
5147
|
* Delete an image set.
|
|
3601
5148
|
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
@@ -3644,6 +5191,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3644
5191
|
* @memberof DefaultApi
|
|
3645
5192
|
*/
|
|
3646
5193
|
v1DeleteWebhookConfiguration(requestParameters: DefaultApiV1DeleteWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
5194
|
+
/**
|
|
5195
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
5196
|
+
* @param {DefaultApiV1GetImageMetadataRequest} requestParameters Request parameters.
|
|
5197
|
+
* @param {*} [options] Override http request option.
|
|
5198
|
+
* @throws {RequiredError}
|
|
5199
|
+
* @memberof DefaultApi
|
|
5200
|
+
*/
|
|
5201
|
+
v1GetImageMetadata(requestParameters: DefaultApiV1GetImageMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ImageMetadata, any>>;
|
|
3647
5202
|
/**
|
|
3648
5203
|
* Get an image set.
|
|
3649
5204
|
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
@@ -3683,6 +5238,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3683
5238
|
* @memberof DefaultApi
|
|
3684
5239
|
*/
|
|
3685
5240
|
v1GetNodeProperties(requestParameters: DefaultApiV1GetNodePropertiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1GroundStationParticipant, any>>;
|
|
5241
|
+
/**
|
|
5242
|
+
* Get recent satellite calibrations by node. Paginate using `before` and `limit` to retrieve previous calibrations
|
|
5243
|
+
* @param {DefaultApiV1GetNodeSatelliteCalibrationsRequest} requestParameters Request parameters.
|
|
5244
|
+
* @param {*} [options] Override http request option.
|
|
5245
|
+
* @throws {RequiredError}
|
|
5246
|
+
* @memberof DefaultApi
|
|
5247
|
+
*/
|
|
5248
|
+
v1GetNodeSatelliteCalibrations(requestParameters: DefaultApiV1GetNodeSatelliteCalibrationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1NodeCalibrationResult[], any>>;
|
|
3686
5249
|
/**
|
|
3687
5250
|
* Get observation features.
|
|
3688
5251
|
* @param {DefaultApiV1GetObservationFeaturesRequest} requestParameters Request parameters.
|
|
@@ -3732,7 +5295,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3732
5295
|
*/
|
|
3733
5296
|
v1GetOrganizationTarget(requestParameters: DefaultApiV1GetOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OrganizationTarget, any>>;
|
|
3734
5297
|
/**
|
|
3735
|
-
* Get organization targets see the [create](#
|
|
5298
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
3736
5299
|
* @param {*} [options] Override http request option.
|
|
3737
5300
|
* @throws {RequiredError}
|
|
3738
5301
|
* @memberof DefaultApi
|
|
@@ -3770,6 +5333,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3770
5333
|
* @memberof DefaultApi
|
|
3771
5334
|
*/
|
|
3772
5335
|
v1GetSearchInstructions(requestParameters?: DefaultApiV1GetSearchInstructionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1SearchInstruction[], any>>;
|
|
5336
|
+
/**
|
|
5337
|
+
* Get state vectors for a satellite.
|
|
5338
|
+
* @param {DefaultApiV1GetStateVectorsRequest} requestParameters Request parameters.
|
|
5339
|
+
* @param {*} [options] Override http request option.
|
|
5340
|
+
* @throws {RequiredError}
|
|
5341
|
+
* @memberof DefaultApi
|
|
5342
|
+
*/
|
|
5343
|
+
v1GetStateVectors(requestParameters: DefaultApiV1GetStateVectorsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1StateVector[], any>>;
|
|
3773
5344
|
/**
|
|
3774
5345
|
* 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.
|
|
3775
5346
|
* @param {DefaultApiV1GetSurveyInstructionsRequest} requestParameters Request parameters.
|
|
@@ -3849,4 +5420,61 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3849
5420
|
* @memberof DefaultApi
|
|
3850
5421
|
*/
|
|
3851
5422
|
v1UpdateWebhookConfiguration(requestParameters: DefaultApiV1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
5423
|
+
/**
|
|
5424
|
+
* Create a plane scan to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
5425
|
+
* @param {DefaultApiV2CreatePlaneScanRequest} requestParameters Request parameters.
|
|
5426
|
+
* @param {*} [options] Override http request option.
|
|
5427
|
+
* @throws {RequiredError}
|
|
5428
|
+
* @memberof DefaultApi
|
|
5429
|
+
*/
|
|
5430
|
+
v2CreatePlaneScan(requestParameters: DefaultApiV2CreatePlaneScanRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
5431
|
+
/**
|
|
5432
|
+
* Create a RIC volume search to search for a target. The system will execute the search and the resulting observations will be available in the observation status endpoint.
|
|
5433
|
+
* @param {DefaultApiV2CreateRicVolumeSearchRequest} requestParameters Request parameters.
|
|
5434
|
+
* @param {*} [options] Override http request option.
|
|
5435
|
+
* @throws {RequiredError}
|
|
5436
|
+
* @memberof DefaultApi
|
|
5437
|
+
*/
|
|
5438
|
+
v2CreateRicVolumeSearch(requestParameters: DefaultApiV2CreateRicVolumeSearchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
5439
|
+
/**
|
|
5440
|
+
* Delete a plane scan.
|
|
5441
|
+
* @param {DefaultApiV2DeletePlaneScanRequest} requestParameters Request parameters.
|
|
5442
|
+
* @param {*} [options] Override http request option.
|
|
5443
|
+
* @throws {RequiredError}
|
|
5444
|
+
* @memberof DefaultApi
|
|
5445
|
+
*/
|
|
5446
|
+
v2DeletePlaneScan(requestParameters: DefaultApiV2DeletePlaneScanRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
5447
|
+
/**
|
|
5448
|
+
* Delete a RIC volume search.
|
|
5449
|
+
* @param {DefaultApiV2DeleteRicVolumeSearchRequest} requestParameters Request parameters.
|
|
5450
|
+
* @param {*} [options] Override http request option.
|
|
5451
|
+
* @throws {RequiredError}
|
|
5452
|
+
* @memberof DefaultApi
|
|
5453
|
+
*/
|
|
5454
|
+
v2DeleteRicVolumeSearch(requestParameters: DefaultApiV2DeleteRicVolumeSearchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
5455
|
+
/**
|
|
5456
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
5457
|
+
* @param {DefaultApiV2GetSearchRequest} requestParameters Request parameters.
|
|
5458
|
+
* @param {*} [options] Override http request option.
|
|
5459
|
+
* @throws {RequiredError}
|
|
5460
|
+
* @memberof DefaultApi
|
|
5461
|
+
*/
|
|
5462
|
+
v2GetSearch(requestParameters: DefaultApiV2GetSearchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V2Search, any>>;
|
|
5463
|
+
/**
|
|
5464
|
+
* Get a list of your organization\'s V2 searches by time range or status.
|
|
5465
|
+
* @param {DefaultApiV2GetSearchesRequest} requestParameters Request parameters.
|
|
5466
|
+
* @param {*} [options] Override http request option.
|
|
5467
|
+
* @throws {RequiredError}
|
|
5468
|
+
* @memberof DefaultApi
|
|
5469
|
+
*/
|
|
5470
|
+
v2GetSearches(requestParameters?: DefaultApiV2GetSearchesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V2Search[], any>>;
|
|
3852
5471
|
}
|
|
5472
|
+
/**
|
|
5473
|
+
* @export
|
|
5474
|
+
*/
|
|
5475
|
+
export declare const V2GetSearchesStatusEnum: {
|
|
5476
|
+
readonly COMPLETED: "COMPLETED";
|
|
5477
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
5478
|
+
readonly FAILED: "FAILED";
|
|
5479
|
+
};
|
|
5480
|
+
export type V2GetSearchesStatusEnum = typeof V2GetSearchesStatusEnum[keyof typeof V2GetSearchesStatusEnum];
|