@ourskyai/sda-api 1.3.8815 → 1.4.118
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +90 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +180 -4
- package/api.ts +1188 -2831
- package/base.ts +14 -24
- package/common.ts +20 -44
- package/configuration.ts +37 -17
- package/dist/api.d.ts +662 -2682
- package/dist/api.js +783 -298
- package/dist/base.d.ts +11 -23
- package/dist/base.js +5 -18
- package/dist/common.d.ts +6 -37
- package/dist/common.js +18 -40
- package/dist/configuration.d.ts +30 -15
- package/dist/configuration.js +5 -3
- package/dist/esm/api.d.ts +662 -2682
- package/dist/esm/api.js +783 -298
- package/dist/esm/base.d.ts +11 -23
- package/dist/esm/base.js +4 -17
- package/dist/esm/common.d.ts +6 -37
- package/dist/esm/common.js +16 -39
- package/dist/esm/configuration.d.ts +30 -15
- package/dist/esm/configuration.js +5 -3
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/AstrometricOffsets.md +31 -0
- package/docs/DefaultApi.md +3166 -0
- package/docs/EmptySuccess.md +20 -0
- package/docs/FilterType.md +60 -0
- package/docs/FitsHeader.md +22 -0
- package/docs/ImageSetType.md +24 -0
- package/docs/Location.md +25 -0
- package/docs/MountGeometry.md +10 -0
- package/docs/MountType.md +10 -0
- package/docs/ObservationBoundingBox.md +26 -0
- package/docs/ObservationQuality.md +26 -0
- package/docs/ObservationResult.md +57 -0
- package/docs/ObservationState.md +16 -0
- package/docs/OrbitType.md +42 -0
- package/docs/SatelliteTargetTrackingStatus.md +12 -0
- package/docs/SearchCompletedReason.md +17 -0
- package/docs/ShutterType.md +10 -0
- package/docs/SuccessfulCreate.md +20 -0
- package/docs/SuccessfulDelete.md +20 -0
- package/docs/TrackingType.md +12 -0
- package/docs/V1AllSkyPredictionLabel.md +16 -0
- package/docs/V1BlackoutVolumeRequest.md +23 -0
- package/docs/V1CreateDirectTaskInstructionRequest.md +28 -0
- package/docs/V1CreateImageMetadataRequest.md +26 -0
- package/docs/V1CreateImageSetImageRequest.md +32 -0
- package/docs/V1CreateImageSetImageResponse.md +23 -0
- package/docs/V1CreateImageSetRequest.md +28 -0
- package/docs/V1CreateOrganizationTargetRequest.md +26 -0
- package/docs/V1CreateSatelliteTargetRequest.md +32 -0
- package/docs/V1CreateSearchInstructionRequest.md +24 -0
- package/docs/V1CreateSurveyInstructionRequest.md +24 -0
- package/docs/V1CreateWebhookConfigurationRequest.md +28 -0
- package/docs/V1CreateWebhookTestRequest.md +20 -0
- package/docs/V1GetSatelliteTargetsResponse.md +20 -0
- package/docs/V1GroundStationParticipant.md +52 -0
- package/docs/V1HFRStar.md +25 -0
- package/docs/V1ImageFileType.md +10 -0
- package/docs/V1ImageMetadata.md +32 -0
- package/docs/V1ImageRejectionReason.md +64 -0
- package/docs/V1ImageSet.md +43 -0
- package/docs/V1ImageSetImage.md +77 -0
- package/docs/V1MatchedStar.md +39 -0
- package/docs/V1NodeCalibrationResult.md +48 -0
- package/docs/V1ObservationFeature.md +39 -0
- package/docs/V1ObservationSequenceResult.md +37 -0
- package/docs/V1ObservationSequenceResultImageSetsInner.md +28 -0
- package/docs/V1ObservationStatus.md +56 -0
- package/docs/V1ObservationWeather.md +22 -0
- package/docs/V1ObservedWeather.md +23 -0
- package/docs/V1ObserverLocation.md +24 -0
- package/docs/V1OrganizationTarget.md +32 -0
- package/docs/V1PassStage.md +12 -0
- package/docs/V1PixelCoordinates.md +23 -0
- package/docs/V1PlaneScanRequest.md +25 -0
- package/docs/V1PlateSolveResult.md +40 -0
- package/docs/V1PlateSolveStatus.md +12 -0
- package/docs/V1Point.md +25 -0
- package/docs/V1PredictedStreakLocation.md +26 -0
- package/docs/V1PredictedWeather.md +21 -0
- package/docs/V1PutOrbitProviderTLERequest.md +33 -0
- package/docs/V1ResolvedImageMetadata.md +52 -0
- package/docs/V1ResolvedImageObservation.md +37 -0
- package/docs/V1ResolvedImagePair.md +41 -0
- package/docs/V1ResolvedImageSet.md +25 -0
- package/docs/V1RicVolumeSearchRequest.md +29 -0
- package/docs/V1SIPCoefficients.md +40 -0
- package/docs/V1SatelliteCalibrationFamily.md +12 -0
- package/docs/V1SatellitePotential.md +37 -0
- package/docs/V1SatelliteTarget.md +83 -0
- package/docs/V1SearchInstruction.md +29 -0
- package/docs/V1SearchInstructionStep.md +27 -0
- package/docs/V1SharpeningMethod.md +10 -0
- package/docs/V1StateVector.md +43 -0
- package/docs/V1SurveyInstruction.md +28 -0
- package/docs/V1SurveyInstructionStep.md +33 -0
- package/docs/V1TargetCorrelation.md +31 -0
- package/docs/V1Tdm.md +35 -0
- package/docs/V1TimeTaggedRaDec.md +28 -0
- package/docs/V1Track.md +24 -0
- package/docs/V1Transformation.md +77 -0
- package/docs/V1UpdateEmailConfigurationRequest.md +20 -0
- package/docs/V1UpdateOrganizationTargetRequest.md +24 -0
- package/docs/V1UpdateSatelliteTargetRequest.md +34 -0
- package/docs/V1UpdateWebhookConfigurationRequest.md +22 -0
- package/docs/V1WebhookConfiguration.md +34 -0
- package/docs/V1WebhookLog.md +30 -0
- package/docs/V2Search.md +29 -0
- package/docs/WeatherCondition.md +20 -0
- package/docs/WebhookAuthType.md +13 -0
- package/docs/WebhookEvent.md +35 -0
- package/index.ts +1 -1
- package/package.json +4 -4
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# EmptySuccess
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { EmptySuccess } from '@ourskyai/sda-api';
|
|
14
|
+
|
|
15
|
+
const instance: EmptySuccess = {
|
|
16
|
+
message,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# FilterType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `NONE` (value: `'NONE'`)
|
|
7
|
+
|
|
8
|
+
* `RED` (value: `'RED'`)
|
|
9
|
+
|
|
10
|
+
* `BLUE` (value: `'BLUE'`)
|
|
11
|
+
|
|
12
|
+
* `GREEN` (value: `'GREEN'`)
|
|
13
|
+
|
|
14
|
+
* `UV` (value: `'UV'`)
|
|
15
|
+
|
|
16
|
+
* `IR` (value: `'IR'`)
|
|
17
|
+
|
|
18
|
+
* `LUMINANCE` (value: `'LUMINANCE'`)
|
|
19
|
+
|
|
20
|
+
* `ENHANCED_LUMINANCE` (value: `'ENHANCED_LUMINANCE'`)
|
|
21
|
+
|
|
22
|
+
* `H_ALPHA` (value: `'H_ALPHA'`)
|
|
23
|
+
|
|
24
|
+
* `H_BETA` (value: `'H_BETA'`)
|
|
25
|
+
|
|
26
|
+
* `S_II` (value: `'S_II'`)
|
|
27
|
+
|
|
28
|
+
* `O_III` (value: `'O_III'`)
|
|
29
|
+
|
|
30
|
+
* `DUAL_BAND` (value: `'DUAL_BAND'`)
|
|
31
|
+
|
|
32
|
+
* `PHOTO_JOHNSON_U` (value: `'PHOTO_JOHNSON_U'`)
|
|
33
|
+
|
|
34
|
+
* `PHOTO_JOHNSON_B` (value: `'PHOTO_JOHNSON_B'`)
|
|
35
|
+
|
|
36
|
+
* `PHOTO_JOHNSON_V` (value: `'PHOTO_JOHNSON_V'`)
|
|
37
|
+
|
|
38
|
+
* `PHOTO_COUSINS_R` (value: `'PHOTO_COUSINS_R'`)
|
|
39
|
+
|
|
40
|
+
* `PHOTO_COUSINS_I` (value: `'PHOTO_COUSINS_I'`)
|
|
41
|
+
|
|
42
|
+
* `PHOTO_SLOAN_U` (value: `'PHOTO_SLOAN_U'`)
|
|
43
|
+
|
|
44
|
+
* `PHOTO_SLOAN_G` (value: `'PHOTO_SLOAN_G'`)
|
|
45
|
+
|
|
46
|
+
* `PHOTO_SLOAN_R` (value: `'PHOTO_SLOAN_R'`)
|
|
47
|
+
|
|
48
|
+
* `PHOTO_SLOAN_I` (value: `'PHOTO_SLOAN_I'`)
|
|
49
|
+
|
|
50
|
+
* `PHOTO_SLOAN_Z` (value: `'PHOTO_SLOAN_Z'`)
|
|
51
|
+
|
|
52
|
+
* `TRIPLE_BAND` (value: `'TRIPLE_BAND'`)
|
|
53
|
+
|
|
54
|
+
* `QUAD_BAND` (value: `'QUAD_BAND'`)
|
|
55
|
+
|
|
56
|
+
* `DARK` (value: `'DARK'`)
|
|
57
|
+
|
|
58
|
+
* `OTHER` (value: `'OTHER'`)
|
|
59
|
+
|
|
60
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# FitsHeader
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**key** | **string** | | [default to undefined]
|
|
9
|
+
**value** | **string** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { FitsHeader } from '@ourskyai/sda-api';
|
|
15
|
+
|
|
16
|
+
const instance: FitsHeader = {
|
|
17
|
+
key,
|
|
18
|
+
value,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ImageSetType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `ASTRONOMICAL` (value: `'ASTRONOMICAL'`)
|
|
7
|
+
|
|
8
|
+
* `EARTH_ORBITAL` (value: `'EARTH_ORBITAL'`)
|
|
9
|
+
|
|
10
|
+
* `GNSS_CALIBRATION` (value: `'GNSS_CALIBRATION'`)
|
|
11
|
+
|
|
12
|
+
* `SATELLITE_CALIBRATION` (value: `'SATELLITE_CALIBRATION'`)
|
|
13
|
+
|
|
14
|
+
* `WAVEFRONT_SENSOR_FACTORY_CALIBRATION` (value: `'WAVEFRONT_SENSOR_FACTORY_CALIBRATION'`)
|
|
15
|
+
|
|
16
|
+
* `ALL_SKY` (value: `'ALL_SKY'`)
|
|
17
|
+
|
|
18
|
+
* `THERMAL` (value: `'THERMAL'`)
|
|
19
|
+
|
|
20
|
+
* `STACKED_ASTRONOMICAL` (value: `'STACKED_ASTRONOMICAL'`)
|
|
21
|
+
|
|
22
|
+
* `TERRESTRIAL_DOWNLINK` (value: `'TERRESTRIAL_DOWNLINK'`)
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Location.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Location
|
|
2
|
+
|
|
3
|
+
Location
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**latitude** | **number** | | [default to undefined]
|
|
10
|
+
**longitude** | **number** | | [default to undefined]
|
|
11
|
+
**altitude** | **number** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { Location } from '@ourskyai/sda-api';
|
|
17
|
+
|
|
18
|
+
const instance: Location = {
|
|
19
|
+
latitude,
|
|
20
|
+
longitude,
|
|
21
|
+
altitude,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# MountGeometry
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `ALT_AZ` (value: `'ALT_AZ'`)
|
|
7
|
+
|
|
8
|
+
* `EQUATORIAL` (value: `'EQUATORIAL'`)
|
|
9
|
+
|
|
10
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# MountType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `ALT_AZ` (value: `'ALT_AZ'`)
|
|
7
|
+
|
|
8
|
+
* `EQUITORIAL` (value: `'EQUITORIAL'`)
|
|
9
|
+
|
|
10
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ObservationBoundingBox
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**startX** | **number** | | [default to undefined]
|
|
9
|
+
**startY** | **number** | | [default to undefined]
|
|
10
|
+
**endX** | **number** | | [default to undefined]
|
|
11
|
+
**endY** | **number** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ObservationBoundingBox } from '@ourskyai/sda-api';
|
|
17
|
+
|
|
18
|
+
const instance: ObservationBoundingBox = {
|
|
19
|
+
startX,
|
|
20
|
+
startY,
|
|
21
|
+
endX,
|
|
22
|
+
endY,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ObservationQuality
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**lineFitOffsetStdDev** | **number** | Standard deviation for the line fit of the observation positions over time | [default to undefined]
|
|
9
|
+
**distanceFromPredictionAverage** | **number** | Average of the distances beween observation and prediction, in arcsec | [optional] [default to undefined]
|
|
10
|
+
**distanceFromPredictionLineFitSlope** | **number** | Slope of the linear fit of distances, in arcsec per second | [optional] [default to undefined]
|
|
11
|
+
**distanceFromPredictionLineFitStdDev** | **number** | Standard deviation of the offsets of the linear fit | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ObservationQuality } from '@ourskyai/sda-api';
|
|
17
|
+
|
|
18
|
+
const instance: ObservationQuality = {
|
|
19
|
+
lineFitOffsetStdDev,
|
|
20
|
+
distanceFromPredictionAverage,
|
|
21
|
+
distanceFromPredictionLineFitSlope,
|
|
22
|
+
distanceFromPredictionLineFitStdDev,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# ObservationResult
|
|
2
|
+
|
|
3
|
+
A single observation result. This is a 1:1 mapping with a single image
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**imageId** | **string** | | [default to undefined]
|
|
10
|
+
**astrometricOffsets** | [**AstrometricOffsets**](AstrometricOffsets.md) | | [default to undefined]
|
|
11
|
+
**imageUrl** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**jpgUrl** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**thumbnailUrl** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**ra** | **number** | The un-corrected apparent right ascension in degrees and EME2000 frame at the ground station | [default to undefined]
|
|
15
|
+
**dec** | **number** | The un-corrected apparent declination in degrees and EME2000 frame at the ground station | [default to undefined]
|
|
16
|
+
**correctedRa** | **number** | The measured right ascension calibrated for stellar aberration in degrees and EME2000 frame | [optional] [default to undefined]
|
|
17
|
+
**correctedDec** | **number** | The measured declination calibrated for stellar aberration in degrees and EME2000 frame | [optional] [default to undefined]
|
|
18
|
+
**boundingBox** | [**ObservationBoundingBox**](ObservationBoundingBox.md) | | [optional] [default to undefined]
|
|
19
|
+
**timestamp** | **string** | | [default to undefined]
|
|
20
|
+
**timingAccuracy** | **number** | Timestamps for this image are considered to be accurate to within +/- this value in seconds | [default to undefined]
|
|
21
|
+
**apparentMagnitude** | **number** | Magnitude of the target in this image. Flux-based when uncalibrated; star-calibrated when apparentMagnitudeIsCalibrated is true. | [optional] [default to undefined]
|
|
22
|
+
**solarPhaseAngle** | **number** | BETA: the solar phase angle, defined as the angle between the target->observer and target->sun vectors, in degrees at the time of observation | [optional] [default to undefined]
|
|
23
|
+
**solarEqPhaseAngle** | **number** | BETA: the solar equatorial phase angle, defined as the solar phase angle in the equatorial plane, in degrees at the time of observation | [optional] [default to undefined]
|
|
24
|
+
**geolat** | **number** | BETA: GEO latitude in degrees, if applicable | [optional] [default to undefined]
|
|
25
|
+
**geolon** | **number** | BETA: GEO longitude in degrees, if applicable | [optional] [default to undefined]
|
|
26
|
+
**distanceFromPrediction** | **number** | The distance from the predicted location in arcseconds (using SGP4 propagation) | [optional] [default to undefined]
|
|
27
|
+
**features** | [**Array<V1ObservationFeature>**](V1ObservationFeature.md) | | [optional] [default to undefined]
|
|
28
|
+
|
|
29
|
+
## Example
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
import { ObservationResult } from '@ourskyai/sda-api';
|
|
33
|
+
|
|
34
|
+
const instance: ObservationResult = {
|
|
35
|
+
imageId,
|
|
36
|
+
astrometricOffsets,
|
|
37
|
+
imageUrl,
|
|
38
|
+
jpgUrl,
|
|
39
|
+
thumbnailUrl,
|
|
40
|
+
ra,
|
|
41
|
+
dec,
|
|
42
|
+
correctedRa,
|
|
43
|
+
correctedDec,
|
|
44
|
+
boundingBox,
|
|
45
|
+
timestamp,
|
|
46
|
+
timingAccuracy,
|
|
47
|
+
apparentMagnitude,
|
|
48
|
+
solarPhaseAngle,
|
|
49
|
+
solarEqPhaseAngle,
|
|
50
|
+
geolat,
|
|
51
|
+
geolon,
|
|
52
|
+
distanceFromPrediction,
|
|
53
|
+
features,
|
|
54
|
+
};
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# ObservationState
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `PENDING` (value: `'PENDING'`)
|
|
7
|
+
|
|
8
|
+
* `UNDERWAY` (value: `'UNDERWAY'`)
|
|
9
|
+
|
|
10
|
+
* `COMPLETED` (value: `'COMPLETED'`)
|
|
11
|
+
|
|
12
|
+
* `FAILED` (value: `'FAILED'`)
|
|
13
|
+
|
|
14
|
+
* `EXPIRED` (value: `'EXPIRED'`)
|
|
15
|
+
|
|
16
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# OrbitType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `GEOSTATIONARY` (value: `'GEOSTATIONARY'`)
|
|
7
|
+
|
|
8
|
+
* `GEOSYNCHRONOUS` (value: `'GEOSYNCHRONOUS'`)
|
|
9
|
+
|
|
10
|
+
* `MEO` (value: `'MEO'`)
|
|
11
|
+
|
|
12
|
+
* `LEO` (value: `'LEO'`)
|
|
13
|
+
|
|
14
|
+
* `GTO` (value: `'GTO'`)
|
|
15
|
+
|
|
16
|
+
* `SSO` (value: `'SSO'`)
|
|
17
|
+
|
|
18
|
+
* `TUNDRA` (value: `'TUNDRA'`)
|
|
19
|
+
|
|
20
|
+
* `MOLNIYA` (value: `'MOLNIYA'`)
|
|
21
|
+
|
|
22
|
+
* `EGO` (value: `'EGO'`)
|
|
23
|
+
|
|
24
|
+
* `ESO` (value: `'ESO'`)
|
|
25
|
+
|
|
26
|
+
* `GHO` (value: `'GHO'`)
|
|
27
|
+
|
|
28
|
+
* `HAO` (value: `'HAO'`)
|
|
29
|
+
|
|
30
|
+
* `HEO` (value: `'HEO'`)
|
|
31
|
+
|
|
32
|
+
* `IGO` (value: `'IGO'`)
|
|
33
|
+
|
|
34
|
+
* `LMO` (value: `'LMO'`)
|
|
35
|
+
|
|
36
|
+
* `MGO` (value: `'MGO'`)
|
|
37
|
+
|
|
38
|
+
* `NSO` (value: `'NSO'`)
|
|
39
|
+
|
|
40
|
+
* `UFO` (value: `'UFO'`)
|
|
41
|
+
|
|
42
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# SatelliteTargetTrackingStatus
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `ACTIVE` (value: `'ACTIVE'`)
|
|
7
|
+
|
|
8
|
+
* `INACTIVE` (value: `'INACTIVE'`)
|
|
9
|
+
|
|
10
|
+
* `DEORBITED` (value: `'DEORBITED'`)
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# SearchCompletedReason
|
|
2
|
+
|
|
3
|
+
The reason a search was completed.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `ALL_HYPOTHESES_TESTED` (value: `'ALL_HYPOTHESES_TESTED'`)
|
|
8
|
+
|
|
9
|
+
* `FOUND_TARGET` (value: `'FOUND_TARGET'`)
|
|
10
|
+
|
|
11
|
+
* `CANCELLED` (value: `'CANCELLED'`)
|
|
12
|
+
|
|
13
|
+
* `FAILED` (value: `'FAILED'`)
|
|
14
|
+
|
|
15
|
+
* `UNDERWAY` (value: `'UNDERWAY'`)
|
|
16
|
+
|
|
17
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# ShutterType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `ROLLING` (value: `'ROLLING'`)
|
|
7
|
+
|
|
8
|
+
* `GLOBAL` (value: `'GLOBAL'`)
|
|
9
|
+
|
|
10
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# SuccessfulCreate
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { SuccessfulCreate } from '@ourskyai/sda-api';
|
|
14
|
+
|
|
15
|
+
const instance: SuccessfulCreate = {
|
|
16
|
+
id,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# SuccessfulDelete
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { SuccessfulDelete } from '@ourskyai/sda-api';
|
|
14
|
+
|
|
15
|
+
const instance: SuccessfulDelete = {
|
|
16
|
+
id,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# TrackingType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `SIDEREAL` (value: `'SIDEREAL'`)
|
|
7
|
+
|
|
8
|
+
* `TARGET_RATE` (value: `'TARGET_RATE'`)
|
|
9
|
+
|
|
10
|
+
* `NONE` (value: `'NONE'`)
|
|
11
|
+
|
|
12
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# V1AllSkyPredictionLabel
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `CLEAR` (value: `'CLEAR'`)
|
|
7
|
+
|
|
8
|
+
* `LIGHT_CLOUDS` (value: `'LIGHT_CLOUDS'`)
|
|
9
|
+
|
|
10
|
+
* `HEAVY_CLOUDS` (value: `'HEAVY_CLOUDS'`)
|
|
11
|
+
|
|
12
|
+
* `PRECIPITATION` (value: `'PRECIPITATION'`)
|
|
13
|
+
|
|
14
|
+
* `UNKNOWN` (value: `'UNKNOWN'`)
|
|
15
|
+
|
|
16
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1BlackoutVolumeRequest
|
|
2
|
+
|
|
3
|
+
A designated volume of space that is not to be observed.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**reference_frame** | **string** | The reference frame in which the volume is defined. | [default to undefined]
|
|
10
|
+
**points** | [**Array<V1Point>**](V1Point.md) | The set of 8 points that define the volume, coordinates should be in the selected reference frame. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1BlackoutVolumeRequest } from '@ourskyai/sda-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1BlackoutVolumeRequest = {
|
|
18
|
+
reference_frame,
|
|
19
|
+
points,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# V1CreateDirectTaskInstructionRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**nodeId** | **string** | Optional node ID to limit execution to a specific node. If null, any node in the network can execute this instruction. | [optional] [default to undefined]
|
|
9
|
+
**executableAfter** | **string** | NET time after which the instruction can be executed (expressed in UTC). If null, the instruction can be executed immediately. | [optional] [default to undefined]
|
|
10
|
+
**executableUntil** | **string** | Latest time the instruction can be executed (expressed in UTC). If null, the instruction will not have an expiration. | [optional] [default to undefined]
|
|
11
|
+
**targetId** | **string** | | [default to undefined]
|
|
12
|
+
**trackingType** | [**TrackingType**](TrackingType.md) | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1CreateDirectTaskInstructionRequest } from '@ourskyai/sda-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1CreateDirectTaskInstructionRequest = {
|
|
20
|
+
nodeId,
|
|
21
|
+
executableAfter,
|
|
22
|
+
executableUntil,
|
|
23
|
+
targetId,
|
|
24
|
+
trackingType,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# V1CreateImageMetadataRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**plateSolveResult** | [**V1PlateSolveResult**](V1PlateSolveResult.md) | | [optional] [default to undefined]
|
|
9
|
+
**inputStars** | [**Array<V1HFRStar>**](V1HFRStar.md) | Extracted star features from the image. Used as inputs to plate solving | [optional] [default to undefined]
|
|
10
|
+
**sipCoefficients** | [**V1SIPCoefficients**](V1SIPCoefficients.md) | | [optional] [default to undefined]
|
|
11
|
+
**photometricZeroPoint** | **number** | Photometric zero point offset. Add to instrumental magnitude (-2.5*log10(flux)) to get calibrated magnitude in standard photometric system. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1CreateImageMetadataRequest } from '@ourskyai/sda-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1CreateImageMetadataRequest = {
|
|
19
|
+
plateSolveResult,
|
|
20
|
+
inputStars,
|
|
21
|
+
sipCoefficients,
|
|
22
|
+
photometricZeroPoint,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# V1CreateImageSetImageRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**imageSetId** | **string** | | [default to undefined]
|
|
9
|
+
**imageFileType** | [**V1ImageFileType**](V1ImageFileType.md) | | [optional] [default to undefined]
|
|
10
|
+
**binning** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**exposureLength** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**imageSha** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**imageSizeMb** | **number** | | [optional] [default to undefined]
|
|
14
|
+
**capturedAt** | **string** | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { V1CreateImageSetImageRequest } from '@ourskyai/sda-api';
|
|
20
|
+
|
|
21
|
+
const instance: V1CreateImageSetImageRequest = {
|
|
22
|
+
imageSetId,
|
|
23
|
+
imageFileType,
|
|
24
|
+
binning,
|
|
25
|
+
exposureLength,
|
|
26
|
+
imageSha,
|
|
27
|
+
imageSizeMb,
|
|
28
|
+
capturedAt,
|
|
29
|
+
};
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1CreateImageSetImageResponse
|
|
2
|
+
|
|
3
|
+
Response from image creation, with image ID and presigned S3 upload URL.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | | [default to undefined]
|
|
10
|
+
**uploadUrl** | **string** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1CreateImageSetImageResponse } from '@ourskyai/sda-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1CreateImageSetImageResponse = {
|
|
18
|
+
id,
|
|
19
|
+
uploadUrl,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# V1CreateImageSetRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**nodeId** | **string** | | [default to undefined]
|
|
9
|
+
**observationId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**type** | [**ImageSetType**](ImageSetType.md) | | [default to undefined]
|
|
11
|
+
**trackingType** | [**TrackingType**](TrackingType.md) | | [optional] [default to undefined]
|
|
12
|
+
**filterType** | [**FilterType**](FilterType.md) | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1CreateImageSetRequest } from '@ourskyai/sda-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1CreateImageSetRequest = {
|
|
20
|
+
nodeId,
|
|
21
|
+
observationId,
|
|
22
|
+
type,
|
|
23
|
+
trackingType,
|
|
24
|
+
filterType,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# V1CreateOrganizationTargetRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**satelliteTargetId** | **string** | | [default to undefined]
|
|
9
|
+
**revisitRateMinutes** | **number** | Desired minutes between revisits. The platform will do a best effort to observe the target at this rate. This is an enterprise feature only. | [optional] [default to undefined]
|
|
10
|
+
**continuousPhotometryEnabled** | **boolean** | Enable continuous photometry mode for this target. Requires the continuous photometry product feature. | [optional] [default to undefined]
|
|
11
|
+
**resolvedImagingEnabled** | **boolean** | Enable resolved imagery collection for this target. Requires the resolved imaging product feature. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1CreateOrganizationTargetRequest } from '@ourskyai/sda-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1CreateOrganizationTargetRequest = {
|
|
19
|
+
satelliteTargetId,
|
|
20
|
+
revisitRateMinutes,
|
|
21
|
+
continuousPhotometryEnabled,
|
|
22
|
+
resolvedImagingEnabled,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|