@ourskyai/sda-api 1.3.5602 → 1.3.6669
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 +1845 -191
- package/base.ts +2 -2
- package/common.ts +2 -2
- package/configuration.ts +2 -2
- package/dist/api.d.ts +1229 -26
- package/dist/api.js +705 -20
- 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 +1229 -26
- package/dist/esm/api.js +704 -19
- 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.6669
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -120,6 +120,10 @@ export interface FitsHeader {
|
|
|
120
120
|
* @enum {string}
|
|
121
121
|
*/
|
|
122
122
|
export declare const ImageSetType: {
|
|
123
|
+
readonly ASTRONOMICAL: "ASTRONOMICAL";
|
|
124
|
+
readonly EARTH_ORBITAL: "EARTH_ORBITAL";
|
|
125
|
+
readonly GNSS_CALIBRATION: "GNSS_CALIBRATION";
|
|
126
|
+
readonly SATELLITE_CALIBRATION: "SATELLITE_CALIBRATION";
|
|
123
127
|
readonly ALL_SKY: "ALL_SKY";
|
|
124
128
|
};
|
|
125
129
|
export type ImageSetType = typeof ImageSetType[keyof typeof ImageSetType];
|
|
@@ -299,13 +303,13 @@ export interface ObservationResult {
|
|
|
299
303
|
*/
|
|
300
304
|
'apparentMagnitude'?: number;
|
|
301
305
|
/**
|
|
302
|
-
* BETA: the solar phase angle in degrees at the time of observation
|
|
306
|
+
* BETA: the solar phase angle, defined as the angle between the target->observer and target->sun vectors, in degrees at the time of observation
|
|
303
307
|
* @type {number}
|
|
304
308
|
* @memberof ObservationResult
|
|
305
309
|
*/
|
|
306
310
|
'solarPhaseAngle'?: number;
|
|
307
311
|
/**
|
|
308
|
-
* BETA: the solar equatorial phase angle in degrees at the time of observation
|
|
312
|
+
* BETA: the solar equatorial phase angle, defined as the solar phase angle in the equatorial plane, in degrees at the time of observation
|
|
309
313
|
* @type {number}
|
|
310
314
|
* @memberof ObservationResult
|
|
311
315
|
*/
|
|
@@ -385,6 +389,18 @@ export declare const SatelliteTargetTrackingStatus: {
|
|
|
385
389
|
readonly DEORBITED: "DEORBITED";
|
|
386
390
|
};
|
|
387
391
|
export type SatelliteTargetTrackingStatus = typeof SatelliteTargetTrackingStatus[keyof typeof SatelliteTargetTrackingStatus];
|
|
392
|
+
/**
|
|
393
|
+
* The reason a search was completed.
|
|
394
|
+
* @export
|
|
395
|
+
* @enum {string}
|
|
396
|
+
*/
|
|
397
|
+
export declare const SearchCompletedReason: {
|
|
398
|
+
readonly ALL_HYPOTHESES_TESTED: "ALL_HYPOTHESES_TESTED";
|
|
399
|
+
readonly FOUND_TARGET: "FOUND_TARGET";
|
|
400
|
+
readonly CANCELLED: "CANCELLED";
|
|
401
|
+
readonly FAILED: "FAILED";
|
|
402
|
+
};
|
|
403
|
+
export type SearchCompletedReason = typeof SearchCompletedReason[keyof typeof SearchCompletedReason];
|
|
388
404
|
/**
|
|
389
405
|
*
|
|
390
406
|
* @export
|
|
@@ -432,6 +448,30 @@ export declare const TrackingType: {
|
|
|
432
448
|
readonly NONE: "NONE";
|
|
433
449
|
};
|
|
434
450
|
export type TrackingType = typeof TrackingType[keyof typeof TrackingType];
|
|
451
|
+
/**
|
|
452
|
+
* A designated volume of space that is not to be observed.
|
|
453
|
+
* @export
|
|
454
|
+
* @interface V1BlackoutVolumeRequest
|
|
455
|
+
*/
|
|
456
|
+
export interface V1BlackoutVolumeRequest {
|
|
457
|
+
/**
|
|
458
|
+
* The reference frame in which the volume is defined.
|
|
459
|
+
* @type {string}
|
|
460
|
+
* @memberof V1BlackoutVolumeRequest
|
|
461
|
+
*/
|
|
462
|
+
'reference_frame': V1BlackoutVolumeRequestReferenceFrameEnum;
|
|
463
|
+
/**
|
|
464
|
+
* The set of 8 points that define the volume, coordinates should be in the selected reference frame.
|
|
465
|
+
* @type {Array<V1Point>}
|
|
466
|
+
* @memberof V1BlackoutVolumeRequest
|
|
467
|
+
*/
|
|
468
|
+
'points': Array<V1Point>;
|
|
469
|
+
}
|
|
470
|
+
export declare const V1BlackoutVolumeRequestReferenceFrameEnum: {
|
|
471
|
+
readonly ECI_J2000: "ECI_J2000";
|
|
472
|
+
readonly ECEF: "ECEF";
|
|
473
|
+
};
|
|
474
|
+
export type V1BlackoutVolumeRequestReferenceFrameEnum = typeof V1BlackoutVolumeRequestReferenceFrameEnum[keyof typeof V1BlackoutVolumeRequestReferenceFrameEnum];
|
|
435
475
|
/**
|
|
436
476
|
*
|
|
437
477
|
* @export
|
|
@@ -444,6 +484,42 @@ export interface V1CreateImageSetImageRequest {
|
|
|
444
484
|
* @memberof V1CreateImageSetImageRequest
|
|
445
485
|
*/
|
|
446
486
|
'imageSetId': string;
|
|
487
|
+
/**
|
|
488
|
+
*
|
|
489
|
+
* @type {V1ImageFileType}
|
|
490
|
+
* @memberof V1CreateImageSetImageRequest
|
|
491
|
+
*/
|
|
492
|
+
'imageFileType'?: V1ImageFileType;
|
|
493
|
+
/**
|
|
494
|
+
*
|
|
495
|
+
* @type {number}
|
|
496
|
+
* @memberof V1CreateImageSetImageRequest
|
|
497
|
+
*/
|
|
498
|
+
'binning'?: number;
|
|
499
|
+
/**
|
|
500
|
+
*
|
|
501
|
+
* @type {number}
|
|
502
|
+
* @memberof V1CreateImageSetImageRequest
|
|
503
|
+
*/
|
|
504
|
+
'exposureLength'?: number;
|
|
505
|
+
/**
|
|
506
|
+
*
|
|
507
|
+
* @type {string}
|
|
508
|
+
* @memberof V1CreateImageSetImageRequest
|
|
509
|
+
*/
|
|
510
|
+
'imageSha'?: string;
|
|
511
|
+
/**
|
|
512
|
+
*
|
|
513
|
+
* @type {number}
|
|
514
|
+
* @memberof V1CreateImageSetImageRequest
|
|
515
|
+
*/
|
|
516
|
+
'imageSizeMb'?: number;
|
|
517
|
+
/**
|
|
518
|
+
*
|
|
519
|
+
* @type {string}
|
|
520
|
+
* @memberof V1CreateImageSetImageRequest
|
|
521
|
+
*/
|
|
522
|
+
'capturedAt'?: string;
|
|
447
523
|
}
|
|
448
524
|
/**
|
|
449
525
|
*
|
|
@@ -767,6 +843,78 @@ export interface V1GroundStationParticipant {
|
|
|
767
843
|
*/
|
|
768
844
|
'focuserTravelDistanceMm'?: number;
|
|
769
845
|
}
|
|
846
|
+
/**
|
|
847
|
+
* HFR extracted star from the image
|
|
848
|
+
* @export
|
|
849
|
+
* @interface V1HFRStar
|
|
850
|
+
*/
|
|
851
|
+
export interface V1HFRStar {
|
|
852
|
+
/**
|
|
853
|
+
*
|
|
854
|
+
* @type {V1PixelCoordinates}
|
|
855
|
+
* @memberof V1HFRStar
|
|
856
|
+
*/
|
|
857
|
+
'coordinates'?: V1PixelCoordinates;
|
|
858
|
+
/**
|
|
859
|
+
*
|
|
860
|
+
* @type {number}
|
|
861
|
+
* @memberof V1HFRStar
|
|
862
|
+
*/
|
|
863
|
+
'hfr': number;
|
|
864
|
+
/**
|
|
865
|
+
*
|
|
866
|
+
* @type {number}
|
|
867
|
+
* @memberof V1HFRStar
|
|
868
|
+
*/
|
|
869
|
+
'flux': number;
|
|
870
|
+
}
|
|
871
|
+
/**
|
|
872
|
+
*
|
|
873
|
+
* @export
|
|
874
|
+
* @enum {string}
|
|
875
|
+
*/
|
|
876
|
+
export declare const V1ImageFileType: {
|
|
877
|
+
readonly FITS: "FITS";
|
|
878
|
+
readonly JPG: "JPG";
|
|
879
|
+
};
|
|
880
|
+
export type V1ImageFileType = typeof V1ImageFileType[keyof typeof V1ImageFileType];
|
|
881
|
+
/**
|
|
882
|
+
*
|
|
883
|
+
* @export
|
|
884
|
+
* @interface V1ImageMetadata
|
|
885
|
+
*/
|
|
886
|
+
export interface V1ImageMetadata {
|
|
887
|
+
/**
|
|
888
|
+
*
|
|
889
|
+
* @type {string}
|
|
890
|
+
* @memberof V1ImageMetadata
|
|
891
|
+
*/
|
|
892
|
+
'id': string;
|
|
893
|
+
/**
|
|
894
|
+
*
|
|
895
|
+
* @type {string}
|
|
896
|
+
* @memberof V1ImageMetadata
|
|
897
|
+
*/
|
|
898
|
+
'imageId': string;
|
|
899
|
+
/**
|
|
900
|
+
*
|
|
901
|
+
* @type {V1PlateSolveResult}
|
|
902
|
+
* @memberof V1ImageMetadata
|
|
903
|
+
*/
|
|
904
|
+
'plateSolveResult': V1PlateSolveResult;
|
|
905
|
+
/**
|
|
906
|
+
* Extracted star features from the image. Used as inputs to plate solving
|
|
907
|
+
* @type {Array<V1HFRStar>}
|
|
908
|
+
* @memberof V1ImageMetadata
|
|
909
|
+
*/
|
|
910
|
+
'inputStars'?: Array<V1HFRStar>;
|
|
911
|
+
/**
|
|
912
|
+
*
|
|
913
|
+
* @type {string}
|
|
914
|
+
* @memberof V1ImageMetadata
|
|
915
|
+
*/
|
|
916
|
+
'createdAt': string;
|
|
917
|
+
}
|
|
770
918
|
/**
|
|
771
919
|
* An image set represents a contiguous set of observations of the same target captured by the same node.
|
|
772
920
|
* @export
|
|
@@ -1010,13 +1158,25 @@ export interface V1ImageSetImage {
|
|
|
1010
1158
|
*/
|
|
1011
1159
|
export interface V1ObservationFeature {
|
|
1012
1160
|
/**
|
|
1013
|
-
*
|
|
1161
|
+
* EME2000 right ascension, corrected for stellar aberration [degrees]
|
|
1162
|
+
* @type {number}
|
|
1163
|
+
* @memberof V1ObservationFeature
|
|
1164
|
+
*/
|
|
1165
|
+
'correctedRa'?: number;
|
|
1166
|
+
/**
|
|
1167
|
+
* EME2000 declination, corrected for stellar aberration [degrees]
|
|
1168
|
+
* @type {number}
|
|
1169
|
+
* @memberof V1ObservationFeature
|
|
1170
|
+
*/
|
|
1171
|
+
'correctedDec'?: number;
|
|
1172
|
+
/**
|
|
1173
|
+
* the right ascension in degrees in EME2000 frame, not corrected for stellar aberration
|
|
1014
1174
|
* @type {number}
|
|
1015
1175
|
* @memberof V1ObservationFeature
|
|
1016
1176
|
*/
|
|
1017
1177
|
'ra': number;
|
|
1018
1178
|
/**
|
|
1019
|
-
* the declination in degrees in EME2000 frame
|
|
1179
|
+
* the declination in degrees in EME2000 frame, not corrected for stellar aberration
|
|
1020
1180
|
* @type {number}
|
|
1021
1181
|
* @memberof V1ObservationFeature
|
|
1022
1182
|
*/
|
|
@@ -1241,6 +1401,31 @@ export interface V1ObservationStatus {
|
|
|
1241
1401
|
*/
|
|
1242
1402
|
'state': ObservationState;
|
|
1243
1403
|
}
|
|
1404
|
+
/**
|
|
1405
|
+
*
|
|
1406
|
+
* @export
|
|
1407
|
+
* @interface V1ObserverLocation
|
|
1408
|
+
*/
|
|
1409
|
+
export interface V1ObserverLocation {
|
|
1410
|
+
/**
|
|
1411
|
+
*
|
|
1412
|
+
* @type {number}
|
|
1413
|
+
* @memberof V1ObserverLocation
|
|
1414
|
+
*/
|
|
1415
|
+
'latitudeRadians': number;
|
|
1416
|
+
/**
|
|
1417
|
+
*
|
|
1418
|
+
* @type {number}
|
|
1419
|
+
* @memberof V1ObserverLocation
|
|
1420
|
+
*/
|
|
1421
|
+
'longitudeRadians': number;
|
|
1422
|
+
/**
|
|
1423
|
+
*
|
|
1424
|
+
* @type {number}
|
|
1425
|
+
* @memberof V1ObserverLocation
|
|
1426
|
+
*/
|
|
1427
|
+
'elevationMeters': number;
|
|
1428
|
+
}
|
|
1244
1429
|
/**
|
|
1245
1430
|
*
|
|
1246
1431
|
* @export
|
|
@@ -1253,6 +1438,12 @@ export interface V1OrganizationTarget {
|
|
|
1253
1438
|
* @memberof V1OrganizationTarget
|
|
1254
1439
|
*/
|
|
1255
1440
|
'id': string;
|
|
1441
|
+
/**
|
|
1442
|
+
*
|
|
1443
|
+
* @type {number}
|
|
1444
|
+
* @memberof V1OrganizationTarget
|
|
1445
|
+
*/
|
|
1446
|
+
'revisitRateMinutes'?: number;
|
|
1256
1447
|
/**
|
|
1257
1448
|
*
|
|
1258
1449
|
* @type {V1SatelliteTarget}
|
|
@@ -1272,6 +1463,191 @@ export interface V1OrganizationTarget {
|
|
|
1272
1463
|
*/
|
|
1273
1464
|
'createdAt': string;
|
|
1274
1465
|
}
|
|
1466
|
+
/**
|
|
1467
|
+
* An (x,y) pixel location in the image
|
|
1468
|
+
* @export
|
|
1469
|
+
* @interface V1PixelCoordinates
|
|
1470
|
+
*/
|
|
1471
|
+
export interface V1PixelCoordinates {
|
|
1472
|
+
/**
|
|
1473
|
+
*
|
|
1474
|
+
* @type {number}
|
|
1475
|
+
* @memberof V1PixelCoordinates
|
|
1476
|
+
*/
|
|
1477
|
+
'x': number;
|
|
1478
|
+
/**
|
|
1479
|
+
*
|
|
1480
|
+
* @type {number}
|
|
1481
|
+
* @memberof V1PixelCoordinates
|
|
1482
|
+
*/
|
|
1483
|
+
'y': number;
|
|
1484
|
+
}
|
|
1485
|
+
/**
|
|
1486
|
+
* Parameters to create a plane scan to search for a target
|
|
1487
|
+
* @export
|
|
1488
|
+
* @interface V1PlaneScanRequest
|
|
1489
|
+
*/
|
|
1490
|
+
export interface V1PlaneScanRequest {
|
|
1491
|
+
/**
|
|
1492
|
+
*
|
|
1493
|
+
* @type {string}
|
|
1494
|
+
* @memberof V1PlaneScanRequest
|
|
1495
|
+
*/
|
|
1496
|
+
'targetId': string;
|
|
1497
|
+
/**
|
|
1498
|
+
* The angle in degrees to search around the target\'s anomaly- centered on the target\'s prior position.
|
|
1499
|
+
* @type {number}
|
|
1500
|
+
* @memberof V1PlaneScanRequest
|
|
1501
|
+
*/
|
|
1502
|
+
'plusMinusAnomalyAngleDegrees': number;
|
|
1503
|
+
/**
|
|
1504
|
+
* The step size in degrees to search across the specified anomaly angle range
|
|
1505
|
+
* @type {number}
|
|
1506
|
+
* @memberof V1PlaneScanRequest
|
|
1507
|
+
*/
|
|
1508
|
+
'stepSizeDegrees': number;
|
|
1509
|
+
}
|
|
1510
|
+
/**
|
|
1511
|
+
* Extracted stars that matched during plate solving
|
|
1512
|
+
* @export
|
|
1513
|
+
* @interface V1Plate
|
|
1514
|
+
*/
|
|
1515
|
+
export interface V1Plate {
|
|
1516
|
+
/**
|
|
1517
|
+
* The x-centroid
|
|
1518
|
+
* @type {number}
|
|
1519
|
+
* @memberof V1Plate
|
|
1520
|
+
*/
|
|
1521
|
+
'xCentroid': number;
|
|
1522
|
+
/**
|
|
1523
|
+
* The y-centroid
|
|
1524
|
+
* @type {number}
|
|
1525
|
+
* @memberof V1Plate
|
|
1526
|
+
*/
|
|
1527
|
+
'yCentroid': number;
|
|
1528
|
+
/**
|
|
1529
|
+
* The UCAC4 or GaiaUD number if known
|
|
1530
|
+
* @type {number}
|
|
1531
|
+
* @memberof V1Plate
|
|
1532
|
+
*/
|
|
1533
|
+
'sequenceNumber': number;
|
|
1534
|
+
/**
|
|
1535
|
+
* Extracted magnitude
|
|
1536
|
+
* @type {number}
|
|
1537
|
+
* @memberof V1Plate
|
|
1538
|
+
*/
|
|
1539
|
+
'magnitude': number;
|
|
1540
|
+
/**
|
|
1541
|
+
* The star RA
|
|
1542
|
+
* @type {number}
|
|
1543
|
+
* @memberof V1Plate
|
|
1544
|
+
*/
|
|
1545
|
+
'raRad': number;
|
|
1546
|
+
/**
|
|
1547
|
+
* The star Dec
|
|
1548
|
+
* @type {number}
|
|
1549
|
+
* @memberof V1Plate
|
|
1550
|
+
*/
|
|
1551
|
+
'decRad': number;
|
|
1552
|
+
/**
|
|
1553
|
+
* The calculated offset from the catalog star, if known. 0 otherwise
|
|
1554
|
+
* @type {number}
|
|
1555
|
+
* @memberof V1Plate
|
|
1556
|
+
*/
|
|
1557
|
+
'catalogOffsetRad': number;
|
|
1558
|
+
}
|
|
1559
|
+
/**
|
|
1560
|
+
*
|
|
1561
|
+
* @export
|
|
1562
|
+
* @interface V1PlateSolveResult
|
|
1563
|
+
*/
|
|
1564
|
+
export interface V1PlateSolveResult {
|
|
1565
|
+
/**
|
|
1566
|
+
*
|
|
1567
|
+
* @type {Array<V1Plate>}
|
|
1568
|
+
* @memberof V1PlateSolveResult
|
|
1569
|
+
*/
|
|
1570
|
+
'plates': Array<V1Plate>;
|
|
1571
|
+
/**
|
|
1572
|
+
* The number of pixels in X directions
|
|
1573
|
+
* @type {number}
|
|
1574
|
+
* @memberof V1PlateSolveResult
|
|
1575
|
+
*/
|
|
1576
|
+
'pixelWidth': number;
|
|
1577
|
+
/**
|
|
1578
|
+
* The number of pixels in Y directions
|
|
1579
|
+
* @type {number}
|
|
1580
|
+
* @memberof V1PlateSolveResult
|
|
1581
|
+
*/
|
|
1582
|
+
'pixelHeight': number;
|
|
1583
|
+
/**
|
|
1584
|
+
* The number of matched stars
|
|
1585
|
+
* @type {number}
|
|
1586
|
+
* @memberof V1PlateSolveResult
|
|
1587
|
+
*/
|
|
1588
|
+
'numberMatchedStars': number;
|
|
1589
|
+
/**
|
|
1590
|
+
* In radians, the exact RA center when matched
|
|
1591
|
+
* @type {number}
|
|
1592
|
+
* @memberof V1PlateSolveResult
|
|
1593
|
+
*/
|
|
1594
|
+
'centerRightAscensionRadians': number;
|
|
1595
|
+
/**
|
|
1596
|
+
* In radians, the exact Dec center when matched
|
|
1597
|
+
* @type {number}
|
|
1598
|
+
* @memberof V1PlateSolveResult
|
|
1599
|
+
*/
|
|
1600
|
+
'centerDeclinationRadians': number;
|
|
1601
|
+
/**
|
|
1602
|
+
* The approximate plate size in X-direction, in radians
|
|
1603
|
+
* @type {number}
|
|
1604
|
+
* @memberof V1PlateSolveResult
|
|
1605
|
+
*/
|
|
1606
|
+
'xSizeRadians': number;
|
|
1607
|
+
/**
|
|
1608
|
+
* The approximate plate size in Y-direction, in radians
|
|
1609
|
+
* @type {number}
|
|
1610
|
+
* @memberof V1PlateSolveResult
|
|
1611
|
+
*/
|
|
1612
|
+
'ySizeRadians': number;
|
|
1613
|
+
/**
|
|
1614
|
+
* True if there is a valid plate match
|
|
1615
|
+
* @type {boolean}
|
|
1616
|
+
* @memberof V1PlateSolveResult
|
|
1617
|
+
*/
|
|
1618
|
+
'isMatched': boolean;
|
|
1619
|
+
/**
|
|
1620
|
+
*
|
|
1621
|
+
* @type {V1Transformation}
|
|
1622
|
+
* @memberof V1PlateSolveResult
|
|
1623
|
+
*/
|
|
1624
|
+
'transformation': V1Transformation;
|
|
1625
|
+
}
|
|
1626
|
+
/**
|
|
1627
|
+
* A point in 3D space.
|
|
1628
|
+
* @export
|
|
1629
|
+
* @interface V1Point
|
|
1630
|
+
*/
|
|
1631
|
+
export interface V1Point {
|
|
1632
|
+
/**
|
|
1633
|
+
* The x-coordinate of the point in meters.
|
|
1634
|
+
* @type {number}
|
|
1635
|
+
* @memberof V1Point
|
|
1636
|
+
*/
|
|
1637
|
+
'x': number;
|
|
1638
|
+
/**
|
|
1639
|
+
* The y-coordinate of the point in meters.
|
|
1640
|
+
* @type {number}
|
|
1641
|
+
* @memberof V1Point
|
|
1642
|
+
*/
|
|
1643
|
+
'y': number;
|
|
1644
|
+
/**
|
|
1645
|
+
* The z-coordinate of the point in meters.
|
|
1646
|
+
* @type {number}
|
|
1647
|
+
* @memberof V1Point
|
|
1648
|
+
*/
|
|
1649
|
+
'z': number;
|
|
1650
|
+
}
|
|
1275
1651
|
/**
|
|
1276
1652
|
*
|
|
1277
1653
|
* @export
|
|
@@ -1303,6 +1679,92 @@ export interface V1PredictedStreakLocation {
|
|
|
1303
1679
|
*/
|
|
1304
1680
|
'endY'?: number;
|
|
1305
1681
|
}
|
|
1682
|
+
/**
|
|
1683
|
+
* 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.
|
|
1684
|
+
* @export
|
|
1685
|
+
* @interface V1PutOrbitProviderTLERequest
|
|
1686
|
+
*/
|
|
1687
|
+
export interface V1PutOrbitProviderTLERequest {
|
|
1688
|
+
/**
|
|
1689
|
+
* Existing target id of an OurSky target that you are providing a TLE for. Leave null if one does not exist in the database.
|
|
1690
|
+
* @type {string}
|
|
1691
|
+
* @memberof V1PutOrbitProviderTLERequest
|
|
1692
|
+
*/
|
|
1693
|
+
'satellite_target_id'?: string;
|
|
1694
|
+
/**
|
|
1695
|
+
*
|
|
1696
|
+
* @type {string}
|
|
1697
|
+
* @memberof V1PutOrbitProviderTLERequest
|
|
1698
|
+
*/
|
|
1699
|
+
'tle_line_1': string;
|
|
1700
|
+
/**
|
|
1701
|
+
*
|
|
1702
|
+
* @type {string}
|
|
1703
|
+
* @memberof V1PutOrbitProviderTLERequest
|
|
1704
|
+
*/
|
|
1705
|
+
'tle_line_2': string;
|
|
1706
|
+
/**
|
|
1707
|
+
*
|
|
1708
|
+
* @type {string}
|
|
1709
|
+
* @memberof V1PutOrbitProviderTLERequest
|
|
1710
|
+
*/
|
|
1711
|
+
'tle_name'?: string;
|
|
1712
|
+
/**
|
|
1713
|
+
* mass in kilograms
|
|
1714
|
+
* @type {number}
|
|
1715
|
+
* @memberof V1PutOrbitProviderTLERequest
|
|
1716
|
+
*/
|
|
1717
|
+
'mass'?: number;
|
|
1718
|
+
/**
|
|
1719
|
+
* The Cr value used to calculate acceleration due to solar radiation pressure
|
|
1720
|
+
* @type {number}
|
|
1721
|
+
* @memberof V1PutOrbitProviderTLERequest
|
|
1722
|
+
*/
|
|
1723
|
+
'coefficientOfReflection'?: number;
|
|
1724
|
+
/**
|
|
1725
|
+
* cross sectional area in meters^2
|
|
1726
|
+
* @type {number}
|
|
1727
|
+
* @memberof V1PutOrbitProviderTLERequest
|
|
1728
|
+
*/
|
|
1729
|
+
'crossSection'?: number;
|
|
1730
|
+
}
|
|
1731
|
+
/**
|
|
1732
|
+
* 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
|
|
1733
|
+
* @export
|
|
1734
|
+
* @interface V1RicVolumeSearchRequest
|
|
1735
|
+
*/
|
|
1736
|
+
export interface V1RicVolumeSearchRequest {
|
|
1737
|
+
/**
|
|
1738
|
+
*
|
|
1739
|
+
* @type {string}
|
|
1740
|
+
* @memberof V1RicVolumeSearchRequest
|
|
1741
|
+
*/
|
|
1742
|
+
'targetId': string;
|
|
1743
|
+
/**
|
|
1744
|
+
* The radial 3-sigma uncertainty in meters
|
|
1745
|
+
* @type {number}
|
|
1746
|
+
* @memberof V1RicVolumeSearchRequest
|
|
1747
|
+
*/
|
|
1748
|
+
'radial3SigmaMeters': number;
|
|
1749
|
+
/**
|
|
1750
|
+
* The intrack 3-sigma uncertainty in meters
|
|
1751
|
+
* @type {number}
|
|
1752
|
+
* @memberof V1RicVolumeSearchRequest
|
|
1753
|
+
*/
|
|
1754
|
+
'intrack3SigmaMeters': number;
|
|
1755
|
+
/**
|
|
1756
|
+
* The crosstrack 3-sigma uncertainty in meters
|
|
1757
|
+
* @type {number}
|
|
1758
|
+
* @memberof V1RicVolumeSearchRequest
|
|
1759
|
+
*/
|
|
1760
|
+
'crosstrack3SigmaMeters': number;
|
|
1761
|
+
/**
|
|
1762
|
+
* The epoch of the RIC standard deviation- if none is provided the current time is used
|
|
1763
|
+
* @type {string}
|
|
1764
|
+
* @memberof V1RicVolumeSearchRequest
|
|
1765
|
+
*/
|
|
1766
|
+
'ricStdevEpoch'?: string;
|
|
1767
|
+
}
|
|
1306
1768
|
/**
|
|
1307
1769
|
* SatellitePotential
|
|
1308
1770
|
* @export
|
|
@@ -1532,6 +1994,12 @@ export interface V1SatelliteTarget {
|
|
|
1532
1994
|
* @memberof V1SatelliteTarget
|
|
1533
1995
|
*/
|
|
1534
1996
|
'area'?: number;
|
|
1997
|
+
/**
|
|
1998
|
+
* Linked satellite target id on our system. See [POST /v1/satellite-target](#tag/satellite-targets/POST/v1/satellite-target)
|
|
1999
|
+
* @type {string}
|
|
2000
|
+
* @memberof V1SatelliteTarget
|
|
2001
|
+
*/
|
|
2002
|
+
'linkedSatelliteTargetId'?: string;
|
|
1535
2003
|
}
|
|
1536
2004
|
/**
|
|
1537
2005
|
* Search Instruction
|
|
@@ -1632,7 +2100,7 @@ export interface V1SurveyInstruction {
|
|
|
1632
2100
|
*/
|
|
1633
2101
|
'firstStepAt'?: string;
|
|
1634
2102
|
/**
|
|
1635
|
-
* Each step indicates a sidereal observation attempt at a given (Ra, Dec)
|
|
2103
|
+
* 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.
|
|
1636
2104
|
* @type {Array<V1SurveyInstructionStep>}
|
|
1637
2105
|
* @memberof V1SurveyInstruction
|
|
1638
2106
|
*/
|
|
@@ -1649,13 +2117,37 @@ export interface V1SurveyInstructionStep {
|
|
|
1649
2117
|
* @type {number}
|
|
1650
2118
|
* @memberof V1SurveyInstructionStep
|
|
1651
2119
|
*/
|
|
1652
|
-
'ra'
|
|
2120
|
+
'ra'?: number;
|
|
1653
2121
|
/**
|
|
1654
2122
|
*
|
|
1655
2123
|
* @type {number}
|
|
1656
2124
|
* @memberof V1SurveyInstructionStep
|
|
1657
2125
|
*/
|
|
1658
|
-
'dec'
|
|
2126
|
+
'dec'?: number;
|
|
2127
|
+
/**
|
|
2128
|
+
*
|
|
2129
|
+
* @type {number}
|
|
2130
|
+
* @memberof V1SurveyInstructionStep
|
|
2131
|
+
*/
|
|
2132
|
+
'az'?: number;
|
|
2133
|
+
/**
|
|
2134
|
+
*
|
|
2135
|
+
* @type {number}
|
|
2136
|
+
* @memberof V1SurveyInstructionStep
|
|
2137
|
+
*/
|
|
2138
|
+
'el'?: number;
|
|
2139
|
+
/**
|
|
2140
|
+
*
|
|
2141
|
+
* @type {string}
|
|
2142
|
+
* @memberof V1SurveyInstructionStep
|
|
2143
|
+
*/
|
|
2144
|
+
'nodeId'?: string;
|
|
2145
|
+
/**
|
|
2146
|
+
*
|
|
2147
|
+
* @type {string}
|
|
2148
|
+
* @memberof V1SurveyInstructionStep
|
|
2149
|
+
*/
|
|
2150
|
+
'time'?: string;
|
|
1659
2151
|
/**
|
|
1660
2152
|
*
|
|
1661
2153
|
* @type {number}
|
|
@@ -1761,6 +2253,249 @@ export interface V1Tdm {
|
|
|
1761
2253
|
*/
|
|
1762
2254
|
'createdBy': string;
|
|
1763
2255
|
}
|
|
2256
|
+
/**
|
|
2257
|
+
*
|
|
2258
|
+
* @export
|
|
2259
|
+
* @interface V1TimeTaggedRaDec
|
|
2260
|
+
*/
|
|
2261
|
+
export interface V1TimeTaggedRaDec {
|
|
2262
|
+
/**
|
|
2263
|
+
*
|
|
2264
|
+
* @type {number}
|
|
2265
|
+
* @memberof V1TimeTaggedRaDec
|
|
2266
|
+
*/
|
|
2267
|
+
'raRadians': number;
|
|
2268
|
+
/**
|
|
2269
|
+
*
|
|
2270
|
+
* @type {number}
|
|
2271
|
+
* @memberof V1TimeTaggedRaDec
|
|
2272
|
+
*/
|
|
2273
|
+
'decRadians': number;
|
|
2274
|
+
/**
|
|
2275
|
+
*
|
|
2276
|
+
* @type {number}
|
|
2277
|
+
* @memberof V1TimeTaggedRaDec
|
|
2278
|
+
*/
|
|
2279
|
+
'magnitude'?: number;
|
|
2280
|
+
/**
|
|
2281
|
+
*
|
|
2282
|
+
* @type {number}
|
|
2283
|
+
* @memberof V1TimeTaggedRaDec
|
|
2284
|
+
*/
|
|
2285
|
+
'solarPhaseAngleRadians'?: number;
|
|
2286
|
+
/**
|
|
2287
|
+
*
|
|
2288
|
+
* @type {string}
|
|
2289
|
+
* @memberof V1TimeTaggedRaDec
|
|
2290
|
+
*/
|
|
2291
|
+
'epoch': string;
|
|
2292
|
+
}
|
|
2293
|
+
/**
|
|
2294
|
+
*
|
|
2295
|
+
* @export
|
|
2296
|
+
* @interface V1Track
|
|
2297
|
+
*/
|
|
2298
|
+
export interface V1Track {
|
|
2299
|
+
/**
|
|
2300
|
+
*
|
|
2301
|
+
* @type {string}
|
|
2302
|
+
* @memberof V1Track
|
|
2303
|
+
*/
|
|
2304
|
+
'id': string;
|
|
2305
|
+
/**
|
|
2306
|
+
*
|
|
2307
|
+
* @type {Array<V1TimeTaggedRaDec>}
|
|
2308
|
+
* @memberof V1Track
|
|
2309
|
+
*/
|
|
2310
|
+
'observations': Array<V1TimeTaggedRaDec>;
|
|
2311
|
+
/**
|
|
2312
|
+
*
|
|
2313
|
+
* @type {V1ObserverLocation}
|
|
2314
|
+
* @memberof V1Track
|
|
2315
|
+
*/
|
|
2316
|
+
'observerLocation': V1ObserverLocation;
|
|
2317
|
+
}
|
|
2318
|
+
/**
|
|
2319
|
+
* Plate to catplate transform with 3rd-order distortion
|
|
2320
|
+
* @export
|
|
2321
|
+
* @interface V1Transformation
|
|
2322
|
+
*/
|
|
2323
|
+
export interface V1Transformation {
|
|
2324
|
+
/**
|
|
2325
|
+
* Affine transformation coefficient
|
|
2326
|
+
* @type {number}
|
|
2327
|
+
* @memberof V1Transformation
|
|
2328
|
+
*/
|
|
2329
|
+
'a': number;
|
|
2330
|
+
/**
|
|
2331
|
+
* Affine transformation coefficient
|
|
2332
|
+
* @type {number}
|
|
2333
|
+
* @memberof V1Transformation
|
|
2334
|
+
*/
|
|
2335
|
+
'b': number;
|
|
2336
|
+
/**
|
|
2337
|
+
* Affine transformation coefficient
|
|
2338
|
+
* @type {number}
|
|
2339
|
+
* @memberof V1Transformation
|
|
2340
|
+
*/
|
|
2341
|
+
'c': number;
|
|
2342
|
+
/**
|
|
2343
|
+
* Affine transformation coefficient
|
|
2344
|
+
* @type {number}
|
|
2345
|
+
* @memberof V1Transformation
|
|
2346
|
+
*/
|
|
2347
|
+
'd': number;
|
|
2348
|
+
/**
|
|
2349
|
+
* Horizontal offset for the affine transformation
|
|
2350
|
+
* @type {number}
|
|
2351
|
+
* @memberof V1Transformation
|
|
2352
|
+
*/
|
|
2353
|
+
'u0': number;
|
|
2354
|
+
/**
|
|
2355
|
+
* Vertical offset for the affine transformation
|
|
2356
|
+
* @type {number}
|
|
2357
|
+
* @memberof V1Transformation
|
|
2358
|
+
*/
|
|
2359
|
+
'v0': number;
|
|
2360
|
+
/**
|
|
2361
|
+
* Scale
|
|
2362
|
+
* @type {number}
|
|
2363
|
+
* @memberof V1Transformation
|
|
2364
|
+
*/
|
|
2365
|
+
'alpha'?: number;
|
|
2366
|
+
/**
|
|
2367
|
+
* Stretch
|
|
2368
|
+
* @type {number}
|
|
2369
|
+
* @memberof V1Transformation
|
|
2370
|
+
*/
|
|
2371
|
+
'beta': number;
|
|
2372
|
+
/**
|
|
2373
|
+
* Rotation
|
|
2374
|
+
* @type {number}
|
|
2375
|
+
* @memberof V1Transformation
|
|
2376
|
+
*/
|
|
2377
|
+
'theta': number;
|
|
2378
|
+
/**
|
|
2379
|
+
* Skew
|
|
2380
|
+
* @type {number}
|
|
2381
|
+
* @memberof V1Transformation
|
|
2382
|
+
*/
|
|
2383
|
+
'gamma': number;
|
|
2384
|
+
/**
|
|
2385
|
+
* 3rd-order plate distortion, X-direction
|
|
2386
|
+
* @type {number}
|
|
2387
|
+
* @memberof V1Transformation
|
|
2388
|
+
*/
|
|
2389
|
+
'epsX': number;
|
|
2390
|
+
/**
|
|
2391
|
+
* 3rd-order plate distortion, Y-direction
|
|
2392
|
+
* @type {number}
|
|
2393
|
+
* @memberof V1Transformation
|
|
2394
|
+
*/
|
|
2395
|
+
'epsY': number;
|
|
2396
|
+
/**
|
|
2397
|
+
* The reference RA and Dec, in radians, at U = 0, V = 0
|
|
2398
|
+
* @type {number}
|
|
2399
|
+
* @memberof V1Transformation
|
|
2400
|
+
*/
|
|
2401
|
+
'raCen': number;
|
|
2402
|
+
/**
|
|
2403
|
+
* The reference RA and Dec, in radians, at U = 0, V = 0
|
|
2404
|
+
* @type {number}
|
|
2405
|
+
* @memberof V1Transformation
|
|
2406
|
+
*/
|
|
2407
|
+
'decCen': number;
|
|
2408
|
+
/**
|
|
2409
|
+
* 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
|
|
2410
|
+
* @type {number}
|
|
2411
|
+
* @memberof V1Transformation
|
|
2412
|
+
*/
|
|
2413
|
+
'px': number;
|
|
2414
|
+
/**
|
|
2415
|
+
* 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
|
|
2416
|
+
* @type {number}
|
|
2417
|
+
* @memberof V1Transformation
|
|
2418
|
+
*/
|
|
2419
|
+
'py': number;
|
|
2420
|
+
/**
|
|
2421
|
+
* The U-coefficients of the full N-th order match, if available. UCoef(0..NumCoef)
|
|
2422
|
+
* @type {Array<number>}
|
|
2423
|
+
* @memberof V1Transformation
|
|
2424
|
+
*/
|
|
2425
|
+
'uCoef': Array<number>;
|
|
2426
|
+
/**
|
|
2427
|
+
* The V-coefficients of the full N-th order match, if available. VCoef(0..NumCoef)
|
|
2428
|
+
* @type {Array<number>}
|
|
2429
|
+
* @memberof V1Transformation
|
|
2430
|
+
*/
|
|
2431
|
+
'vCoef': Array<number>;
|
|
2432
|
+
/**
|
|
2433
|
+
* The X-coefficients of the full N-th order match, if available. XCoef(0..NumCoef)
|
|
2434
|
+
* @type {Array<number>}
|
|
2435
|
+
* @memberof V1Transformation
|
|
2436
|
+
*/
|
|
2437
|
+
'xCoef': Array<number>;
|
|
2438
|
+
/**
|
|
2439
|
+
* The Y-coefficients of the full N-th order match, if available. YCoef(0..NumCoef)
|
|
2440
|
+
* @type {Array<number>}
|
|
2441
|
+
* @memberof V1Transformation
|
|
2442
|
+
*/
|
|
2443
|
+
'yCoef': Array<number>;
|
|
2444
|
+
/**
|
|
2445
|
+
* The number of coefficients + 1. 0 if there is no high-order match
|
|
2446
|
+
* @type {number}
|
|
2447
|
+
* @memberof V1Transformation
|
|
2448
|
+
*/
|
|
2449
|
+
'numCoef': number;
|
|
2450
|
+
/**
|
|
2451
|
+
* The RMS fit error, in radians, for the simple affine + third-order distortion transform
|
|
2452
|
+
* @type {number}
|
|
2453
|
+
* @memberof V1Transformation
|
|
2454
|
+
*/
|
|
2455
|
+
'fitErrorRadians': number;
|
|
2456
|
+
/**
|
|
2457
|
+
* The RMS fit error, in pixels, for the simple affine + third-order distortion transform
|
|
2458
|
+
* @type {number}
|
|
2459
|
+
* @memberof V1Transformation
|
|
2460
|
+
*/
|
|
2461
|
+
'fitErrorPix': number;
|
|
2462
|
+
/**
|
|
2463
|
+
* The RMS fit error, in radians, for the full third-order transform
|
|
2464
|
+
* @type {number}
|
|
2465
|
+
* @memberof V1Transformation
|
|
2466
|
+
*/
|
|
2467
|
+
'fitError3Radians': number;
|
|
2468
|
+
/**
|
|
2469
|
+
* The RMS fit error, in pixels, for the full third-order transform
|
|
2470
|
+
* @type {number}
|
|
2471
|
+
* @memberof V1Transformation
|
|
2472
|
+
*/
|
|
2473
|
+
'fitError3Pix': number;
|
|
2474
|
+
/**
|
|
2475
|
+
* The difference in scale values between the X and Y axes, used to test the match geometry
|
|
2476
|
+
* @type {number}
|
|
2477
|
+
* @memberof V1Transformation
|
|
2478
|
+
*/
|
|
2479
|
+
'stretch': number;
|
|
2480
|
+
/**
|
|
2481
|
+
* The image skew, used to test the match geometry
|
|
2482
|
+
* @type {number}
|
|
2483
|
+
* @memberof V1Transformation
|
|
2484
|
+
*/
|
|
2485
|
+
'skew': number;
|
|
2486
|
+
/**
|
|
2487
|
+
* The matched image scale, in pixels per radian
|
|
2488
|
+
* @type {number}
|
|
2489
|
+
* @memberof V1Transformation
|
|
2490
|
+
*/
|
|
2491
|
+
'scale': number;
|
|
2492
|
+
/**
|
|
2493
|
+
* The image rotation, in degrees, agrees with PinPoint
|
|
2494
|
+
* @type {number}
|
|
2495
|
+
* @memberof V1Transformation
|
|
2496
|
+
*/
|
|
2497
|
+
'rotation': number;
|
|
2498
|
+
}
|
|
1764
2499
|
/**
|
|
1765
2500
|
*
|
|
1766
2501
|
* @export
|
|
@@ -1824,7 +2559,7 @@ export interface V1UpdateSatelliteTargetRequest {
|
|
|
1824
2559
|
*/
|
|
1825
2560
|
'tleLine2': string;
|
|
1826
2561
|
/**
|
|
1827
|
-
*
|
|
2562
|
+
* The OurSky Satellite Target. When this is specified OurSky will automatically choose the TLE to use based on which target has the newest TLE. The private target or the upstream target. Caution, setting this to null will unlink the target
|
|
1828
2563
|
* @type {string}
|
|
1829
2564
|
* @memberof V1UpdateSatelliteTargetRequest
|
|
1830
2565
|
*/
|
|
@@ -1965,6 +2700,43 @@ export interface V1WebhookLog {
|
|
|
1965
2700
|
*/
|
|
1966
2701
|
'log'?: string;
|
|
1967
2702
|
}
|
|
2703
|
+
/**
|
|
2704
|
+
* V2 Search- created by either RIC volumetric search or plane scan.
|
|
2705
|
+
* @export
|
|
2706
|
+
* @interface V2Search
|
|
2707
|
+
*/
|
|
2708
|
+
export interface V2Search {
|
|
2709
|
+
/**
|
|
2710
|
+
*
|
|
2711
|
+
* @type {string}
|
|
2712
|
+
* @memberof V2Search
|
|
2713
|
+
*/
|
|
2714
|
+
'searchId': string;
|
|
2715
|
+
/**
|
|
2716
|
+
*
|
|
2717
|
+
* @type {string}
|
|
2718
|
+
* @memberof V2Search
|
|
2719
|
+
*/
|
|
2720
|
+
'targetId': string;
|
|
2721
|
+
/**
|
|
2722
|
+
*
|
|
2723
|
+
* @type {string}
|
|
2724
|
+
* @memberof V2Search
|
|
2725
|
+
*/
|
|
2726
|
+
'completedAt'?: string | null;
|
|
2727
|
+
/**
|
|
2728
|
+
*
|
|
2729
|
+
* @type {SearchCompletedReason}
|
|
2730
|
+
* @memberof V2Search
|
|
2731
|
+
*/
|
|
2732
|
+
'completedReason'?: SearchCompletedReason;
|
|
2733
|
+
/**
|
|
2734
|
+
*
|
|
2735
|
+
* @type {Array<string>}
|
|
2736
|
+
* @memberof V2Search
|
|
2737
|
+
*/
|
|
2738
|
+
'observationSequenceResultIds': Array<string>;
|
|
2739
|
+
}
|
|
1968
2740
|
/**
|
|
1969
2741
|
*
|
|
1970
2742
|
* @export
|
|
@@ -2008,6 +2780,9 @@ export declare const WebhookEvent: {
|
|
|
2008
2780
|
readonly V1_EO_CALIBRATION_OBSERVATION_CREATED: "V1_EO_CALIBRATION_OBSERVATION_CREATED";
|
|
2009
2781
|
readonly V1_NODE_CALIBRATION_DATA_CREATED: "V1_NODE_CALIBRATION_DATA_CREATED";
|
|
2010
2782
|
readonly V1_NODE_UPDATED: "V1_NODE_UPDATED";
|
|
2783
|
+
readonly V1_EO_SKY_IMAGERY_CREATED: "V1_EO_SKY_IMAGERY_CREATED";
|
|
2784
|
+
readonly V2_SEARCH_COMPLETED: "V2_SEARCH_COMPLETED";
|
|
2785
|
+
readonly V1_UCT_CREATED: "V1_UCT_CREATED";
|
|
2011
2786
|
};
|
|
2012
2787
|
export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
2013
2788
|
/**
|
|
@@ -2015,6 +2790,21 @@ export type WebhookEvent = typeof WebhookEvent[keyof typeof WebhookEvent];
|
|
|
2015
2790
|
* @export
|
|
2016
2791
|
*/
|
|
2017
2792
|
export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2793
|
+
/**
|
|
2794
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
2795
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
2796
|
+
* @param {string} [after] The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time.
|
|
2797
|
+
* @param {*} [options] Override http request option.
|
|
2798
|
+
* @throws {RequiredError}
|
|
2799
|
+
*/
|
|
2800
|
+
getUncorrelatedTracks: (after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2801
|
+
/**
|
|
2802
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
2803
|
+
* @param {V1BlackoutVolumeRequest} v1BlackoutVolumeRequest
|
|
2804
|
+
* @param {*} [options] Override http request option.
|
|
2805
|
+
* @throws {RequiredError}
|
|
2806
|
+
*/
|
|
2807
|
+
v1CreateBlackoutVolume: (v1BlackoutVolumeRequest: V1BlackoutVolumeRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2018
2808
|
/**
|
|
2019
2809
|
* Create an image set.
|
|
2020
2810
|
* @param {V1CreateImageSetRequest} v1CreateImageSetRequest
|
|
@@ -2030,7 +2820,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2030
2820
|
*/
|
|
2031
2821
|
v1CreateImageSetImage: (v1CreateImageSetImageRequest: V1CreateImageSetImageRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2032
2822
|
/**
|
|
2033
|
-
* 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](#
|
|
2823
|
+
* 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.
|
|
2034
2824
|
* @param {V1CreateOrganizationTargetRequest} v1CreateOrganizationTargetRequest
|
|
2035
2825
|
* @param {*} [options] Override http request option.
|
|
2036
2826
|
* @throws {RequiredError}
|
|
@@ -2044,9 +2834,10 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2044
2834
|
*/
|
|
2045
2835
|
v1CreateSatelliteTarget: (v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2046
2836
|
/**
|
|
2047
|
-
* 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.
|
|
2837
|
+
* 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.
|
|
2048
2838
|
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
2049
2839
|
* @param {*} [options] Override http request option.
|
|
2840
|
+
* @deprecated
|
|
2050
2841
|
* @throws {RequiredError}
|
|
2051
2842
|
*/
|
|
2052
2843
|
v1CreateSearchInstruction: (v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
@@ -2071,6 +2862,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2071
2862
|
* @throws {RequiredError}
|
|
2072
2863
|
*/
|
|
2073
2864
|
v1CreateWebhookTest: (v1CreateWebhookTestRequest: V1CreateWebhookTestRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2865
|
+
/**
|
|
2866
|
+
* Delete a blackout volume.
|
|
2867
|
+
* @param {string} id
|
|
2868
|
+
* @param {*} [options] Override http request option.
|
|
2869
|
+
* @throws {RequiredError}
|
|
2870
|
+
*/
|
|
2871
|
+
v1DeleteBlackoutVolume: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2074
2872
|
/**
|
|
2075
2873
|
* Delete an image set.
|
|
2076
2874
|
* @param {string} id
|
|
@@ -2113,6 +2911,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2113
2911
|
* @throws {RequiredError}
|
|
2114
2912
|
*/
|
|
2115
2913
|
v1DeleteWebhookConfiguration: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2914
|
+
/**
|
|
2915
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
2916
|
+
* @param {string} imageId
|
|
2917
|
+
* @param {*} [options] Override http request option.
|
|
2918
|
+
* @throws {RequiredError}
|
|
2919
|
+
*/
|
|
2920
|
+
v1GetImageMetadata: (imageId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2116
2921
|
/**
|
|
2117
2922
|
* Get an image set.
|
|
2118
2923
|
* @param {string} id
|
|
@@ -2197,7 +3002,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2197
3002
|
*/
|
|
2198
3003
|
v1GetOrganizationTarget: (organizationTargetId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2199
3004
|
/**
|
|
2200
|
-
* Get organization targets see the [create](#
|
|
3005
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
2201
3006
|
* @param {*} [options] Override http request option.
|
|
2202
3007
|
* @throws {RequiredError}
|
|
2203
3008
|
*/
|
|
@@ -2274,6 +3079,13 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2274
3079
|
* @throws {RequiredError}
|
|
2275
3080
|
*/
|
|
2276
3081
|
v1GetWebhookLogs: (webhookId: string, limit?: number, offset?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3082
|
+
/**
|
|
3083
|
+
* Create or update an orbit for a target via a two-line element set (TLE)
|
|
3084
|
+
* @param {V1PutOrbitProviderTLERequest} v1PutOrbitProviderTLERequest
|
|
3085
|
+
* @param {*} [options] Override http request option.
|
|
3086
|
+
* @throws {RequiredError}
|
|
3087
|
+
*/
|
|
3088
|
+
v1PutOrbitProviderTLEOrbit: (v1PutOrbitProviderTLERequest: V1PutOrbitProviderTLERequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2277
3089
|
/**
|
|
2278
3090
|
* 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.
|
|
2279
3091
|
* @param {V1UpdateEmailConfigurationRequest} v1UpdateEmailConfigurationRequest
|
|
@@ -2289,7 +3101,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2289
3101
|
*/
|
|
2290
3102
|
v1UpdateOrganizationTarget: (v1UpdateOrganizationTargetRequest: V1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2291
3103
|
/**
|
|
2292
|
-
* Update satellite target.
|
|
3104
|
+
* Update a private satellite target.
|
|
2293
3105
|
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
2294
3106
|
* @param {*} [options] Override http request option.
|
|
2295
3107
|
* @throws {RequiredError}
|
|
@@ -2302,12 +3114,62 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2302
3114
|
* @throws {RequiredError}
|
|
2303
3115
|
*/
|
|
2304
3116
|
v1UpdateWebhookConfiguration: (v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3117
|
+
/**
|
|
3118
|
+
* 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.
|
|
3119
|
+
* @param {V1PlaneScanRequest} v1PlaneScanRequest
|
|
3120
|
+
* @param {*} [options] Override http request option.
|
|
3121
|
+
* @throws {RequiredError}
|
|
3122
|
+
*/
|
|
3123
|
+
v2CreatePlaneScan: (v1PlaneScanRequest: V1PlaneScanRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3124
|
+
/**
|
|
3125
|
+
* 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.
|
|
3126
|
+
* @param {V1RicVolumeSearchRequest} v1RicVolumeSearchRequest
|
|
3127
|
+
* @param {*} [options] Override http request option.
|
|
3128
|
+
* @throws {RequiredError}
|
|
3129
|
+
*/
|
|
3130
|
+
v2CreateRicVolumeSearch: (v1RicVolumeSearchRequest: V1RicVolumeSearchRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3131
|
+
/**
|
|
3132
|
+
* Delete a plane scan.
|
|
3133
|
+
* @param {string} id
|
|
3134
|
+
* @param {*} [options] Override http request option.
|
|
3135
|
+
* @throws {RequiredError}
|
|
3136
|
+
*/
|
|
3137
|
+
v2DeletePlaneScan: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3138
|
+
/**
|
|
3139
|
+
* Delete a RIC volume search.
|
|
3140
|
+
* @param {string} id
|
|
3141
|
+
* @param {*} [options] Override http request option.
|
|
3142
|
+
* @throws {RequiredError}
|
|
3143
|
+
*/
|
|
3144
|
+
v2DeleteRicVolumeSearch: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3145
|
+
/**
|
|
3146
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
3147
|
+
* @param {string} searchId
|
|
3148
|
+
* @param {*} [options] Override http request option.
|
|
3149
|
+
* @throws {RequiredError}
|
|
3150
|
+
*/
|
|
3151
|
+
v2GetSearch: (searchId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2305
3152
|
};
|
|
2306
3153
|
/**
|
|
2307
3154
|
* DefaultApi - functional programming interface
|
|
2308
3155
|
* @export
|
|
2309
3156
|
*/
|
|
2310
3157
|
export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
3158
|
+
/**
|
|
3159
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
3160
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
3161
|
+
* @param {string} [after] The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time.
|
|
3162
|
+
* @param {*} [options] Override http request option.
|
|
3163
|
+
* @throws {RequiredError}
|
|
3164
|
+
*/
|
|
3165
|
+
getUncorrelatedTracks(after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1Track>>>;
|
|
3166
|
+
/**
|
|
3167
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
3168
|
+
* @param {V1BlackoutVolumeRequest} v1BlackoutVolumeRequest
|
|
3169
|
+
* @param {*} [options] Override http request option.
|
|
3170
|
+
* @throws {RequiredError}
|
|
3171
|
+
*/
|
|
3172
|
+
v1CreateBlackoutVolume(v1BlackoutVolumeRequest: V1BlackoutVolumeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
2311
3173
|
/**
|
|
2312
3174
|
* Create an image set.
|
|
2313
3175
|
* @param {V1CreateImageSetRequest} v1CreateImageSetRequest
|
|
@@ -2323,7 +3185,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2323
3185
|
*/
|
|
2324
3186
|
v1CreateImageSetImage(v1CreateImageSetImageRequest: V1CreateImageSetImageRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1CreateImageSetImageResponse>>;
|
|
2325
3187
|
/**
|
|
2326
|
-
* 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](#
|
|
3188
|
+
* 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.
|
|
2327
3189
|
* @param {V1CreateOrganizationTargetRequest} v1CreateOrganizationTargetRequest
|
|
2328
3190
|
* @param {*} [options] Override http request option.
|
|
2329
3191
|
* @throws {RequiredError}
|
|
@@ -2337,9 +3199,10 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2337
3199
|
*/
|
|
2338
3200
|
v1CreateSatelliteTarget(v1CreateSatelliteTargetRequest: V1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
2339
3201
|
/**
|
|
2340
|
-
* 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.
|
|
3202
|
+
* 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.
|
|
2341
3203
|
* @param {V1CreateSearchInstructionRequest} v1CreateSearchInstructionRequest
|
|
2342
3204
|
* @param {*} [options] Override http request option.
|
|
3205
|
+
* @deprecated
|
|
2343
3206
|
* @throws {RequiredError}
|
|
2344
3207
|
*/
|
|
2345
3208
|
v1CreateSearchInstruction(v1CreateSearchInstructionRequest: V1CreateSearchInstructionRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
@@ -2364,6 +3227,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2364
3227
|
* @throws {RequiredError}
|
|
2365
3228
|
*/
|
|
2366
3229
|
v1CreateWebhookTest(v1CreateWebhookTestRequest: V1CreateWebhookTestRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
3230
|
+
/**
|
|
3231
|
+
* Delete a blackout volume.
|
|
3232
|
+
* @param {string} id
|
|
3233
|
+
* @param {*} [options] Override http request option.
|
|
3234
|
+
* @throws {RequiredError}
|
|
3235
|
+
*/
|
|
3236
|
+
v1DeleteBlackoutVolume(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulDelete>>;
|
|
2367
3237
|
/**
|
|
2368
3238
|
* Delete an image set.
|
|
2369
3239
|
* @param {string} id
|
|
@@ -2406,6 +3276,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2406
3276
|
* @throws {RequiredError}
|
|
2407
3277
|
*/
|
|
2408
3278
|
v1DeleteWebhookConfiguration(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
3279
|
+
/**
|
|
3280
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
3281
|
+
* @param {string} imageId
|
|
3282
|
+
* @param {*} [options] Override http request option.
|
|
3283
|
+
* @throws {RequiredError}
|
|
3284
|
+
*/
|
|
3285
|
+
v1GetImageMetadata(imageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1ImageMetadata>>;
|
|
2409
3286
|
/**
|
|
2410
3287
|
* Get an image set.
|
|
2411
3288
|
* @param {string} id
|
|
@@ -2490,7 +3367,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2490
3367
|
*/
|
|
2491
3368
|
v1GetOrganizationTarget(organizationTargetId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OrganizationTarget>>;
|
|
2492
3369
|
/**
|
|
2493
|
-
* Get organization targets see the [create](#
|
|
3370
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
2494
3371
|
* @param {*} [options] Override http request option.
|
|
2495
3372
|
* @throws {RequiredError}
|
|
2496
3373
|
*/
|
|
@@ -2567,6 +3444,13 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2567
3444
|
* @throws {RequiredError}
|
|
2568
3445
|
*/
|
|
2569
3446
|
v1GetWebhookLogs(webhookId: string, limit?: number, offset?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<V1WebhookLog>>>;
|
|
3447
|
+
/**
|
|
3448
|
+
* Create or update an orbit for a target via a two-line element set (TLE)
|
|
3449
|
+
* @param {V1PutOrbitProviderTLERequest} v1PutOrbitProviderTLERequest
|
|
3450
|
+
* @param {*} [options] Override http request option.
|
|
3451
|
+
* @throws {RequiredError}
|
|
3452
|
+
*/
|
|
3453
|
+
v1PutOrbitProviderTLEOrbit(v1PutOrbitProviderTLERequest: V1PutOrbitProviderTLERequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
2570
3454
|
/**
|
|
2571
3455
|
* 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.
|
|
2572
3456
|
* @param {V1UpdateEmailConfigurationRequest} v1UpdateEmailConfigurationRequest
|
|
@@ -2582,7 +3466,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2582
3466
|
*/
|
|
2583
3467
|
v1UpdateOrganizationTarget(v1UpdateOrganizationTargetRequest: V1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V1OrganizationTarget>>;
|
|
2584
3468
|
/**
|
|
2585
|
-
* Update satellite target.
|
|
3469
|
+
* Update a private satellite target.
|
|
2586
3470
|
* @param {V1UpdateSatelliteTargetRequest} v1UpdateSatelliteTargetRequest
|
|
2587
3471
|
* @param {*} [options] Override http request option.
|
|
2588
3472
|
* @throws {RequiredError}
|
|
@@ -2595,12 +3479,62 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2595
3479
|
* @throws {RequiredError}
|
|
2596
3480
|
*/
|
|
2597
3481
|
v1UpdateWebhookConfiguration(v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
3482
|
+
/**
|
|
3483
|
+
* 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.
|
|
3484
|
+
* @param {V1PlaneScanRequest} v1PlaneScanRequest
|
|
3485
|
+
* @param {*} [options] Override http request option.
|
|
3486
|
+
* @throws {RequiredError}
|
|
3487
|
+
*/
|
|
3488
|
+
v2CreatePlaneScan(v1PlaneScanRequest: V1PlaneScanRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
3489
|
+
/**
|
|
3490
|
+
* 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.
|
|
3491
|
+
* @param {V1RicVolumeSearchRequest} v1RicVolumeSearchRequest
|
|
3492
|
+
* @param {*} [options] Override http request option.
|
|
3493
|
+
* @throws {RequiredError}
|
|
3494
|
+
*/
|
|
3495
|
+
v2CreateRicVolumeSearch(v1RicVolumeSearchRequest: V1RicVolumeSearchRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuccessfulCreate>>;
|
|
3496
|
+
/**
|
|
3497
|
+
* Delete a plane scan.
|
|
3498
|
+
* @param {string} id
|
|
3499
|
+
* @param {*} [options] Override http request option.
|
|
3500
|
+
* @throws {RequiredError}
|
|
3501
|
+
*/
|
|
3502
|
+
v2DeletePlaneScan(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
3503
|
+
/**
|
|
3504
|
+
* Delete a RIC volume search.
|
|
3505
|
+
* @param {string} id
|
|
3506
|
+
* @param {*} [options] Override http request option.
|
|
3507
|
+
* @throws {RequiredError}
|
|
3508
|
+
*/
|
|
3509
|
+
v2DeleteRicVolumeSearch(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmptySuccess>>;
|
|
3510
|
+
/**
|
|
3511
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
3512
|
+
* @param {string} searchId
|
|
3513
|
+
* @param {*} [options] Override http request option.
|
|
3514
|
+
* @throws {RequiredError}
|
|
3515
|
+
*/
|
|
3516
|
+
v2GetSearch(searchId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2Search>>;
|
|
2598
3517
|
};
|
|
2599
3518
|
/**
|
|
2600
3519
|
* DefaultApi - factory interface
|
|
2601
3520
|
* @export
|
|
2602
3521
|
*/
|
|
2603
3522
|
export declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
3523
|
+
/**
|
|
3524
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
3525
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
3526
|
+
* @param {DefaultApiGetUncorrelatedTracksRequest} requestParameters Request parameters.
|
|
3527
|
+
* @param {*} [options] Override http request option.
|
|
3528
|
+
* @throws {RequiredError}
|
|
3529
|
+
*/
|
|
3530
|
+
getUncorrelatedTracks(requestParameters?: DefaultApiGetUncorrelatedTracksRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1Track>>;
|
|
3531
|
+
/**
|
|
3532
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
3533
|
+
* @param {DefaultApiV1CreateBlackoutVolumeRequest} requestParameters Request parameters.
|
|
3534
|
+
* @param {*} [options] Override http request option.
|
|
3535
|
+
* @throws {RequiredError}
|
|
3536
|
+
*/
|
|
3537
|
+
v1CreateBlackoutVolume(requestParameters: DefaultApiV1CreateBlackoutVolumeRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
2604
3538
|
/**
|
|
2605
3539
|
* Create an image set.
|
|
2606
3540
|
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
@@ -2616,7 +3550,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2616
3550
|
*/
|
|
2617
3551
|
v1CreateImageSetImage(requestParameters: DefaultApiV1CreateImageSetImageRequest, options?: AxiosRequestConfig): AxiosPromise<V1CreateImageSetImageResponse>;
|
|
2618
3552
|
/**
|
|
2619
|
-
* 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](#
|
|
3553
|
+
* 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.
|
|
2620
3554
|
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
2621
3555
|
* @param {*} [options] Override http request option.
|
|
2622
3556
|
* @throws {RequiredError}
|
|
@@ -2630,9 +3564,10 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2630
3564
|
*/
|
|
2631
3565
|
v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
2632
3566
|
/**
|
|
2633
|
-
* 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.
|
|
3567
|
+
* 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.
|
|
2634
3568
|
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
2635
3569
|
* @param {*} [options] Override http request option.
|
|
3570
|
+
* @deprecated
|
|
2636
3571
|
* @throws {RequiredError}
|
|
2637
3572
|
*/
|
|
2638
3573
|
v1CreateSearchInstruction(requestParameters: DefaultApiV1CreateSearchInstructionRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
@@ -2657,6 +3592,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2657
3592
|
* @throws {RequiredError}
|
|
2658
3593
|
*/
|
|
2659
3594
|
v1CreateWebhookTest(requestParameters: DefaultApiV1CreateWebhookTestRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
3595
|
+
/**
|
|
3596
|
+
* Delete a blackout volume.
|
|
3597
|
+
* @param {DefaultApiV1DeleteBlackoutVolumeRequest} requestParameters Request parameters.
|
|
3598
|
+
* @param {*} [options] Override http request option.
|
|
3599
|
+
* @throws {RequiredError}
|
|
3600
|
+
*/
|
|
3601
|
+
v1DeleteBlackoutVolume(requestParameters: DefaultApiV1DeleteBlackoutVolumeRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulDelete>;
|
|
2660
3602
|
/**
|
|
2661
3603
|
* Delete an image set.
|
|
2662
3604
|
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
@@ -2699,6 +3641,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2699
3641
|
* @throws {RequiredError}
|
|
2700
3642
|
*/
|
|
2701
3643
|
v1DeleteWebhookConfiguration(requestParameters: DefaultApiV1DeleteWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
3644
|
+
/**
|
|
3645
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
3646
|
+
* @param {DefaultApiV1GetImageMetadataRequest} requestParameters Request parameters.
|
|
3647
|
+
* @param {*} [options] Override http request option.
|
|
3648
|
+
* @throws {RequiredError}
|
|
3649
|
+
*/
|
|
3650
|
+
v1GetImageMetadata(requestParameters: DefaultApiV1GetImageMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<V1ImageMetadata>;
|
|
2702
3651
|
/**
|
|
2703
3652
|
* Get an image set.
|
|
2704
3653
|
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
@@ -2776,7 +3725,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2776
3725
|
*/
|
|
2777
3726
|
v1GetOrganizationTarget(requestParameters: DefaultApiV1GetOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<V1OrganizationTarget>;
|
|
2778
3727
|
/**
|
|
2779
|
-
* Get organization targets see the [create](#
|
|
3728
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
2780
3729
|
* @param {*} [options] Override http request option.
|
|
2781
3730
|
* @throws {RequiredError}
|
|
2782
3731
|
*/
|
|
@@ -2843,6 +3792,13 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2843
3792
|
* @throws {RequiredError}
|
|
2844
3793
|
*/
|
|
2845
3794
|
v1GetWebhookLogs(requestParameters: DefaultApiV1GetWebhookLogsRequest, options?: AxiosRequestConfig): AxiosPromise<Array<V1WebhookLog>>;
|
|
3795
|
+
/**
|
|
3796
|
+
* Create or update an orbit for a target via a two-line element set (TLE)
|
|
3797
|
+
* @param {DefaultApiV1PutOrbitProviderTLEOrbitRequest} requestParameters Request parameters.
|
|
3798
|
+
* @param {*} [options] Override http request option.
|
|
3799
|
+
* @throws {RequiredError}
|
|
3800
|
+
*/
|
|
3801
|
+
v1PutOrbitProviderTLEOrbit(requestParameters: DefaultApiV1PutOrbitProviderTLEOrbitRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
2846
3802
|
/**
|
|
2847
3803
|
* 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.
|
|
2848
3804
|
* @param {DefaultApiV1UpdateEmailConfigurationRequest} requestParameters Request parameters.
|
|
@@ -2858,7 +3814,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2858
3814
|
*/
|
|
2859
3815
|
v1UpdateOrganizationTarget(requestParameters: DefaultApiV1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig): AxiosPromise<V1OrganizationTarget>;
|
|
2860
3816
|
/**
|
|
2861
|
-
* Update satellite target.
|
|
3817
|
+
* Update a private satellite target.
|
|
2862
3818
|
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
2863
3819
|
* @param {*} [options] Override http request option.
|
|
2864
3820
|
* @throws {RequiredError}
|
|
@@ -2871,7 +3827,68 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
2871
3827
|
* @throws {RequiredError}
|
|
2872
3828
|
*/
|
|
2873
3829
|
v1UpdateWebhookConfiguration(requestParameters: DefaultApiV1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
3830
|
+
/**
|
|
3831
|
+
* 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.
|
|
3832
|
+
* @param {DefaultApiV2CreatePlaneScanRequest} requestParameters Request parameters.
|
|
3833
|
+
* @param {*} [options] Override http request option.
|
|
3834
|
+
* @throws {RequiredError}
|
|
3835
|
+
*/
|
|
3836
|
+
v2CreatePlaneScan(requestParameters: DefaultApiV2CreatePlaneScanRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
3837
|
+
/**
|
|
3838
|
+
* 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.
|
|
3839
|
+
* @param {DefaultApiV2CreateRicVolumeSearchRequest} requestParameters Request parameters.
|
|
3840
|
+
* @param {*} [options] Override http request option.
|
|
3841
|
+
* @throws {RequiredError}
|
|
3842
|
+
*/
|
|
3843
|
+
v2CreateRicVolumeSearch(requestParameters: DefaultApiV2CreateRicVolumeSearchRequest, options?: AxiosRequestConfig): AxiosPromise<SuccessfulCreate>;
|
|
3844
|
+
/**
|
|
3845
|
+
* Delete a plane scan.
|
|
3846
|
+
* @param {DefaultApiV2DeletePlaneScanRequest} requestParameters Request parameters.
|
|
3847
|
+
* @param {*} [options] Override http request option.
|
|
3848
|
+
* @throws {RequiredError}
|
|
3849
|
+
*/
|
|
3850
|
+
v2DeletePlaneScan(requestParameters: DefaultApiV2DeletePlaneScanRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
3851
|
+
/**
|
|
3852
|
+
* Delete a RIC volume search.
|
|
3853
|
+
* @param {DefaultApiV2DeleteRicVolumeSearchRequest} requestParameters Request parameters.
|
|
3854
|
+
* @param {*} [options] Override http request option.
|
|
3855
|
+
* @throws {RequiredError}
|
|
3856
|
+
*/
|
|
3857
|
+
v2DeleteRicVolumeSearch(requestParameters: DefaultApiV2DeleteRicVolumeSearchRequest, options?: AxiosRequestConfig): AxiosPromise<EmptySuccess>;
|
|
3858
|
+
/**
|
|
3859
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
3860
|
+
* @param {DefaultApiV2GetSearchRequest} requestParameters Request parameters.
|
|
3861
|
+
* @param {*} [options] Override http request option.
|
|
3862
|
+
* @throws {RequiredError}
|
|
3863
|
+
*/
|
|
3864
|
+
v2GetSearch(requestParameters: DefaultApiV2GetSearchRequest, options?: AxiosRequestConfig): AxiosPromise<V2Search>;
|
|
2874
3865
|
};
|
|
3866
|
+
/**
|
|
3867
|
+
* Request parameters for getUncorrelatedTracks operation in DefaultApi.
|
|
3868
|
+
* @export
|
|
3869
|
+
* @interface DefaultApiGetUncorrelatedTracksRequest
|
|
3870
|
+
*/
|
|
3871
|
+
export interface DefaultApiGetUncorrelatedTracksRequest {
|
|
3872
|
+
/**
|
|
3873
|
+
* The timestamp to get the next page of results. Defaults to the 1 day prior to the current UTC time.
|
|
3874
|
+
* @type {string}
|
|
3875
|
+
* @memberof DefaultApiGetUncorrelatedTracks
|
|
3876
|
+
*/
|
|
3877
|
+
readonly after?: string;
|
|
3878
|
+
}
|
|
3879
|
+
/**
|
|
3880
|
+
* Request parameters for v1CreateBlackoutVolume operation in DefaultApi.
|
|
3881
|
+
* @export
|
|
3882
|
+
* @interface DefaultApiV1CreateBlackoutVolumeRequest
|
|
3883
|
+
*/
|
|
3884
|
+
export interface DefaultApiV1CreateBlackoutVolumeRequest {
|
|
3885
|
+
/**
|
|
3886
|
+
*
|
|
3887
|
+
* @type {V1BlackoutVolumeRequest}
|
|
3888
|
+
* @memberof DefaultApiV1CreateBlackoutVolume
|
|
3889
|
+
*/
|
|
3890
|
+
readonly v1BlackoutVolumeRequest: V1BlackoutVolumeRequest;
|
|
3891
|
+
}
|
|
2875
3892
|
/**
|
|
2876
3893
|
* Request parameters for v1CreateImageSet operation in DefaultApi.
|
|
2877
3894
|
* @export
|
|
@@ -2976,6 +3993,19 @@ export interface DefaultApiV1CreateWebhookTestRequest {
|
|
|
2976
3993
|
*/
|
|
2977
3994
|
readonly v1CreateWebhookTestRequest: V1CreateWebhookTestRequest;
|
|
2978
3995
|
}
|
|
3996
|
+
/**
|
|
3997
|
+
* Request parameters for v1DeleteBlackoutVolume operation in DefaultApi.
|
|
3998
|
+
* @export
|
|
3999
|
+
* @interface DefaultApiV1DeleteBlackoutVolumeRequest
|
|
4000
|
+
*/
|
|
4001
|
+
export interface DefaultApiV1DeleteBlackoutVolumeRequest {
|
|
4002
|
+
/**
|
|
4003
|
+
*
|
|
4004
|
+
* @type {string}
|
|
4005
|
+
* @memberof DefaultApiV1DeleteBlackoutVolume
|
|
4006
|
+
*/
|
|
4007
|
+
readonly id: string;
|
|
4008
|
+
}
|
|
2979
4009
|
/**
|
|
2980
4010
|
* Request parameters for v1DeleteImageSet operation in DefaultApi.
|
|
2981
4011
|
* @export
|
|
@@ -3054,6 +4084,19 @@ export interface DefaultApiV1DeleteWebhookConfigurationRequest {
|
|
|
3054
4084
|
*/
|
|
3055
4085
|
readonly id: string;
|
|
3056
4086
|
}
|
|
4087
|
+
/**
|
|
4088
|
+
* Request parameters for v1GetImageMetadata operation in DefaultApi.
|
|
4089
|
+
* @export
|
|
4090
|
+
* @interface DefaultApiV1GetImageMetadataRequest
|
|
4091
|
+
*/
|
|
4092
|
+
export interface DefaultApiV1GetImageMetadataRequest {
|
|
4093
|
+
/**
|
|
4094
|
+
*
|
|
4095
|
+
* @type {string}
|
|
4096
|
+
* @memberof DefaultApiV1GetImageMetadata
|
|
4097
|
+
*/
|
|
4098
|
+
readonly imageId: string;
|
|
4099
|
+
}
|
|
3057
4100
|
/**
|
|
3058
4101
|
* Request parameters for v1GetImageSet operation in DefaultApi.
|
|
3059
4102
|
* @export
|
|
@@ -3390,6 +4433,19 @@ export interface DefaultApiV1GetWebhookLogsRequest {
|
|
|
3390
4433
|
*/
|
|
3391
4434
|
readonly offset?: number;
|
|
3392
4435
|
}
|
|
4436
|
+
/**
|
|
4437
|
+
* Request parameters for v1PutOrbitProviderTLEOrbit operation in DefaultApi.
|
|
4438
|
+
* @export
|
|
4439
|
+
* @interface DefaultApiV1PutOrbitProviderTLEOrbitRequest
|
|
4440
|
+
*/
|
|
4441
|
+
export interface DefaultApiV1PutOrbitProviderTLEOrbitRequest {
|
|
4442
|
+
/**
|
|
4443
|
+
*
|
|
4444
|
+
* @type {V1PutOrbitProviderTLERequest}
|
|
4445
|
+
* @memberof DefaultApiV1PutOrbitProviderTLEOrbit
|
|
4446
|
+
*/
|
|
4447
|
+
readonly v1PutOrbitProviderTLERequest: V1PutOrbitProviderTLERequest;
|
|
4448
|
+
}
|
|
3393
4449
|
/**
|
|
3394
4450
|
* Request parameters for v1UpdateEmailConfiguration operation in DefaultApi.
|
|
3395
4451
|
* @export
|
|
@@ -3442,6 +4498,71 @@ export interface DefaultApiV1UpdateWebhookConfigurationRequest {
|
|
|
3442
4498
|
*/
|
|
3443
4499
|
readonly v1UpdateWebhookConfigurationRequest: V1UpdateWebhookConfigurationRequest;
|
|
3444
4500
|
}
|
|
4501
|
+
/**
|
|
4502
|
+
* Request parameters for v2CreatePlaneScan operation in DefaultApi.
|
|
4503
|
+
* @export
|
|
4504
|
+
* @interface DefaultApiV2CreatePlaneScanRequest
|
|
4505
|
+
*/
|
|
4506
|
+
export interface DefaultApiV2CreatePlaneScanRequest {
|
|
4507
|
+
/**
|
|
4508
|
+
*
|
|
4509
|
+
* @type {V1PlaneScanRequest}
|
|
4510
|
+
* @memberof DefaultApiV2CreatePlaneScan
|
|
4511
|
+
*/
|
|
4512
|
+
readonly v1PlaneScanRequest: V1PlaneScanRequest;
|
|
4513
|
+
}
|
|
4514
|
+
/**
|
|
4515
|
+
* Request parameters for v2CreateRicVolumeSearch operation in DefaultApi.
|
|
4516
|
+
* @export
|
|
4517
|
+
* @interface DefaultApiV2CreateRicVolumeSearchRequest
|
|
4518
|
+
*/
|
|
4519
|
+
export interface DefaultApiV2CreateRicVolumeSearchRequest {
|
|
4520
|
+
/**
|
|
4521
|
+
*
|
|
4522
|
+
* @type {V1RicVolumeSearchRequest}
|
|
4523
|
+
* @memberof DefaultApiV2CreateRicVolumeSearch
|
|
4524
|
+
*/
|
|
4525
|
+
readonly v1RicVolumeSearchRequest: V1RicVolumeSearchRequest;
|
|
4526
|
+
}
|
|
4527
|
+
/**
|
|
4528
|
+
* Request parameters for v2DeletePlaneScan operation in DefaultApi.
|
|
4529
|
+
* @export
|
|
4530
|
+
* @interface DefaultApiV2DeletePlaneScanRequest
|
|
4531
|
+
*/
|
|
4532
|
+
export interface DefaultApiV2DeletePlaneScanRequest {
|
|
4533
|
+
/**
|
|
4534
|
+
*
|
|
4535
|
+
* @type {string}
|
|
4536
|
+
* @memberof DefaultApiV2DeletePlaneScan
|
|
4537
|
+
*/
|
|
4538
|
+
readonly id: string;
|
|
4539
|
+
}
|
|
4540
|
+
/**
|
|
4541
|
+
* Request parameters for v2DeleteRicVolumeSearch operation in DefaultApi.
|
|
4542
|
+
* @export
|
|
4543
|
+
* @interface DefaultApiV2DeleteRicVolumeSearchRequest
|
|
4544
|
+
*/
|
|
4545
|
+
export interface DefaultApiV2DeleteRicVolumeSearchRequest {
|
|
4546
|
+
/**
|
|
4547
|
+
*
|
|
4548
|
+
* @type {string}
|
|
4549
|
+
* @memberof DefaultApiV2DeleteRicVolumeSearch
|
|
4550
|
+
*/
|
|
4551
|
+
readonly id: string;
|
|
4552
|
+
}
|
|
4553
|
+
/**
|
|
4554
|
+
* Request parameters for v2GetSearch operation in DefaultApi.
|
|
4555
|
+
* @export
|
|
4556
|
+
* @interface DefaultApiV2GetSearchRequest
|
|
4557
|
+
*/
|
|
4558
|
+
export interface DefaultApiV2GetSearchRequest {
|
|
4559
|
+
/**
|
|
4560
|
+
*
|
|
4561
|
+
* @type {string}
|
|
4562
|
+
* @memberof DefaultApiV2GetSearch
|
|
4563
|
+
*/
|
|
4564
|
+
readonly searchId: string;
|
|
4565
|
+
}
|
|
3445
4566
|
/**
|
|
3446
4567
|
* DefaultApi - object-oriented interface
|
|
3447
4568
|
* @export
|
|
@@ -3449,6 +4570,23 @@ export interface DefaultApiV1UpdateWebhookConfigurationRequest {
|
|
|
3449
4570
|
* @extends {BaseAPI}
|
|
3450
4571
|
*/
|
|
3451
4572
|
export declare class DefaultApi extends BaseAPI {
|
|
4573
|
+
/**
|
|
4574
|
+
* This endpoint returns a list of uncorrelated tracks collected by the network.
|
|
4575
|
+
* @summary Get uncorrelated tracks collected by the network.
|
|
4576
|
+
* @param {DefaultApiGetUncorrelatedTracksRequest} requestParameters Request parameters.
|
|
4577
|
+
* @param {*} [options] Override http request option.
|
|
4578
|
+
* @throws {RequiredError}
|
|
4579
|
+
* @memberof DefaultApi
|
|
4580
|
+
*/
|
|
4581
|
+
getUncorrelatedTracks(requestParameters?: DefaultApiGetUncorrelatedTracksRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1Track[], any>>;
|
|
4582
|
+
/**
|
|
4583
|
+
* Create a blackout volume to avoid observing a region of space when scheduling searches.
|
|
4584
|
+
* @param {DefaultApiV1CreateBlackoutVolumeRequest} requestParameters Request parameters.
|
|
4585
|
+
* @param {*} [options] Override http request option.
|
|
4586
|
+
* @throws {RequiredError}
|
|
4587
|
+
* @memberof DefaultApi
|
|
4588
|
+
*/
|
|
4589
|
+
v1CreateBlackoutVolume(requestParameters: DefaultApiV1CreateBlackoutVolumeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
3452
4590
|
/**
|
|
3453
4591
|
* Create an image set.
|
|
3454
4592
|
* @param {DefaultApiV1CreateImageSetRequest} requestParameters Request parameters.
|
|
@@ -3466,7 +4604,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3466
4604
|
*/
|
|
3467
4605
|
v1CreateImageSetImage(requestParameters: DefaultApiV1CreateImageSetImageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1CreateImageSetImageResponse, any>>;
|
|
3468
4606
|
/**
|
|
3469
|
-
* 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](#
|
|
4607
|
+
* 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.
|
|
3470
4608
|
* @param {DefaultApiV1CreateOrganizationTargetRequest} requestParameters Request parameters.
|
|
3471
4609
|
* @param {*} [options] Override http request option.
|
|
3472
4610
|
* @throws {RequiredError}
|
|
@@ -3482,9 +4620,10 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3482
4620
|
*/
|
|
3483
4621
|
v1CreateSatelliteTarget(requestParameters: DefaultApiV1CreateSatelliteTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
3484
4622
|
/**
|
|
3485
|
-
* 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.
|
|
4623
|
+
* 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.
|
|
3486
4624
|
* @param {DefaultApiV1CreateSearchInstructionRequest} requestParameters Request parameters.
|
|
3487
4625
|
* @param {*} [options] Override http request option.
|
|
4626
|
+
* @deprecated
|
|
3488
4627
|
* @throws {RequiredError}
|
|
3489
4628
|
* @memberof DefaultApi
|
|
3490
4629
|
*/
|
|
@@ -3513,6 +4652,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3513
4652
|
* @memberof DefaultApi
|
|
3514
4653
|
*/
|
|
3515
4654
|
v1CreateWebhookTest(requestParameters: DefaultApiV1CreateWebhookTestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
4655
|
+
/**
|
|
4656
|
+
* Delete a blackout volume.
|
|
4657
|
+
* @param {DefaultApiV1DeleteBlackoutVolumeRequest} requestParameters Request parameters.
|
|
4658
|
+
* @param {*} [options] Override http request option.
|
|
4659
|
+
* @throws {RequiredError}
|
|
4660
|
+
* @memberof DefaultApi
|
|
4661
|
+
*/
|
|
4662
|
+
v1DeleteBlackoutVolume(requestParameters: DefaultApiV1DeleteBlackoutVolumeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulDelete, any>>;
|
|
3516
4663
|
/**
|
|
3517
4664
|
* Delete an image set.
|
|
3518
4665
|
* @param {DefaultApiV1DeleteImageSetRequest} requestParameters Request parameters.
|
|
@@ -3561,6 +4708,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3561
4708
|
* @memberof DefaultApi
|
|
3562
4709
|
*/
|
|
3563
4710
|
v1DeleteWebhookConfiguration(requestParameters: DefaultApiV1DeleteWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
4711
|
+
/**
|
|
4712
|
+
* Get metadata about an image by image id. This includes plate solve results
|
|
4713
|
+
* @param {DefaultApiV1GetImageMetadataRequest} requestParameters Request parameters.
|
|
4714
|
+
* @param {*} [options] Override http request option.
|
|
4715
|
+
* @throws {RequiredError}
|
|
4716
|
+
* @memberof DefaultApi
|
|
4717
|
+
*/
|
|
4718
|
+
v1GetImageMetadata(requestParameters: DefaultApiV1GetImageMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1ImageMetadata, any>>;
|
|
3564
4719
|
/**
|
|
3565
4720
|
* Get an image set.
|
|
3566
4721
|
* @param {DefaultApiV1GetImageSetRequest} requestParameters Request parameters.
|
|
@@ -3649,7 +4804,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3649
4804
|
*/
|
|
3650
4805
|
v1GetOrganizationTarget(requestParameters: DefaultApiV1GetOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OrganizationTarget, any>>;
|
|
3651
4806
|
/**
|
|
3652
|
-
* Get organization targets see the [create](#
|
|
4807
|
+
* Get organization targets see the [create](#tag/organization-targets/POST/v1/organization-target) endpoint for more details.
|
|
3653
4808
|
* @param {*} [options] Override http request option.
|
|
3654
4809
|
* @throws {RequiredError}
|
|
3655
4810
|
* @memberof DefaultApi
|
|
@@ -3726,6 +4881,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3726
4881
|
* @memberof DefaultApi
|
|
3727
4882
|
*/
|
|
3728
4883
|
v1GetWebhookLogs(requestParameters: DefaultApiV1GetWebhookLogsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1WebhookLog[], any>>;
|
|
4884
|
+
/**
|
|
4885
|
+
* Create or update an orbit for a target via a two-line element set (TLE)
|
|
4886
|
+
* @param {DefaultApiV1PutOrbitProviderTLEOrbitRequest} requestParameters Request parameters.
|
|
4887
|
+
* @param {*} [options] Override http request option.
|
|
4888
|
+
* @throws {RequiredError}
|
|
4889
|
+
* @memberof DefaultApi
|
|
4890
|
+
*/
|
|
4891
|
+
v1PutOrbitProviderTLEOrbit(requestParameters: DefaultApiV1PutOrbitProviderTLEOrbitRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
3729
4892
|
/**
|
|
3730
4893
|
* 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.
|
|
3731
4894
|
* @param {DefaultApiV1UpdateEmailConfigurationRequest} requestParameters Request parameters.
|
|
@@ -3743,7 +4906,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3743
4906
|
*/
|
|
3744
4907
|
v1UpdateOrganizationTarget(requestParameters: DefaultApiV1UpdateOrganizationTargetRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V1OrganizationTarget, any>>;
|
|
3745
4908
|
/**
|
|
3746
|
-
* Update satellite target.
|
|
4909
|
+
* Update a private satellite target.
|
|
3747
4910
|
* @param {DefaultApiV1UpdateSatelliteTargetRequest} requestParameters Request parameters.
|
|
3748
4911
|
* @param {*} [options] Override http request option.
|
|
3749
4912
|
* @throws {RequiredError}
|
|
@@ -3758,4 +4921,44 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3758
4921
|
* @memberof DefaultApi
|
|
3759
4922
|
*/
|
|
3760
4923
|
v1UpdateWebhookConfiguration(requestParameters: DefaultApiV1UpdateWebhookConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
4924
|
+
/**
|
|
4925
|
+
* 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.
|
|
4926
|
+
* @param {DefaultApiV2CreatePlaneScanRequest} requestParameters Request parameters.
|
|
4927
|
+
* @param {*} [options] Override http request option.
|
|
4928
|
+
* @throws {RequiredError}
|
|
4929
|
+
* @memberof DefaultApi
|
|
4930
|
+
*/
|
|
4931
|
+
v2CreatePlaneScan(requestParameters: DefaultApiV2CreatePlaneScanRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
4932
|
+
/**
|
|
4933
|
+
* 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.
|
|
4934
|
+
* @param {DefaultApiV2CreateRicVolumeSearchRequest} requestParameters Request parameters.
|
|
4935
|
+
* @param {*} [options] Override http request option.
|
|
4936
|
+
* @throws {RequiredError}
|
|
4937
|
+
* @memberof DefaultApi
|
|
4938
|
+
*/
|
|
4939
|
+
v2CreateRicVolumeSearch(requestParameters: DefaultApiV2CreateRicVolumeSearchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuccessfulCreate, any>>;
|
|
4940
|
+
/**
|
|
4941
|
+
* Delete a plane scan.
|
|
4942
|
+
* @param {DefaultApiV2DeletePlaneScanRequest} requestParameters Request parameters.
|
|
4943
|
+
* @param {*} [options] Override http request option.
|
|
4944
|
+
* @throws {RequiredError}
|
|
4945
|
+
* @memberof DefaultApi
|
|
4946
|
+
*/
|
|
4947
|
+
v2DeletePlaneScan(requestParameters: DefaultApiV2DeletePlaneScanRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
4948
|
+
/**
|
|
4949
|
+
* Delete a RIC volume search.
|
|
4950
|
+
* @param {DefaultApiV2DeleteRicVolumeSearchRequest} requestParameters Request parameters.
|
|
4951
|
+
* @param {*} [options] Override http request option.
|
|
4952
|
+
* @throws {RequiredError}
|
|
4953
|
+
* @memberof DefaultApi
|
|
4954
|
+
*/
|
|
4955
|
+
v2DeleteRicVolumeSearch(requestParameters: DefaultApiV2DeleteRicVolumeSearchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmptySuccess, any>>;
|
|
4956
|
+
/**
|
|
4957
|
+
* Get a V2 search (created by RIC volumetric search or plane scan endpoints) by ID.
|
|
4958
|
+
* @param {DefaultApiV2GetSearchRequest} requestParameters Request parameters.
|
|
4959
|
+
* @param {*} [options] Override http request option.
|
|
4960
|
+
* @throws {RequiredError}
|
|
4961
|
+
* @memberof DefaultApi
|
|
4962
|
+
*/
|
|
4963
|
+
v2GetSearch(requestParameters: DefaultApiV2GetSearchRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<V2Search, any>>;
|
|
3761
4964
|
}
|