@ourskyai/astro-api 1.3.8815 → 1.4.123

package/docs/V1CreateCalibrationMasterRequest.md

@@ -0,0 +1,42 @@
+# V1CreateCalibrationMasterRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodeId** | **string** |  | [default to undefined]
+**calibrationMasterType** | [**CalibrationMasterType**](CalibrationMasterType.md) |  | [default to undefined]
+**filterType** | [**FilterType**](FilterType.md) |  | [optional] [default to undefined]
+**binXY** | **number** |  | [default to undefined]
+**gain** | **number** |  | [optional] [default to undefined]
+**readoutMode** | **number** |  | [optional] [default to undefined]
+**temperature** | **number** | temperature in degrees celsius | [optional] [default to undefined]
+**exposureTime** | **number** |  | [default to undefined]
+**rotatorAngle** | **number** |  | [optional] [default to undefined]
+**offset** | **number** |  | [optional] [default to undefined]
+**overwrite** | **boolean** |  | [optional] [default to undefined]
+**capturedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateCalibrationMasterRequest } from '@ourskyai/astro-api';
+
+const instance: V1CreateCalibrationMasterRequest = {
+    nodeId,
+    calibrationMasterType,
+    filterType,
+    binXY,
+    gain,
+    readoutMode,
+    temperature,
+    exposureTime,
+    rotatorAngle,
+    offset,
+    overwrite,
+    capturedAt,
+};
+```
+
+[[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/V1CreateCalibrationMasterResponse.md

@@ -0,0 +1,22 @@
+# V1CreateCalibrationMasterResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**uploadUrl** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateCalibrationMasterResponse } from '@ourskyai/astro-api';
+
+const instance: V1CreateCalibrationMasterResponse = {
+    id,
+    uploadUrl,
+};
+```
+
+[[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/V1CreateCalibrationSetImageRequest.md

@@ -0,0 +1,22 @@
+# V1CreateCalibrationSetImageRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**calibrationSetId** | **string** |  | [default to undefined]
+**nodeId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateCalibrationSetImageRequest } from '@ourskyai/astro-api';
+
+const instance: V1CreateCalibrationSetImageRequest = {
+    calibrationSetId,
+    nodeId,
+};
+```
+
+[[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/V1CreateCalibrationSetImageResponse.md

@@ -0,0 +1,22 @@
+# V1CreateCalibrationSetImageResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**uploadUrl** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateCalibrationSetImageResponse } from '@ourskyai/astro-api';
+
+const instance: V1CreateCalibrationSetImageResponse = {
+    id,
+    uploadUrl,
+};
+```
+
+[[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/V1CreateCalibrationSetRequest.md

@@ -0,0 +1,40 @@
+# V1CreateCalibrationSetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodeId** | **string** |  | [default to undefined]
+**calibrationSetType** | [**CalibrationMasterType**](CalibrationMasterType.md) |  | [default to undefined]
+**filterType** | [**FilterType**](FilterType.md) |  | [optional] [default to undefined]
+**binXY** | **number** |  | [default to undefined]
+**gain** | **number** |  | [optional] [default to undefined]
+**readoutMode** | **number** |  | [optional] [default to undefined]
+**temperature** | **number** | temperature in degrees celsius | [optional] [default to undefined]
+**exposureTime** | **number** |  | [default to undefined]
+**rotatorAngle** | **number** |  | [optional] [default to undefined]
+**offset** | **number** |  | [optional] [default to undefined]
+**capturedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateCalibrationSetRequest } from '@ourskyai/astro-api';
+
+const instance: V1CreateCalibrationSetRequest = {
+    nodeId,
+    calibrationSetType,
+    filterType,
+    binXY,
+    gain,
+    readoutMode,
+    temperature,
+    exposureTime,
+    rotatorAngle,
+    offset,
+    capturedAt,
+};
+```
+
+[[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/V1CreateCalibrationSetResponse.md

@@ -0,0 +1,20 @@
+# V1CreateCalibrationSetResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateCalibrationSetResponse } from '@ourskyai/astro-api';
+
+const instance: V1CreateCalibrationSetResponse = {
+    id,
+};
+```
+
+[[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/V1CreateImageSetImageRequest.md

@@ -0,0 +1,32 @@
+# V1CreateImageSetImageRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**imageSetId** | **string** |  | [default to undefined]
+**imageFileType** | [**V1ImageFileType**](V1ImageFileType.md) |  | [optional] [default to undefined]
+**binning** | **number** |  | [optional] [default to undefined]
+**exposureLength** | **number** |  | [optional] [default to undefined]
+**imageSha** | **string** |  | [optional] [default to undefined]
+**imageSizeMb** | **number** |  | [optional] [default to undefined]
+**capturedAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateImageSetImageRequest } from '@ourskyai/astro-api';
+
+const instance: V1CreateImageSetImageRequest = {
+    imageSetId,
+    imageFileType,
+    binning,
+    exposureLength,
+    imageSha,
+    imageSizeMb,
+    capturedAt,
+};
+```
+
+[[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/V1CreateImageSetImageResponse.md

@@ -0,0 +1,23 @@
+# V1CreateImageSetImageResponse
+
+Response from image creation, with image ID and presigned S3 upload URL.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**uploadUrl** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateImageSetImageResponse } from '@ourskyai/astro-api';
+
+const instance: V1CreateImageSetImageResponse = {
+    id,
+    uploadUrl,
+};
+```
+
+[[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/V1CreateImageSetRequest.md

@@ -0,0 +1,28 @@
+# V1CreateImageSetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodeId** | **string** |  | [default to undefined]
+**observationId** | **string** |  | [optional] [default to undefined]
+**type** | [**ImageSetType**](ImageSetType.md) |  | [default to undefined]
+**trackingType** | [**TrackingType**](TrackingType.md) |  | [optional] [default to undefined]
+**filterType** | [**FilterType**](FilterType.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateImageSetRequest } from '@ourskyai/astro-api';
+
+const instance: V1CreateImageSetRequest = {
+    nodeId,
+    observationId,
+    type,
+    trackingType,
+    filterType,
+};
+```
+
+[[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/V1CreateNodeRequest.md

@@ -0,0 +1,37 @@
+# V1CreateNodeRequest
+
+Create Node
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**observatoryId** | **string** |  | [optional] [default to undefined]
+**cameraId** | **string** |  | [default to undefined]
+**opticalTubeId** | **string** |  | [default to undefined]
+**mountId** | **string** |  | [default to undefined]
+**filterWheelId** | **string** |  | [optional] [default to undefined]
+**focuserId** | **string** |  | [optional] [default to undefined]
+**maxAltitude** | **number** |  | [default to undefined]
+**location** | [**Location**](Location.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateNodeRequest } from '@ourskyai/astro-api';
+
+const instance: V1CreateNodeRequest = {
+    name,
+    observatoryId,
+    cameraId,
+    opticalTubeId,
+    mountId,
+    filterWheelId,
+    focuserId,
+    maxAltitude,
+    location,
+};
+```
+
+[[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/V1CreateOpticalTrainInstanceRequest.md

@@ -0,0 +1,28 @@
+# V1CreateOpticalTrainInstanceRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cameraInstanceId** | **string** |  | [optional] [default to undefined]
+**rotatorInstanceId** | **string** |  | [optional] [default to undefined]
+**filterWheelInstanceId** | **string** |  | [optional] [default to undefined]
+**focuserInstanceId** | **string** |  | [optional] [default to undefined]
+**opticalTubeInstanceId** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateOpticalTrainInstanceRequest } from '@ourskyai/astro-api';
+
+const instance: V1CreateOpticalTrainInstanceRequest = {
+    cameraInstanceId,
+    rotatorInstanceId,
+    filterWheelInstanceId,
+    focuserInstanceId,
+    opticalTubeInstanceId,
+};
+```
+
+[[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/V1ElevationMaskPoint.md

@@ -0,0 +1,25 @@
+# V1ElevationMaskPoint
+
+Elevation Mask Point
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**azimuthDegrees** | **number** |  | [default to undefined]
+**minAltitudeDegrees** | **number** |  | [default to undefined]
+**maxAltitudeDegrees** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1ElevationMaskPoint } from '@ourskyai/astro-api';
+
+const instance: V1ElevationMaskPoint = {
+    azimuthDegrees,
+    minAltitudeDegrees,
+    maxAltitudeDegrees,
+};
+```
+
+[[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/V1Focuser.md

@@ -0,0 +1,27 @@
+# V1Focuser
+
+Focuser
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**model** | **string** |  | [default to undefined]
+**manufacturer** | **string** |  | [optional] [default to undefined]
+**travelDistanceMm** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1Focuser } from '@ourskyai/astro-api';
+
+const instance: V1Focuser = {
+    id,
+    model,
+    manufacturer,
+    travelDistanceMm,
+};
+```
+
+[[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/V1GainCurve.md

@@ -0,0 +1,25 @@
+# V1GainCurve
+
+Gain Curve
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gainMode** | **number** |  | [default to undefined]
+**gainCurve** | [**Array<V1GainCurvePoint>**](V1GainCurvePoint.md) |  | [default to undefined]
+**readoutNoiseCurve** | [**Array<V1ReadNoisePoint>**](V1ReadNoisePoint.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1GainCurve } from '@ourskyai/astro-api';
+
+const instance: V1GainCurve = {
+    gainMode,
+    gainCurve,
+    readoutNoiseCurve,
+};
+```
+
+[[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/V1GainCurvePoint.md

@@ -0,0 +1,22 @@
+# V1GainCurvePoint
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gain** | **number** |  | [default to undefined]
+**eADU** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1GainCurvePoint } from '@ourskyai/astro-api';
+
+const instance: V1GainCurvePoint = {
+    gain,
+    eADU,
+};
+```
+
+[[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/V1GetAstroPlatformCreditBalanceResponse.md

@@ -0,0 +1,21 @@
+# V1GetAstroPlatformCreditBalanceResponse
+
+Astro Platform Credit Balance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetAstroPlatformCreditBalanceResponse } from '@ourskyai/astro-api';
+
+const instance: V1GetAstroPlatformCreditBalanceResponse = {
+    amount,
+};
+```
+
+[[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/V1GetNodes.md

@@ -0,0 +1,20 @@
+# V1GetNodes
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodes** | [**Array<V1NodeWithLocation>**](V1NodeWithLocation.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetNodes } from '@ourskyai/astro-api';
+
+const instance: V1GetNodes = {
+    nodes,
+};
+```
+
+[[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/V1GetOrCreateCameraRequest.md

@@ -0,0 +1,60 @@
+# V1GetOrCreateCameraRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**model** | **string** |  | [optional] [default to undefined]
+**pixelSizeMicrons** | **number** |  | [optional] [default to undefined]
+**fullWellCapacity** | **number** |  | [optional] [default to undefined]
+**pixelsX** | **number** |  | [optional] [default to undefined]
+**pixelsY** | **number** |  | [optional] [default to undefined]
+**megapixels** | **number** |  | [optional] [default to undefined]
+**chilled** | **boolean** |  | [optional] [default to undefined]
+**shutterType** | [**ShutterType**](ShutterType.md) |  | [optional] [default to undefined]
+**sensorXmm** | **number** |  | [optional] [default to undefined]
+**sensorYmm** | **number** |  | [optional] [default to undefined]
+**unityGain** | **number** |  | [optional] [default to undefined]
+**optimalNighttimeGain** | **number** |  | [optional] [default to undefined]
+**optimalNighttimeGainOffset** | **number** |  | [optional] [default to undefined]
+**optimalNighttimeGainMode** | **number** |  | [optional] [default to undefined]
+**supportsVideoMode** | **boolean** |  | [optional] [default to undefined]
+**adcBitDepth** | **number** |  | [optional] [default to undefined]
+**quantumEfficiency** | **number** |  | [optional] [default to undefined]
+**gainCurves** | [**Array<V1GainCurve>**](V1GainCurve.md) |  | [optional] [default to undefined]
+**setupActions** | [**Array<V1SetupAction>**](V1SetupAction.md) |  | [optional] [default to undefined]
+**isColor** | **boolean** |  | [optional] [default to undefined]
+**videoModeFramerateProperties** | [**Array<V1VideoModeFramerateProperty>**](V1VideoModeFramerateProperty.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetOrCreateCameraRequest } from '@ourskyai/astro-api';
+
+const instance: V1GetOrCreateCameraRequest = {
+    model,
+    pixelSizeMicrons,
+    fullWellCapacity,
+    pixelsX,
+    pixelsY,
+    megapixels,
+    chilled,
+    shutterType,
+    sensorXmm,
+    sensorYmm,
+    unityGain,
+    optimalNighttimeGain,
+    optimalNighttimeGainOffset,
+    optimalNighttimeGainMode,
+    supportsVideoMode,
+    adcBitDepth,
+    quantumEfficiency,
+    gainCurves,
+    setupActions,
+    isColor,
+    videoModeFramerateProperties,
+};
+```
+
+[[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/V1GetOrCreateFocuserRequest.md

@@ -0,0 +1,24 @@
+# V1GetOrCreateFocuserRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**model** | **string** |  | [optional] [default to undefined]
+**manufacturer** | **string** |  | [optional] [default to undefined]
+**travelDistanceMm** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetOrCreateFocuserRequest } from '@ourskyai/astro-api';
+
+const instance: V1GetOrCreateFocuserRequest = {
+    model,
+    manufacturer,
+    travelDistanceMm,
+};
+```
+
+[[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/V1GetOrCreateMountRequest.md

@@ -0,0 +1,24 @@
+# V1GetOrCreateMountRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**model** | **string** |  | [optional] [default to undefined]
+**type** | [**MountType**](MountType.md) |  | [optional] [default to undefined]
+**geometry** | [**MountGeometry**](MountGeometry.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetOrCreateMountRequest } from '@ourskyai/astro-api';
+
+const instance: V1GetOrCreateMountRequest = {
+    model,
+    type,
+    geometry,
+};
+```
+
+[[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/V1GetOrCreateOpticalTubeRequest.md

@@ -0,0 +1,26 @@
+# V1GetOrCreateOpticalTubeRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**model** | **string** |  | [optional] [default to undefined]
+**focalLengthMm** | **number** |  | [optional] [default to undefined]
+**apertureMm** | **number** |  | [optional] [default to undefined]
+**type** | [**OpticalTubeType**](OpticalTubeType.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetOrCreateOpticalTubeRequest } from '@ourskyai/astro-api';
+
+const instance: V1GetOrCreateOpticalTubeRequest = {
+    model,
+    focalLengthMm,
+    apertureMm,
+    type,
+};
+```
+
+[[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/V1ImageFileType.md

@@ -0,0 +1,10 @@
+# V1ImageFileType
+
+
+## Enum
+
+* `FITS` (value: `'FITS'`)
+
+* `JPG` (value: `'JPG'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)