@ourskyai/platform-api 1.3.8639 → 1.4.118

package/docs/V1AutoFocusInstruction.md

@@ -0,0 +1,23 @@
+# V1AutoFocusInstruction
+
+Autofocus Instruction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**coordinates** | [**Array<V1AutoFocusInstructionCoordinatesInner>**](V1AutoFocusInstructionCoordinatesInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1AutoFocusInstruction } from '@ourskyai/platform-api';
+
+const instance: V1AutoFocusInstruction = {
+    id,
+    coordinates,
+};
+```
+
+[[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/V1AutoFocusInstructionCoordinatesInner.md

@@ -0,0 +1,23 @@
+# V1AutoFocusInstructionCoordinatesInner
+
+Coordinates in degrees in epoch J2000
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rightAscension** | **number** |  | [optional] [default to undefined]
+**declination** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1AutoFocusInstructionCoordinatesInner } from '@ourskyai/platform-api';
+
+const instance: V1AutoFocusInstructionCoordinatesInner = {
+    rightAscension,
+    declination,
+};
+```
+
+[[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/V1BlackoutBox.md

@@ -0,0 +1,26 @@
+# V1BlackoutBox
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**raStartDegrees** | **number** |  | [optional] [default to undefined]
+**raEndDegrees** | **number** |  | [optional] [default to undefined]
+**decStartDegrees** | **number** |  | [optional] [default to undefined]
+**decEndDegrees** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1BlackoutBox } from '@ourskyai/platform-api';
+
+const instance: V1BlackoutBox = {
+    raStartDegrees,
+    raEndDegrees,
+    decStartDegrees,
+    decEndDegrees,
+};
+```
+
+[[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/platform-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/V1CameraRollImage.md

@@ -0,0 +1,34 @@
+# V1CameraRollImage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**imageSetId** | **string** |  | [default to undefined]
+**imageType** | [**ImageSetType**](ImageSetType.md) |  | [default to undefined]
+**thumbnailUrl** | **string** |  | [default to undefined]
+**fullSizeJpegUrl** | **string** |  | [default to undefined]
+**width** | **number** |  | [optional] [default to undefined]
+**height** | **number** |  | [optional] [default to undefined]
+**capturedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CameraRollImage } from '@ourskyai/platform-api';
+
+const instance: V1CameraRollImage = {
+    id,
+    imageSetId,
+    imageType,
+    thumbnailUrl,
+    fullSizeJpegUrl,
+    width,
+    height,
+    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/V1ClientToken.md

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

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

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

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

package/docs/V1CreateAllSkyPredictionRequest.md

@@ -0,0 +1,24 @@
+# V1CreateAllSkyPredictionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**imageId** | **string** |  | [default to undefined]
+**label** | [**V1AllSkyPredictionLabel**](V1AllSkyPredictionLabel.md) |  | [default to undefined]
+**confidence** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateAllSkyPredictionRequest } from '@ourskyai/platform-api';
+
+const instance: V1CreateAllSkyPredictionRequest = {
+    imageId,
+    label,
+    confidence,
+};
+```
+
+[[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/V1CreateAutofocusResultRequest.md

@@ -0,0 +1,28 @@
+# V1CreateAutofocusResultRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | The autofocus id | [default to undefined]
+**node_id** | **string** | The node that autofocus was performed on. | [default to undefined]
+**autofocus_time** | **string** | The timestamp when the autofocus operation was completed. | [default to undefined]
+**hfrBefore** | **number** | The HFR value before autofocusing. | [default to undefined]
+**hfrAfter** | **number** | The HFR value after autofocusing. | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateAutofocusResultRequest } from '@ourskyai/platform-api';
+
+const instance: V1CreateAutofocusResultRequest = {
+    id,
+    node_id,
+    autofocus_time,
+    hfrBefore,
+    hfrAfter,
+};
+```
+
+[[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/V1CreateImageMetadataRequest.md

@@ -0,0 +1,26 @@
+# V1CreateImageMetadataRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**plateSolveResult** | [**V1PlateSolveResult**](V1PlateSolveResult.md) |  | [optional] [default to undefined]
+**inputStars** | [**Array<V1HFRStar>**](V1HFRStar.md) | Extracted star features from the image. Used as inputs to plate solving | [optional] [default to undefined]
+**sipCoefficients** | [**V1SIPCoefficients**](V1SIPCoefficients.md) |  | [optional] [default to undefined]
+**photometricZeroPoint** | **number** | Photometric zero point offset. Add to instrumental magnitude (-2.5*log10(flux)) to get calibrated magnitude in standard photometric system. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateImageMetadataRequest } from '@ourskyai/platform-api';
+
+const instance: V1CreateImageMetadataRequest = {
+    plateSolveResult,
+    inputStars,
+    sipCoefficients,
+    photometricZeroPoint,
+};
+```
+
+[[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/platform-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/platform-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/V1CreateImageSetImageUploadUrlRequest.md

@@ -0,0 +1,26 @@
+# V1CreateImageSetImageUploadUrlRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**imageSetId** | **string** |  | [default to undefined]
+**imageId** | **string** |  | [default to undefined]
+**imageFileType** | [**V1ImageFileType**](V1ImageFileType.md) |  | [default to undefined]
+**assetSize** | [**V1AssetSize**](V1AssetSize.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateImageSetImageUploadUrlRequest } from '@ourskyai/platform-api';
+
+const instance: V1CreateImageSetImageUploadUrlRequest = {
+    imageSetId,
+    imageId,
+    imageFileType,
+    assetSize,
+};
+```
+
+[[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/V1CreateImageSetImageUploadUrlResponse.md

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

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

@@ -0,0 +1,37 @@
+# V1CreateNodeControllerCrashReportRequest
+
+create a crash report
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lineageId** | **string** |  | [default to undefined]
+**fileSha** | **string** |  | [default to undefined]
+**fileSizeMb** | **number** |  | [default to undefined]
+**softwareVersion** | **string** |  | [default to undefined]
+**componentName** | **string** |  | [default to undefined]
+**kernelVersion** | **string** |  | [default to undefined]
+**backtrace** | **string** |  | [default to undefined]
+**singleThreadBacktrace** | **string** |  | [optional] [default to undefined]
+**addressSanitizerBacktrace** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateNodeControllerCrashReportRequest } from '@ourskyai/platform-api';
+
+const instance: V1CreateNodeControllerCrashReportRequest = {
+    lineageId,
+    fileSha,
+    fileSizeMb,
+    softwareVersion,
+    componentName,
+    kernelVersion,
+    backtrace,
+    singleThreadBacktrace,
+    addressSanitizerBacktrace,
+};
+```
+
+[[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/V1CreateNodeControllerCrashReportResponse.md

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

@@ -0,0 +1,28 @@
+# V1CreateNodeDiagnostic
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**componentType** | [**V1NodeComponentType**](V1NodeComponentType.md) |  | [default to undefined]
+**componentId** | **string** |  | [default to undefined]
+**diagnosticType** | [**V1NodeDiagnosticType**](V1NodeDiagnosticType.md) |  | [default to undefined]
+**value** | **string** |  | [default to undefined]
+**measuredAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateNodeDiagnostic } from '@ourskyai/platform-api';
+
+const instance: V1CreateNodeDiagnostic = {
+    componentType,
+    componentId,
+    diagnosticType,
+    value,
+    measuredAt,
+};
+```
+
+[[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/V1CreateNodeDiagnosticsRequest.md

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

@@ -0,0 +1,24 @@
+# V1CreateNodeEvent
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**V1NodeEventType**](V1NodeEventType.md) |  | [default to undefined]
+**body** | **object** |  | [default to undefined]
+**generatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { V1CreateNodeEvent } from '@ourskyai/platform-api';
+
+const instance: V1CreateNodeEvent = {
+    type,
+    body,
+    generatedAt,
+};
+```
+
+[[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/V1CreateNodeEventsRequest.md

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

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