@ourskyai/astro-api 1.3.8815 → 1.4.123

package/docs/EmptySuccess.md

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

@@ -0,0 +1,60 @@
+# FilterType
+
+
+## Enum
+
+* `NONE` (value: `'NONE'`)
+
+* `RED` (value: `'RED'`)
+
+* `BLUE` (value: `'BLUE'`)
+
+* `GREEN` (value: `'GREEN'`)
+
+* `UV` (value: `'UV'`)
+
+* `IR` (value: `'IR'`)
+
+* `LUMINANCE` (value: `'LUMINANCE'`)
+
+* `ENHANCED_LUMINANCE` (value: `'ENHANCED_LUMINANCE'`)
+
+* `H_ALPHA` (value: `'H_ALPHA'`)
+
+* `H_BETA` (value: `'H_BETA'`)
+
+* `S_II` (value: `'S_II'`)
+
+* `O_III` (value: `'O_III'`)
+
+* `DUAL_BAND` (value: `'DUAL_BAND'`)
+
+* `PHOTO_JOHNSON_U` (value: `'PHOTO_JOHNSON_U'`)
+
+* `PHOTO_JOHNSON_B` (value: `'PHOTO_JOHNSON_B'`)
+
+* `PHOTO_JOHNSON_V` (value: `'PHOTO_JOHNSON_V'`)
+
+* `PHOTO_COUSINS_R` (value: `'PHOTO_COUSINS_R'`)
+
+* `PHOTO_COUSINS_I` (value: `'PHOTO_COUSINS_I'`)
+
+* `PHOTO_SLOAN_U` (value: `'PHOTO_SLOAN_U'`)
+
+* `PHOTO_SLOAN_G` (value: `'PHOTO_SLOAN_G'`)
+
+* `PHOTO_SLOAN_R` (value: `'PHOTO_SLOAN_R'`)
+
+* `PHOTO_SLOAN_I` (value: `'PHOTO_SLOAN_I'`)
+
+* `PHOTO_SLOAN_Z` (value: `'PHOTO_SLOAN_Z'`)
+
+* `TRIPLE_BAND` (value: `'TRIPLE_BAND'`)
+
+* `QUAD_BAND` (value: `'QUAD_BAND'`)
+
+* `DARK` (value: `'DARK'`)
+
+* `OTHER` (value: `'OTHER'`)
+
+[[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/FitsHeader.md

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

@@ -0,0 +1,24 @@
+# ImageSetType
+
+
+## Enum
+
+* `ASTRONOMICAL` (value: `'ASTRONOMICAL'`)
+
+* `EARTH_ORBITAL` (value: `'EARTH_ORBITAL'`)
+
+* `GNSS_CALIBRATION` (value: `'GNSS_CALIBRATION'`)
+
+* `SATELLITE_CALIBRATION` (value: `'SATELLITE_CALIBRATION'`)
+
+* `WAVEFRONT_SENSOR_FACTORY_CALIBRATION` (value: `'WAVEFRONT_SENSOR_FACTORY_CALIBRATION'`)
+
+* `ALL_SKY` (value: `'ALL_SKY'`)
+
+* `THERMAL` (value: `'THERMAL'`)
+
+* `STACKED_ASTRONOMICAL` (value: `'STACKED_ASTRONOMICAL'`)
+
+* `TERRESTRIAL_DOWNLINK` (value: `'TERRESTRIAL_DOWNLINK'`)
+
+[[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/IntegrationTime.md

@@ -0,0 +1,27 @@
+# IntegrationTime
+
+Stacked image integration times by filter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filterType** | [**FilterType**](FilterType.md) |  | [default to undefined]
+**imageCount** | **number** |  | [default to undefined]
+**exposureDurationSeconds** | **number** |  | [default to undefined]
+**combinedExposureSeconds** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { IntegrationTime } from '@ourskyai/astro-api';
+
+const instance: IntegrationTime = {
+    filterType,
+    imageCount,
+    exposureDurationSeconds,
+    combinedExposureSeconds,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Location.md

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

@@ -0,0 +1,10 @@
+# MountGeometry
+
+
+## Enum
+
+* `ALT_AZ` (value: `'ALT_AZ'`)
+
+* `EQUATORIAL` (value: `'EQUATORIAL'`)
+
+[[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/MountType.md

@@ -0,0 +1,10 @@
+# MountType
+
+
+## Enum
+
+* `ALT_AZ` (value: `'ALT_AZ'`)
+
+* `EQUITORIAL` (value: `'EQUITORIAL'`)
+
+[[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/NodeState.md

@@ -0,0 +1,20 @@
+# NodeState
+
+
+## Enum
+
+* `READY` (value: `'READY'`)
+
+* `PENDING` (value: `'PENDING'`)
+
+* `OFFLINE` (value: `'OFFLINE'`)
+
+* `UNAVAILABLE` (value: `'UNAVAILABLE'`)
+
+* `UNKNOWN` (value: `'UNKNOWN'`)
+
+* `SUPERSEDED` (value: `'SUPERSEDED'`)
+
+* `DECOMMISSIONED` (value: `'DECOMMISSIONED'`)
+
+[[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/OpticalTubeType.md

@@ -0,0 +1,16 @@
+# OpticalTubeType
+
+
+## Enum
+
+* `NEWTONIAN` (value: `'NEWTONIAN'`)
+
+* `SCT` (value: `'SCT'`)
+
+* `MCT` (value: `'MCT'`)
+
+* `RC` (value: `'RC'`)
+
+* `REFRACTOR` (value: `'REFRACTOR'`)
+
+[[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/ShutterType.md

@@ -0,0 +1,10 @@
+# ShutterType
+
+
+## Enum
+
+* `ROLLING` (value: `'ROLLING'`)
+
+* `GLOBAL` (value: `'GLOBAL'`)
+
+[[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/SuccessfulCreate.md

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

@@ -0,0 +1,12 @@
+# TrackingType
+
+
+## Enum
+
+* `SIDEREAL` (value: `'SIDEREAL'`)
+
+* `TARGET_RATE` (value: `'TARGET_RATE'`)
+
+* `NONE` (value: `'NONE'`)
+
+[[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/V1AstroProject.md

@@ -0,0 +1,43 @@
+# V1AstroProject
+
+Astro Project
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**targetId** | **string** |  | [optional] [default to undefined]
+**ra** | **number** |  | [optional] [default to undefined]
+**dec** | **number** |  | [optional] [default to undefined]
+**cameraId** | **string** |  | [default to undefined]
+**otaId** | **string** |  | [default to undefined]
+**imageSets** | **Array<string>** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [optional] [default to undefined]
+**totalImages** | **number** |  | [default to undefined]
+**uploadedImages** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1AstroProject } from '@ourskyai/astro-api';
+
+const instance: V1AstroProject = {
+    id,
+    name,
+    targetId,
+    ra,
+    dec,
+    cameraId,
+    otaId,
+    imageSets,
+    createdAt,
+    updatedAt,
+    totalImages,
+    uploadedImages,
+};
+```
+
+[[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/V1AstroProjectAsset.md

@@ -0,0 +1,41 @@
+# V1AstroProjectAsset
+
+Astro Project Asset
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**assetType** | [**AssetType**](AssetType.md) |  | [default to undefined]
+**filterType** | [**Array<FilterType>**](FilterType.md) |  | [optional] [default to undefined]
+**metadata** | [**V1AstroProjectAssetMetadata**](V1AstroProjectAssetMetadata.md) |  | [optional] [default to undefined]
+**url** | **string** |  | [default to undefined]
+**fileSizeMb** | **number** |  | [optional] [default to undefined]
+**fileType** | [**AssetFileType**](AssetFileType.md) |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**createdBy** | **string** |  | [default to undefined]
+**numberOfCombinedImages** | **number** |  | [optional] [default to undefined]
+**combinedExposureSeconds** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1AstroProjectAsset } from '@ourskyai/astro-api';
+
+const instance: V1AstroProjectAsset = {
+    id,
+    assetType,
+    filterType,
+    metadata,
+    url,
+    fileSizeMb,
+    fileType,
+    createdAt,
+    createdBy,
+    numberOfCombinedImages,
+    combinedExposureSeconds,
+};
+```
+
+[[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/V1AstroProjectAssetMetadata.md

@@ -0,0 +1,22 @@
+# V1AstroProjectAssetMetadata
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integrationTime** | [**Array<IntegrationTime>**](IntegrationTime.md) |  | [optional] [default to undefined]
+**colorCombination** | [**V1AstroProjectAssetMetadataColorCombination**](V1AstroProjectAssetMetadataColorCombination.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1AstroProjectAssetMetadata } from '@ourskyai/astro-api';
+
+const instance: V1AstroProjectAssetMetadata = {
+    integrationTime,
+    colorCombination,
+};
+```
+
+[[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/V1AstroProjectAssetMetadataColorCombination.md

@@ -0,0 +1,24 @@
+# V1AstroProjectAssetMetadataColorCombination
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**red** | [**Array<FilterType>**](FilterType.md) |  | [optional] [default to undefined]
+**green** | [**Array<FilterType>**](FilterType.md) |  | [optional] [default to undefined]
+**blue** | [**Array<FilterType>**](FilterType.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1AstroProjectAssetMetadataColorCombination } from '@ourskyai/astro-api';
+
+const instance: V1AstroProjectAssetMetadataColorCombination = {
+    red,
+    green,
+    blue,
+};
+```
+
+[[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/V1AstroProjectJobLog.md

@@ -0,0 +1,31 @@
+# V1AstroProjectJobLog
+
+Astro Project Job Log
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**jobStatus** | [**V1JobStatus**](V1JobStatus.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**startedAt** | **string** |  | [optional] [default to undefined]
+**finishedAt** | **string** |  | [optional] [default to undefined]
+**progress** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1AstroProjectJobLog } from '@ourskyai/astro-api';
+
+const instance: V1AstroProjectJobLog = {
+    id,
+    jobStatus,
+    createdAt,
+    startedAt,
+    finishedAt,
+    progress,
+};
+```
+
+[[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/V1AstroTarget.md

@@ -0,0 +1,33 @@
+# V1AstroTarget
+
+Astro Target
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**ngc_id** | **string** |  | [optional] [default to undefined]
+**ic_id** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**messier_catalog_name** | **string** |  | [optional] [default to undefined]
+**ra** | **number** |  | [default to undefined]
+**dec** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1AstroTarget } from '@ourskyai/astro-api';
+
+const instance: V1AstroTarget = {
+    id,
+    ngc_id,
+    ic_id,
+    name,
+    messier_catalog_name,
+    ra,
+    dec,
+};
+```
+
+[[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/V1CalibrationMaster.md

@@ -0,0 +1,43 @@
+# V1CalibrationMaster
+
+Calibration Master
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **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]
+**offset** | **number** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**createdBy** | **string** |  | [default to undefined]
+**rotatorAngle** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CalibrationMaster } from '@ourskyai/astro-api';
+
+const instance: V1CalibrationMaster = {
+    id,
+    calibrationMasterType,
+    filterType,
+    binXY,
+    gain,
+    readoutMode,
+    temperature,
+    exposureTime,
+    offset,
+    createdAt,
+    createdBy,
+    rotatorAngle,
+};
+```
+
+[[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/V1Camera.md

@@ -0,0 +1,47 @@
+# V1Camera
+
+Camera
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**model** | **string** |  | [default to undefined]
+**pixelSizeMicrons** | **number** |  | [default to undefined]
+**pixelsX** | **number** |  | [optional] [default to undefined]
+**pixelsY** | **number** |  | [optional] [default to undefined]
+**megapixels** | **number** |  | [default to undefined]
+**chilled** | **boolean** |  | [default to undefined]
+**adcBitDepth** | **number** |  | [default to undefined]
+**gpsTimestamps** | **boolean** |  | [optional] [default to undefined]
+**shutterType** | [**ShutterType**](ShutterType.md) |  | [default to undefined]
+**fullWellCapacity** | **number** |  | [optional] [default to undefined]
+**setupActions** | [**Array<V1SetupAction>**](V1SetupAction.md) |  | [optional] [default to undefined]
+**isColor** | **boolean** |  | [default to undefined]
+**videoModeFramerateProperties** | [**Array<V1VideoModeFramerateProperty>**](V1VideoModeFramerateProperty.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1Camera } from '@ourskyai/astro-api';
+
+const instance: V1Camera = {
+    id,
+    model,
+    pixelSizeMicrons,
+    pixelsX,
+    pixelsY,
+    megapixels,
+    chilled,
+    adcBitDepth,
+    gpsTimestamps,
+    shutterType,
+    fullWellCapacity,
+    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/V1CreateAstroProjectImageSetRequest.md

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

@@ -0,0 +1,30 @@
+# V1CreateAstroProjectRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**targetId** | **string** |  | [optional] [default to undefined]
+**ra** | **number** |  | [optional] [default to undefined]
+**dec** | **number** |  | [optional] [default to undefined]
+**nodeId** | **string** |  | [default to undefined]
+**filterType** | [**FilterType**](FilterType.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateAstroProjectRequest } from '@ourskyai/astro-api';
+
+const instance: V1CreateAstroProjectRequest = {
+    name,
+    targetId,
+    ra,
+    dec,
+    nodeId,
+    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/V1CreateAstroProjectResponse.md

@@ -0,0 +1,23 @@
+# V1CreateAstroProjectResponse
+
+Create Astro Response
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**imageSetId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateAstroProjectResponse } from '@ourskyai/astro-api';
+
+const instance: V1CreateAstroProjectResponse = {
+    id,
+    imageSetId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)