@ourskyai/sda-api 1.3.8815 → 1.4.123
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,56 @@
|
|
|
1
|
+
# V1ObservationStatus
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**observationId** | **string** | The ID of the observation, null if the observation has not happened yet | [optional] [default to undefined]
|
|
9
|
+
**targetId** | **string** | | [default to undefined]
|
|
10
|
+
**trackingType** | [**TrackingType**](TrackingType.md) | | [optional] [default to undefined]
|
|
11
|
+
**ra** | **number** | The expected RA at the time of the observation, null if the observation has not happened yet | [optional] [default to undefined]
|
|
12
|
+
**dec** | **number** | The expected Dec at the time of the observation, null if the observation has not happened yet | [optional] [default to undefined]
|
|
13
|
+
**observationTime** | **string** | Time the observation was executed at, null if the observation has not happened yet | [optional] [default to undefined]
|
|
14
|
+
**tleLine1** | **string** | TLE line 1 of when the observation was tasked, null if the observation has not happened yet | [optional] [default to undefined]
|
|
15
|
+
**tleLine2** | **string** | TLE line 2 of when the observation was tasked, null if the observation has not happened yet | [optional] [default to undefined]
|
|
16
|
+
**tleEpoch** | **string** | TLE Epoch of when the observation was tasked, null if the observation has not happened yet | [optional] [default to undefined]
|
|
17
|
+
**imageSetId** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**observationSequenceResultId** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**searchInstructionId** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**surveyInstructionId** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**resolvedImageInstructionId** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**directTaskId** | **string** | | [optional] [default to undefined]
|
|
23
|
+
**completedAt** | **string** | The time the observation was completed in our system, null if the observation has not happened yet | [optional] [default to undefined]
|
|
24
|
+
**scheduledAt** | **string** | The time the instruction was scheduled for, if applicable (direct tasked instructions only) | [optional] [default to undefined]
|
|
25
|
+
**validUntil** | **string** | The time the instruction was valid until, if applicable (direct tasked instructions only) | [optional] [default to undefined]
|
|
26
|
+
**state** | [**ObservationState**](ObservationState.md) | | [default to undefined]
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
import { V1ObservationStatus } from '@ourskyai/sda-api';
|
|
32
|
+
|
|
33
|
+
const instance: V1ObservationStatus = {
|
|
34
|
+
observationId,
|
|
35
|
+
targetId,
|
|
36
|
+
trackingType,
|
|
37
|
+
ra,
|
|
38
|
+
dec,
|
|
39
|
+
observationTime,
|
|
40
|
+
tleLine1,
|
|
41
|
+
tleLine2,
|
|
42
|
+
tleEpoch,
|
|
43
|
+
imageSetId,
|
|
44
|
+
observationSequenceResultId,
|
|
45
|
+
searchInstructionId,
|
|
46
|
+
surveyInstructionId,
|
|
47
|
+
resolvedImageInstructionId,
|
|
48
|
+
directTaskId,
|
|
49
|
+
completedAt,
|
|
50
|
+
scheduledAt,
|
|
51
|
+
validUntil,
|
|
52
|
+
state,
|
|
53
|
+
};
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
[[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
|
+
# V1ObservationWeather
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**observed** | [**V1ObservedWeather**](V1ObservedWeather.md) | | [optional] [default to undefined]
|
|
9
|
+
**predicted** | [**V1PredictedWeather**](V1PredictedWeather.md) | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1ObservationWeather } from '@ourskyai/sda-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1ObservationWeather = {
|
|
17
|
+
observed,
|
|
18
|
+
predicted,
|
|
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,23 @@
|
|
|
1
|
+
# V1ObservedWeather
|
|
2
|
+
|
|
3
|
+
Sky condition from the closest all-sky camera image within 15 minutes of the observation. Null if no image was available.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**condition** | [**V1AllSkyPredictionLabel**](V1AllSkyPredictionLabel.md) | | [optional] [default to undefined]
|
|
10
|
+
**confidence** | **number** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1ObservedWeather } from '@ourskyai/sda-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1ObservedWeather = {
|
|
18
|
+
condition,
|
|
19
|
+
confidence,
|
|
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,24 @@
|
|
|
1
|
+
# V1ObserverLocation
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**latitudeRadians** | **number** | | [default to undefined]
|
|
9
|
+
**longitudeRadians** | **number** | | [default to undefined]
|
|
10
|
+
**elevationMeters** | **number** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1ObserverLocation } from '@ourskyai/sda-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1ObserverLocation = {
|
|
18
|
+
latitudeRadians,
|
|
19
|
+
longitudeRadians,
|
|
20
|
+
elevationMeters,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
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)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# V1OrganizationTarget
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**revisitRateMinutes** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**resolvedImagingEnabled** | **boolean** | Whether to automatically create resolved imaging instructions for this target. | [optional] [default to undefined]
|
|
11
|
+
**continuousPhotometryEnabled** | **boolean** | Whether continuous photometry mode is enabled for this target. Requires the continuous photometry product feature. | [optional] [default to undefined]
|
|
12
|
+
**satelliteTarget** | [**V1SatelliteTarget**](V1SatelliteTarget.md) | | [default to undefined]
|
|
13
|
+
**createdBy** | **string** | | [default to undefined]
|
|
14
|
+
**createdAt** | **string** | | [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { V1OrganizationTarget } from '@ourskyai/sda-api';
|
|
20
|
+
|
|
21
|
+
const instance: V1OrganizationTarget = {
|
|
22
|
+
id,
|
|
23
|
+
revisitRateMinutes,
|
|
24
|
+
resolvedImagingEnabled,
|
|
25
|
+
continuousPhotometryEnabled,
|
|
26
|
+
satelliteTarget,
|
|
27
|
+
createdBy,
|
|
28
|
+
createdAt,
|
|
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,12 @@
|
|
|
1
|
+
# V1PassStage
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `RISING` (value: `'rising'`)
|
|
7
|
+
|
|
8
|
+
* `PEAK` (value: `'peak'`)
|
|
9
|
+
|
|
10
|
+
* `FALLING` (value: `'falling'`)
|
|
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,23 @@
|
|
|
1
|
+
# V1PixelCoordinates
|
|
2
|
+
|
|
3
|
+
An (x,y) pixel location in the image
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**x** | **number** | | [default to undefined]
|
|
10
|
+
**y** | **number** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1PixelCoordinates } from '@ourskyai/sda-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1PixelCoordinates = {
|
|
18
|
+
x,
|
|
19
|
+
y,
|
|
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,25 @@
|
|
|
1
|
+
# V1PlaneScanRequest
|
|
2
|
+
|
|
3
|
+
Parameters to create a plane scan to search for a target
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**targetId** | **string** | | [default to undefined]
|
|
10
|
+
**plusMinusAnomalyAngleDegrees** | **number** | The angle in degrees to search around the target\'s anomaly- centered on the target\'s prior position. | [default to undefined]
|
|
11
|
+
**stepSizeDegrees** | **number** | Deprecated. Omit to use dynamic FOV-based tiling instead. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1PlaneScanRequest } from '@ourskyai/sda-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1PlaneScanRequest = {
|
|
19
|
+
targetId,
|
|
20
|
+
plusMinusAnomalyAngleDegrees,
|
|
21
|
+
stepSizeDegrees,
|
|
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,40 @@
|
|
|
1
|
+
# V1PlateSolveResult
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | [**V1PlateSolveStatus**](V1PlateSolveStatus.md) | | [optional] [default to undefined]
|
|
9
|
+
**matchedStars** | [**Array<V1MatchedStar>**](V1MatchedStar.md) | | [optional] [default to undefined]
|
|
10
|
+
**pixelWidth** | **number** | The number of pixels in X directions | [default to undefined]
|
|
11
|
+
**pixelHeight** | **number** | The number of pixels in Y directions | [default to undefined]
|
|
12
|
+
**numberMatchedStars** | **number** | The number of matched stars | [default to undefined]
|
|
13
|
+
**centerRightAscensionRadians** | **number** | In radians, the exact RA center when matched | [default to undefined]
|
|
14
|
+
**centerDeclinationRadians** | **number** | In radians, the exact Dec center when matched | [default to undefined]
|
|
15
|
+
**xSizeRadians** | **number** | The approximate plate size in X-direction, in radians | [default to undefined]
|
|
16
|
+
**ySizeRadians** | **number** | The approximate plate size in Y-direction, in radians | [default to undefined]
|
|
17
|
+
**isMatched** | **boolean** | True if there is a valid plate match | [default to undefined]
|
|
18
|
+
**transformation** | [**V1Transformation**](V1Transformation.md) | | [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { V1PlateSolveResult } from '@ourskyai/sda-api';
|
|
24
|
+
|
|
25
|
+
const instance: V1PlateSolveResult = {
|
|
26
|
+
status,
|
|
27
|
+
matchedStars,
|
|
28
|
+
pixelWidth,
|
|
29
|
+
pixelHeight,
|
|
30
|
+
numberMatchedStars,
|
|
31
|
+
centerRightAscensionRadians,
|
|
32
|
+
centerDeclinationRadians,
|
|
33
|
+
xSizeRadians,
|
|
34
|
+
ySizeRadians,
|
|
35
|
+
isMatched,
|
|
36
|
+
transformation,
|
|
37
|
+
};
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[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
|
+
# V1PlateSolveStatus
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `MATCH_FOUND` (value: `'MATCH_FOUND'`)
|
|
7
|
+
|
|
8
|
+
* `NO_MATCH_FOUND` (value: `'NO_MATCH_FOUND'`)
|
|
9
|
+
|
|
10
|
+
* `CANCELLED` (value: `'CANCELLED'`)
|
|
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)
|
package/docs/V1Point.md
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# V1Point
|
|
2
|
+
|
|
3
|
+
A point in 3D space.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**x** | **number** | The x-coordinate of the point in meters. | [default to undefined]
|
|
10
|
+
**y** | **number** | The y-coordinate of the point in meters. | [default to undefined]
|
|
11
|
+
**z** | **number** | The z-coordinate of the point in meters. | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1Point } from '@ourskyai/sda-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1Point = {
|
|
19
|
+
x,
|
|
20
|
+
y,
|
|
21
|
+
z,
|
|
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,26 @@
|
|
|
1
|
+
# V1PredictedStreakLocation
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**startX** | **number** | | [optional] [default to undefined]
|
|
9
|
+
**startY** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**endX** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**endY** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1PredictedStreakLocation } from '@ourskyai/sda-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1PredictedStreakLocation = {
|
|
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,21 @@
|
|
|
1
|
+
# V1PredictedWeather
|
|
2
|
+
|
|
3
|
+
Sky condition derived from the weather forecast associated with the observation. Null if no forecast was recorded.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**condition** | [**V1AllSkyPredictionLabel**](V1AllSkyPredictionLabel.md) | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1PredictedWeather } from '@ourskyai/sda-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1PredictedWeather = {
|
|
17
|
+
condition,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[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,33 @@
|
|
|
1
|
+
# V1PutOrbitProviderTLERequest
|
|
2
|
+
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**satellite_target_id** | **string** | Existing target id of an OurSky target that you are providing a TLE for. Leave null if one does not exist in the database. | [optional] [default to undefined]
|
|
10
|
+
**tle_line_1** | **string** | | [default to undefined]
|
|
11
|
+
**tle_line_2** | **string** | | [default to undefined]
|
|
12
|
+
**tle_name** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**mass** | **number** | mass in kilograms | [optional] [default to undefined]
|
|
14
|
+
**coefficientOfReflection** | **number** | The Cr value used to calculate acceleration due to solar radiation pressure | [optional] [default to undefined]
|
|
15
|
+
**crossSection** | **number** | cross sectional area in meters^2 | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { V1PutOrbitProviderTLERequest } from '@ourskyai/sda-api';
|
|
21
|
+
|
|
22
|
+
const instance: V1PutOrbitProviderTLERequest = {
|
|
23
|
+
satellite_target_id,
|
|
24
|
+
tle_line_1,
|
|
25
|
+
tle_line_2,
|
|
26
|
+
tle_name,
|
|
27
|
+
mass,
|
|
28
|
+
coefficientOfReflection,
|
|
29
|
+
crossSection,
|
|
30
|
+
};
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
[[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,52 @@
|
|
|
1
|
+
# V1ResolvedImageMetadata
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**imageId** | **string** | | [default to undefined]
|
|
9
|
+
**sharpenedImageId** | **string** | | [default to undefined]
|
|
10
|
+
**imageSetId** | **string** | | [default to undefined]
|
|
11
|
+
**capturedAt** | **string** | | [default to undefined]
|
|
12
|
+
**exposureSeconds** | **number** | | [default to undefined]
|
|
13
|
+
**sharpnessScore** | **number** | | [default to undefined]
|
|
14
|
+
**normalizedSharpnessScore** | **number** | | [optional] [default to undefined]
|
|
15
|
+
**sharpeningMethod** | [**V1SharpeningMethod**](V1SharpeningMethod.md) | | [default to undefined]
|
|
16
|
+
**elevationDeg** | **number** | | [optional] [default to undefined]
|
|
17
|
+
**azimuthDeg** | **number** | | [optional] [default to undefined]
|
|
18
|
+
**rangeMeters** | **number** | | [optional] [default to undefined]
|
|
19
|
+
**passStage** | [**V1PassStage**](V1PassStage.md) | | [optional] [default to undefined]
|
|
20
|
+
**ricAzimuthDeg** | **number** | | [optional] [default to undefined]
|
|
21
|
+
**ricElevationDeg** | **number** | | [optional] [default to undefined]
|
|
22
|
+
**observerPhaseAngleDeg** | **number** | | [optional] [default to undefined]
|
|
23
|
+
**angularResolutionArcsecPerPx** | **number** | | [default to undefined]
|
|
24
|
+
**targetResolutionMetersPerPx** | **number** | | [optional] [default to undefined]
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { V1ResolvedImageMetadata } from '@ourskyai/sda-api';
|
|
30
|
+
|
|
31
|
+
const instance: V1ResolvedImageMetadata = {
|
|
32
|
+
imageId,
|
|
33
|
+
sharpenedImageId,
|
|
34
|
+
imageSetId,
|
|
35
|
+
capturedAt,
|
|
36
|
+
exposureSeconds,
|
|
37
|
+
sharpnessScore,
|
|
38
|
+
normalizedSharpnessScore,
|
|
39
|
+
sharpeningMethod,
|
|
40
|
+
elevationDeg,
|
|
41
|
+
azimuthDeg,
|
|
42
|
+
rangeMeters,
|
|
43
|
+
passStage,
|
|
44
|
+
ricAzimuthDeg,
|
|
45
|
+
ricElevationDeg,
|
|
46
|
+
observerPhaseAngleDeg,
|
|
47
|
+
angularResolutionArcsecPerPx,
|
|
48
|
+
targetResolutionMetersPerPx,
|
|
49
|
+
};
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
[[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,37 @@
|
|
|
1
|
+
# V1ResolvedImageObservation
|
|
2
|
+
|
|
3
|
+
Lightweight summary of a resolved-image observation with the top-9 sharpest thumbnails for grid preview.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**observationId** | **string** | | [default to undefined]
|
|
10
|
+
**imageSetId** | **string** | The image set whose sharpened images this observation produced. Pass this to V1GetResolvedImageSet to get the full unsharpened/sharpened FITS and JPG URLs. | [default to undefined]
|
|
11
|
+
**targetId** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**noradId** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**timeUtc** | **string** | | [default to undefined]
|
|
14
|
+
**sharpenedImageCount** | **number** | Total number of sharpened images for this observation. | [default to undefined]
|
|
15
|
+
**peakAltitudeDeg** | **number** | Maximum observed elevation angle (degrees above horizon) across all sharpened images for this observation. | [optional] [default to undefined]
|
|
16
|
+
**bestResolutionMetersPerPx** | **number** | Best ground-sample-distance achieved during the pass, in meters per pixel. | [optional] [default to undefined]
|
|
17
|
+
**sharpestByAngle** | [**Array<V1ResolvedImagePair>**](V1ResolvedImagePair.md) | Top-9 sharpest images for grid preview. Only the sharpenedThumbnailUrl is populated; full URLs are available via the resolved image set endpoint. | [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { V1ResolvedImageObservation } from '@ourskyai/sda-api';
|
|
23
|
+
|
|
24
|
+
const instance: V1ResolvedImageObservation = {
|
|
25
|
+
observationId,
|
|
26
|
+
imageSetId,
|
|
27
|
+
targetId,
|
|
28
|
+
noradId,
|
|
29
|
+
timeUtc,
|
|
30
|
+
sharpenedImageCount,
|
|
31
|
+
peakAltitudeDeg,
|
|
32
|
+
bestResolutionMetersPerPx,
|
|
33
|
+
sharpestByAngle,
|
|
34
|
+
};
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[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,41 @@
|
|
|
1
|
+
# V1ResolvedImagePair
|
|
2
|
+
|
|
3
|
+
A paired unsharpened and sharpened image from resolved imaging, with viewing geometry.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**unsharpenedImageId** | **string** | | [default to undefined]
|
|
10
|
+
**sharpenedImageId** | **string** | | [default to undefined]
|
|
11
|
+
**unsharpenedImageUrl** | **string** | Presigned URL for the unsharpened FITS image. | [optional] [default to undefined]
|
|
12
|
+
**unsharpenedJpgUrl** | **string** | Presigned URL for the unsharpened JPG image. | [optional] [default to undefined]
|
|
13
|
+
**sharpenedImageUrl** | **string** | Presigned URL for the sharpened FITS image. | [optional] [default to undefined]
|
|
14
|
+
**sharpenedJpgUrl** | **string** | Presigned URL for the sharpened JPG image. | [optional] [default to undefined]
|
|
15
|
+
**sharpenedThumbnailUrl** | **string** | Presigned URL for the sharpened thumbnail image. | [optional] [default to undefined]
|
|
16
|
+
**featureSharpnessScore** | **number** | Sharpness score from resolved image processing. Null if scoring failed. | [optional] [default to undefined]
|
|
17
|
+
**normalizedSharpnessScore** | **number** | | [optional] [default to undefined]
|
|
18
|
+
**elevationDeg** | **number** | | [optional] [default to undefined]
|
|
19
|
+
**passStage** | [**V1PassStage**](V1PassStage.md) | | [optional] [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { V1ResolvedImagePair } from '@ourskyai/sda-api';
|
|
25
|
+
|
|
26
|
+
const instance: V1ResolvedImagePair = {
|
|
27
|
+
unsharpenedImageId,
|
|
28
|
+
sharpenedImageId,
|
|
29
|
+
unsharpenedImageUrl,
|
|
30
|
+
unsharpenedJpgUrl,
|
|
31
|
+
sharpenedImageUrl,
|
|
32
|
+
sharpenedJpgUrl,
|
|
33
|
+
sharpenedThumbnailUrl,
|
|
34
|
+
featureSharpnessScore,
|
|
35
|
+
normalizedSharpnessScore,
|
|
36
|
+
elevationDeg,
|
|
37
|
+
passStage,
|
|
38
|
+
};
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
[[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,25 @@
|
|
|
1
|
+
# V1ResolvedImageSet
|
|
2
|
+
|
|
3
|
+
A resolved image set containing paired unsharpened and sharpened images with sharpness scores.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**unsharpenedImageSetId** | **string** | | [default to undefined]
|
|
10
|
+
**images** | [**Array<V1ResolvedImagePair>**](V1ResolvedImagePair.md) | | [default to undefined]
|
|
11
|
+
**sharpestByAngle** | [**Array<V1ResolvedImagePair>**](V1ResolvedImagePair.md) | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { V1ResolvedImageSet } from '@ourskyai/sda-api';
|
|
17
|
+
|
|
18
|
+
const instance: V1ResolvedImageSet = {
|
|
19
|
+
unsharpenedImageSetId,
|
|
20
|
+
images,
|
|
21
|
+
sharpestByAngle,
|
|
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,29 @@
|
|
|
1
|
+
# V1RicVolumeSearchRequest
|
|
2
|
+
|
|
3
|
+
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
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**targetId** | **string** | | [default to undefined]
|
|
10
|
+
**radial3SigmaMeters** | **number** | The radial 3-sigma uncertainty in meters | [default to undefined]
|
|
11
|
+
**intrack3SigmaMeters** | **number** | The intrack 3-sigma uncertainty in meters | [default to undefined]
|
|
12
|
+
**crosstrack3SigmaMeters** | **number** | The crosstrack 3-sigma uncertainty in meters | [default to undefined]
|
|
13
|
+
**ricStdevEpoch** | **string** | The epoch of the RIC standard deviation- if none is provided the current time is used | [optional] [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { V1RicVolumeSearchRequest } from '@ourskyai/sda-api';
|
|
19
|
+
|
|
20
|
+
const instance: V1RicVolumeSearchRequest = {
|
|
21
|
+
targetId,
|
|
22
|
+
radial3SigmaMeters,
|
|
23
|
+
intrack3SigmaMeters,
|
|
24
|
+
crosstrack3SigmaMeters,
|
|
25
|
+
ricStdevEpoch,
|
|
26
|
+
};
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
[[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,40 @@
|
|
|
1
|
+
# V1SIPCoefficients
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**order** | **number** | Order of the SIP transformation | [default to undefined]
|
|
9
|
+
**A** | **Array<Array<number>>** | Forward SIP coefficients matrix A | [default to undefined]
|
|
10
|
+
**B** | **Array<Array<number>>** | Forward SIP coefficients matrix B | [default to undefined]
|
|
11
|
+
**CD1_1** | **number** | Coordinate description matrix element (1,1) - maps pixel coordinates to sky coordinates in degrees, encapsulating scale, rotation and skew | [default to undefined]
|
|
12
|
+
**CD1_2** | **number** | Coordinate description matrix element (1,2) - maps pixel coordinates to sky coordinates in degrees, encapsulating scale, rotation and skew | [default to undefined]
|
|
13
|
+
**CD2_1** | **number** | Coordinate description matrix element (2,1) - maps pixel coordinates to sky coordinates in degrees, encapsulating scale, rotation and skew | [default to undefined]
|
|
14
|
+
**CD2_2** | **number** | Coordinate description matrix element (2,2) - maps pixel coordinates to sky coordinates in degrees, encapsulating scale, rotation and skew | [default to undefined]
|
|
15
|
+
**coordinateReferencePixelX** | **number** | X coordinate of the reference pixel | [default to undefined]
|
|
16
|
+
**coordinateReferencePixelY** | **number** | Y coordinate of the reference pixel | [default to undefined]
|
|
17
|
+
**coordinateReferenceRADegrees** | **number** | Right ascension of the reference coordinate in degrees | [default to undefined]
|
|
18
|
+
**coordinateReferenceDecDegrees** | **number** | Declination of the reference coordinate in degrees | [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { V1SIPCoefficients } from '@ourskyai/sda-api';
|
|
24
|
+
|
|
25
|
+
const instance: V1SIPCoefficients = {
|
|
26
|
+
order,
|
|
27
|
+
A,
|
|
28
|
+
B,
|
|
29
|
+
CD1_1,
|
|
30
|
+
CD1_2,
|
|
31
|
+
CD2_1,
|
|
32
|
+
CD2_2,
|
|
33
|
+
coordinateReferencePixelX,
|
|
34
|
+
coordinateReferencePixelY,
|
|
35
|
+
coordinateReferenceRADegrees,
|
|
36
|
+
coordinateReferenceDecDegrees,
|
|
37
|
+
};
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[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
|
+
# V1SatelliteCalibrationFamily
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `GPS` (value: `'GPS'`)
|
|
7
|
+
|
|
8
|
+
* `ILRS` (value: `'ILRS'`)
|
|
9
|
+
|
|
10
|
+
* `SWARM` (value: `'SWARM'`)
|
|
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)
|