@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
package/docs/V2Search.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# V2Search
|
|
2
|
+
|
|
3
|
+
V2 Search- created by either RIC volumetric search or plane scan.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**searchId** | **string** | | [default to undefined]
|
|
10
|
+
**targetId** | **string** | | [default to undefined]
|
|
11
|
+
**completedAt** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**completedReason** | [**SearchCompletedReason**](SearchCompletedReason.md) | | [optional] [default to undefined]
|
|
13
|
+
**observationSequenceResultIds** | **Array<string>** | | [default to undefined]
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import { V2Search } from '@ourskyai/sda-api';
|
|
19
|
+
|
|
20
|
+
const instance: V2Search = {
|
|
21
|
+
searchId,
|
|
22
|
+
targetId,
|
|
23
|
+
completedAt,
|
|
24
|
+
completedReason,
|
|
25
|
+
observationSequenceResultIds,
|
|
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,20 @@
|
|
|
1
|
+
# WeatherCondition
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `THUNDERSTORM` (value: `'THUNDERSTORM'`)
|
|
7
|
+
|
|
8
|
+
* `DRIZZLE` (value: `'DRIZZLE'`)
|
|
9
|
+
|
|
10
|
+
* `RAIN` (value: `'RAIN'`)
|
|
11
|
+
|
|
12
|
+
* `SNOW` (value: `'SNOW'`)
|
|
13
|
+
|
|
14
|
+
* `ATMOSPHERE` (value: `'ATMOSPHERE'`)
|
|
15
|
+
|
|
16
|
+
* `CLEAR` (value: `'CLEAR'`)
|
|
17
|
+
|
|
18
|
+
* `CLOUDS` (value: `'CLOUDS'`)
|
|
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,13 @@
|
|
|
1
|
+
# WebhookAuthType
|
|
2
|
+
|
|
3
|
+
Authorization mechanism required for webhook endpoint, if any. Use `NONE` if not required.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `NONE` (value: `'NONE'`)
|
|
8
|
+
|
|
9
|
+
* `BASIC` (value: `'BASIC'`)
|
|
10
|
+
|
|
11
|
+
* `BEARER` (value: `'BEARER'`)
|
|
12
|
+
|
|
13
|
+
[[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,35 @@
|
|
|
1
|
+
# WebhookEvent
|
|
2
|
+
|
|
3
|
+
Webhook events that can be subscribed to. For `EO_OBSERVATION` events, please refer to the Unified Data Library for the full schema.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `V1_TDM_CREATED` (value: `'V1_TDM_CREATED'`)
|
|
8
|
+
|
|
9
|
+
* `V1_OBSERVATION_SEQUENCE_RESULT_CREATED` (value: `'V1_OBSERVATION_SEQUENCE_RESULT_CREATED'`)
|
|
10
|
+
|
|
11
|
+
* `V1_OBSERVATION_CREATED` (value: `'V1_OBSERVATION_CREATED'`)
|
|
12
|
+
|
|
13
|
+
* `V1_IMAGE_CREATED` (value: `'V1_IMAGE_CREATED'`)
|
|
14
|
+
|
|
15
|
+
* `V1_STREAK_CREATED` (value: `'V1_STREAK_CREATED'`)
|
|
16
|
+
|
|
17
|
+
* `V1_SATELLITE_TARGET_TRACKING_DEACTIVATED` (value: `'V1_SATELLITE_TARGET_TRACKING_DEACTIVATED'`)
|
|
18
|
+
|
|
19
|
+
* `V1_EO_OBSERVATION_CREATED` (value: `'V1_EO_OBSERVATION_CREATED'`)
|
|
20
|
+
|
|
21
|
+
* `V1_OBSERVATION_STATUS_UPDATED` (value: `'V1_OBSERVATION_STATUS_UPDATED'`)
|
|
22
|
+
|
|
23
|
+
* `V1_EO_CALIBRATION_OBSERVATION_CREATED` (value: `'V1_EO_CALIBRATION_OBSERVATION_CREATED'`)
|
|
24
|
+
|
|
25
|
+
* `V1_NODE_CALIBRATION_DATA_CREATED` (value: `'V1_NODE_CALIBRATION_DATA_CREATED'`)
|
|
26
|
+
|
|
27
|
+
* `V1_NODE_UPDATED` (value: `'V1_NODE_UPDATED'`)
|
|
28
|
+
|
|
29
|
+
* `V1_EO_SKY_IMAGERY_CREATED` (value: `'V1_EO_SKY_IMAGERY_CREATED'`)
|
|
30
|
+
|
|
31
|
+
* `V2_SEARCH_COMPLETED` (value: `'V2_SEARCH_COMPLETED'`)
|
|
32
|
+
|
|
33
|
+
* `V1_UCT_CREATED` (value: `'V1_UCT_CREATED'`)
|
|
34
|
+
|
|
35
|
+
[[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/index.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* OurSky SDA
|
|
5
5
|
* 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 1.
|
|
7
|
+
* The version of the OpenAPI document: 1.4.123
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ourskyai/sda-api",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.4.123",
|
|
4
4
|
"description": "OpenAPI client for @ourskyai/sda-api",
|
|
5
5
|
"author": "OpenAPI-Generator Contributors",
|
|
6
6
|
"repository": {
|
|
@@ -24,10 +24,10 @@
|
|
|
24
24
|
"prepare": "npm run build"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"axios": "^
|
|
27
|
+
"axios": "^1.6.1"
|
|
28
28
|
},
|
|
29
29
|
"devDependencies": {
|
|
30
|
-
"@types/node": "
|
|
31
|
-
"typescript": "^4.0"
|
|
30
|
+
"@types/node": "12.11.5 - 12.20.42",
|
|
31
|
+
"typescript": "^4.0 || ^5.0"
|
|
32
32
|
}
|
|
33
33
|
}
|