@ourskyai/astro-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 +76 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +155 -4
- package/api.ts +869 -3218
- package/base.ts +14 -24
- package/common.ts +20 -44
- package/configuration.ts +37 -17
- package/dist/api.d.ts +449 -2852
- package/dist/api.js +640 -619
- 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 +449 -2852
- package/dist/esm/api.js +640 -619
- 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/AssetFileType.md +18 -0
- package/docs/AssetType.md +16 -0
- package/docs/CalibrationMasterType.md +12 -0
- package/docs/DailyWeatherCity.md +22 -0
- package/docs/DailyWeatherForecastItem.md +40 -0
- package/docs/DailyWeatherForecastItemTemp.md +26 -0
- package/docs/DailyWeatherForecastItemWeatherInner.md +26 -0
- package/docs/DailyWeatherForecastListResponse.md +22 -0
- package/docs/DefaultApi.md +2560 -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/IntegrationTime.md +27 -0
- package/docs/Location.md +25 -0
- package/docs/MountGeometry.md +10 -0
- package/docs/MountType.md +10 -0
- package/docs/NodeState.md +20 -0
- package/docs/OpticalTubeType.md +16 -0
- package/docs/ShutterType.md +10 -0
- package/docs/SuccessfulCreate.md +20 -0
- package/docs/TrackingType.md +12 -0
- package/docs/V1AstroProject.md +43 -0
- package/docs/V1AstroProjectAsset.md +41 -0
- package/docs/V1AstroProjectAssetMetadata.md +22 -0
- package/docs/V1AstroProjectAssetMetadataColorCombination.md +24 -0
- package/docs/V1AstroProjectJobLog.md +31 -0
- package/docs/V1AstroTarget.md +33 -0
- package/docs/V1CalibrationMaster.md +43 -0
- package/docs/V1Camera.md +47 -0
- package/docs/V1CreateAstroProjectImageSetRequest.md +24 -0
- package/docs/V1CreateAstroProjectRequest.md +30 -0
- package/docs/V1CreateAstroProjectResponse.md +23 -0
- package/docs/V1CreateCalibrationMasterRequest.md +42 -0
- package/docs/V1CreateCalibrationMasterResponse.md +22 -0
- package/docs/V1CreateCalibrationSetImageRequest.md +22 -0
- package/docs/V1CreateCalibrationSetImageResponse.md +22 -0
- package/docs/V1CreateCalibrationSetRequest.md +40 -0
- package/docs/V1CreateCalibrationSetResponse.md +20 -0
- package/docs/V1CreateImageSetImageRequest.md +32 -0
- package/docs/V1CreateImageSetImageResponse.md +23 -0
- package/docs/V1CreateImageSetRequest.md +28 -0
- package/docs/V1CreateNodeRequest.md +37 -0
- package/docs/V1CreateOpticalTrainInstanceRequest.md +28 -0
- package/docs/V1ElevationMaskPoint.md +25 -0
- package/docs/V1Focuser.md +27 -0
- package/docs/V1GainCurve.md +25 -0
- package/docs/V1GainCurvePoint.md +22 -0
- package/docs/V1GetAstroPlatformCreditBalanceResponse.md +21 -0
- package/docs/V1GetNodes.md +20 -0
- package/docs/V1GetOrCreateCameraRequest.md +60 -0
- package/docs/V1GetOrCreateFocuserRequest.md +24 -0
- package/docs/V1GetOrCreateMountRequest.md +24 -0
- package/docs/V1GetOrCreateOpticalTubeRequest.md +26 -0
- package/docs/V1ImageFileType.md +10 -0
- package/docs/V1ImageRejectionReason.md +64 -0
- package/docs/V1ImageSet.md +43 -0
- package/docs/V1ImageSetImage.md +77 -0
- package/docs/V1JobStatus.md +16 -0
- package/docs/V1Mount.md +23 -0
- package/docs/V1Node.md +59 -0
- package/docs/V1NodeWithLocation.md +23 -0
- package/docs/V1OpticalTrainInstance.md +43 -0
- package/docs/V1OpticalTube.md +27 -0
- package/docs/V1PlatformCredit.md +37 -0
- package/docs/V1PlatformCreditSource.md +14 -0
- package/docs/V1PlatformCreditType.md +8 -0
- package/docs/V1PlatformCreditUnit.md +8 -0
- package/docs/V1PredictedStreakLocation.md +26 -0
- package/docs/V1PutStackAstroProjectRequest.md +20 -0
- package/docs/V1PutStackAstroProjectResponse.md +23 -0
- package/docs/V1ReadNoisePoint.md +22 -0
- package/docs/V1SetupAction.md +23 -0
- package/docs/V1UpdateNodeRequest.md +51 -0
- package/docs/V1VideoModeFramerateProperty.md +28 -0
- package/docs/V2UpdateNodeRequest.md +43 -0
- package/index.ts +1 -1
- package/package.json +4 -4
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# V1ImageRejectionReason
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `TARGET_NOT_FOUND` (value: `'TARGET_NOT_FOUND'`)
|
|
7
|
+
|
|
8
|
+
* `RATE_TARGET_NOT_FOUND` (value: `'RATE_TARGET_NOT_FOUND'`)
|
|
9
|
+
|
|
10
|
+
* `RATE_PLATE_SOLVE_FAILURE` (value: `'RATE_PLATE_SOLVE_FAILURE'`)
|
|
11
|
+
|
|
12
|
+
* `STREAK_DETECTION_FAILURE` (value: `'STREAK_DETECTION_FAILURE'`)
|
|
13
|
+
|
|
14
|
+
* `PLATE_SOLVE_FAILURE` (value: `'PLATE_SOLVE_FAILURE'`)
|
|
15
|
+
|
|
16
|
+
* `PLATE_SOLVE_NOT_ENOUGH_STARS_FAILURE` (value: `'PLATE_SOLVE_NOT_ENOUGH_STARS_FAILURE'`)
|
|
17
|
+
|
|
18
|
+
* `PLATE_SOLVE_NO_SOLUTION_FAILURE` (value: `'PLATE_SOLVE_NO_SOLUTION_FAILURE'`)
|
|
19
|
+
|
|
20
|
+
* `CROP_IMAGE_FAILURE` (value: `'CROP_IMAGE_FAILURE'`)
|
|
21
|
+
|
|
22
|
+
* `COSMETIC_CORRECTION_FAILURE` (value: `'COSMETIC_CORRECTION_FAILURE'`)
|
|
23
|
+
|
|
24
|
+
* `GRADIENT_REMOVAL_FAILURE` (value: `'GRADIENT_REMOVAL_FAILURE'`)
|
|
25
|
+
|
|
26
|
+
* `CATMAG_FAILURE` (value: `'CATMAG_FAILURE'`)
|
|
27
|
+
|
|
28
|
+
* `IMAGE_QUALITY_TOO_LOW` (value: `'IMAGE_QUALITY_TOO_LOW'`)
|
|
29
|
+
|
|
30
|
+
* `OBSERVATION_NOT_FOUND` (value: `'OBSERVATION_NOT_FOUND'`)
|
|
31
|
+
|
|
32
|
+
* `NODE_NOT_FOUND` (value: `'NODE_NOT_FOUND'`)
|
|
33
|
+
|
|
34
|
+
* `CAMERA_NOT_FOUND` (value: `'CAMERA_NOT_FOUND'`)
|
|
35
|
+
|
|
36
|
+
* `OTA_NOT_FOUND` (value: `'OTA_NOT_FOUND'`)
|
|
37
|
+
|
|
38
|
+
* `TLE_NOT_EXTRACTED` (value: `'TLE_NOT_EXTRACTED'`)
|
|
39
|
+
|
|
40
|
+
* `FAILED_TO_LOAD` (value: `'FAILED_TO_LOAD'`)
|
|
41
|
+
|
|
42
|
+
* `GPS_ERROR` (value: `'GPS_ERROR'`)
|
|
43
|
+
|
|
44
|
+
* `MUTEX_TIMEOUT` (value: `'MUTEX_TIMEOUT'`)
|
|
45
|
+
|
|
46
|
+
* `AWAIT_TIMEOUT` (value: `'AWAIT_TIMEOUT'`)
|
|
47
|
+
|
|
48
|
+
* `CATALOG_COMPARE_ERROR` (value: `'CATALOG_COMPARE_ERROR'`)
|
|
49
|
+
|
|
50
|
+
* `SAVE_FAILURE` (value: `'SAVE_FAILURE'`)
|
|
51
|
+
|
|
52
|
+
* `RATE_CATALOG_COMPARE_ERROR` (value: `'RATE_CATALOG_COMPARE_ERROR'`)
|
|
53
|
+
|
|
54
|
+
* `MISSING_IMG_WIDTH_HEADER` (value: `'MISSING_IMG_WIDTH_HEADER'`)
|
|
55
|
+
|
|
56
|
+
* `CALIBRATION_FAILURE` (value: `'CALIBRATION_FAILURE'`)
|
|
57
|
+
|
|
58
|
+
* `HOT_PIXEL_REMOVAL_FAILURE` (value: `'HOT_PIXEL_REMOVAL_FAILURE'`)
|
|
59
|
+
|
|
60
|
+
* `PIPELINE_TIMEOUT` (value: `'PIPELINE_TIMEOUT'`)
|
|
61
|
+
|
|
62
|
+
* `UNKNOWN_ERROR` (value: `'UNKNOWN_ERROR'`)
|
|
63
|
+
|
|
64
|
+
[[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,43 @@
|
|
|
1
|
+
# V1ImageSet
|
|
2
|
+
|
|
3
|
+
An image set represents a contiguous set of observations of the same target captured by the same node.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | | [default to undefined]
|
|
10
|
+
**targetId** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**ra** | **number** | | [optional] [default to undefined]
|
|
12
|
+
**dec** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**nodeId** | **string** | | [default to undefined]
|
|
14
|
+
**observationId** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**trackingType** | [**TrackingType**](TrackingType.md) | | [default to undefined]
|
|
16
|
+
**filterType** | [**FilterType**](FilterType.md) | | [optional] [default to undefined]
|
|
17
|
+
**createdAt** | **string** | | [default to undefined]
|
|
18
|
+
**updatedAt** | **string** | | [optional] [default to undefined]
|
|
19
|
+
**ourskyPluginVersion** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**isResolved** | **boolean** | True if this image set is from a resolved imaging observation. | [optional] [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { V1ImageSet } from '@ourskyai/astro-api';
|
|
26
|
+
|
|
27
|
+
const instance: V1ImageSet = {
|
|
28
|
+
id,
|
|
29
|
+
targetId,
|
|
30
|
+
ra,
|
|
31
|
+
dec,
|
|
32
|
+
nodeId,
|
|
33
|
+
observationId,
|
|
34
|
+
trackingType,
|
|
35
|
+
filterType,
|
|
36
|
+
createdAt,
|
|
37
|
+
updatedAt,
|
|
38
|
+
ourskyPluginVersion,
|
|
39
|
+
isResolved,
|
|
40
|
+
};
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
[[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,77 @@
|
|
|
1
|
+
# V1ImageSetImage
|
|
2
|
+
|
|
3
|
+
Image Set Image
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | | [default to undefined]
|
|
10
|
+
**thumbnailUrl** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**imageUrl** | **string** | | [default to undefined]
|
|
12
|
+
**fullJpgUrl** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**nodeId** | **string** | | [default to undefined]
|
|
14
|
+
**targetId** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**ra** | **number** | | [optional] [default to undefined]
|
|
16
|
+
**dec** | **number** | | [optional] [default to undefined]
|
|
17
|
+
**imageSetId** | **string** | | [default to undefined]
|
|
18
|
+
**darkCalibrated** | **boolean** | | [default to undefined]
|
|
19
|
+
**flatCalibrated** | **boolean** | | [default to undefined]
|
|
20
|
+
**biasCalibrated** | **boolean** | | [default to undefined]
|
|
21
|
+
**fwhmAverage** | **number** | | [optional] [default to undefined]
|
|
22
|
+
**fwhmStdDev** | **number** | | [optional] [default to undefined]
|
|
23
|
+
**fwhmAngle** | **number** | | [optional] [default to undefined]
|
|
24
|
+
**raOffset** | **number** | | [optional] [default to undefined]
|
|
25
|
+
**decOffset** | **number** | | [optional] [default to undefined]
|
|
26
|
+
**totalOffset** | **number** | | [optional] [default to undefined]
|
|
27
|
+
**totalOffsetStdDev** | **number** | | [optional] [default to undefined]
|
|
28
|
+
**totalOffsetRMS** | **number** | | [optional] [default to undefined]
|
|
29
|
+
**capturedAt** | **string** | | [default to undefined]
|
|
30
|
+
**createdAt** | **string** | | [default to undefined]
|
|
31
|
+
**binning** | **number** | | [optional] [default to undefined]
|
|
32
|
+
**exposureLength** | **number** | | [default to undefined]
|
|
33
|
+
**fitsHeaders** | [**Array<FitsHeader>**](FitsHeader.md) | | [default to undefined]
|
|
34
|
+
**predictedStreakLocation** | [**V1PredictedStreakLocation**](V1PredictedStreakLocation.md) | | [optional] [default to undefined]
|
|
35
|
+
**rejectedReason** | [**V1ImageRejectionReason**](V1ImageRejectionReason.md) | | [optional] [default to undefined]
|
|
36
|
+
**featureSharpnessScore** | **number** | Sharpness score from resolved image processing. Null for non-resolved images. | [optional] [default to undefined]
|
|
37
|
+
**executionEnvironment** | **string** | | [optional] [default to undefined]
|
|
38
|
+
|
|
39
|
+
## Example
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
import { V1ImageSetImage } from '@ourskyai/astro-api';
|
|
43
|
+
|
|
44
|
+
const instance: V1ImageSetImage = {
|
|
45
|
+
id,
|
|
46
|
+
thumbnailUrl,
|
|
47
|
+
imageUrl,
|
|
48
|
+
fullJpgUrl,
|
|
49
|
+
nodeId,
|
|
50
|
+
targetId,
|
|
51
|
+
ra,
|
|
52
|
+
dec,
|
|
53
|
+
imageSetId,
|
|
54
|
+
darkCalibrated,
|
|
55
|
+
flatCalibrated,
|
|
56
|
+
biasCalibrated,
|
|
57
|
+
fwhmAverage,
|
|
58
|
+
fwhmStdDev,
|
|
59
|
+
fwhmAngle,
|
|
60
|
+
raOffset,
|
|
61
|
+
decOffset,
|
|
62
|
+
totalOffset,
|
|
63
|
+
totalOffsetStdDev,
|
|
64
|
+
totalOffsetRMS,
|
|
65
|
+
capturedAt,
|
|
66
|
+
createdAt,
|
|
67
|
+
binning,
|
|
68
|
+
exposureLength,
|
|
69
|
+
fitsHeaders,
|
|
70
|
+
predictedStreakLocation,
|
|
71
|
+
rejectedReason,
|
|
72
|
+
featureSharpnessScore,
|
|
73
|
+
executionEnvironment,
|
|
74
|
+
};
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
[[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
|
+
# V1JobStatus
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `PENDING` (value: `'PENDING'`)
|
|
7
|
+
|
|
8
|
+
* `RUNNING` (value: `'RUNNING'`)
|
|
9
|
+
|
|
10
|
+
* `SUCCEEDED` (value: `'SUCCEEDED'`)
|
|
11
|
+
|
|
12
|
+
* `CANCELLED` (value: `'CANCELLED'`)
|
|
13
|
+
|
|
14
|
+
* `FAILED` (value: `'FAILED'`)
|
|
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)
|
package/docs/V1Mount.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# V1Mount
|
|
2
|
+
|
|
3
|
+
Mount
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | | [default to undefined]
|
|
10
|
+
**model** | **string** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1Mount } from '@ourskyai/astro-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1Mount = {
|
|
18
|
+
id,
|
|
19
|
+
model,
|
|
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)
|
package/docs/V1Node.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# V1Node
|
|
2
|
+
|
|
3
|
+
Node
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**name** | **string** | | [default to undefined]
|
|
10
|
+
**observatoryId** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**organizationId** | **string** | | [default to undefined]
|
|
12
|
+
**cameraId** | **string** | | [default to undefined]
|
|
13
|
+
**opticalTubeId** | **string** | | [default to undefined]
|
|
14
|
+
**mountId** | **string** | | [default to undefined]
|
|
15
|
+
**mountInstanceId** | **string** | | [default to undefined]
|
|
16
|
+
**opticalTrainInstanceIds** | **Array<string>** | | [default to undefined]
|
|
17
|
+
**filterWheelId** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**minAltitude** | **number** | | [default to undefined]
|
|
19
|
+
**elevationMask** | [**Array<V1ElevationMaskPoint>**](V1ElevationMaskPoint.md) | | [optional] [default to undefined]
|
|
20
|
+
**createdAt** | **string** | | [default to undefined]
|
|
21
|
+
**updatedAt** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**state** | [**NodeState**](NodeState.md) | | [optional] [default to undefined]
|
|
23
|
+
**id** | **string** | | [default to undefined]
|
|
24
|
+
**lineageId** | **string** | | [default to undefined]
|
|
25
|
+
**nodeControllerId** | **string** | | [optional] [default to undefined]
|
|
26
|
+
**location** | [**Location**](Location.md) | | [default to undefined]
|
|
27
|
+
**canonicalName** | **string** | | [optional] [default to undefined]
|
|
28
|
+
**betaSoftwareReleaseChannelUpdatesEnabled** | **boolean** | | [optional] [default to undefined]
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import { V1Node } from '@ourskyai/astro-api';
|
|
34
|
+
|
|
35
|
+
const instance: V1Node = {
|
|
36
|
+
name,
|
|
37
|
+
observatoryId,
|
|
38
|
+
organizationId,
|
|
39
|
+
cameraId,
|
|
40
|
+
opticalTubeId,
|
|
41
|
+
mountId,
|
|
42
|
+
mountInstanceId,
|
|
43
|
+
opticalTrainInstanceIds,
|
|
44
|
+
filterWheelId,
|
|
45
|
+
minAltitude,
|
|
46
|
+
elevationMask,
|
|
47
|
+
createdAt,
|
|
48
|
+
updatedAt,
|
|
49
|
+
state,
|
|
50
|
+
id,
|
|
51
|
+
lineageId,
|
|
52
|
+
nodeControllerId,
|
|
53
|
+
location,
|
|
54
|
+
canonicalName,
|
|
55
|
+
betaSoftwareReleaseChannelUpdatesEnabled,
|
|
56
|
+
};
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
[[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
|
+
# V1NodeWithLocation
|
|
2
|
+
|
|
3
|
+
Node with location
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**node** | [**V1Node**](V1Node.md) | | [default to undefined]
|
|
10
|
+
**location** | [**Location**](Location.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1NodeWithLocation } from '@ourskyai/astro-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1NodeWithLocation = {
|
|
18
|
+
node,
|
|
19
|
+
location,
|
|
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,43 @@
|
|
|
1
|
+
# V1OpticalTrainInstance
|
|
2
|
+
|
|
3
|
+
An optical train instance configuration.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | | [default to undefined]
|
|
10
|
+
**cameraInstanceId** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**rotatorInstanceId** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**filterWheelInstanceId** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**focuserInstanceId** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**opticalTubeInstanceId** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**createdAt** | **string** | | [default to undefined]
|
|
16
|
+
**createdBy** | **string** | | [default to undefined]
|
|
17
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
18
|
+
**updatedBy** | **string** | | [default to undefined]
|
|
19
|
+
**deletedAt** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**deletedBy** | **string** | | [optional] [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { V1OpticalTrainInstance } from '@ourskyai/astro-api';
|
|
26
|
+
|
|
27
|
+
const instance: V1OpticalTrainInstance = {
|
|
28
|
+
id,
|
|
29
|
+
cameraInstanceId,
|
|
30
|
+
rotatorInstanceId,
|
|
31
|
+
filterWheelInstanceId,
|
|
32
|
+
focuserInstanceId,
|
|
33
|
+
opticalTubeInstanceId,
|
|
34
|
+
createdAt,
|
|
35
|
+
createdBy,
|
|
36
|
+
updatedAt,
|
|
37
|
+
updatedBy,
|
|
38
|
+
deletedAt,
|
|
39
|
+
deletedBy,
|
|
40
|
+
};
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
[[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,27 @@
|
|
|
1
|
+
# V1OpticalTube
|
|
2
|
+
|
|
3
|
+
Optical Tube
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | | [default to undefined]
|
|
10
|
+
**model** | **string** | | [default to undefined]
|
|
11
|
+
**focalLengthMm** | **number** | | [default to undefined]
|
|
12
|
+
**apertureMm** | **number** | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1OpticalTube } from '@ourskyai/astro-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1OpticalTube = {
|
|
20
|
+
id,
|
|
21
|
+
model,
|
|
22
|
+
focalLengthMm,
|
|
23
|
+
apertureMm,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[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
|
+
# V1PlatformCredit
|
|
2
|
+
|
|
3
|
+
Platform Credit
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | | [default to undefined]
|
|
10
|
+
**organization** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**type** | [**V1PlatformCreditType**](V1PlatformCreditType.md) | | [default to undefined]
|
|
12
|
+
**unit** | [**V1PlatformCreditUnit**](V1PlatformCreditUnit.md) | | [default to undefined]
|
|
13
|
+
**source** | [**V1PlatformCreditSource**](V1PlatformCreditSource.md) | | [default to undefined]
|
|
14
|
+
**amount** | **number** | | [default to undefined]
|
|
15
|
+
**createdBy** | **string** | | [default to undefined]
|
|
16
|
+
**createdAt** | **string** | | [default to undefined]
|
|
17
|
+
**updatedAt** | **string** | | [default to undefined]
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import { V1PlatformCredit } from '@ourskyai/astro-api';
|
|
23
|
+
|
|
24
|
+
const instance: V1PlatformCredit = {
|
|
25
|
+
id,
|
|
26
|
+
organization,
|
|
27
|
+
type,
|
|
28
|
+
unit,
|
|
29
|
+
source,
|
|
30
|
+
amount,
|
|
31
|
+
createdBy,
|
|
32
|
+
createdAt,
|
|
33
|
+
updatedAt,
|
|
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,14 @@
|
|
|
1
|
+
# V1PlatformCreditSource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `SIGNUP` (value: `'SIGNUP'`)
|
|
7
|
+
|
|
8
|
+
* `OSR_CONTRIBUTION` (value: `'OSR_CONTRIBUTION'`)
|
|
9
|
+
|
|
10
|
+
* `STACKING` (value: `'STACKING'`)
|
|
11
|
+
|
|
12
|
+
* `ADMIN` (value: `'ADMIN'`)
|
|
13
|
+
|
|
14
|
+
[[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/astro-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,20 @@
|
|
|
1
|
+
# V1PutStackAstroProjectRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**projectId** | **string** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { V1PutStackAstroProjectRequest } from '@ourskyai/astro-api';
|
|
14
|
+
|
|
15
|
+
const instance: V1PutStackAstroProjectRequest = {
|
|
16
|
+
projectId,
|
|
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,23 @@
|
|
|
1
|
+
# V1PutStackAstroProjectResponse
|
|
2
|
+
|
|
3
|
+
Stack Astro Project Response
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**jobId** | **string** | | [default to undefined]
|
|
10
|
+
**jobName** | **string** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1PutStackAstroProjectResponse } from '@ourskyai/astro-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1PutStackAstroProjectResponse = {
|
|
18
|
+
jobId,
|
|
19
|
+
jobName,
|
|
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,22 @@
|
|
|
1
|
+
# V1ReadNoisePoint
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**gain** | **number** | | [default to undefined]
|
|
9
|
+
**eRMS** | **number** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { V1ReadNoisePoint } from '@ourskyai/astro-api';
|
|
15
|
+
|
|
16
|
+
const instance: V1ReadNoisePoint = {
|
|
17
|
+
gain,
|
|
18
|
+
eRMS,
|
|
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
|
+
# V1SetupAction
|
|
2
|
+
|
|
3
|
+
Setup Action
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**action** | **string** | | [default to undefined]
|
|
10
|
+
**arguments** | **Array<string>** | | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { V1SetupAction } from '@ourskyai/astro-api';
|
|
16
|
+
|
|
17
|
+
const instance: V1SetupAction = {
|
|
18
|
+
action,
|
|
19
|
+
arguments,
|
|
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,51 @@
|
|
|
1
|
+
# V1UpdateNodeRequest
|
|
2
|
+
|
|
3
|
+
Update Node
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**nodeId** | **string** | | [default to undefined]
|
|
10
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**observatoryId** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**cameraId** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**opticalTubeId** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**mountId** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**filterWheelId** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**focuserId** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**rotatorInstanceId** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**maxAltitude** | **number** | | [optional] [default to undefined]
|
|
19
|
+
**elevationMask** | [**Array<V1ElevationMaskPoint>**](V1ElevationMaskPoint.md) | | [optional] [default to undefined]
|
|
20
|
+
**location** | [**Location**](Location.md) | | [optional] [default to undefined]
|
|
21
|
+
**ipAddress** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**canonicalName** | **string** | | [optional] [default to undefined]
|
|
23
|
+
**betaSoftwareReleaseChannelUpdatesEnabled** | **boolean** | | [optional] [default to undefined]
|
|
24
|
+
**state** | [**NodeState**](NodeState.md) | | [optional] [default to undefined]
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { V1UpdateNodeRequest } from '@ourskyai/astro-api';
|
|
30
|
+
|
|
31
|
+
const instance: V1UpdateNodeRequest = {
|
|
32
|
+
nodeId,
|
|
33
|
+
name,
|
|
34
|
+
observatoryId,
|
|
35
|
+
cameraId,
|
|
36
|
+
opticalTubeId,
|
|
37
|
+
mountId,
|
|
38
|
+
filterWheelId,
|
|
39
|
+
focuserId,
|
|
40
|
+
rotatorInstanceId,
|
|
41
|
+
maxAltitude,
|
|
42
|
+
elevationMask,
|
|
43
|
+
location,
|
|
44
|
+
ipAddress,
|
|
45
|
+
canonicalName,
|
|
46
|
+
betaSoftwareReleaseChannelUpdatesEnabled,
|
|
47
|
+
state,
|
|
48
|
+
};
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
[[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
|
+
# V1VideoModeFramerateProperty
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**roiXPixels** | **number** | | [default to undefined]
|
|
9
|
+
**roiYPixels** | **number** | | [default to undefined]
|
|
10
|
+
**adcBitDepth** | **number** | | [default to undefined]
|
|
11
|
+
**fps** | **number** | | [default to undefined]
|
|
12
|
+
**binning** | **number** | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { V1VideoModeFramerateProperty } from '@ourskyai/astro-api';
|
|
18
|
+
|
|
19
|
+
const instance: V1VideoModeFramerateProperty = {
|
|
20
|
+
roiXPixels,
|
|
21
|
+
roiYPixels,
|
|
22
|
+
adcBitDepth,
|
|
23
|
+
fps,
|
|
24
|
+
binning,
|
|
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)
|