@ourskyai/platform-api 1.3.8815 → 1.4.123

package/docs/V1CreateNodeFlareResponse.md

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

@@ -0,0 +1,67 @@
+# V1CreateProcessedImageSetImageRequest
+
+Data needed to create a complete image set image and its extracted data.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**imageSetId** | **string** |  | [default to undefined]
+**binning** | **number** |  | [default to undefined]
+**exposureLength** | **number** |  | [default to undefined]
+**imageSha** | **string** |  | [optional] [default to undefined]
+**imageSizeMb** | **number** |  | [optional] [default to undefined]
+**capturedAt** | **string** |  | [default to undefined]
+**gpsTimestamp** | **boolean** |  | [default to undefined]
+**rejectedReason** | [**V1ImageRejectionReason**](V1ImageRejectionReason.md) |  | [optional] [default to undefined]
+**fwhmAverage** | **number** |  | [optional] [default to undefined]
+**fwhmStdDev** | **number** |  | [optional] [default to undefined]
+**raDegrees** | **number** |  | [optional] [default to undefined]
+**decDegrees** | **number** |  | [optional] [default to undefined]
+**raOffset** | **number** |  | [optional] [default to undefined]
+**decOffset** | **number** |  | [optional] [default to undefined]
+**totalOffset** | **number** |  | [optional] [default to undefined]
+**totalOffsetStdDev** | **number** |  | [optional] [default to undefined]
+**totalOffsetRMS** | **number** |  | [optional] [default to undefined]
+**fitsHeaders** | [**Array<FitsHeader>**](FitsHeader.md) |  | [default to undefined]
+**extractedStreaks** | [**Array<V1ImageSetImageStreak>**](V1ImageSetImageStreak.md) |  | [optional] [default to undefined]
+**extractedDots** | [**Array<V1ImageSetImageDot>**](V1ImageSetImageDot.md) |  | [optional] [default to undefined]
+**targetPrediction** | [**V1PredictedStreakLocation**](V1PredictedStreakLocation.md) |  | [optional] [default to undefined]
+**streakExtractionSource** | [**StreakExtractionSource**](StreakExtractionSource.md) |  | [optional] [default to undefined]
+**attemptedExtractionMethods** | [**Array<StreakExtractionSource>**](StreakExtractionSource.md) |  | [optional] [default to undefined]
+**successfulExtractionMethod** | [**StreakExtractionSource**](StreakExtractionSource.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateProcessedImageSetImageRequest } from '@ourskyai/platform-api';
+
+const instance: V1CreateProcessedImageSetImageRequest = {
+    imageSetId,
+    binning,
+    exposureLength,
+    imageSha,
+    imageSizeMb,
+    capturedAt,
+    gpsTimestamp,
+    rejectedReason,
+    fwhmAverage,
+    fwhmStdDev,
+    raDegrees,
+    decDegrees,
+    raOffset,
+    decOffset,
+    totalOffset,
+    totalOffsetStdDev,
+    totalOffsetRMS,
+    fitsHeaders,
+    extractedStreaks,
+    extractedDots,
+    targetPrediction,
+    streakExtractionSource,
+    attemptedExtractionMethods,
+    successfulExtractionMethod,
+};
+```
+
+[[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/V1CreateTimeWindowedAssetRequest.md

@@ -0,0 +1,34 @@
+# V1CreateTimeWindowedAssetRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodeId** | **string** |  | [default to undefined]
+**assetType** | [**V1TimeWindowedAssetType**](V1TimeWindowedAssetType.md) |  | [default to undefined]
+**dataSource** | [**V1DataSource**](V1DataSource.md) |  | [optional] [default to undefined]
+**description** | **string** |  | [default to undefined]
+**assetStartTime** | **string** |  | [default to undefined]
+**assetEndTime** | **string** |  | [default to undefined]
+**fileSha** | **string** |  | [default to undefined]
+**fileSizeMb** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateTimeWindowedAssetRequest } from '@ourskyai/platform-api';
+
+const instance: V1CreateTimeWindowedAssetRequest = {
+    nodeId,
+    assetType,
+    dataSource,
+    description,
+    assetStartTime,
+    assetEndTime,
+    fileSha,
+    fileSizeMb,
+};
+```
+
+[[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/V1CreateTimeWindowedAssetResponse.md

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

@@ -0,0 +1,10 @@
+# V1DataSource
+
+
+## Enum
+
+* `ALL_SKY_VISIBLE` (value: `'ALL_SKY_VISIBLE'`)
+
+* `ALL_SKY_THERMAL` (value: `'ALL_SKY_THERMAL'`)
+
+[[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/V1DiagnosticInstruction.md

@@ -0,0 +1,21 @@
+# V1DiagnosticInstruction
+
+Diagnostic Instruction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**diagnosticType** | [**V1NodeDiagnosticType**](V1NodeDiagnosticType.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1DiagnosticInstruction } from '@ourskyai/platform-api';
+
+const instance: V1DiagnosticInstruction = {
+    diagnosticType,
+};
+```
+
+[[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/V1DisableDebugServices.md

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

@@ -0,0 +1,24 @@
+# V1DurationMeasured
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [default to undefined]
+**startedAt** | **string** |  | [default to undefined]
+**endedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1DurationMeasured } from '@ourskyai/platform-api';
+
+const instance: V1DurationMeasured = {
+    name,
+    startedAt,
+    endedAt,
+};
+```
+
+[[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/platform-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/V1EnableAutonomousOperation.md

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

@@ -0,0 +1,26 @@
+# V1EnableDebugServices
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodeId** | **string** |  | [default to undefined]
+**datadogAPIKey** | **string** |  | [default to undefined]
+**datadogURL** | **string** |  | [default to undefined]
+**executableAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1EnableDebugServices } from '@ourskyai/platform-api';
+
+const instance: V1EnableDebugServices = {
+    nodeId,
+    datadogAPIKey,
+    datadogURL,
+    executableAt,
+};
+```
+
+[[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/V1EnableManualOperation.md

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

@@ -0,0 +1,8 @@
+# V1FileType
+
+
+## Enum
+
+* `ZIP` (value: `'ZIP'`)
+
+[[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/platform-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/platform-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/platform-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/V1GenerateEdgeTokenResponse.md

@@ -0,0 +1,22 @@
+# V1GenerateEdgeTokenResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **string** | The signed JWT token for authenticating against the edge controller | [default to undefined]
+**expiresAt** | **string** | The expiration time of the token | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1GenerateEdgeTokenResponse } from '@ourskyai/platform-api';
+
+const instance: V1GenerateEdgeTokenResponse = {
+    token,
+    expiresAt,
+};
+```
+
+[[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/V1GetInstructionRequest.md

@@ -0,0 +1,28 @@
+# V1GetInstructionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nodeId** | **string** |  | [default to undefined]
+**supportedDiagnostics** | [**Array<V1NodeDiagnosticType>**](V1NodeDiagnosticType.md) |  | [default to undefined]
+**altitude** | **number** |  | [optional] [default to undefined]
+**azimuth** | **number** |  | [optional] [default to undefined]
+**uploadHealth** | [**V1GetInstructionRequestUploadHealth**](V1GetInstructionRequestUploadHealth.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetInstructionRequest } from '@ourskyai/platform-api';
+
+const instance: V1GetInstructionRequest = {
+    nodeId,
+    supportedDiagnostics,
+    altitude,
+    azimuth,
+    uploadHealth,
+};
+```
+
+[[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/V1GetInstructionRequestUploadHealth.md

@@ -0,0 +1,24 @@
+# V1GetInstructionRequestUploadHealth
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**queueSize** | **number** |  | [optional] [default to undefined]
+**lastUploadTime** | **string** |  | [optional] [default to undefined]
+**averageUploadDurationSeconds** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1GetInstructionRequestUploadHealth } from '@ourskyai/platform-api';
+
+const instance: V1GetInstructionRequestUploadHealth = {
+    queueSize,
+    lastUploadTime,
+    averageUploadDurationSeconds,
+};
+```
+
+[[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/V1GetNodeCommandsResponse.md

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